v0.1.0¶
Release Date: 2026-11-20
Highlights¶
- Check a credential registry against reality.
credforge checkcompares a systemspec-credential registry and its event log with the stores and consumers it names, and reports each store asmissing,stale,unregistered,changed,unrecorded,unlisted,unobservedorpresent. - No value is ever read. Observers list names and when each was last
set; no type has a field for a value, and the AWS observer never calls
GetParameter. - Catches what breaks builds. A workflow reading a secret its
repository never had is
unregistered; a store last set before the credential's rotation isstale. - Records what it sees.
--recordlogs unrecorded stores ascreatedand changed ones asdeployed, so the event log and the rotation calendar catch up with the stores.
Status¶
v0.1.0 is read-only. Organization and environment secrets, issuer observations such as a token's expiry, and installing and rotating values through OmniVault providers follow; the roadmap lists them.
Features¶
Comparison¶
Compare is a pure function over the registry, the log and what was
observed. For each active credential's primary and rendered stores:
| State | When |
|---|---|
unobserved |
No listed scope covers the store |
missing |
A listed scope does not hold it, and the credential is not tagged optional |
unrecorded |
Held, and the log has no created, rotated or deployed event |
stale |
Set more than the grace before the latest created or rotated event |
changed |
Set more than the grace after the latest created, rotated or deployed event |
present |
Otherwise |
Names no credential in use stores are unlisted, including those only a
retired credential stores. A name a consumer reads and no credential stores
is unregistered; a GitHub organization secret satisfies a repository's
reference. The grace, a day by default, absorbs the time between changing a
value and recording it.
Connectors¶
| Package | Observes |
|---|---|
github |
A repository's Actions secret names and updated_at; its workflows' secrets.NAME and secrets['NAME'] references |
awsssm |
Parameter Store names and last change, one directory level at a time, with DescribeParameters |
Targets file¶
A JSON file, with a schema generated from the Go types, binds each store
type and account the registry names to a connection: a GitHub token's
environment variable and API URL, or an AWS profile and region. It holds no
secrets. Stores no binding reaches are unobserved, not missing.
Command line¶
credforge check writes text or JSON, records with --record, filters with
--only and --include-planned, and exits 1 on --fail-on states (default
missing,stale,unregistered) and 2 on errors. credforge schema targets
prints the targets schema. cli.New mounts the same commands in a host tool
that builds its registry and targets file in Go.
Installation¶
go install github.com/plexusone/credforge/cmd/[email protected]
go get github.com/plexusone/[email protected]