Directories
¶
| Path | Synopsis |
|---|---|
|
Package adapter defines the compiled-in deployment-module seam.
|
Package adapter defines the compiled-in deployment-module seam. |
|
awssm
Package awssm is the AWS Secrets Manager deployment adapter (#158).
|
Package awssm is the AWS Secrets Manager deployment adapter (#158). |
|
awssm/awssmtest
Package awssmtest is an isolated, in-process AWS Secrets Manager and STS emulator for adapter tests.
|
Package awssmtest is an isolated, in-process AWS Secrets Manager and STS emulator for adapter tests. |
|
cloudflare
Package cloudflare implements one-way synchronization into Cloudflare Workers secrets and Cloudflare Pages encrypted environment variables.
|
Package cloudflare implements one-way synchronization into Cloudflare Workers secrets and Cloudflare Pages encrypted environment variables. |
|
forgejo
Package forgejo is the Forgejo REST v1 reference deployment adapter.
|
Package forgejo is the Forgejo REST v1 reference deployment adapter. |
|
githubactions
Package githubactions implements the GitHub Actions deployment adapter.
|
Package githubactions implements the GitHub Actions deployment adapter. |
|
gitlab
Package gitlab implements the GitLab CI/CD variable deployment adapter.
|
Package gitlab implements the GitLab CI/CD variable deployment adapter. |
|
sealedwebhook
Package sealedwebhook is the generic HTTPS push adapter.
|
Package sealedwebhook is the generic HTTPS push adapter. |
|
vaultkv
Package vaultkv is the one-way Vault/OpenBao KV v2 synchronization adapter.
|
Package vaultkv is the one-way Vault/OpenBao KV v2 synchronization adapter. |
|
Package admission is the pre-authentication admission control the threat model requires and the ops spec dimensions: an instance-wide semaphore over Argon2id execution, a bounded queue, per-source-IP rate limiting, and per-account backoff.
|
Package admission is the pre-authentication admission control the threat model requires and the ops spec dimensions: an instance-wide semaphore over Argon2id execution, a bounded queue, per-source-IP rate limiting, and per-account backoff. |
|
Package app wires config, store, migrations, service, and the HTTP layer into the runnable subcommands.
|
Package app wires config, store, migrations, service, and the HTTP layer into the runnable subcommands. |
|
Package audit is the audit-model ADR's event vocabulary: the envelope, the closed category.action registry, retention classes, outcome licensing, and the free-text hygiene applied to every attacker-influencable string before it lands in a durable surveillance record.
|
Package audit is the audit-model ADR's event vocabulary: the envelope, the closed category.action registry, retention classes, outcome licensing, and the free-text hygiene applied to every attacker-influencable string before it lands in a durable surveillance record. |
|
Package auditexport validates the negotiated audit export completion contract.
|
Package auditexport validates the negotiated audit export completion contract. |
|
Package authz is the authorization chokepoint (permission + tenant-isolation ADRs): authorize(principal, capability-formula, scope) evaluated in-transaction against current policy with no cache, returning a proof-carrying value the store accepts calls only with.
|
Package authz is the authorization chokepoint (permission + tenant-isolation ADRs): authorize(principal, capability-formula, scope) evaluated in-transaction against current policy with no cache, returning a proof-carrying value the store accepts calls only with. |
|
gen
command
Command gen compiles reviewed authority metadata into static Go.
|
Command gen compiles reviewed authority metadata into static Go. |
|
Package backupreceipt owns public upgrade-backup evidence.
|
Package backupreceipt owns public upgrade-backup evidence. |
|
Package bench defines the required floor measurement evidence and its gate.
|
Package bench defines the required floor measurement evidence and its gate. |
|
Package buildcompat exposes the source-owned declaration embedded at build time.
|
Package buildcompat exposes the source-owned declaration embedded at build time. |
|
Package cli is the client-side surface: the noun-verb verb table, context resolution, the local trust store, and the output grammar.
|
Package cli is the client-side surface: the noun-verb verb table, context resolution, the local trust store, and the output grammar. |
|
Package compose is the client-side library for Hikyo's Docker Compose delivery path (compose-integration ADR).
|
Package compose is the client-side library for Hikyo's Docker Compose delivery path (compose-integration ADR). |
|
Package config parses flags and environment strictly and fail-fast (system-architecture ADR § Tooling defaults): unknown HIKYO_* keys warn, missing prod-critical keys refuse to start, nothing silently conjures a database.
|
Package config parses flags and environment strictly and fail-fast (system-architecture ADR § Tooling defaults): unknown HIKYO_* keys warn, missing prod-critical keys refuse to start, nothing silently conjures a database. |
|
Package configrollout executes a committed configuration decision against one installation-owned deployment.
|
Package configrollout executes a committed configuration decision against one installation-owned deployment. |
|
Package console renders calm, human-readable messages for Hikyo's terminal surfaces.
|
Package console renders calm, human-readable messages for Hikyo's terminal surfaces. |
|
Package crypto is the envelope package — the sole crypto chokepoint fixed by the encryption-model ADR and placed here by the system-architecture ADR.
|
Package crypto is the envelope package — the sole crypto chokepoint fixed by the encryption-model ADR and placed here by the system-architecture ADR. |
|
backup
Package backup owns the age container around an instance export (#76, encryption-model ADR § Backups and exports).
|
Package backup owns the age container around an instance export (#76, encryption-model ADR § Backups and exports). |
|
sealedhook
Package sealedhook owns every cryptographic operation of the sealed webhook receiver protocol (docs/spec/sealed-webhook.md).
|
Package sealedhook owns every cryptographic operation of the sealed webhook receiver protocol (docs/spec/sealed-webhook.md). |
|
Package definitions is the canonical definitions-bundle vocabulary and the pure diffing engine behind `definitions export | check | plan | apply` (source-of-truth ADR, as amended by the flat-model ADR).
|
Package definitions is the canonical definitions-bundle vocabulary and the pure diffing engine behind `definitions export | check | plan | apply` (source-of-truth ADR, as amended by the flat-model ADR). |
|
Package delivery owns the canonical encodings the machine fetch path keys: the delivery manifest the change token covers, and the tuple the conditional cursor is bound to.
|
Package delivery owns the canonical encodings the machine fetch path keys: the delivery manifest the change token covers, and the tuple the conditional cursor is bound to. |
|
Package deliverytarget owns the closed vocabulary, bounds and derived state of delivery-target condition reporting (k8s-condition-reporting ADR).
|
Package deliverytarget owns the closed vocabulary, bounds and derived state of delivery-target condition reporting (k8s-condition-reporting ADR). |
|
Package devupgrade owns synthetic, installation-local development custody.
|
Package devupgrade owns synthetic, installation-local development custody. |
|
Package diagnostics provides opt-in, command-scoped progress on stderr.
|
Package diagnostics provides opt-in, command-scoped progress on stderr. |
|
Package disclose implements the universal print triad (api-cli-surface ADR § Output grammar): every path that can emit secret plaintext sends it to exactly one of three destinations, and refuses otherwise.
|
Package disclose implements the universal print triad (api-cli-surface ADR § Output grammar): every path that can emit secret plaintext sends it to exactly one of three destinations, and refuses otherwise. |
|
Package domain holds the leaf vocabulary shared by the authorization package, the store, and the service layer: tenant identifiers, capability atoms, scopes, and the canonical error sentinels.
|
Package domain holds the leaf vocabulary shared by the authorization package, the store, and the service layer: tenant identifiers, capability atoms, scopes, and the canonical error sentinels. |
|
Package dotenv parses a standard `.env` file into ordered key/value entries.
|
Package dotenv parses a standard `.env` file into ordered key/value entries. |
|
Package dynamic defines the compiled-in dynamic-secret provider seam and the credential-material generator.
|
Package dynamic defines the compiled-in dynamic-secret provider seam and the credential-material generator. |
|
postgres
Package postgres implements the dynamic-secret Provider seam over a PostgreSQL engine.
|
Package postgres implements the dynamic-secret Provider seam over a PostgreSQL engine. |
|
Package federationhttp owns bounded, direct federation HTTP transport.
|
Package federationhttp owns bounded, direct federation HTTP transport. |
|
Package filedurability synchronizes published file directory entries.
|
Package filedurability synchronizes published file directory entries. |
|
Package filesync is the client-side library for Hikyo's generic file destination (#164): an authenticated client on the destination host pulls one revision of a server-side file target and atomically renders it to a locally configured directory.
|
Package filesync is the client-side library for Hikyo's generic file destination (#164): an authenticated client on the destination host pulls one revision of a server-side file target and atomically renders it to a locally configured directory. |
|
Package freetext provides bounded, token-redacting hygiene for untrusted text.
|
Package freetext provides bounded, token-redacting hygiene for untrusted text. |
|
Package hostupgrade provides the bounded, operator-invoked systemd adapter.
|
Package hostupgrade provides the bounded, operator-invoked systemd adapter. |
|
Package importer is the client-side import framework (#68, import-paths ADR as amended by the flat-model ADR).
|
Package importer is the client-side import framework (#68, import-paths ADR as amended by the flat-model ADR). |
|
Package jwkssource owns the closed representation and parsing policy for a federation issuer's signing-key source.
|
Package jwkssource owns the closed representation and parsing policy for a federation issuer's signing-key source. |
|
Package lint holds the three custom static analyzers the tenant-isolation ADR fixes (proof signatures, SQL predicate confinement, proof-forgery guard).
|
Package lint holds the three custom static analyzers the tenant-isolation ADR fixes (proof signatures, SQL predicate confinement, proof-forgery guard). |
|
Package localsocket provides same-user Unix-domain HTTP transport.
|
Package localsocket provides same-user Unix-domain HTTP transport. |
|
Package mail prepares immutable SMTP configuration and sends text-only mail.
|
Package mail prepares immutable SMTP configuration and sends text-only mail. |
|
Package mailtest supplies an in-process TLS SMTP sink for conformance tests.
|
Package mailtest supplies an in-process TLS SMTP sink for conformance tests. |
|
cmd
command
Command mailtest exposes the existing TLS SMTP fixture to browser tests.
|
Command mailtest exposes the existing TLS SMTP fixture to browser tests. |
|
Package multicall owns the closed host-mode inventory shared by dispatch, usage coverage, and security classification.
|
Package multicall owns the closed host-mode inventory shared by dispatch, usage coverage, and security classification. |
|
Package netpolicy owns the default-deny public-egress address policy shared by authenticated outbound integrations.
|
Package netpolicy owns the default-deny public-egress address policy shared by authenticated outbound integrations. |
|
Package oauth2rp implements profile-pinned OAuth2 wire mechanics over x/oauth2.
|
Package oauth2rp implements profile-pinned OAuth2 wire mechanics over x/oauth2. |
|
Package oidcfed validates externally issued OIDC ID tokens presented as a machine credential (#62, machine-identities ADR § Federation), and owns the server-side JWKS cache with its bounded staleness window.
|
Package oidcfed validates externally issued OIDC ID tokens presented as a machine credential (#62, machine-identities ADR § Federation), and owns the server-side JWKS cache with its bounded staleness window. |
|
Package oidcrp is the OIDC relying-party wrapper: discovery, authorization URL construction, code exchange and complete ID-token validation, all behind go-oidc and golang.org/x/oauth2.
|
Package oidcrp is the OIDC relying-party wrapper: discovery, authorization URL construction, code exchange and complete ID-token validation, all behind go-oidc and golang.org/x/oauth2. |
|
Package oidctest is a test-only OpenID Provider: discovery, JWKS, authorization and token endpoints over httptest, RS256-signed ID tokens with caller-controlled claims.
|
Package oidctest is a test-only OpenID Provider: discovery, JWKS, authorization and token endpoints over httptest, RS256-signed ID tokens with caller-controlled claims. |
|
cmd
command
Command oidctest-idp exposes the internal fake provider to browser-flow tests.
|
Command oidctest-idp exposes the internal fake provider to browser-flow tests. |
|
Package operation carries the transport-independent authorization contract attached by every network adapter before it invokes a service operation.
|
Package operation carries the transport-independent authorization contract attached by every network adapter before it invokes a service operation. |
|
api/v1alpha1
Package v1alpha1 defines the Hikyo operator's CustomResourceDefinition Go types: HikyoInstance (cluster-scoped connection configuration) and HikyoSecret (namespaced delivery request).
|
Package v1alpha1 defines the Hikyo operator's CustomResourceDefinition Go types: HikyoInstance (cluster-scoped connection configuration) and HikyoSecret (namespaced delivery request). |
|
client
Package client is the operator's HTTP client for the Hikyo delivery surface.
|
Package client is the operator's HTTP client for the Hikyo delivery surface. |
|
Package pairing implements the cryptographic adapters for manually authorized instance pairing.
|
Package pairing implements the cryptographic adapters for manually authorized instance pairing. |
|
Package parameters implements bounded, single-pass config substitution.
|
Package parameters implements bounded, single-pass config substitution. |
|
Package pathutil centralizes filesystem containment checks.
|
Package pathutil centralizes filesystem containment checks. |
|
Package pki is the private-PKI core (#154, docs/adr/pki.md): closed key algorithms, decidable certificate-profile policy, and the X.509 signing and CRL primitives.
|
Package pki is the private-PKI core (#154, docs/adr/pki.md): closed key algorithms, decidable certificate-profile policy, and the X.509 signing and CRL primitives. |
|
Package releaseidentity defines release-wide claims.
|
Package releaseidentity defines release-wide claims. |
|
Package releasetrust authenticates release and operator evidence using maintained Sigstore verifiers.
|
Package releasetrust authenticates release and operator evidence using maintained Sigstore verifiers. |
|
testfixture
Package testfixture creates ephemeral signed release evidence for tests.
|
Package testfixture creates ephemeral signed release evidence for tests. |
|
Package remotefetch is the directory tier's outbound client (#71, multi-instance ADR § The outbound client).
|
Package remotefetch is the directory tier's outbound client (#71, multi-instance ADR § The outbound client). |
|
Package repscan is local repository and CI secret scanning (#153).
|
Package repscan is local repository and CI secret scanning (#153). |
|
Package runtimeconfig owns the closed, versioned catalogue consumed by the running Hikyo instance.
|
Package runtimeconfig owns the closed, versioned catalogue consumed by the running Hikyo instance. |
|
Package samlsp owns Hikyo's relying-party policy around SAML parsing and identity material.
|
Package samlsp owns Hikyo's relying-party policy around SAML parsing and identity material. |
|
Package samltest provides a deliberately small SAML IdP fixture for Hikyo's end-to-end tests.
|
Package samltest provides a deliberately small SAML IdP fixture for Hikyo's end-to-end tests. |
|
Package scanning is the secret-scanning ruleset (ADR docs/adr/secret-scanning.md).
|
Package scanning is the secret-scanning ruleset (ADR docs/adr/secret-scanning.md). |
|
bench
Package bench is the schema shared by cmd/bench-scan (which writes the result artifact) and the scanning validation test (which parses it).
|
Package bench is the schema shared by cmd/bench-scan (which writes the result artifact) and the scanning validation test (which parses it). |
|
corpus
Package corpus is the true-positive / false-positive fixture corpus for the secret scanner (ADR §3, SS1).
|
Package corpus is the true-positive / false-positive fixture corpus for the secret scanner (ADR §3, SS1). |
|
gen
command
Command gen produces internal/scanning/rules_gen.go from the vendored gitleaks snapshot plus the committed allowlist.
|
Command gen produces internal/scanning/rules_gen.go from the vendored gitleaks snapshot plus the committed allowlist. |
|
Package schema is the key catalogue's declaration vocabulary and its value-validation engine (#49, schema-model ADR as amended by the flat-model ADR).
|
Package schema is the key catalogue's declaration vocabulary and its value-validation engine (#49, schema-model ADR as amended by the flat-model ADR). |
|
Package scimproto is the SCIM 2.0 wire protocol Hikyo implements: the closed resource set, the closed filter grammar, the closed PATCH operation x path matrix, the RFC 7644 error shapes, and the discovery documents.
|
Package scimproto is the SCIM 2.0 wire protocol Hikyo implements: the closed resource set, the closed filter grammar, the closed PATCH operation x path matrix, the RFC 7644 error shapes, and the discovery documents. |
|
Package sealedreceiver is the reference implementation of the receiver side of the sealed webhook protocol (docs/spec/sealed-webhook.md).
|
Package sealedreceiver is the reference implementation of the receiver side of the sealed webhook protocol (docs/spec/sealed-webhook.md). |
|
Package securefile owns atomic publication of permission-sensitive files.
|
Package securefile owns atomic publication of permission-sensitive files. |
|
Package selfupdate installs a selected Hikyo release over the current binary.
|
Package selfupdate installs a selected Hikyo release over the current binary. |
|
Package server is the HTTP layer: chi router, health surfaces, and the generated API.
|
Package server is the HTTP layer: chi router, health surfaces, and the generated API. |
|
Package service is the domain layer.
|
Package service is the domain layer. |
|
Package sshca is the OpenSSH user-certificate core (#155): the closed key algorithm set, CA key custody encoding, certificate construction under a profile's constraints, and the Key Revocation List encoder.
|
Package sshca is the OpenSSH user-certificate core (#155): the closed key algorithm set, CA key custody encoding, certificate construction under a profile's constraints, and the Key Revocation List encoder. |
|
Package storagehealth measures the filesystem containing a datastore.
|
Package storagehealth measures the filesystem containing a datastore. |
|
Package store owns datastore access.
|
Package store owns datastore access. |
|
auditrow
Package auditrow is the single audit Row → engine-parameter mapping, shared by the store's audit repositories and the authorization package's denial writer so the two writers cannot drift (audit-model ADR: one envelope-to-column mapping).
|
Package auditrow is the single audit Row → engine-parameter mapping, shared by the store's audit repositories and the authorization package's denial writer so the two writers cannot drift (audit-model ADR: one envelope-to-column mapping). |
|
authn
Package authn is the authorization package's enumerated resolution surface (tenant-isolation ADR § bootstrap carve-out): authorize() cannot run under a proof, so the reads it needs to mint one — chain resolution and grant lookup — live here, and nowhere else may read chain tables with request-supplied identifiers.
|
Package authn is the authorization package's enumerated resolution surface (tenant-isolation ADR § bootstrap carve-out): authorize() cannot run under a proof, so the reads it needs to mint one — chain resolution and grant lookup — live here, and nowhere else may read chain tables with request-supplied identifiers. |
|
keyring
Package keyring implements crypto.KeyStore over the datastore: every access runs through the transactional boundary, with the hierarchy-generation fence acquired in the same transaction as the writes it fences.
|
Package keyring implements crypto.KeyStore over the datastore: every access runs through the transactional boundary, with the hierarchy-generation fence acquired in the same transaction as the writes it fences. |
|
migrate
Package migrate applies the embedded goose migrations.
|
Package migrate applies the embedded goose migrations. |
|
tx
Package tx owns the transactional boundary (system-architecture ADR § Transaction boundary).
|
Package tx owns the transactional boundary (system-architecture ADR § Transaction boundary). |
|
upgrade
Package upgrade stores upgrade state.
|
Package upgrade stores upgrade state. |
|
testutil
|
|
|
fixtureref
Package fixtureref validates qualified references to executable test fixtures.
|
Package fixtureref validates qualified references to executable test fixtures. |
|
Package tlspolicy owns Hikyo's inbound certificate loading policy.
|
Package tlspolicy owns Hikyo's inbound certificate loading policy. |
|
Package tlstest mints ephemeral certificate chains for inbound TLS tests.
|
Package tlstest mints ephemeral certificate chains for inbound TLS tests. |
|
Package transit is the custody seam of the transit surface (#156, transit ADR D3).
|
Package transit is the custody seam of the transit surface (#156, transit ADR D3). |
|
transittest
Package transittest holds the in-memory mock external custody provider (transit ADR D3).
|
Package transittest holds the in-memory mock external custody provider (transit ADR D3). |
|
Package updatecheck selects update notices from Hikyo's release channel.
|
Package updatecheck selects update notices from Hikyo's release channel. |
|
Package updater preserves legacy deployment journal/protocol compatibility while refusing every apply entry point.
|
Package updater preserves legacy deployment journal/protocol compatibility while refusing every apply entry point. |
|
Package upgradeassembly authenticates public release evidence and durably publishes the exact offline bundle consumed by the mandatory runtime gate.
|
Package upgradeassembly authenticates public release evidence and durably publishes the exact offline bundle consumed by the mandatory runtime gate. |
|
Package upgradebundle loads bounded offline release evidence through the signature-backed trust factories.
|
Package upgradebundle loads bounded offline release evidence through the signature-backed trust factories. |
|
testfixture
Package testfixture writes ephemeral, genuinely signed offline bundles for integration tests.
|
Package testfixture writes ephemeral, genuinely signed offline bundles for integration tests. |
|
Package upgradecompat binds authenticated release declarations and plans bounded deterministic upgrade routes.
|
Package upgradecompat binds authenticated release declarations and plans bounded deterministic upgrade routes. |
|
Package upgradecustody owns encrypted, operator-only installation custody.
|
Package upgradecustody owns encrypted, operator-only installation custody. |
|
Package upgradegate composes release verification, durable migration state, public backup evidence and bounded candidate health before runtime admission.
|
Package upgradegate composes release verification, durable migration state, public backup evidence and bounded candidate health before runtime admission. |
|
testfixture
Package testfixture invokes the actual signed development gate for owned databases.
|
Package testfixture invokes the actual signed development gate for owned databases. |
|
Package webauthnrp is the WebAuthn relying-party wrapper: ceremony construction and response validation, all behind go-webauthn/webauthn.
|
Package webauthnrp is the WebAuthn relying-party wrapper: ceremony construction and response validation, all behind go-webauthn/webauthn. |
|
Package webauthntest is a test-only software authenticator built on descope/virtualwebauthn.
|
Package webauthntest is a test-only software authenticator built on descope/virtualwebauthn. |
|
Package webui carries the built single-page application, or nothing.
|
Package webui carries the built single-page application, or nothing. |
Click to show internal directories.
Click to hide internal directories.