mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 16:01:30 +00:00
shankar0123
21aeed4f4e
Phase 0 closure (Path B2, post-rewrite):
addlicense sweep — adds the canonical certctl LLC copyright + BUSL-1.1
SPDX header to every production Go file. Template:
// Copyright 2026 certctl LLC. All rights reserved.
// SPDX-License-Identifier: BUSL-1.1
Coverage: 338 / 338 production Go files (cmd/ + internal/, excluding
*_test.go and **/testdata/**). Pre-sweep coverage was 22 / 338 (6.5%);
post-sweep is 338 / 338 (100%).
Normalized 22 pre-existing legacy headers (`// Copyright (c) certctl`
+ `// SPDX-License-Identifier: BSL-1.1`) and 1 file using a
`Certctl Contributors` attribution. The legacy SPDX ID `BSL-1.1`
is non-standard; the official SPDX identifier for Business Source
License 1.1 is `BUSL-1.1` (capital U). All 338 files now share the
canonical form.
Generated via:
addlicense -c "certctl LLC" -y 2026 \
-f cowork/legal/copyright-header.tpl \
-ignore '**/testdata/**' -ignore '**/*_test.go' \
cmd/ internal/
Verification:
find cmd internal -name '*.go' -not -name '*_test.go' \
-not -path '*/testdata/*' \
-exec grep -L '^// Copyright 2026 certctl LLC' {} \; | wc -l
Returns: 0
gofmt clean. Header additions are comments only, no compile impact.
Closes: cowork/certctl-architecture-diligence-audit.html#fix-RED-4
44 lines
1.9 KiB
Go
44 lines
1.9 KiB
Go
// Copyright 2026 certctl LLC. All rights reserved.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package issuer
|
|
|
|
import "context"
|
|
|
|
// Lifecycle is an OPTIONAL extension interface for issuer connectors that
|
|
// need to run long-running background work bound to a context. Connectors
|
|
// that hold no background goroutines (almost all of them) do not implement
|
|
// this interface and the registry feature-detects via type assertion.
|
|
//
|
|
// Concrete users today (2026-05-03):
|
|
// - VaultPKI: periodic POST /v1/auth/token/renew-self at TTL/2 cadence
|
|
// so long-lived deploys don't hit token expiry.
|
|
//
|
|
// The lifecycle contract is deliberately small. Connectors that need
|
|
// per-tick state, retries, or cross-tick cancellation handle all of that
|
|
// internally; the registry's job is just "kick off background work
|
|
// once" and "block until it cleanly exits". Keeping the interface this
|
|
// small means new lifecycle-bearing connectors don't have to touch the
|
|
// registry plumbing — they implement Start/Stop and the existing
|
|
// IssuerRegistry.StartLifecycles / StopLifecycles wiring picks them up
|
|
// automatically.
|
|
//
|
|
// Start MUST be non-blocking — spawn a goroutine and return immediately.
|
|
// Returning an error means startup failed; the registry logs the error
|
|
// and continues. Stop MUST block until the goroutine has fully exited;
|
|
// callers rely on this for graceful shutdown ordering.
|
|
type Lifecycle interface {
|
|
// Start kicks off any long-running background work bound to ctx.
|
|
// Returns nil on successful startup; the goroutine continues until
|
|
// ctx is cancelled or Stop is called. Returns a non-nil error if
|
|
// startup itself failed (e.g. precondition not met) — the goroutine
|
|
// did NOT start and Stop need not be called.
|
|
Start(ctx context.Context) error
|
|
|
|
// Stop blocks until the background work has fully exited. Safe to
|
|
// call after Start returned an error or wasn't called at all.
|
|
// Idempotent — multiple Stop calls return immediately after the
|
|
// first.
|
|
Stop()
|
|
}
|