Skip to content

How-To: Monitor and Filter the Audit Log

The Keyserver records signing, certificate issuance, approvals, key, subject, role and session changes, and HSM events in an append-only audit log. This page shows how to find and read those records in the UI.

Production Authentication Required

Audit log access is security- and compliance-relevant. In production it must be performed by identities authenticated through your external OAuth2/OIDC provider (Azure Entra ID, GitLab OIDC, ...). The internal Authserver is for trial environments only.

Prerequisites

  • Access to the Keyserver UI at https://keyclient.<UNIQUE-ID>.cryptera-security.io
  • A subject with a role built from the reviewer Nature, or another role granting audit-log read access. Viewing the log needs no administrative session.

Step 1: Navigate to the Audit Log Page

Click Audit in the navigation bar. The read-only list shows ID, Event, Created By, Created Date, API Name and Details for each entry.

Step 2: Understand Audit Event Types

Event Meaning
REST An audited REST API call. Most entries are REST: administrative changes (subjects, roles, keys, sessions), datastore operations, approvals, and the signing and certificate calls (createoperation, order, createcertificate). Filter by API Name to narrow them down
KEYGEN A key pair was generated inside the HSM
INAUGURATION The HSM's own initial audit trail, captured when this deployment's HSM was first set up
INITIALIZATION The Keyserver started and (re-)initialized its connection to the HSM. An HSM backup is taken at that point where the HSM model supports it
SIGN Reserved for HSM-level signing. Signing requests through the REST API are recorded as REST; the HSM's record of the signing appears as an HSM audit line with Activity SIGN (Step 4a)

Step 3: Filter Audit Logs

Set any of the filters on the right of the page, then click Search:

Filter Behavior
Select Event Dropdown of the event types that occur in the current log (Step 2)
Select Created By Dropdown of the subjects that performed the recorded actions
Select API Name Dropdown of the apiname values that occur in the current log (Step 3a)
Select Signing Key Dropdown of the Key IDs in the log: signing keys and datastore entries. The label says Signing Key for both
Administration Session ID Free text. Shows every entry recorded under that administrative session
Operation ID Free text. Shows every entry for one signing or certificate-issuance operation
From Date / To Date Date pickers, no presets. From Date is inclusive and To Date is exclusive, both at UTC midnight. To include a day, set To Date to the day after. The default shows today's entries
entries per page 4 to 32 rows per page

Result cap

The view returns at most the 100 most recent matching entries, newest first. The total number of matches is still reported; if it is larger than the rows shown, narrow the filters or the date range.

Step 3a: Common apiname Filter Values

apiname is the most precise filter. The dropdown offers only values that occur in the current log. The most common:

apiname Operation data field
createoperation Client created a signing/certificate operation Full request body JSON
order Client placed a sign order Full request body JSON
createcertificate Client issued a device certificate Full request body JSON (including the submitted CSR)
approve Approver approved an operation null
revokeapproval Approver clicked Revoke, cancelling the whole operation null
canceloperation Client cancelled an operation null
adddataentry Datastore entry created SHA-256 hex of the secret, never plaintext
updatedataentry Datastore entry value updated SHA-256 hex of the new secret
deletedataentry Datastore entry deleted null (keyid is also null; the entry was renamed)
getdata Client fetched a datastore value null (content not recorded)
getprivkeys Client fetched a KEYSTORE private key null (key material not recorded)
createcsr Admin downloaded a CSR with Get CSR null (content not recorded)

Administrative changes have their own apinames (addsubject, addrole, addsigningkey, addadminsession, and their update, delete and revoke counterparts). The complete list and the fields each apiname populates are in the Audit Coverage Reference.

One signing pipeline run: filter on Operation ID to see createoperation, any approve entries and the order (or createcertificate) entry in one view.

A deleted datastore entry: its deletedataentry entry has no Key ID. See Delete an entry in the datastore guide for how to trace it.

Step 4: Inspect an Audit Entry

Click the eye icon under Details. The detail view shows Event, Created By, Created Date, API, Key ID, Object ID, Operation ID, Administration Session ID and Authorizers, and the entry's Data (JSON): for REST calls, the request payload, following the data-field rules above.

Step 4a: Inspect HSM Audit Entries

Entries for HSM-located keys that have associated HSM log records show a second icon, a hard-drive rack, next to the eye icon. Click it to open the HSM audit view, with one row per HSM log line:

  • ID: the HSM audit line identifier
  • Activity: the Keyserver operation during which the HSM log was captured: INAUGURATION, NEWKEYPAIR, SIGN, BACKUP, GETPRIVATEKEY, IMPORTKEYPAIR
  • Entry: the unmodified line from the HSM's internal audit log, for example:
item:   229 -- cmd: 0x4e -- length:    3 -- session key: 0x0003 -- target key: 0x9530 -- second key: 0xffff -- result: 0xce -- tick: 9830 -- hash: 001b9a0384376b54703c126c8154bcee

Each line carries an HSM-provided hash, which the Keyserver uses to store each HSM line only once when it re-reads the HSM's log. The audit entry records the request; the HSM lines record what the HSM did.

Availability depends on the key's location

HSM audit entries exist only for HSM-located keys; KEYSTORE keys have no HSM log, and the icon never appears for them. The line format depends on the HSM model backing your deployment. In trial environments the entries are illustrative examples rather than a hardware audit trail.

Step 5: Common Use Cases

Goal Filters
Investigate a refused sign order A refused sign order leaves no audit entry; its status code and message are in the HTTP response (Troubleshoot API Errors). Filter on the Operation ID to see how the operation was created, approved or revoked, and the order entries that used up its count
Review all signatures for a release Select Signing Key: the firmware key; date range: the release day (To Date is exclusive)
Verify approver activity API Name approve, Created By the approver's subject
Audit administrative changes API Name for the change (for example updaterole, addsubject, updatesigningkey), date range: the last 30 days
Track provisioning activity Select Signing Key: the provisioning CA key; Created By: the provisioning client

Step 6: Exporting Records

The audit log cannot be exported: the page has no export button and the client API has no audit endpoint. Filter to the window you need and read it in place; screenshots and copied text are not a verifiable archive. Do not query the Keyserver database directly; its schema is internal and changes between releases. If you need audit records in an external log or SIEM, contact Cryptera.

Best practices for audit log monitoring

  • Review production logs weekly for unexpected subjects performing actions, unusual signing patterns and key configuration changes.
  • Log refused requests in the pipeline. Refused sign orders leave no audit entry, so keep each refused request's status code and response body in the pipeline log.