Configuration Items
The KeySafe 5 Service configuration file is located at %NFAST_DATA_HOME%/keysafe5/server/config/config.yaml.
The install contains an example configuration file at %NFAST_DATA_HOME%/keysafe5/server/config/config.yaml.example which can be used to revert back to original configuration if needed.
Please ensure that all certificates, private keys and credential files are stored securely and have appropriate permissions set to prevent unauthorized access, as they contain sensitive information.
Unless configured otherwise, %NFAST_DATA_HOME% is located at /opt/nfast on Linux and %ProgramData%\nCipher on Windows.
|
Time durations are a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
For example, 30s configures a time interval of 30 seconds.
|
| Configuration Key | Description | Default |
|---|---|---|
|
Host used for serving the WebUI and API.
Entrust recommends keeping this value as |
|
|
Port used for serving the WebUI and API. If this port is not available, KeySafe 5 will fail to start. |
|
|
Period of time before timing out reading a request. |
|
|
Period of time before timing out writing a response. This should be at least as long as you’d expect the slowest nShield request in your environment to take (e.g. the amount of time to write a card when creating a Security World) |
|
|
Amount of time to wait after each request for the next request before timing out. |
|
|
Maximum number of bytes to read while parsing the request header’s keys and values |
|
|
Minimum TLS protocol version allowed.
Valid values: |
|
|
Allowed cipher suites. The default provided here is the list of recommended cipher suites. TLSv1.3 cipher suites are currently not configurable. See Supported TLS Cipher Suites. |
|
|
How often the WebUI will poll the backend. Set 0 to disable auto refresh in the WebUI. |
|
|
Host used for communication with KeySafe 5 Agents. |
|
|
Port used for communication with KeySafe 5 Agents. If this port is not available, KeySafe 5 will fail to start. |
|
|
Enable message bus server compatibility mode. If false, this KeySafe 5 Server will only be able to communicate with KeySafe 5 v1.5, or newer, Agents |
|
|
Minimum TLS protocol version allowed.
Valid values: |
|
|
Allowed cipher suites. The default provided here is the list of recommended cipher suites. TLSv1.3 cipher suites are currently not configurable. See Supported TLS Cipher Suites. |
|
|
Enable OCSP checks |
|
|
OCSP Stapling Mode - [auto, always, never].
|
|
|
HTTP URL used to get OCSP staples.
Overrides the OCSP Responder URI set in certificates. |
`` |
|
Cache OCSP staples to local file storage. |
|
|
Authentication type applied to the WebUI/API interface.
Valid values: |
|
|
Listing of OIDC/OAuth2 issuers configured, each of the following items are per issuer. Please refer to your Identity Provider’s documentation for details, these items are usually returned from its .well-known/openid-configuration endpoint. |
`` |
|
Name for the issuer to be displayed in the WebUI. |
|
|
Identity of the issuer This MUST match the 'iss' payload in any issued JWT by the issuer |
|
|
URL of the issuers public key set to validate signature of the JWT.
Can only set one of |
|
|
JWKs of public keys to validate signature of the JWT
Can only set one of |
|
|
Period of time that the JWKs will be refreshed
Will be the largest of either the Cache-Control response header, the Expires header or this value.
Not used if |
|
|
List of JWT audiences that are allowed access. A JWT containing any of these audiences will be accepted. |
|
|
ID of the application to request a JWT for. |
|
|
Which grant type to execute during authentication. |
|
|
List of scopes to request. |
|
|
URL that the issuer will redirect to on successful logout. |
|
|
URL of the issuer to request authentication. |
|
|
URL of the issuer to obtain a token. |
|
|
URL of the issuer to obtain user information. |
|
|
URL of the issuer to end the session. |
|
|
Minimum severity level of log statements to output.
Valid values: |
|
|
Format of the log statements.
Valid values: |
|
|
To enable log output to file, set to |
|
|
The absolute path of the directory to which logs should be written.
The default is |
|
|
Type of database to use for KeySafe 5. Valid values: [sqlite, mongodb] |
|
|
Timeout for database requests. |
|
|
Absolute path of the directory in which KeySafe 5 will store its database files. KeySafe 5 must have permission to read and write to this directory. If not specified, it defaults to $NFAST_KMDATA/databases |
|
|
MongoDB database hosts list, comma separated. IPv6 addresses must be in the form [host]:port Only applied if database.type==mongodb |
`` |
|
Name of the MongoDB replica set. Only applied if database.type==mongodb |
`` |
|
Database name prefix. Use this setting if you are pointing multiple KeySafe 5 instances at the same MongoDB server to avoid database conflict. Only applied if database.type==mongodb |
`` |
|
Authentication method for the MongoDB connection. Valid values: [none, pwd, x509] none: No authentication required for connections pwd: SCRAM authentication x509: x.509 certificate authentication Only applied if database.type==mongodb |
|
|
The name of the Authentication Database for MongoDB. See https://docs.mongodb.com/manual/core/security-users/#std-label-authentication-database Only applied if database.type==mongodb |
`` |
|
File containing the MongoDB username - only applicable if auth.type=pwd Only applied if database.type==mongodb |
|
|
File containing the MongoDB password - only applicable if auth.type=pwd Only applied if database.type==mongodb |
|
|
x.509 client certificate - only applicable when auth.type=x509 Only applied if database.type==mongodb |
|
|
x.509 client private key - only applicable when auth.type=x509 Only applied if database.type==mongodb |
|
|
Set to |
|
|
Server CA certificate. Only applied if database.type==mongodb |
|
|
Minimum TLS protocol version allowed.
Valid values: |
|
|
Allowed cipher suites. The default provided here is the list of recommended cipher suites. TLSv1.3 cipher suites are currently not configurable. See Supported TLS Cipher Suites. Only applied if database.type==mongodb |
|
|
Timeout for connection to the MongoDB server. Only applied if database.type==mongodb |
|
|
Timeout for selecting a connection from the connection pool. Only applied if database.type==mongodb |
|
|
Timeout waiting for read/write in the socket. Only applied if database.type==mongodb |
|
|
Minimum connections to use in the MongoDB connection pool. Only applied if database.type==mongodb |
|
|
Maximum connections to use in the MongoDB connection pool. Only applied if database.type==mongodb |
|
|
Period of time between health checks. |
|
|
Time before a running health check should fail. |
|
|
Period of time before a liveness check is marked as failing. |
|
|
Maximum amount of time a clock on a KeySafe 5 agent can differ from this service before the host clockSkew health check fails. |
|
|
Absolute path of the directory in which KeySafe 5 will store large files. These may be gigabytes in size. KeySafe 5 must have permission to read and write to this directory. If not specified, it defaults to $NFAST_KEYSAFE5/server/filestore |
|
|
Duration to retain metric samples in storage.
Supported time units: y (years), w (weeks), d (days), h (hours), m (minutes), s (seconds), ms (milliseconds) |
|
|
Maximum total size of storage blocks to retain.
When the limit is reached, the oldest data is deleted first.
Set to 0 to disable size-based retention.
Supported units: B, KB, MB, GB, TB, PB, EB (using binary prefixes, for example, 1KB = 1024B) |
|
|
Absolute path to the directory where databases containing metric samples and alerts are stored. KeySafe 5 must have read and write permissions for this directory. If not specified, the default is $NFAST_KMDATA/databases |
|
|
SMTP server used for sending alert notifications. |
`` |
|
Sender address used in alert notification emails. |
|
|
Enable authenticated sending for the SMTP server. Note: For authenticated email, the SMTP server must support TLS, and its CA certificate must be in the operating system trust store. |
|
|
Absolute path to the file containing the SMTP username for authentication. |
`` |
|
Absolute path to the file containing the SMTP password for authentication. |
`` |
|
Address of the host the email footer to link to.
If not specified, the default is "" and the footer will not be displayed. |
`` |