Skip to content

Fortified IDDocs

CEF event logging

Enable the optional closed catalog of content-free CEF events to the application log or to a dedicated file.

Signing Server can write security and operational events in Common Event Format. Logging is optional, off by default, and works in DSS human signing, CSC, organization seal and time stamp modes.

The events are best effort. They never replace the audit in the database, and they do not prove that signing completed or that a message was delivered.

Add an event_log section to the configuration:

{
"event_log": {
"format": "cef",
"destination": "file",
"directory": "/var/log/signing/events",
"queue_capacity": 1024,
"max_file_bytes": 8388608,
"retained_files": 4
}
}
Name Description Default
format Required. cef is the only format.
destination Required. application writes each event once to the application console, file writes only to a dedicated file. There is no combined mode.
directory Required for file and not allowed for application. The parent directory must exist. Each process needs its own directory.
queue_capacity 16–4096 records. 1024
max_file_bytes 65536–67108864. 8388608
retained_files 1–8 archives. 4

An event is at most 4,096 bytes. With the file destination the server writes events.log and the archives events-1.log and upward, plus a lock file. The directory must be a private local directory owned by the service account, with mode 0700 and files with 0600 on POSIX or an owner-only ACL on Windows. Startup rejects symlinks, unsafe permissions, unrelated files and a second writer, and it never repairs or deletes unrelated files. In Docker, use /var/log/signing on a persistent volume owned by UID 10001.

Without event_log the server writes no events. Offline commands do not create output files.

The vendor is Fortified ID and the product is IDOmbud Signing Server. The extensions are:

Extension Content
rt Observation time in UTC epoch milliseconds.
externalId A unique event UUID.
act The stage or action.
outcome The observed result. HTTP success is not signing success.
reason An optional fixed failure code.
cs1 (InteractionId) The UUID of one HTTP exchange.
cs2 (ServiceMode) human, csc, seal or timestamp.
cs3 (Stage) The fixed stage.
cs4 (RuntimeInstance) A random identifier for the process instance.
cn1 (ElapsedMicros) Elapsed microseconds, when available.

Events never contain source addresses, host names, identifiers, digests, messages, payloads, signatures, tokens, secrets, keys, paths or exception text.

ID Event
SS1000 Service started
SS1001 Service stopping
SS1002 Startup failed
SS1100 Sign request outcome
SS1101 Consent outcome
SS1102 Callback outcome
SS1200 DSS response outcome
SS1201 Authorization check outcome
SS1300 Document crypto outcome
SS1400 Database availability
SS1401 Document provider availability
SS1402 Readiness
SS1500 Work admission outcome
SS1501 Pending flow admission outcome
SS1502 Health admission outcome
SS1600 Seal request outcome
SS1601 Time stamp request outcome
SS1602 Verified machine request before service invocation
SS1700 CSC HTTP handler outcome

Severity is 3 for success, started, stopping and cancellation, 4 for expiry, 5 for rejection, duplicate and an explicit provider refusal, and 7 for failure, unavailable, unknown outcome, an invalid time stamp and startup failure.

Request threads only place events in a bounded queue. One background worker writes them, so blocked or full output never delays a request, changes authorization or causes a retry. A full queue drops the newest event. Counters for accepted, dropped, invalid, written, failed and pending events appear in the operational log line when logging is enabled. A process that is killed does not necessarily write a final event.

On startup the server scans existing event files and rejects foreign or damaged records without rewriting them. This does not protect the logs against the authorized owner.