Skip to content
Registry StackDocsDevelopment (unreleased)

Configure Transit signing for Evidence Gateway and Registry Mint

For the operator

View as Markdown

Use this procedure to move Evidence Gateway or Registry Mint from disposable local signing to a strict deployment. Each service signs through its own workload-local Unix-socket proxy. The service process receives no Vault or OpenBao token, and the provider retains the private key.

You need:

  • A Vault or OpenBao Transit mount administered outside the application workload.
  • A separate provider identity and Transit key for each service and environment.
  • An auto-auth method appropriate for the deployment platform.
  • A reviewed deployment target based on the ready-to-copy templates under products/evidence/reference/deployment-targets/.
  • An approved tool that can convert a P-256 public key from PEM to JWK and calculate its RFC 7638 SHA-256 thumbprint.

The commands use a Transit mount named transit. Change the mount consistently when your provider uses another name.

Run the provider administration commands through an authenticated operator session, not from the Evidence Gateway or Mint container. Create non-derived, non-exportable P-256 keys with plaintext backup disabled:

Terminal window
vault write transit/keys/evidence-signing \
type=ecdsa-p256 \
derived=false \
exportable=false \
allow_plaintext_backup=false
vault write transit/keys/mint-signing \
type=ecdsa-p256 \
derived=false \
exportable=false \
allow_plaintext_backup=false

Use the equivalent bao commands for OpenBao. The Vault Transit API and OpenBao Transit API define the same fields used by the runtime checks.

Read each key’s metadata and record the nonzero version that the application will pin:

Terminal window
vault read -format=json transit/keys/evidence-signing > "<operator-review-path>/evidence-key.json"
vault read -format=json transit/keys/mint-signing > "<operator-review-path>/mint-key.json"

The reviewed metadata must report type: ecdsa-p256, derived: false, exportable: false, allow_plaintext_backup: false, and signing support. Remove the local review files after recording the approved public projection and controls. Do not commit provider responses.

Convert the selected version’s public PEM to an exact public JSON Web Key (JWK). Compute the RFC 7638 thumbprint from crv, kty, x, and y, then use that 43-character value as both kid and the filename:

{
"kty": "EC",
"crv": "P-256",
"x": "<base64url-x-coordinate>",
"y": "<base64url-y-coordinate>",
"alg": "ES256",
"kid": "<rfc7638-thumbprint>"
}

The object must contain exactly those six members and no private member. Put each service’s public JWK in its complete environment target:

environments/<environment>/
evidence/public-keys/<evidence-thumbprint>.jwk.json
mint/public-keys/<mint-thumbprint>.jwk.json

Keep Evidence Gateway signing, Mint signing, Evidence Gateway audit, Mint audit, subject binding, and client keys distinct. Run the target’s check-public-key-separation.sh before review when you start from the maintained deployment-target templates.

Configure the governed key and runtime signer

Section titled “Configure the governed key and runtime signer”

Reference the Evidence Gateway public JWK from governance.yaml:

signing:
format: flattened-jws-json
algorithm: ES256
activePublicJwkFile: public-keys/<evidence-thumbprint>.jwk.json
publishedPublicJwkFiles: []
revokedKeyIds: []
jwksPath: /.well-known/evidence/jwks.json
maximumAssertionValiditySeconds: 300
verifierClockSkewSeconds: 30

Bind the matching provider key and version in runtime.yaml:

signer:
kind: transit
unixSocketPath: /run/registry-evidence/transit-proxy.sock
mount: transit
keyName: evidence-signing
keyVersion: <nonzero-version>
timeoutMilliseconds: 2000

Registry Mint keeps both blocks in mint.yaml:

validationMode: strict
signing:
algorithm: ES256
activePublicJwkFile: public-keys/<mint-thumbprint>.jwk.json
publishedPublicJwkFiles: []
revokedKeyIds: []
signer:
kind: transit
unixSocketPath: /run/registry-mint/transit-proxy.sock
mount: transit
keyName: mint-signing
keyVersion: <nonzero-version>
timeoutMilliseconds: 2000

Do not put a provider token, auto-auth credential, or private JWK in either configuration.

Give each proxy identity only read access to its named key metadata and update access to its sign endpoint:

path "transit/keys/evidence-signing" {
capabilities = ["read"]
}
path "transit/sign/evidence-signing/sha2-256" {
capabilities = ["update"]
required_parameters = ["input", "key_version", "marshaling_algorithm", "prehashed"]
allowed_parameters = {
"input" = []
"key_version" = [<nonzero-version>]
"marshaling_algorithm" = ["jws"]
"prehashed" = [true]
}
}

Use a corresponding policy for mint-signing. The parameter constraints make the service identity usable only for the pinned version and exact JWS signing request shape. During a planned rotation, temporarily allow the old and new numeric versions, for example "key_version" = [7, 8], then remove the retired version after the overlap window. The provider’s min_encryption_version provides a second retirement control.

The Evidence Gateway proxy’s core boundary is:

vault {
address = "https://vault.example.com:8200"
retry {
num_retries = -1
}
}
api_proxy {
use_auto_auth_token = "force"
}
listener "unix" {
address = "/run/registry-evidence/transit-proxy.sock"
tls_disable = true
socket_mode = "0660"
socket_user = "<proxy-user>"
socket_group = "<evidence-group>"
require_request_header = true
}

Add the deployment’s reviewed auto_auth method and provider trust settings. Use a separate socket, identity, and configuration for Mint.

Configure one proxy per service to:

  • Listen only on the service-specific Unix socket.
  • Force its auto-auth token for proxied requests.
  • Require the X-Vault-Request header.
  • Set retry.num_retries to -1 and leave VAULT_MAX_RETRIES unset.
  • Set socket ownership so only the intended workload can connect.

These settings make one application signing attempt one provider signing request. The application timeout remains the outer bound. The Vault API proxy documentation describes forced auto-auth, and the Vault Agent configuration defines the retry and request-header controls. OpenBao deployments use the corresponding OpenBao Agent configuration.

Start each proxy before checking its service. Run the checks from the final execution context so the commands see the same socket, public keys, paths, ownership, and secret roots as the service:

Terminal window
evidence check --runtime "<candidate>/runtime.yaml"
mint check --config "<mint-directory>/mint.yaml"

Each check reads provider metadata, verifies the pinned version and custody controls, compares the provider public key with the governed JWK, and performs a sign-and-verify self-test. A mismatch, timeout, malformed response, or unavailable proxy fails the check.

Start the services only after the checks pass. Route requests only after both /ready endpoints report ready. If provider access fails later, signing fails closed and readiness reports the signer unavailable. Readiness recovers after a successful provider self-test.

  • If metadata validation fails, compare the key type, custody controls, signing support, and pinned version with the governed configuration.
  • If public-key matching fails, regenerate the JWK from the pinned provider version. Do not edit x, y, or kid by hand.
  • If the proxy refuses requests, check the named-key policy, forced auto-auth state, socket ownership, and required request header.
  • If checks time out, inspect the workload-local proxy and provider path. Do not add application or proxy retries.