Glossary¶
A¶
Access Token¶
An OAuth2 JSON Web Token (JWT) sent with every API request to authenticate it. Issued by the identity provider (for example Azure Entra ID or GitLab), or by the Authserver in the trial environment.
Administrative Session¶
A temporary privilege window, authorized by the configured number of authorizers, required for administrative changes. See Administrative Sessions.
Approver¶
A subject (usually a user) allowed to approve signing or certificate issuance operations, or to cancel them with Revoke. The human checkpoint of the approval workflow.
C¶
CA Key¶
A Certificate Authority key that signs device certificates from CSRs. Sits below a ROOT key in the device certificate hierarchy.
Certificate (Public Certificate)¶
An X.509 certificate holding the public key of a Keyserver signing key. Used to verify signatures and establish trust.
CI/CD Client¶
See Client (Subject).
Client (Subject)¶
A non-interactive subject used by an automated system, such as a CI/CD pipeline (GitLab CI, Azure DevOps) or a build server. Authenticates through OAuth2 Client Credentials or token federation.
CSR (Certificate Signing Request)¶
A request, generated by a device or tool, that carries a public key and identity information. Submitted to the Keyserver to obtain a certificate signed by a CA key.
D¶
Data Key (DATAKEY Permission)¶
A role permission granting a client read access to one specific datastore entry via GET /api/datas/{keyid}. One permission per entry.
Datastore¶
An AES-256 encrypted key-value store for build-time secrets (symmetric keys, configuration values) that clients fetch over the REST API. See Manage the Datastore.
Device Certificate¶
An X.509 certificate issued to an embedded device or hardware module, from a CSR, signed by a CA key.
E¶
Engine (OpenSSL)¶
OpenSSL's original mechanism for loading external crypto modules, including PKCS#11, used through libengine-pkcs11-openssl. Deprecated in OpenSSL 3.x in favor of providers and removed in OpenSSL 4.x. The Keyserver OpenSSL guides use the engine by default and also document the provider. See Engine interface.
External Identity Provider¶
An OAuth2/OIDC-compliant authentication service, such as Azure Entra ID or GitLab. The Keyserver relies on it for all production authentication.
F¶
Firmware Signing Key (FW Key)¶
A key that signs firmware or software hashes, often with Required Approvers set.
H¶
Hash Algorithm¶
The hash a signing key is configured with (for example SHA256 or SHA384). Hash the data with it before submitting the sign order; the Keyserver does not check the hash length, so a hash made with another algorithm gives a signature that does not verify as the key's algorithm.
HSM (Hardware Security Module)¶
A secure cryptographic device where private keys are generated and stored. Private keys in the HSM never leave it in plaintext. For an exportable key, use KEYSTORE storage; see Key Storage.
K¶
Key ID¶
The unique identifier of a signing key, used in API calls and as the PKCS#11 object label.
Key Type¶
One of:
ROOT: root certificate authorityCA: device certificate issuerFW: firmware or software signing key
Key Usage Restriction¶
The part of an operation that names a key and how many times it may be used (maxusagecount).
KEYSTORE (Key Location)¶
The per-key alternative to HSM storage: the key pair is kept in an encrypted file store, and the private key can be exported via GET /api/keys/priv/{keyid}. HSM is the default and recommended location.
N¶
Nature¶
A preset bundle of permissions for a common role type: user, keyadmin, useradmin, authorizer, fwsigner, devcertsigner, approver, reviewer. We recommend building roles from Natures rather than individual permissions. See Nature reference for the full table.
O¶
OAuth2¶
The authorization framework the Keyserver uses to validate subjects' tokens. The documented flows are Client Credentials and Authorization Code.
OIDC (OpenID Connect)¶
An identity layer on top of OAuth2 that defines identity claims and ID tokens.
Operation¶
A time-limited permission to perform cryptographic actions with one or more keys. It carries a validity window, a usage count per key, a description, and an approval status. See Operations.
Operation Approval¶
The human verification step required before an operation that includes a key with Required Approvers above 0 can be used, for any of its keys.
Operation ID¶
The unique identifier returned when an operation is created. Used in sign orders, and as an audit log filter to trace all events of one operation.
Orderer¶
A subject that creates operations and submits sign orders for specific keys, typically a CI/CD client. Built with the fwsigner Nature (or devcertsigner for certificate issuance). Keep orderers and approvers on separate subjects. See Why approvals exist.
P¶
PKCS#11¶
The standard API for accessing cryptographic tokens. Cryptera's PKCS#11 module, libpkcs11ks, lets PKCS#11 tools sign with Keyserver keys; see How the module works.
PKCE (Proof Key for Code Exchange)¶
A security extension to the OAuth2 Authorization Code flow, used for devices and public clients.
Provider (OpenSSL 3.x)¶
The OpenSSL 3.x mechanism for loading external cryptographic modules, superseding engines. The PKCS#11 module is supported through the pkcs11-provider package. See Provider interface, which also explains why libp11's pkcs11prov must not be used for signing.
R¶
Reviewer¶
A subject whose role is built from the reviewer Nature: read-only access to subjects, roles, signing keys, authorizers, administrative sessions, the audit log (including HSM entries), statistics and the datastore entry list. Cannot request or approve operations.
Role¶
A set of permissions assigned to subjects. Examples: ci-orderer-key2 (fwsigner on one key), fw-approver-key2 (approver on one key), and the built-in KEYADMIN, USERADMIN and REVIEWER.
ROOT Key¶
The top-level certificate authority, which signs the certificates of CA and FW keys. There is one ROOT key per trust domain. Firmware signing and device identity are normally separate hierarchies, each with its own ROOT, so one Keyserver commonly holds several.
S¶
Sign Order¶
A request, submitted under an approved operation via POST /api/signorders, to sign a hash. Consumes one use of that key within the operation. Certificate issuance from a CSR uses a different endpoint, POST /api/certificates.
Signature Format¶
The output format of a sign order (signatureformat):
asn1: for ECDSA, a DER(r, s)sequence, as OpenSSL expects; for RSA, a plain PKCS#1 v1.5 signaturep1363: raw(r, s)concatenation, common in embedded verification. ECDSA only; on an RSA key it returns400cms: a CMS SignedData structurepem: accepted, but returns the same payload asasn1. Useasn1
See Signature Formats.
Signing¶
Generating a digital signature with a Keyserver key.
Subject¶
A user or client identity registered in the Keyserver. See Subjects.
T¶
Token¶
See Access Token.
Trusted Certificate Chain¶
The chain of certificates (ROOT → CA → device) that lets devices be authenticated.
U¶
User (Subject)¶
A human operator who logs in via the browser, typically for reviews, approvals and administrative tasks.
Usage Count¶
The number of signatures allowed per key in an operation (maxusagecount). Each sign order consumes one use of its key.
V¶
Validity Window¶
The time, in milliseconds (validms), during which an operation remains usable. After it expires, sign orders and certificate requests are rejected with 410.