Documentation
¶
Overview ¶
Package github implements the github source plugin: lists repositories and organization members from a single GitHub organization and emits two evidence types — github_repository and github_org_member — suitable for SOC 2 branch-protection and 2FA coverage policies.
Per the KISS-no-DRY axiom (docs/architecture/04-source-plugins.md §The plugin contract), the plugin caches nothing across Collect calls. N policies bound to this plugin → N invocations of Collect.
Test injection: the API interface mirrors the pattern used by internal/sources/aws/iam — the concrete *httpAPI satisfies it, and unit tests inject an in-memory fake. The real HTTP adapter has no integration tests today (deferred — live API integration tests are out of scope for this batch).
Index ¶
Constants ¶
const ( EvidenceTypeRepository = "git_repository" EvidenceTypeDirectoryUser = "directory_user" EvidenceTypeOrgPolicy = "source_control_org_policy" EvidenceTypeVulnerability = "vulnerability_finding" )
Evidence type IDs this plugin emits.
EvidenceTypeRepository is the cross-vendor git_repository shape; GitHub is one of several substitutable source-code platforms (GitLab, Bitbucket, future Gitea/Azure DevOps). EvidenceTypeDirectoryUser is the cross-vendor directory_user shape — GitHub org members are one of several substitutable directory sources (AWS IAM, Okta, future Azure AD/LDAP). EvidenceTypeOrgPolicy is the cross-vendor source_control_org_policy shape — a single org/group-level governance record (GitHub org, GitLab group, Bitbucket workspace). EvidenceTypeVulnerability is the cross-vendor vulnerability_finding shape — one record per open Dependabot alert; GitHub is one of several substitutable finding sources (AWS Inspector, GCP SCC).
const SourceID = "github"
SourceID is the registered ID for the github plugin instance.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API interface {
// ListRepos returns all repos in the configured organization.
// Implementations must page transparently — callers receive the
// full list in one slice.
ListRepos(ctx context.Context) ([]Repo, error)
// ListOrgMembers returns all members of the configured org along
// with their 2FA state and role. 2FA state requires admin scope.
ListOrgMembers(ctx context.Context) ([]Member, error)
// ListOutsideCollaborators returns users with access to org repos
// who are not org members (external identities). 2FA state requires
// admin scope; these users carry no org role.
ListOutsideCollaborators(ctx context.Context) ([]Member, error)
// GetOrgPolicy returns the configured org's governance settings.
// The org-settings fields (2FA requirement, default permission)
// require an org-admin-scoped token.
GetOrgPolicy(ctx context.Context) (OrgPolicy, error)
// ListDependabotAlerts returns the org's open Dependabot alerts.
// Requires a token with security-events read access; when Dependabot
// alerts are disabled for the org (403) the implementation returns an
// empty slice rather than an error, so the per-repo enablement gap is
// reported by the dependabot_alerts_enabled policy instead of failing
// the run.
ListDependabotAlerts(ctx context.Context) ([]DependabotAlert, error)
}
API is the subset of the GitHub REST API the plugin uses. Defining it as an interface lets tests inject a fake without making real network calls; the concrete *httpAPI satisfies it.
type DependabotAlert ¶ added in v0.36.0
type DependabotAlert struct {
Number int
RepoFullName string
PackageName string
Summary string
Severity string
State string
CVEID string
CVSSScore float64
// PatchAvailable is true when GitHub reports a first patched version.
PatchAvailable bool
}
DependabotAlert is the subset of an org Dependabot alert the plugin maps to one vulnerability_finding record. Severity and State carry GitHub's raw vocabulary (low/medium/high/critical, open/dismissed/ fixed); the plugin normalizes them to the evidence type's enums.
type Options ¶
type Options struct {
API API
Org string
// Now is injected so tests can produce deterministic CollectedAt
// values. Production callers leave it nil → time.Now().UTC().
Now func() time.Time
}
Options is the constructor input.
type OrgPolicy ¶ added in v0.36.0
type OrgPolicy struct {
// TwoFactorRequired is the org-wide MFA enforcement flag. GitHub
// reports this as a tri-state (true/false/null when the caller lacks
// admin scope); the adapter normalizes null to false.
TwoFactorRequired bool
// DefaultRepoPermission is the baseline member permission: one of
// none/read/write/admin (GitHub's default_repository_permission).
DefaultRepoPermission string
MembersCanCreatePublicRepos bool
WebCommitSignoffRequired bool
AdvancedSecurityNewRepos bool
SecretScanningNewRepos bool
DependabotAlertsNewRepos bool
}
OrgPolicy is the org/group-level governance state the plugin extracts from a single organization. Exactly one OrgPolicy maps to one source_control_org_policy record. Every field maps to a property of that evidence type so policies never read an absent field.
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin is the in-process github source.
func New ¶
New constructs a Plugin around an explicit API implementation. Callers using the real GitHub REST API should use NewFromToken.
func NewFromToken ¶
NewFromToken constructs a Plugin backed by the real GitHub REST API using the supplied personal-access or app token. The plugin issues requests against api.github.com. Live integration tests are deferred.
func (*Plugin) Collect ¶
func (p *Plugin) Collect(ctx context.Context, req core.SlotRequest) ([]core.EvidenceRecord, error)
Collect returns records for every evidence type in req.AcceptedTypes that this plugin emits. A slot whose Accepts list includes both github types gets records for both in a single call. Records are sorted by ID within each type group; the collector splits them by Type for envelope writing.
type Repo ¶
type Repo struct {
Name string
DefaultBranch string
ProtectionOn bool
RequiredReviews int
// Branch-protection rule details (default branch).
RequiresSignedCommits bool
RequiresLinearHistory bool
AllowsForcePush bool
DismissStaleReviews bool
RequireCodeOwnerReviews bool
// Repository attributes.
IsPrivate bool
Archived bool
// Code-security and analysis features.
SecretScanningEnabled bool
PushProtectionEnabled bool
DependabotAlertsEnabled bool
CodeScanningEnabled bool
}
Repo is the subset of fields the plugin extracts from a repository listing. The plugin returns one record per Repo, augmented with branch-protection state and code-security settings queried via follow-up calls. Every field maps to a property of the git_repository evidence type so policies never read an absent field.