pki category
This category of logs contains all the requests concerning the PKI module.
setup action 
The setup action means that a setup request has been made. This is the case every time the PKI module configuration has been loaded for a given tenant. It generates an "info" severity log in the event of success, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier. Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| enabled |
Indicate if the PKI module is enabled. |
Boolean | Mandatory |
| default_pki_id |
ID of the PKI engine. |
String | Mandatory if "enabled" is "true" |
| errors |
List of configuration errors where each error is a JSON object with a code and a message. If the log severity is "info", the list is empty. Example: [ { code: 2002010, message: 'Module: Pki not enabled for tenantId bc337abd-0d4f-43f9-aaf6-54ef7268d2e5. Reason: Validation failed. Reasons are: [Wrong type error: <tenant>/pki/authentication property must be array]' } ] |
String |
Mandatory if "enabled" is "true"
|
load_pki action
The load_pki action means that a PKI engine has been loaded for a given tenant. This step may occur during a call to the /simpleenroll endpoint. It generates an "info" severity log in the event of success, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier. Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| pki_name | Name of the PKI engine. | String | Mandatory |
| pki_id |
ID of the PKI engine. |
String | Mandatory |
| ra.type | Type of the Registration Authority (RA). | String | Mandatory |
| ca.type | Type of the Certification Authority (CA). | String | Mandatory |
| ca.certificate_chain | File containing the CA certificate chain. | String | Mandatory |
| ca.key | File containing the CA private key. | String | Mandatory |
| ca.key_algo |
CA signature algorithm. |
String | Mandatory only if "info" severity |
| errors |
JSON object containing an error code and a message indicating why the PKI engine could not be loaded. Example: error: { code: 2024002, message: 'No pem data found in file /etc/stormshield/cse/key.pem' }, |
Object | Mandatory only if "err" severity |
issue_cert action
The issue_cert action means that a certificate has been issued following a Certificate Signing Request (CSR). This action occurs when calling the /simpleenroll endpoint. It generates an "info" severity log in the event of success, or an "err" severity log in the event of an error.
The log fields for this action are as follows:
|
Field |
Description |
Type |
Mandatory/Optional |
|---|---|---|---|
|
tenant_id |
Tenant identifier. Example: 025f02fe-bee2-444b-bf76-b5ead30327c0 |
String in uuid v4 format | Mandatory |
| pki_id |
ID of the PKI engine. |
String | Mandatory only if "info" severity |
| spki_hash | Hash of the Subject Public Key Information. | String | Mandatory only if "info" severity |
| algo |
Signature algorithm and hash. Example: rsassa_pkcs1_v1_5.sha-512 |
String | Mandatory only if "info" severity |
| public_key.type | Type of algorithm used for public keys. | String | Mandatory only if "info" severity |
| csr.DN | List of the Distinguished Names attributes in the CSR. | Object | Mandatory only if "info" severity |
| issued_certificate.serial_number | Serial number of the certificate issued. | String | Mandatory only if "info" severity |
| issued_certificate.DN | List of the Distinguished Names attributes in the certificate issued. | Object | Mandatory only if "info" severity |
| errors |
JSON object containing an error code and a message indicating why the certificate could not be issued. Example:
error: { code: 2026011, message: 'Unable to decode certification request" } |
Object | Mandatory only if "err" severity |