KMIPServer Class
Properties Methods Events Configuration Settings Errors
The KMIPServer class provides server-side functionality for Key Management Interoperability Protocol (KMIP).
Syntax
secureblackbox.Kmipserver
Remarks
The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between different key management servers and clients.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Active | Indicates if the KMIP server is active and listening to incoming connections. |
CACertificate | The default CA certificate. |
CertificateRequest | The received certificate request. |
CertStorage | A database of certificates managed by the server. |
EncoderType | Specifies the KMIP encoder type. |
ExternalCrypto | Provides access to external signing and DC parameters. |
GeneratedCert | Contains the certificate that has just been generated. |
Port | A port to listen for connections on. |
SocketSettings | Manages network connection settings. |
StorageFileName | A path to the KMIP object database. |
TLSSettings | Manages TLS layer settings. |
Users | A database of registered users. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
GetClientCert | Populates the per-connection certificate object. |
GetClientCertRequest | Populates the per-connection certificate request object. |
SetClientCert | Commits the per-connection certificate object to the connection context. |
Start | Start the KMIP server. |
Stop | Stops the KMIP server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
AfterGenerateCert | Signifies completion of certificate generation. |
AfterGenerateKey | Signifies completion of key generation. |
AuthAttempt | Fires when a connected client makes an authentication attempt. |
BeforeGenerateCert | Fires when a certificate generation request is received. |
BeforeGenerateKey | Fires when a key generation request is received. |
DestroyAction | Fires when an object destruction request is received. |
Error | Information about any errors that occur during KMIP operations. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
Notification | This event notifies the application about an underlying control flow event. |
Request | Fires when a request is received from the client. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AuthBasic | Turns on/off the basic authentication. |
AuthDigest | Turns on/off the digest authentication. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
MajorProtocolVersion | Major protocol version on the KMIP server. |
MinorProtocolVersion | Minor protocol version on the KMIP server. |
SSLMode | Whether to establish a TLS-secured connection. |
UseChunkedTransfer | Whether to use chunked encoding of the data. |
UseCompression | Whether to use GZip compression. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |