Documentation
¶
There is no documentation for this package.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd is the Plumber command line: the cobra commands (analyze, config, explain, catalog, version), the provider dispatch between the GitLab and GitHub analysis paths, terminal rendering, and every output writer (results JSON, SARIF, GitLab SAST, OCSF, CSV, PBOM) plus the platform push.
|
Package cmd is the Plumber command line: the cobra commands (analyze, config, explain, catalog, version), the provider dispatch between the GitLab and GitHub analysis paths, terminal rendering, and every output writer (results JSON, SARIF, GitLab SAST, OCSF, CSV, PBOM) plus the platform push. |
|
Package configuration owns .plumber.yaml: the typed control configuration structs, loading with unknown-key validation and the v1 to v2 conversion, the overlay merge over the shipped default, the required-components expression parser, the control registry (ids, categories, providers) and the reflected config schema the platform renders forms from.
|
Package configuration owns .plumber.yaml: the typed control configuration structs, loading with unknown-key validation and the v1 to v2 conversion, the overlay merge over the shipped default, the required-components expression parser, the control registry (ids, categories, providers) and the reflected config schema the platform renders forms from. |
|
Package control runs an analysis end to end: it drives the provider data collections, projects the collected data and the user's configuration onto the Rego engine input, evaluates the policies, and turns findings into per-control statuses, the Plumber score, and the catalog of controls and issue codes that every other consumer (the terminal, the outputs, the platform) reads from.
|
Package control runs an analysis end to end: it drives the provider data collections, projects the collected data and the user's configuration onto the Rego engine input, evaluates the policies, and turns findings into per-control statuses, the Plumber score, and the catalog of controls and issue codes that every other consumer (the terminal, the outputs, the platform) reads from. |
|
Package defaultConfig embeds the CLI's shipped .plumber.yaml, the baseline every zero-config run and every `extends: plumber:default` overlay starts from.
|
Package defaultConfig embeds the CLI's shipped .plumber.yaml, the baseline every zero-config run and every `extends: plumber:default` overlay starts from. |
|
finding
|
|
|
identity
Package identity computes the stable identity of a finding: the recipe (versioned by RecipeVersion) that turns a finding's code, subject and configuration into the hash the platform tracks an issue by across runs.
|
Package identity computes the stable identity of a finding: the recipe (versioned by RecipeVersion) that turns a finding's code, subject and configuration into the hash the platform tracks an issue by across runs. |
|
Package github is the GitHub provider: the workflow parser over .github/workflows, the action metadata client that resolves `uses:` refs against the GitHub API, branch protection and ruleset reads, and the intermediate-representation builder the Rego policies evaluate.
|
Package github is the GitHub provider: the workflow parser over .github/workflows, the action metadata client that resolves `uses:` refs against the GitHub API, branch protection and ruleset reads, and the intermediate-representation builder the Rego policies evaluate. |
|
Package gitlab is the GitLab provider: the API clients (REST and GraphQL), the data collections over a project (CI configuration and its includes, images, branch protection, approvals, CI/CD variables, security policy), the intermediate-representation builder those collections feed, and the merge-request comment and badge writers.
|
Package gitlab is the GitLab provider: the API clients (REST and GraphQL), the data collections over a project (CI configuration and its includes, images, branch protection, approvals, CI/CD variables, security policy), the intermediate-representation builder those collections feed, and the merge-request comment and badge writers. |
|
internal
|
|
|
cidigest
Package cidigest computes the CI config content digest the platform and the CLI compare to decide whether a branch may reuse the platform snapshot's resolved config: a content-keyed (not branch-keyed) identity for a project's CI config, made of the root file plus every LOCAL include statically reachable from it.
|
Package cidigest computes the CI config content digest the platform and the CLI compare to decide whether a branch may reuse the platform snapshot's resolved config: a content-keyed (not branch-keyed) identity for a project's CI config, made of the root file plus every LOCAL include statically reachable from it. |
|
engine/opa
Package opa hosts the Rego engine: it compiles the embedded policies, evaluates them over the intermediate representation and the projected configuration, and returns findings with their source locations.
|
Package opa hosts the Rego engine: it compiles the embedded policies, evaluates them over the intermediate representation and the projected configuration, and returns findings with their source locations. |
|
ir
Package ir is the provider-neutral intermediate representation of a pipeline: jobs, images, includes, branches, variables and settings in the one shape every Rego policy reads, built by the gitlab and github packages.
|
Package ir is the provider-neutral intermediate representation of a pipeline: jobs, images, includes, branches, variables and settings in the one shape every Rego policy reads, built by the gitlab and github packages. |
|
platform
Package platform is the CLI side of the platform link: the /context read that a linked run starts from (policies, snapshot lanes, dismissals), the run context that records what the platform served, and the HTTP client with its OIDC token exchange.
|
Package platform is the CLI side of the platform link: the /context read that a linked run starts from (policies, snapshot lanes, dismissals), the run context that records what the platform served, and the HTTP client with its OIDC token exchange. |
|
Package pbom generates the Pipeline Bill of Materials: the CycloneDX and native documents that inventory a pipeline's includes, components, images and actions together with their compliance verdicts.
|
Package pbom generates the Pipeline Bill of Materials: the CycloneDX and native documents that inventory a pipeline's includes, components, images and actions together with their compliance verdicts. |
|
Package policies embeds the Rego policies, one file per control, that the engine evaluates over the intermediate representation.
|
Package policies embeds the Rego policies, one file per control, that the engine evaluates over the intermediate representation. |
|
Package provider is the seam between the command line and the two analysis paths: one Provider implementation per git host (GitLab, GitHub) answers how to run the analysis, compute compliance, write the PBOM and perform the post-analysis actions, so the cmd package never branches on the provider name itself.
|
Package provider is the seam between the command line and the two analysis paths: one Provider implementation per git host (GitLab, GitHub) answers how to run the analysis, compute compliance, write the PBOM and perform the post-analysis actions, so the cmd package never branches on the provider name itself. |
|
Package utils holds the small provider-neutral helpers shared across the CLI: git remote detection and parsing, bounded file reads, FNV hashing, and container image reference normalization.
|
Package utils holds the small provider-neutral helpers shared across the CLI: git remote detection and parsing, bounded file reads, FNV hashing, and container image reference normalization. |
Click to show internal directories.
Click to hide internal directories.