Skip to content

Audit Coverage Reference

This page is the normative list of what the Cryptera Keyserver records in the audit log, and what it omits. If an action is not in the tables below, do not assume it is recorded. Use it to answer compliance questions, write audit queries, or confirm that sensitive material stays out of the log.

Significant actions, not every request

The audit log records security-significant actions: signing operations, approvals, signatures, certificate issuance, administrative changes, and sensitive reads such as datastore and private-key retrieval. It is not a request log. Ordinary read calls that populate the UI (listing keys, roles, subjects, or the audit log itself) are not recorded.


Audit entry structure

Every audit entry contains the following fields:

Field Type Description
apiname string The operation that was performed; the primary filter key
keyid string | null The signing key involved, or null if not applicable
objectid string | null Database primary key of the affected object (e.g. datastore entry ID)
operationid string | null The signing operation UUID, for pipeline-related entries
adminsessionid string | null The administrative session ID under which the action occurred
data string | null JSON of the request body, or null; see Rules for the data field
id string The audit entry's own identifier
authorizers string | null Who authorized the administrative session, for session-scoped entries
hsmentrycount number How many HSM sub-entries this entry has; open the entry's HSM audit view to read them
createddate number Unix epoch in milliseconds
createdby string Identity of the actor: the Subject name recorded for the request
event string Event category; see Audit event categories

Filter on apiname; the values are listed below.

Values present in your log

The audit log page builds its Event, API Name, Created By and Signing Key dropdowns from the values present in your log. A value appears there only once the action has run on your instance.


Complete apiname reference

Datastore operations

apiname Triggered by keyid data field
adddataentry Creating a datastore entry (admin UI) The entry's keyid SHA-256 hex digest of the secret value, never the plaintext secret
updatedataentry Updating a datastore entry's value (admin UI) The entry's keyid SHA-256 hex digest of the new secret value, never the plaintext secret
deletedataentry Deleting a datastore entry (admin UI) null null
getdata A client fetching a datastore value via GET /api/datas/{keyid} The entry's keyid null

Signing key operations

apiname Triggered by keyid data field
createcsr Admin downloading a CSR via the "Get CSR" button in the signing key edit panel The signing key's keyid null
getprivkeys A client fetching a KEYSTORE private key via GET /api/keys/priv/{keyid} The signing key's keyid null

Administrative operations

Changes made through the admin UI are audited under the apiname of the UI API operation that performed them. These are the values Monitor and Filter the Audit Log sends you here for. All carry adminsessionid, since they require an active administrative session.

Area apiname Triggered by
Administrative sessions addadminsession Creating an administrative session
revokeadminsession Revoking one
addauthorizer / revokeauthorizer Authorizing, or withdrawing authorization from, someone else's session
Signing keys addsigningkey Creating or importing a key
updatesigningkey Editing a key, including changing Required Approvers
revokesigningkey Revoking a key (keys are never deleted)
createcsr Exporting a CSR via "Get CSR"; see the signing key table above
Roles addrole / updaterole / deleterole Role creation, edit, and soft-delete
Subjects addsubject / updatesubject / deletesubject Subject creation, edit (including role attachment), and soft-delete
Datastore adddataentry / updatedataentry / deletedataentry See the datastore table above

Read-only UI calls (getroles, getsubjects, getsigningkeys, getaudits, getstatistics, getnatures, getconfigs, getuserinfo, getadminsession, getauthorizer, getapprovals, getdataentries, gethsmauditentries, getpgp) are not recorded.

Signing pipeline operations

apiname Triggered by keyid operationid data field
createoperation A client creating a signing operation via POST /api/operations null The new operation's UUID Full request body JSON
order A client placing a sign order via POST /api/signorders The signing key's keyid The operation UUID Full request body JSON
approve An approver approving an operation via the approvals UI null (an approval covers the whole operation, which may span several keys; filter by operationid) The operation UUID null
createcertificate A client issuing a device certificate via POST /api/certificates The CA key's keyid The operation UUID Full request body JSON, including the submitted CSR PEM (public material, no secrets)
canceloperation A client cancelling an operation via DELETE /api/operations/{id} null The operation UUID null
revokeapproval An approver clicking Revoke in the approvals UI, which cancels the whole operation null The operation UUID null

Rules for the data field

The data field follows a consistent rule based on whether the operation is an incoming write or an outgoing read:

Incoming writes: SHA-256 hash stored, never plaintext

When a secret value is sent to the Keyserver in the request body, the data field stores a SHA-256 hex digest of it instead of the value. To confirm that a known value was written, hash it and compare.

Applies to: adddataentry, updatedataentry

Outgoing reads: data field is null

When the Keyserver returns sensitive material in its response (a datastore secret, a private key PEM, a CSR), the data field is null. The entry records that the access happened, not what was returned.

Applies to: getdata, getprivkeys, createcsr

Pipeline operations: full request body stored

For signing pipeline operations (createoperation, order, createcertificate), the full JSON request body is stored in data. These requests carry operational metadata (key IDs, descriptions, hash values to sign, CSRs, operation IDs) and no secrets. approve stores no body (data is null).

Never stored

Besides the material the rules above exclude, two kinds never appear in any audit entry: OAuth2 access tokens, which are not part of any audited request body, and plaintext private keys. An imported key's addsigningkey entry stores the request body, which carries the private key only in its PGP-encrypted upload form.


Filtering notes

Finding datastore delete entries

deletedataentry entries carry keyid=null because the entry's keyid is renamed on deletion to {original-keyid}-deleted-{timestamp}. The renamed keyid no longer matches the original.

objectid cannot be filtered on; it is only a field on the entries returned. To find the delete entry for a specific datastore entry, note its objectid before deleting it. The adddataentry (or updatedataentry) entry for that keyid carries it and can be found by keyid while the entry exists. Afterwards, filter by apiname=deletedataentry plus a date range and match the objectid against the entries returned.

Tracing a complete signing pipeline

To see all audit entries for one signing operation, filter by operationid. This returns the createoperation entry, any approve entries, and the order (or, for certificate issuance, createcertificate) entries together.

Tracing all activity within an administrative session

Filter by adminsessionid to see every change made during a specific session, such as key creation, role edits and subject changes. The session ID is shown in the Admin page while a session is active and is recorded on all entries created under it.


Audit event categories

The event field groups entries into broad categories for high-level reporting. The enum declares five values, and four of them are written:

event When it appears
REST Any audited REST API call: administrative changes, datastore operations, approvals, and the signing and certificate pipeline
KEYGEN Key generation for a key that has no earlier audit entry. Normally the HSM lines from generating a key are attached to that key's addsigningkey entry instead
INAUGURATION The HSM's own initial audit trail, captured from the file supplied when this deployment's HSM was first set up
INITIALIZATION Recorded each time the Keyserver starts up and (re-)initializes its connection to the HSM; an HSM backup is taken at that point where the HSM model supports it
SIGN Never written. Nothing records this value. Signing requests (order, createcertificate, createcsr) are recorded under REST, and the HSM's own record of the signing appears as an HSM audit sub-entry with activity SIGN (see below). Do not filter on it

apiname is populated only on REST entries; KEYGEN, INAUGURATION and INITIALIZATION entries have none.


HSM audit sub-entries

Audit entries for HSM-located signing keys carry an hsmentrycount field: the number of HSM log lines associated with the entry. When hsmentrycount > 0, the audit log UI offers the HSM audit view for that entry, as in Step 4a: Inspect HSM Audit Entries of the audit log guide.

Each HSM audit line carries the following fields:

Field Description
id The HSM audit line identifier
createdby Identity recorded as having created the line
createddate Timestamp the line was captured
activity The keyserver operation during which the HSM log was captured: INAUGURATION, NEWKEYPAIR, SIGN, BACKUP, GETPRIVATEKEY, IMPORTKEYPAIR
entry The unmodified log line from the HSM's own internal audit log
hash HSM-provided hash used to deduplicate re-reads of the HSM log

The HSM audit view shows only ID, Activity and Entry; createdby, createddate and hash are recorded but not shown there.

A single REST entry can carry sub-entries of more than one activity. For example, building a CSR reads the private key and signs the request, so a createcsr entry can carry both GETPRIVATEKEY and SIGN lines.

Do not read hsmentrycount as an operation count: it counts HSM log lines, and one keyserver operation routinely produces several.

BACKUP is an activity value on HSM audit sub-entries only, not an event category. It is recorded when the Keyserver backs up the HSM, for example during the INITIALIZATION event at startup.


Reading the audit log

The audit log is read in the Keyserver web UI. See Monitor and Filter the Audit Log for the available filters, the [from, to) date-window semantics and the 100-most-recent result cap.

The client API covers keys, operations, sign orders, certificates and datastore reads. It does not include audit retrieval, so this release has no supported programmatic way to query or export the log. If you need audit records in an external log or SIEM system, raise it with Cryptera. Do not read the Keyserver database directly: the schema is internal and is not a compatibility surface.