# KMIPServer Class

The KMIPServer class provides server-side functionality for Key Management Interoperability Protocol (KMIP).

## Syntax

```text
KMIPServer
```

## Remarks

The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between key management servers and clients. KMIP servers are typically responsible for managing cryptographic keys and providing access to them to remote client applications.

## 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](#active-property-kmipserver-class) | Indicates if the KMIP server is active and listening to incoming connections. |
| [AllowKeepAlive](#allowkeepalive-property-kmipserver-class) | Enables or disables keep-alive mode. |
| [AuthRealm](#authrealm-property-kmipserver-class) | Specifies authentication realm for digest and NTLM authentication. |
| [AuthTypes](#authtypes-property-kmipserver-class) | Defines allowed HTTP authentication types. |
| [BoundPort](#boundport-property-kmipserver-class) | Indicates the bound listening port. |
| [CACertificate](#cacertificate-property-kmipserver-class) | The default CA certificate. |
| [Certificate](#certificate-property-kmipserver-class) | Contains the certificate that has just been generated or added. |
| [CompressionLevel](#compressionlevel-property-kmipserver-class) | The default compression level to use. |
| [ExternalCrypto](#externalcrypto-property-kmipserver-class) | Provides access to external signing and DC parameters. |
| [FIPSMode](#fipsmode-property-kmipserver-class) | Reserved. |
| [HandshakeTimeout](#handshaketimeout-property-kmipserver-class) | Specifies the handshake timeout in milliseconds. |
| [Host](#host-property-kmipserver-class) | Specifies the host name of the KMIP server. |
| [Key](#key-property-kmipserver-class) | Contains the key that has just been generated or added. |
| [PinnedClient](#pinnedclient-property-kmipserver-class) | Populates the pinned client details. |
| [PinnedClientChain](#pinnedclientchain-property-kmipserver-class) | Contains the certificate chain of the pinned client. |
| [Port](#port-property-kmipserver-class) | A port to listen for connections on. |
| [ReadOnly](#readonly-property-kmipserver-class) | Controls whether the server works in read-only mode. |
| [SessionTimeout](#sessiontimeout-property-kmipserver-class) | Specifies the default session timeout value in milliseconds. |
| [SocketSettings](#socketsettings-property-kmipserver-class) | Manages network connection settings. |
| [StorageFileName](#storagefilename-property-kmipserver-class) | A path to the KMIP object database. |
| [TLSServerChain](#tlsserverchain-property-kmipserver-class) | The server's TLS certificates. |
| [TLSSettings](#tlssettings-property-kmipserver-class) | Manages TLS layer settings. |
| [UseChunkedTransfer](#usechunkedtransfer-property-kmipserver-class) | Enables chunked transfer. |
| [UseCompression](#usecompression-property-kmipserver-class) | Enables or disables server-side compression. |
| [UseHTTP](#usehttp-property-kmipserver-class) | Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS. |
| [Users](#users-property-kmipserver-class) | 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.*

|  |  |
| --- | --- |
| [Cleanup](#cleanup-method-kmipserver-class) | Cleans up the server environment by purging expired sessions and cleaning caches. |
| [Config](#config-method-kmipserver-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-kmipserver-class) | Performs an additional action. |
| [DropClient](#dropclient-method-kmipserver-class) | Terminates a client connection. |
| [GetClientCert](#getclientcert-method-kmipserver-class) | Populates the per-connection certificate object. |
| [GetClientKey](#getclientkey-method-kmipserver-class) | Populates the per-connection key object. |
| [GetRequestHeader](#getrequestheader-method-kmipserver-class) | Returns a request header value. |
| [GetResponseHeader](#getresponseheader-method-kmipserver-class) | Returns a response header value. |
| [ListClients](#listclients-method-kmipserver-class) | Enumerates the connected clients. |
| [PinClient](#pinclient-method-kmipserver-class) | Takes a snapshot of the connection's properties. |
| [ProcessGenericRequest](#processgenericrequest-method-kmipserver-class) | Processes a generic HTTP request. |
| [Reset](#reset-method-kmipserver-class) | Resets the class settings. |
| [SetClientBytes](#setclientbytes-method-kmipserver-class) | Commits a data buffer to the connection. |
| [SetClientCert](#setclientcert-method-kmipserver-class) | Commits the per-connection certificate object to the connection context. |
| [SetClientKey](#setclientkey-method-kmipserver-class) | Commits the per-connection key object to the connection context. |
| [SetResponseHeader](#setresponseheader-method-kmipserver-class) | Sets a response header. |
| [Start](#start-method-kmipserver-class) | Start the KMIP server. |
| [Stop](#stop-method-kmipserver-class) | 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.*

|  |  |
| --- | --- |
| [Accept](#accept-event-kmipserver-class) | Reports an incoming connection. |
| [ActivateObject](#activateobject-event-kmipserver-class) | Notifies the application about the object activation request. |
| [Add](#add-event-kmipserver-class) | Passes the certificate import request to the application. |
| [AddKey](#addkey-event-kmipserver-class) | Expects the application to handle the key import request. |
| [AfterAdd](#afteradd-event-kmipserver-class) | Notifies the application about completion of the certificate import operation. |
| [AfterAddKey](#afteraddkey-event-kmipserver-class) | Reports the completion of the key import procedure. |
| [AfterBrowse](#afterbrowse-event-kmipserver-class) | KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation. |
| [AfterDecrypt](#afterdecrypt-event-kmipserver-class) | Notifies the application about completion of the decryption call. |
| [AfterDeriveKey](#afterderivekey-event-kmipserver-class) | Notifies the application about completion of the key derivation request. |
| [AfterEdit](#afteredit-event-kmipserver-class) | Notifies the application of completion of the object editing operation. |
| [AfterEncrypt](#afterencrypt-event-kmipserver-class) | Notifies the application about the completion of the encryption call. |
| [AfterGenerate](#aftergenerate-event-kmipserver-class) | Signifies completion of certificate generation. |
| [AfterGenerateKey](#aftergeneratekey-event-kmipserver-class) | Notifies the application of the completion of key generation procedure. |
| [AfterGenerateKeyPair](#aftergeneratekeypair-event-kmipserver-class) | Notifies the application of the completion of keypair generation. |
| [AfterHash](#afterhash-event-kmipserver-class) | Notifies the application about completion of the hashing call. |
| [AfterList](#afterlist-event-kmipserver-class) | Notifies the application about completion of the list command. |
| [AfterObtainLease](#afterobtainlease-event-kmipserver-class) | Reports the completion of lease allocation operation. |
| [AfterReadObject](#afterreadobject-event-kmipserver-class) | Notifies the application of the completion of the read operation on the object. |
| [AfterReCertify](#afterrecertify-event-kmipserver-class) | Notifies the application about the completion of the re-certify operation. |
| [AfterReKey](#afterrekey-event-kmipserver-class) | Notifies the application about the completion of the re-key operation. |
| [AfterRekeyKeyPair](#afterrekeykeypair-event-kmipserver-class) | Notifies the application about the completion of the re-key keypair operation. |
| [AfterRemoveObject](#afterremoveobject-event-kmipserver-class) | Notifies the application about completion of the object removal request. |
| [AfterSign](#aftersign-event-kmipserver-class) | Notifies the application of completion of a signing operation. |
| [AfterVerify](#afterverify-event-kmipserver-class) | Notifies the application about completion of the Verify operation. |
| [AfterVerifyHash](#afterverifyhash-event-kmipserver-class) | Notifies the application about completion of the hash verification. |
| [ArchiveObject](#archiveobject-event-kmipserver-class) | Notifies the application about the received object archival request. |
| [AuthAttempt](#authattempt-event-kmipserver-class) | Fires when a connected client makes an authentication attempt. |
| [BeforeAdd](#beforeadd-event-kmipserver-class) | Fires when a certificate import request is received from a client. |
| [BeforeAddKey](#beforeaddkey-event-kmipserver-class) | Fires when a key import request is received from the client. |
| [BeforeBrowse](#beforebrowse-event-kmipserver-class) | Notifies the application about the browse request being received. |
| [BeforeDecrypt](#beforedecrypt-event-kmipserver-class) | Notifies the application about the initiation of the decryption operation. |
| [BeforeDeriveKey](#beforederivekey-event-kmipserver-class) | Fires when a derive key request is received. |
| [BeforeEdit](#beforeedit-event-kmipserver-class) | Notifies the application about the start of the object editing operation. |
| [BeforeEncrypt](#beforeencrypt-event-kmipserver-class) | Notifies the application about the initiation of an encryption operation. |
| [BeforeGenerate](#beforegenerate-event-kmipserver-class) | Fires when a certificate generation request is received. |
| [BeforeGenerateKey](#beforegeneratekey-event-kmipserver-class) | Fires when a key generation request is received. |
| [BeforeGenerateKeyPair](#beforegeneratekeypair-event-kmipserver-class) | Fires when a key generation request is received. |
| [BeforeHash](#beforehash-event-kmipserver-class) | Notifies the application about the initiation of the hashing operation. |
| [BeforeList](#beforelist-event-kmipserver-class) | Notifies the application about the initiation of the list operation. |
| [BeforeObtainLease](#beforeobtainlease-event-kmipserver-class) | Notifies the application about the client requesting an object lease. |
| [BeforeReadObject](#beforereadobject-event-kmipserver-class) | Notifies the application about the start of the object reading request. |
| [BeforeReCertify](#beforerecertify-event-kmipserver-class) | Notifies the application about a re-certification request. |
| [BeforeReKey](#beforerekey-event-kmipserver-class) | Notifies the application about a re-key request received. |
| [BeforeRekeyKeyPair](#beforerekeykeypair-event-kmipserver-class) | Notifies the application about a keypair re-key request received. |
| [BeforeRemoveObject](#beforeremoveobject-event-kmipserver-class) | Notifies the application about an incoming Remove Object request. |
| [BeforeSign](#beforesign-event-kmipserver-class) | Notifies the application about the initiation of a signing operation. |
| [BeforeVerify](#beforeverify-event-kmipserver-class) | Notifies the application about the initiation of the verify operation. |
| [BeforeVerifyHash](#beforeverifyhash-event-kmipserver-class) | Notifies the application about the initiation of the hash verification operation. |
| [Cancel](#cancel-event-kmipserver-class) | Reports a cancellation request received from the client. |
| [Check](#check-event-kmipserver-class) | Notifies the application about a Check request received. |
| [Connect](#connect-event-kmipserver-class) | Reports an accepted connection. |
| [Decrypt](#decrypt-event-kmipserver-class) | Instructs the application to decrypt a chunk of data. |
| [DeleteAttribute](#deleteattribute-event-kmipserver-class) | Instructs the application to delete an object attribute. |
| [DeriveKey](#derivekey-event-kmipserver-class) | Notifies the application of key derivation request. |
| [Disconnect](#disconnect-event-kmipserver-class) | Fires to report a disconnected client. |
| [Encrypt](#encrypt-event-kmipserver-class) | Instructs the application to encrypt a chunk of data. |
| [Error](#error-event-kmipserver-class) | Information about errors during data delivery. |
| [ExternalSign](#externalsign-event-kmipserver-class) | Handles remote or external signing initiated by the server protocol. |
| [Generate](#generate-event-kmipserver-class) | Notifies the application about an incoming Generate request. |
| [GenerateKey](#generatekey-event-kmipserver-class) | Notifies the application about an incoming Generate request. |
| [GenerateKeyPair](#generatekeypair-event-kmipserver-class) | Notifies the application about an incoming Generate request. |
| [GetUsageAllocation](#getusageallocation-event-kmipserver-class) | Notifies the application about an incoming Get Usage Allocation request. |
| [Hash](#hash-event-kmipserver-class) | Instructs the application to update the current hashing operation. |
| [HeadersPrepared](#headersprepared-event-kmipserver-class) | Fires when the response headers have been formed and are ready to be sent to the server. |
| [KMIPAuthAttempt](#kmipauthattempt-event-kmipserver-class) | Fires when a connected client makes an authentication attempt. |
| [List](#list-event-kmipserver-class) | Instructs the application to return the list of objects that match the specified criteria. |
| [ListAttributes](#listattributes-event-kmipserver-class) | Requests a list of object attribute names from the application. |
| [Notification](#notification-event-kmipserver-class) | This event notifies the application about an underlying control flow event. |
| [ObtainLease](#obtainlease-event-kmipserver-class) | Lets the application handle the lease request. |
| [OperationAttempt](#operationattempt-event-kmipserver-class) | Fires when a request is received from the client. |
| [Poll](#poll-event-kmipserver-class) | Notifies the application about the received Poll request. |
| [ReadAttribute](#readattribute-event-kmipserver-class) | Requests an object attribute value from the application. |
| [ReadObject](#readobject-event-kmipserver-class) | Requests the details of the object from the application. |
| [ReCertify](#recertify-event-kmipserver-class) | Notifies the application about an incoming re-certification request. |
| [RecoverObject](#recoverobject-event-kmipserver-class) | Notifies the application about an incoming Recover Object request. |
| [ReKey](#rekey-event-kmipserver-class) | Notifies the application about an incoming re-key request. |
| [RekeyKeyPair](#rekeykeypair-event-kmipserver-class) | Notifies the application about an incoming re-key request. |
| [RemoveObject](#removeobject-event-kmipserver-class) | Notifies the application about the object deletion request. |
| [Request](#request-event-kmipserver-class) | Notifies the application about KMIP requests being received. |
| [Response](#response-event-kmipserver-class) | Notifies the application about KMIP responses being sent back. |
| [RevokeObject](#revokeobject-event-kmipserver-class) | Instructs the application to revoke an object. |
| [RNGGenerate](#rnggenerate-event-kmipserver-class) | Asks the application for another block of random numbers. |
| [RNGSeed](#rngseed-event-kmipserver-class) | Tells the application to seed the random number generator. |
| [SetAttribute](#setattribute-event-kmipserver-class) | Passes a set-attribute request to the application. |
| [Sign](#sign-event-kmipserver-class) | Instructs the application to sign data with a private key. |
| [TLSCertValidate](#tlscertvalidate-event-kmipserver-class) | Fires when a client certificate needs to be validated. |
| [TLSEstablished](#tlsestablished-event-kmipserver-class) | Reports the setup of a TLS session. |
| [TLSHandshake](#tlshandshake-event-kmipserver-class) | Fires when a newly established client connection initiates a TLS handshake. |
| [TLSPSK](#tlspsk-event-kmipserver-class) | Requests a pre-shared key for TLS-PSK. |
| [TLSShutdown](#tlsshutdown-event-kmipserver-class) | Reports closure of a TLS session. |
| [ValidateChain](#validatechain-event-kmipserver-class) | Passes the chain validation request to the application. |
| [Verify](#verify-event-kmipserver-class) | KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it. |
| [VerifyHash](#verifyhash-event-kmipserver-class) | Delegates the hash verification operation to a custom handler. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AllowKeepAlive](#AllowKeepAlive) | Enables or disables keep-alive mode. |
| [AllowOptionsResponseWithoutAuth](#AllowOptionsResponseWithoutAuth) | Enables unauthenticated responses to OPTIONS requests. |
| [AuthBasic](#AuthBasic) | Turns on/off the basic authentication. |
| [AuthDigest](#AuthDigest) | Turns on/off the digest authentication. |
| [AuthDigestExpire](#AuthDigestExpire) | Specifies digest expiration time for digest authentication. |
| [AuthRealm](#AuthRealm) | Specifies authentication realm for digest and NTLM authentication. |
| [CompressionLevel](#CompressionLevel) | The default compression level to use. |
| [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. |
| [HomePage](#HomePage) | Specifies the home page resource name. |
| [MajorProtocolVersion](#MajorProtocolVersion) | Major protocol version on the KMIP server. |
| [MinorProtocolVersion](#MinorProtocolVersion) | Minor protocol version on the KMIP server. |
| [OAuthAllowAccessByDefault](#OAuthAllowAccessByDefault) | Specifies whether access to a resource is allowed by default. |
| [OAuthAutoValidateTokens](#OAuthAutoValidateTokens) | Allows to validate OAuth 2.0 access tokens automatically. |
| [OAuthIntrospectionClientID](#OAuthIntrospectionClientID) | Specifies a client ID on the authentication service. |
| [OAuthIntrospectionClientSecret](#OAuthIntrospectionClientSecret) | Specifies a client secret on the authentication service. |
| [OAuthIntrospectionURL](#OAuthIntrospectionURL) | Specifies the URL to be used to introspect access tokens. |
| [OAuthTokenValidationKeys](#OAuthTokenValidationKeys) | Specifies JW keys in JSON format for validating access token signatures. |
| [RequestFilter](#RequestFilter) | The request string modifier. |
| [SSLMode](#SSLMode) | Whether to establish a TLS-secured connection. |
| [UseChunkedTransfer](#UseChunkedTransfer) | Whether to use chunked encoding of the data. |
| [UseChunkedTransfer](#UseChunkedTransfer) | Enables chunked transfer. |
| [UseCompression](#UseCompression) | Whether to use GZip compression. |
| [UseCompression](#UseCompression) | Enables or disables server-side compression. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# Active Property ([KMIPServer](#kmipserver-class) Class)

Indicates if the KMIP server is active and listening to incoming connections.

## Syntax

```text
ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();
```

## Default Value

FALSE

## Remarks

Check this property to find out if the KMIP server is in an active state. Use [Start](#start-method-kmipserver-class) and [Stop](#stop-method-kmipserver-class) methods to launch and stop the server.

This property is read-only and not available at design time.

## Data Type

Boolean

# AllowKeepAlive Property ([KMIPServer](#kmipserver-class) Class)

Enables or disables keep-alive mode.

## Syntax

```text
ANSI (Cross Platform)
int GetAllowKeepAlive();int SetAllowKeepAlive(int bAllowKeepAlive);

Unicode (Windows)
BOOL GetAllowKeepAlive();INT SetAllowKeepAlive(BOOL bAllowKeepAlive);
```

## Default Value

TRUE

## Remarks

Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while.

## Data Type

Boolean

# AuthRealm Property ([KMIPServer](#kmipserver-class) Class)

Specifies authentication realm for digest and NTLM authentication.

## Syntax

```text
ANSI (Cross Platform)
char* GetAuthRealm();int SetAuthRealm(const char* lpszAuthRealm);

Unicode (Windows)
LPWSTR GetAuthRealm();INT SetAuthRealm(LPCWSTR lpszAuthRealm);
```

## Default Value

"SecureBlackbox"

## Remarks

Specifies authentication realm for digest and NTLM authentication types.

## Data Type

String

# AuthTypes Property ([KMIPServer](#kmipserver-class) Class)

Defines allowed HTTP authentication types.

## Syntax

```text
ANSI (Cross Platform)
int GetAuthTypes();int SetAuthTypes(int iAuthTypes);

Unicode (Windows)
INT GetAuthTypes();INT SetAuthTypes(INT iAuthTypes);
```

## Default Value

0

## Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

|  |  |  |
| --- | --- | --- |
| haBasic | 0x01 | Basic authentication |
| haDigest | 0x02 | Digest authentication (RFC 2617) |
| haNTLM | 0x04 | Windows NTLM authentication |
| haKerberos | 0x08 | Kerberos (Negotiate) authentication |
| haOAuth2 | 0x10 | OAuth2 authentication |

## Data Type

Integer

# BoundPort Property ([KMIPServer](#kmipserver-class) Class)

Indicates the bound listening port.

## Syntax

```text
ANSI (Cross Platform)
int GetBoundPort();

Unicode (Windows)
INT GetBoundPort();
```

## Default Value

0

## Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals [Port](#port-property-kmipserver-class) if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

This property is read-only and not available at design time.

## Data Type

Integer

# CACertificate Property ([KMIPServer](#kmipserver-class) Class)

The default CA certificate.

## Syntax

```text
SecureBlackboxCertificate* GetCACertificate();
int SetCACertificate(SecureBlackboxCertificate* val);
```

## Remarks

KMIP server uses this certificate to sign incoming certificate requests. All certificates generated by the KMIP server will be signed by this CA.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# Certificate Property ([KMIPServer](#kmipserver-class) Class)

Contains the certificate that has just been generated or added.

## Syntax

```text
SecureBlackboxCertificate* GetCertificate();
int SetCertificate(SecureBlackboxCertificate* val);
```

## Remarks

Use this property to access the certificate that has just been generated or added.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# CompressionLevel Property ([KMIPServer](#kmipserver-class) Class)

The default compression level to use.

## Syntax

```text
ANSI (Cross Platform)
int GetCompressionLevel();int SetCompressionLevel(int iCompressionLevel);

Unicode (Windows)
INT GetCompressionLevel();INT SetCompressionLevel(INT iCompressionLevel);
```

## Default Value

6

## Remarks

Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest.

## Data Type

Integer

# ExternalCrypto Property ([KMIPServer](#kmipserver-class) Class)

Provides access to external signing and DC parameters.

## Syntax

```text
SecureBlackboxExternalCrypto* GetExternalCrypto();
```

## Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the [ExternalSign](#externalsign-event-kmipserver-class) event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

## Data Type

[SecureBlackboxExternalCrypto](#externalcrypto-type)

# FIPSMode Property ([KMIPServer](#kmipserver-class) Class)

Reserved.

## Syntax

```text
ANSI (Cross Platform)
int GetFIPSMode();int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode);
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# HandshakeTimeout Property ([KMIPServer](#kmipserver-class) Class)

Specifies the handshake timeout in milliseconds.

## Syntax

```text
ANSI (Cross Platform)
int GetHandshakeTimeout();int SetHandshakeTimeout(int iHandshakeTimeout);

Unicode (Windows)
INT GetHandshakeTimeout();INT SetHandshakeTimeout(INT iHandshakeTimeout);
```

## Default Value

20000

## Remarks

Use this property to set the TLS handshake timeout.

## Data Type

Integer

# Host Property ([KMIPServer](#kmipserver-class) Class)

Specifies the host name of the KMIP server.

## Syntax

```text
ANSI (Cross Platform)
char* GetHost();int SetHost(const char* lpszHost);

Unicode (Windows)
LPWSTR GetHost();INT SetHost(LPCWSTR lpszHost);
```

## Default Value

""

## Remarks

Use this property to specify the address of the KMIP server.

## Data Type

String

# Key Property ([KMIPServer](#kmipserver-class) Class)

Contains the key that has just been generated or added.

## Syntax

```text
SecureBlackboxCryptoKey* GetKey();
int SetKey(SecureBlackboxCryptoKey* val);
```

## Remarks

Use this property to access the key that has just been generated or added.

This property is not available at design time.

## Data Type

[SecureBlackboxCryptoKey](#cryptokey-type)

# PinnedClient Property ([KMIPServer](#kmipserver-class) Class)

Populates the pinned client details.

## Syntax

```text
SecureBlackboxTLSConnectionInfo* GetPinnedClient();
```

## Remarks

Use this property to access the details of the client connection previously pinned with [PinClient](#pinclient-method-kmipserver-class) method.

This property is read-only and not available at design time.

## Data Type

[SecureBlackboxTLSConnectionInfo](#tlsconnectioninfo-type)

# PinnedClientChain Property ([KMIPServer](#kmipserver-class) Class)

Contains the certificate chain of the pinned client.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();
```

## Remarks

Use this property to access the certificate chain of the client connection pinned previously with a [PinClient](#pinclient-method-kmipserver-class) call.

This property is read-only and not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# Port Property ([KMIPServer](#kmipserver-class) Class)

A port to listen for connections on.

## Syntax

```text
ANSI (Cross Platform)
int GetPort();int SetPort(int iPort);

Unicode (Windows)
INT GetPort();INT SetPort(INT iPort);
```

## Default Value

5696

## Remarks

Use this property to specify the listening port.

## Data Type

Integer

# ReadOnly Property ([KMIPServer](#kmipserver-class) Class)

Controls whether the server works in read-only mode.

## Syntax

```text
ANSI (Cross Platform)
int GetReadOnly();int SetReadOnly(int bReadOnly);

Unicode (Windows)
BOOL GetReadOnly();INT SetReadOnly(BOOL bReadOnly);
```

## Default Value

FALSE

## Remarks

Use this property to enable or disable read-only mode on the server. It is an easy way to prevent connecting users from adding or removing objects managed by the server.

This property is not available at design time.

## Data Type

Boolean

# SessionTimeout Property ([KMIPServer](#kmipserver-class) Class)

Specifies the default session timeout value in milliseconds.

## Syntax

```text
ANSI (Cross Platform)
int GetSessionTimeout();int SetSessionTimeout(int iSessionTimeout);

Unicode (Windows)
INT GetSessionTimeout();INT SetSessionTimeout(INT iSessionTimeout);
```

## Default Value

360000

## Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

## Data Type

Integer

# SocketSettings Property ([KMIPServer](#kmipserver-class) Class)

Manages network connection settings.

## Syntax

```text
SecureBlackboxSocketSettings* GetSocketSettings();
```

## Remarks

Use this property to tune up network connection parameters.

This property is read-only.

## Data Type

[SecureBlackboxSocketSettings](#socketsettings-type)

# StorageFileName Property ([KMIPServer](#kmipserver-class) Class)

A path to the KMIP object database.

## Syntax

```text
ANSI (Cross Platform)
char* GetStorageFileName();int SetStorageFileName(const char* lpszStorageFileName);

Unicode (Windows)
LPWSTR GetStorageFileName();INT SetStorageFileName(LPCWSTR lpszStorageFileName);
```

## Default Value

""

## Remarks

Assign the path to the database of objects managed by the KMIP server to this property.

## Data Type

String

# TLSServerChain Property ([KMIPServer](#kmipserver-class) Class)

The server's TLS certificates.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

 A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# TLSSettings Property ([KMIPServer](#kmipserver-class) Class)

Manages TLS layer settings.

## Syntax

```text
SecureBlackboxTLSSettings* GetTLSSettings();
```

## Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

## Data Type

[SecureBlackboxTLSSettings](#tlssettings-type)

# UseChunkedTransfer Property ([KMIPServer](#kmipserver-class) Class)

Enables chunked transfer.

## Syntax

```text
ANSI (Cross Platform)
int GetUseChunkedTransfer();int SetUseChunkedTransfer(int bUseChunkedTransfer);

Unicode (Windows)
BOOL GetUseChunkedTransfer();INT SetUseChunkedTransfer(BOOL bUseChunkedTransfer);
```

## Default Value

FALSE

## Remarks

Use this property to enable chunked content encoding.

## Data Type

Boolean

# UseCompression Property ([KMIPServer](#kmipserver-class) Class)

Enables or disables server-side compression.

## Syntax

```text
ANSI (Cross Platform)
int GetUseCompression();int SetUseCompression(int bUseCompression);

Unicode (Windows)
BOOL GetUseCompression();INT SetUseCompression(BOOL bUseCompression);
```

## Default Value

FALSE

## Remarks

Use this property to enable or disable server-side content compression.

## Data Type

Boolean

# UseHTTP Property ([KMIPServer](#kmipserver-class) Class)

Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS.

## Syntax

```text
ANSI (Cross Platform)
int GetUseHTTP();int SetUseHTTP(int bUseHTTP);

Unicode (Windows)
BOOL GetUseHTTP();INT SetUseHTTP(BOOL bUseHTTP);
```

## Default Value

FALSE

## Remarks

Set this property to true to tell the server to expect HTTP(S) connections instead of TCP-based KMIP requests.

This property is not available at design time.

## Data Type

Boolean

# Users Property ([KMIPServer](#kmipserver-class) Class)

A database of registered users.

## Syntax

```text
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers();
int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
```

## Remarks

Use this property to configure user authentication on the KMIP server.

This property is not available at design time.

## Data Type

[SecureBlackboxUserAccount](#useraccount-type)

# Cleanup Method ([KMIPServer](#kmipserver-class) Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

## Syntax

```text
ANSI (Cross Platform)
int Cleanup();

Unicode (Windows)
INT Cleanup();
```

## Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Config Method ([KMIPServer](#kmipserver-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-kmipserver-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-kmipserver-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DoAction Method ([KMIPServer](#kmipserver-class) Class)

Performs an additional action.

## Syntax

```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```

## Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter.

*ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DropClient Method ([KMIPServer](#kmipserver-class) Class)

Terminates a client connection.

## Syntax

```text
ANSI (Cross Platform)
int DropClient(int64 lConnectionId, int bForced);

Unicode (Windows)
INT DropClient(LONG64 lConnectionId, BOOL bForced);
```

## Remarks

Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetClientCert Method ([KMIPServer](#kmipserver-class) Class)

Populates the per-connection certificate object.

## Syntax

```text
ANSI (Cross Platform)
int GetClientCert(int64 lConnectionID);

Unicode (Windows)
INT GetClientCert(LONG64 lConnectionID);
```

## Remarks

This method populates the certificate template/object received with the certificate generation request in [Certificate](#certificate-property-kmipserver-class) property.

Call this method from your [BeforeGenerate](#beforegenerate-event-kmipserver-class) event handler to populate the certificate template, as received in the request. It is still not late to alter the details of the certificate on this stage.

Call it from your [AfterGenerate](#aftergenerate-event-kmipserver-class) event handler to populate the certificate that has been generated.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetClientKey Method ([KMIPServer](#kmipserver-class) Class)

Populates the per-connection key object.

## Syntax

```text
ANSI (Cross Platform)
int GetClientKey(int64 lConnectionID);

Unicode (Windows)
INT GetClientKey(LONG64 lConnectionID);
```

## Remarks

This method populates the key template/object received with the key generation request in [Key](#key-property-kmipserver-class) property.

Call this method from your [BeforeGenerateKey](#beforegeneratekey-event-kmipserver-class) event handler to populate the key template, as received in the request. It is still not late to alter the details of the key on this stage.

Call it from your [AfterGenerateKey](#aftergeneratekey-event-kmipserver-class) event handler to populate the key that has been generated.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetRequestHeader Method ([KMIPServer](#kmipserver-class) Class)

Returns a request header value.

## Syntax

```text
ANSI (Cross Platform)
char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
```

## Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetResponseHeader Method ([KMIPServer](#kmipserver-class) Class)

Returns a response header value.

## Syntax

```text
ANSI (Cross Platform)
char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
```

## Remarks

Use this method to get the value of a response header. A good place to call this method is [HeadersPrepared](#headersprepared-event-kmipserver-class) event. Call the method with empty *HeaderName* to get the whole response header.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# ListClients Method ([KMIPServer](#kmipserver-class) Class)

Enumerates the connected clients.

## Syntax

```text
ANSI (Cross Platform)
char* ListClients();

Unicode (Windows)
LPWSTR ListClients();
```

## Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# PinClient Method ([KMIPServer](#kmipserver-class) Class)

Takes a snapshot of the connection's properties.

## Syntax

```text
ANSI (Cross Platform)
int PinClient(int64 lConnectionId);

Unicode (Windows)
INT PinClient(LONG64 lConnectionId);
```

## Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in [PinnedClient](#pinnedclient-property-kmipserver-class) and [PinnedClientChain](#pinnedclientchain-property-kmipserver-class) properties.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ProcessGenericRequest Method ([KMIPServer](#kmipserver-class) Class)

Processes a generic HTTP request.

## Syntax

```text
ANSI (Cross Platform)
char* ProcessGenericRequest(int64 lConnectionId, const char* lpRequestBytes, int lenRequestBytes, int *lpSize = NULL);

Unicode (Windows)
LPSTR ProcessGenericRequest(LONG64 lConnectionId, LPCSTR lpRequestBytes, INT lenRequestBytes, LPINT lpSize = NULL);
```

## Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. *ConnectionId* allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

## Error Handling (C++)

This method returns a Byte Array value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Reset Method ([KMIPServer](#kmipserver-class) Class)

Resets the class settings.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

Reset is a generic method available in every class.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetClientBytes Method ([KMIPServer](#kmipserver-class) Class)

Commits a data buffer to the connection.

## Syntax

```text
ANSI (Cross Platform)
int SetClientBytes(int64 lConnectionID, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetClientBytes(LONG64 lConnectionID, LPCSTR lpValue, INT lenValue);
```

## Remarks

Use this method from your [Response](#response-event-kmipserver-class) [Encrypt](#encrypt-event-kmipserver-class) [AfterEncrypt](#afterencrypt-event-kmipserver-class) [Decrypt](#decrypt-event-kmipserver-class) [AfterDecrypt](#afterdecrypt-event-kmipserver-class) [Sign](#sign-event-kmipserver-class) [AfterSign](#aftersign-event-kmipserver-class) events handler to commit a new data to the server component.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetClientCert Method ([KMIPServer](#kmipserver-class) Class)

Commits the per-connection certificate object to the connection context.

## Syntax

```text
ANSI (Cross Platform)
int SetClientCert(int64 lConnectionID);

Unicode (Windows)
INT SetClientCert(LONG64 lConnectionID);
```

## Remarks

This method commits the certificate object stored in [Certificate](#certificate-property-kmipserver-class) to the connection context.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetClientKey Method ([KMIPServer](#kmipserver-class) Class)

Commits the per-connection key object to the connection context.

## Syntax

```text
ANSI (Cross Platform)
int SetClientKey(int64 lConnectionID);

Unicode (Windows)
INT SetClientKey(LONG64 lConnectionID);
```

## Remarks

This method commits the key object stored in [Key](#key-property-kmipserver-class) to the connection context.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetResponseHeader Method ([KMIPServer](#kmipserver-class) Class)

Sets a response header.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);

Unicode (Windows)
INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);
```

## Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Start Method ([KMIPServer](#kmipserver-class) Class)

Start the KMIP server.

## Syntax

```text
ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();
```

## Remarks

Call this method to activate the KMIP server and start listening to incoming connections.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Stop Method ([KMIPServer](#kmipserver-class) Class)

Stops the KMIP server.

## Syntax

```text
ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();
```

## Remarks

Call this method to stop the KMIP server.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Accept Event ([KMIPServer](#kmipserver-class) Class)

Reports an incoming connection.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAccept(KMIPServerAcceptEventParams *e);
typedef struct {  const char *RemoteAddress;  int RemotePort;  int Accept;
  int reserved;
} KMIPServerAcceptEventParams;

Unicode (Windows)
virtual INT FireAccept(KMIPServerAcceptEventParams *e);
typedef struct {  LPCWSTR RemoteAddress;  INT RemotePort;  BOOL Accept;
  INT reserved;
} KMIPServerAcceptEventParams;
```

## Remarks

This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it.

Subscribe to [Connect](#connect-event-kmipserver-class) event to be notified of every connection that has been set up.

# ActivateObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the object activation request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireActivateObject(KMIPServerActivateObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerActivateObjectEventParams;

Unicode (Windows)
virtual INT FireActivateObject(KMIPServerActivateObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerActivateObjectEventParams;
```

## Remarks

Subscribe to this event to get notified about object activation requests. The *ObjectId* parameter contain the unique identifier of the object being activated.

Object activation requests are handled in a simplified way, without using the three-step virtualization approach.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Add Event ([KMIPServer](#kmipserver-class) Class)

Passes the certificate import request to the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAdd(KMIPServerAddEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  char *CertId;  int OperationStatus;
  int reserved;
} KMIPServerAddEventParams;

Unicode (Windows)
virtual INT FireAdd(KMIPServerAddEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  LPWSTR CertId;  INT OperationStatus;
  INT reserved;
} KMIPServerAddEventParams;
```

## Remarks

The server uses this event to allow the application to customize a certificate import request. This request fires after [BeforeAdd](#beforeadd-event-kmipserver-class) if the *Action* parameter passed back to it was set to *fraCustom*.

The *Group* parameter indicates the shared name for the certificate elements (public key, private key, certificate). The *CertId* provides a unique identifier for the certificate object. Both can be adjusted by the application as required. Use the [Certificate](#certificate-property-kmipserver-class) object to access the certificate parameters.

Upon completion of the processing, set the value of *OperationStatus* to match the result of the operation.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AddKey Event ([KMIPServer](#kmipserver-class) Class)

Expects the application to handle the key import request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAddKey(KMIPServerAddKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  char *KeyId;  int OperationStatus;
  int reserved;
} KMIPServerAddKeyEventParams;

Unicode (Windows)
virtual INT FireAddKey(KMIPServerAddKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  LPWSTR KeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAddKeyEventParams;
```

## Remarks

Application uses this event to wiretap into the key import procedure. For this event to be invoked, the *fraCustom* action needs to be previously returned from the [BeforeAddKey](#beforeaddkey-event-kmipserver-class) event.

The handler of this event should process the key data provided via the [Key](#key-property-kmipserver-class) property, typically by storing the key object in a local database. The handler also should set the *KeyId* and, optionally, *Group* parameters to match the properties of the new key object. The result of the operation should be returned via the *OperationStatus* parameter.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterAdd Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the certificate import operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterAdd(KMIPServerAfterAddEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  char *CertId;  int OperationStatus;
  int reserved;
} KMIPServerAfterAddEventParams;

Unicode (Windows)
virtual INT FireAfterAdd(KMIPServerAfterAddEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  LPWSTR CertId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterAddEventParams;
```

## Remarks

The class fires this event upon completion of certificate import routine. The certificate object that has been generated can be read from the [Certificate](#certificate-property-kmipserver-class) property.

The *Group* and *CertId* parameters contain the name of the group and the unique identifier assigned to the new certificate. The *OperationStatus* parameter contains the result of the operation. The application can adjust them as required.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterAddKey Event ([KMIPServer](#kmipserver-class) Class)

Reports the completion of the key import procedure.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterAddKey(KMIPServerAfterAddKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  char *KeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterAddKeyEventParams;

Unicode (Windows)
virtual INT FireAfterAddKey(KMIPServerAfterAddKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  LPWSTR KeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterAddKeyEventParams;
```

## Remarks

The component uses the AfterAddKey event to notify the application about completion of the key import processing. The *OperationStatus* parameter returns the operation result. The *KeyId* and *Group* parameters are set to match the properties of the newly created key. The application can change them if required.

This event fires both for "normal" and "virtualized" requests, independently of the value of the *Action* parameter returned from the [BeforeAddKey](#beforeaddkey-event-kmipserver-class) event. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterBrowse Event ([KMIPServer](#kmipserver-class) Class)

KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterBrowse(KMIPServerAfterBrowseEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerAfterBrowseEventParams;

Unicode (Windows)
virtual INT FireAfterBrowse(KMIPServerAfterBrowseEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterBrowseEventParams;
```

## Remarks

The *ConnectionID* parameter identifies the client connection, and the *ObjectId* parameter specifies the unique ID of the object the attributes of which are being requested.

This event follows the three-step virtualization approach, and fires after the preceding [BeforeBrowse](#beforebrowse-event-kmipserver-class) and [ReadAttribute](#readattribute-event-kmipserver-class) events.

Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterDecrypt Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the decryption call.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterDecrypt(KMIPServerAfterDecryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *DecryptedData;
  int lenDecryptedData;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterDecryptEventParams;

Unicode (Windows)
virtual INT FireAfterDecrypt(KMIPServerAfterDecryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCSTR DecryptedData;
  INT lenDecryptedData;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterDecryptEventParams;
```

## Remarks

The component uses this event to notify the application about completion of the decrypt request. The event parameters provide the details of the decryption operation. This event fires independently of whether the build-in or virtualized decryption is used.

The *ObjectId* parameter contains the unique identifier of the decryption key. *DecryptedData* contains the decryption result. The *CorrelationValue* string is a linking token that allows to associate several pieces of a multi-step decryption operation together. The *OperationStatus* contains the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterDeriveKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the key derivation request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterDeriveKey(KMIPServerAfterDeriveKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *NewKeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterDeriveKeyEventParams;

Unicode (Windows)
virtual INT FireAfterDeriveKey(KMIPServerAfterDeriveKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR NewKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterDeriveKeyEventParams;
```

## Remarks

Use this event to get notified about completion of key derivation requests. The *OperationStatus* parameter specifies the result of the key derivation operation. The *NewKeyId* contains the unique identifier of the new key. You can change both parameters if required.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterEdit Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of completion of the object editing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterEdit(KMIPServerAfterEditEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerAfterEditEventParams;

Unicode (Windows)
virtual INT FireAfterEdit(KMIPServerAfterEditEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterEditEventParams;
```

## Remarks

The component fires this event to notify the application about completion of an edit operation. An edit operation consists of a number of individual attribute update requests.

The *ObjectId* parameter contains the unique identifier of the object that was edited. Use the *OperationStatus* parameter to check or update the result of the operation.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterEncrypt Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the completion of the encryption call.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterEncrypt(KMIPServerAfterEncryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *EncryptedData;
  int lenEncryptedData;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterEncryptEventParams;

Unicode (Windows)
virtual INT FireAfterEncrypt(KMIPServerAfterEncryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCSTR EncryptedData;
  INT lenEncryptedData;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterEncryptEventParams;
```

## Remarks

The component uses this event to notify the application about completion of the encrypt request. The event parameters provide the details of the encryption operation. This event fires independently of whether the build-in or virtualized decryption is used.

The *ObjectId* parameter contains the unique identifier of the encryption key. *EncryptedData* contains the encryption result. The *CorrelationValue* string is a linking token that allows to associate several pieces of a multi-step encryption operation together. The *OperationStatus* contains the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterGenerate Event ([KMIPServer](#kmipserver-class) Class)

Signifies completion of certificate generation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterGenerate(KMIPServerAfterGenerateEventParams *e);
typedef struct {  int64 ConnectionId;  char *CertId;  int OperationStatus;
  int reserved;
} KMIPServerAfterGenerateEventParams;

Unicode (Windows)
virtual INT FireAfterGenerate(KMIPServerAfterGenerateEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR CertId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterGenerateEventParams;
```

## Remarks

The class fires this event upon completion of certificate generation routine. The generated certificate can be read from [Certificate](#certificate-property-kmipserver-class).

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterGenerateKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of the completion of key generation procedure.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterGenerateKey(KMIPServerAfterGenerateKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *KeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterGenerateKeyEventParams;

Unicode (Windows)
virtual INT FireAfterGenerateKey(KMIPServerAfterGenerateKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR KeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterGenerateKeyEventParams;
```

## Remarks

The component uses this event to notify the application about the completion of the key generation procedure. The *KeyId* parameter contains the ID of the new key object (and can be changed by the user code if required). The *OperationStatus* parameter reports the result of the operation.

This event is the third and conclusive in the sequence of [BeforeGenerateKey](#beforegeneratekey-event-kmipserver-class), [GenerateKey](#generatekey-event-kmipserver-class), and the AfterGenerateKey events. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterGenerateKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of the completion of keypair generation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterGenerateKeyPair(KMIPServerAfterGenerateKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  char *PrivateKeyId;  char *PublicKeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterGenerateKeyPairEventParams;

Unicode (Windows)
virtual INT FireAfterGenerateKeyPair(KMIPServerAfterGenerateKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR PrivateKeyId;  LPWSTR PublicKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterGenerateKeyPairEventParams;
```

## Remarks

The component uses this event to notify the application about the completion of the keypair generation operation. The *PrivateKeyId* and *PublicKeyId* parameters contain the IDs of the new private and public keys respectively. The *OperationStatus* parameter returns the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterHash Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the hashing call.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterHash(KMIPServerAfterHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashData;
  int lenHashData;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterHashEventParams;

Unicode (Windows)
virtual INT FireAfterHash(KMIPServerAfterHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCSTR HashData;
  INT lenHashData;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterHashEventParams;
```

## Remarks

Subscribe to this event to be notified about completion of the hashing request processing. The *DataHash* parameter contains the hash that has been calculated. The *OperationStatus* parameter contains the operation result. If the hashing operation was a MAC (keyed) operation, the ID of the key is passed to the *ObjectId* parameter.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterList Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the list command.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterList(KMIPServerAfterListEventParams *e);
typedef struct {  int64 ConnectionId;  int ObjectType;  int ObjectStatus;  int OnlyFreshObjects;  char *ObjectIds;  int OperationStatus;
  int reserved;
} KMIPServerAfterListEventParams;

Unicode (Windows)
virtual INT FireAfterList(KMIPServerAfterListEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT ObjectType;  INT ObjectStatus;  BOOL OnlyFreshObjects;  LPWSTR ObjectIds;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterListEventParams;
```

## Remarks

The component uses this event to notify the application about the completion of the list command. The *ObjectType*, *ObjectStatus*, and *OnlyFreshObjects* contain the listing criteria. The *ObjectIds* contains a list of object unique identifiers, separated by newlines.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterObtainLease Event ([KMIPServer](#kmipserver-class) Class)

Reports the completion of lease allocation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterObtainLease(KMIPServerAfterObtainLeaseEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int LeaseTime;  char *LastChangeDate;  int OperationStatus;
  int reserved;
} KMIPServerAfterObtainLeaseEventParams;

Unicode (Windows)
virtual INT FireAfterObtainLease(KMIPServerAfterObtainLeaseEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT LeaseTime;  LPWSTR LastChangeDate;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterObtainLeaseEventParams;
```

## Remarks

The component uses this event to notify the application about the completion of lease allocation operation. The *ObjectId* parameter specifies the identifier of the object a lease for each is allocated. The *LeaseTime* and *LastChangeDate* parameters specify parameters of the lease.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterReadObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of the completion of the read operation on the object.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterReadObject(KMIPServerAfterReadObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int ObjectType;  int OperationStatus;
  int reserved;
} KMIPServerAfterReadObjectEventParams;

Unicode (Windows)
virtual INT FireAfterReadObject(KMIPServerAfterReadObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT ObjectType;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterReadObjectEventParams;
```

## Remarks

Use this event to be notified about completion of the read operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterReCertify Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the completion of the re-certify operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterReCertify(KMIPServerAfterReCertifyEventParams *e);
typedef struct {  int64 ConnectionId;  char *NewCertId;  int OperationStatus;
  int reserved;
} KMIPServerAfterReCertifyEventParams;

Unicode (Windows)
virtual INT FireAfterReCertify(KMIPServerAfterReCertifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR NewCertId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterReCertifyEventParams;
```

## Remarks

The server component uses this event to notify the application about the completion of the re-certification (certificate renewal) operation. The *NewCertId* contains the unique ID of the new certificate object. You can adjust it if required.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterReKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the completion of the re-key operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterReKey(KMIPServerAfterReKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *NewKeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterReKeyEventParams;

Unicode (Windows)
virtual INT FireAfterReKey(KMIPServerAfterReKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR NewKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterReKeyEventParams;
```

## Remarks

The server component uses this event to notify the application about the completion of the re-key (key renewal) operation. The *NewKeyId* contains the unique ID of the new key object. You can adjust it if required.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRekeyKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the completion of the re-key keypair operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRekeyKeyPair(KMIPServerAfterRekeyKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  char *NewPrivateKeyId;  char *NewPublicKeyId;  int OperationStatus;
  int reserved;
} KMIPServerAfterRekeyKeyPairEventParams;

Unicode (Windows)
virtual INT FireAfterRekeyKeyPair(KMIPServerAfterRekeyKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR NewPrivateKeyId;  LPWSTR NewPublicKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterRekeyKeyPairEventParams;
```

## Remarks

The server component uses this event to notify the application about the completion of the re-key (asymmetric key renewal) operation. The *NewPrivateKeyId* and *NewPublicKeyId* parameters contains the unique ID of the new key objects. You can adjust them if required.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRemoveObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the object removal request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRemoveObject(KMIPServerAfterRemoveObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerAfterRemoveObjectEventParams;

Unicode (Windows)
virtual INT FireAfterRemoveObject(KMIPServerAfterRemoveObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterRemoveObjectEventParams;
```

## Remarks

Subscribe to this event to be notified about completion of an object removal request. The *OperationStatus* parameter contains the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterSign Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of completion of a signing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterSign(KMIPServerAfterSignEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int InputIsHash;  const char *SignatureData;
  int lenSignatureData;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterSignEventParams;

Unicode (Windows)
virtual INT FireAfterSign(KMIPServerAfterSignEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  BOOL InputIsHash;  LPCSTR SignatureData;
  INT lenSignatureData;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterSignEventParams;
```

## Remarks

The component uses this event to notify the application about the completion of a signing operation.

The *ObjectId* parameter contains the unique identifier of the signing key. *SignatureData* contains the signing result. The *CorrelationValue* string is a linking token that allows to associate several pieces of a multi-step signing operation together. The *OperationStatus* contains the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterVerify Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the Verify operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterVerify(KMIPServerAfterVerifyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int InputIsHash;  int ValidationResult;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterVerifyEventParams;

Unicode (Windows)
virtual INT FireAfterVerify(KMIPServerAfterVerifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  BOOL InputIsHash;  INT ValidationResult;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterVerifyEventParams;
```

## Remarks

The component fires this event to notify the application of a completion of a verification operation. The *ValidationResult* parameter contains the validity status of the signature.

The *ObjectId* parameter contains the unique identifier of the verifying key. The *OperationStatus* parameter contains the result of the operation.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterVerifyHash Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about completion of the hash verification.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterVerifyHash(KMIPServerAfterVerifyHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int IsValid;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerAfterVerifyHashEventParams;

Unicode (Windows)
virtual INT FireAfterVerifyHash(KMIPServerAfterVerifyHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  BOOL IsValid;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerAfterVerifyHashEventParams;
```

## Remarks

The component uses this event to notify the application about hash verification result. The optional *ObjectId* parameter contains the unique identifier of the key object if HMAC algorithm is used.

The *IsValid* parameter contains the validity factor of the hash.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ArchiveObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the received object archival request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireArchiveObject(KMIPServerArchiveObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerArchiveObjectEventParams;

Unicode (Windows)
virtual INT FireArchiveObject(KMIPServerArchiveObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerArchiveObjectEventParams;
```

## Remarks

The component fires this event when it receives an object archival request from a connected client. The archival procedure go through a simplified handling route, without the three-step flow.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AuthAttempt Event ([KMIPServer](#kmipserver-class) Class)

Fires when a connected client makes an authentication attempt.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAuthAttempt(KMIPServerAuthAttemptEventParams *e);
typedef struct {  int64 ConnectionID;  const char *HTTPMethod;  const char *URI;  const char *AuthMethod;  const char *Username;  const char *Password;  int Allow;
  int reserved;
} KMIPServerAuthAttemptEventParams;

Unicode (Windows)
virtual INT FireAuthAttempt(KMIPServerAuthAttemptEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR HTTPMethod;  LPCWSTR URI;  LPCWSTR AuthMethod;  LPCWSTR Username;  LPCWSTR Password;  BOOL Allow;
  INT reserved;
} KMIPServerAuthAttemptEventParams;
```

## Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the *Allow* parameter to let the client through.

*ConnectionID* contains the unique session identifier for that client, *HTTPMethod* specifies the HTTP method (GET, POST, etc.) used to access the *URI* resource, *AuthMethod* specifies the authentication method, and *Username* and *Password* contain the professed credentials.

# BeforeAdd Event ([KMIPServer](#kmipserver-class) Class)

Fires when a certificate import request is received from a client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeAdd(KMIPServerBeforeAddEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  int Action;
  int reserved;
} KMIPServerBeforeAddEventParams;

Unicode (Windows)
virtual INT FireBeforeAdd(KMIPServerBeforeAddEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  INT Action;
  INT reserved;
} KMIPServerBeforeAddEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to import a certificate on to the server. The supplied certificate is available in [Certificate](#certificate-property-kmipserver-class) object.

The *Group* parameter specifies a common identifier for objects related to the certificate being imported: the certificate, its public key, and its private key.

# BeforeAddKey Event ([KMIPServer](#kmipserver-class) Class)

Fires when a key import request is received from the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeAddKey(KMIPServerBeforeAddKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *Group;  int Action;
  int reserved;
} KMIPServerBeforeAddKeyEventParams;

Unicode (Windows)
virtual INT FireBeforeAddKey(KMIPServerBeforeAddKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR Group;  INT Action;
  INT reserved;
} KMIPServerBeforeAddKeyEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to import a key on to the server. The supplied key is available in the [Key](#key-property-kmipserver-class) parameter.

For keypairs, the *Group* parameter contains a common label that will be applied to both parts of that keypair (the public key object and the private key object).

# BeforeBrowse Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the browse request being received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeBrowse(KMIPServerBeforeBrowseEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ObjectId;  int Action;
  int reserved;
} KMIPServerBeforeBrowseEventParams;

Unicode (Windows)
virtual INT FireBeforeBrowse(KMIPServerBeforeBrowseEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ObjectId;  INT Action;
  INT reserved;
} KMIPServerBeforeBrowseEventParams;
```

## Remarks

The component uses this event to notify the application about a browse request received for an object *ObjectId*.

# BeforeDecrypt Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of the decryption operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeDecrypt(KMIPServerBeforeDecryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeDecryptEventParams;

Unicode (Windows)
virtual INT FireBeforeDecrypt(KMIPServerBeforeDecryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeDecryptEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of the decryption operation. The *ObjectId* parameter contains a reference to the decryption key. The optional *CorrelationValue* parameter can be used to link consecutive steps of multi-part decryption operation together.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# BeforeDeriveKey Event ([KMIPServer](#kmipserver-class) Class)

Fires when a derive key request is received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeDeriveKey(KMIPServerBeforeDeriveKeyEventParams *e);
typedef struct {  int64 ConnectionId;  int ObjectType;  const char *ObjectIds;  const char *DerivationMethod;  int Action;
  int reserved;
} KMIPServerBeforeDeriveKeyEventParams;

Unicode (Windows)
virtual INT FireBeforeDeriveKey(KMIPServerBeforeDeriveKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT ObjectType;  LPCWSTR ObjectIds;  LPCWSTR DerivationMethod;  INT Action;
  INT reserved;
} KMIPServerBeforeDeriveKeyEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to derive a key. The supplied certificate is available in [Key](#key-property-kmipserver-class).

# BeforeEdit Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the start of the object editing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeEdit(KMIPServerBeforeEditEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ObjectId;  int Action;
  int reserved;
} KMIPServerBeforeEditEventParams;

Unicode (Windows)
virtual INT FireBeforeEdit(KMIPServerBeforeEditEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ObjectId;  INT Action;
  INT reserved;
} KMIPServerBeforeEditEventParams;
```

## Remarks

The editing operation consists of a sequence of attribute update requests. Each attribute is provided to the application via an individual [SetAttribute](#setattribute-event-kmipserver-class) call. When the list of supplied attributes has been exhausted, the [AfterEdit](#afteredit-event-kmipserver-class) event call follows.

The *ObjectId* parameter specifies the identifier of the object being edited.

# BeforeEncrypt Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of an encryption operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeEncrypt(KMIPServerBeforeEncryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeEncryptEventParams;

Unicode (Windows)
virtual INT FireBeforeEncrypt(KMIPServerBeforeEncryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeEncryptEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of an encryption operation. The *ObjectId* parameter contains a reference to the encryption key. The optional *CorrelationValue* parameter can be used to link consecutive steps of multi-part encryption operation together.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# BeforeGenerate Event ([KMIPServer](#kmipserver-class) Class)

Fires when a certificate generation request is received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeGenerate(KMIPServerBeforeGenerateEventParams *e);
typedef struct {  int64 ConnectionId;  const char *PublicKeyId;  int Action;
  int reserved;
} KMIPServerBeforeGenerateEventParams;

Unicode (Windows)
virtual INT FireBeforeGenerate(KMIPServerBeforeGenerateEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR PublicKeyId;  INT Action;
  INT reserved;
} KMIPServerBeforeGenerateEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to generate a certificate. The supplied certificate template is available in [Certificate](#certificate-property-kmipserver-class).

# BeforeGenerateKey Event ([KMIPServer](#kmipserver-class) Class)

Fires when a key generation request is received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeGenerateKey(KMIPServerBeforeGenerateKeyEventParams *e);
typedef struct {  int64 ConnectionId;  char *KeyAlgorithm;  int KeyLength;  int Action;
  int reserved;
} KMIPServerBeforeGenerateKeyEventParams;

Unicode (Windows)
virtual INT FireBeforeGenerateKey(KMIPServerBeforeGenerateKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR KeyAlgorithm;  INT KeyLength;  INT Action;
  INT reserved;
} KMIPServerBeforeGenerateKeyEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to generate a key. *KeyAlgorithm* and *KeyLength* parameters specify the requested key properties.

# BeforeGenerateKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Fires when a key generation request is received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeGenerateKeyPair(KMIPServerBeforeGenerateKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  char *KeyAlgorithm;  int KeyLength;  char *Scheme;  char *SchemeParams;  int Action;
  int reserved;
} KMIPServerBeforeGenerateKeyPairEventParams;

Unicode (Windows)
virtual INT FireBeforeGenerateKeyPair(KMIPServerBeforeGenerateKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPWSTR KeyAlgorithm;  INT KeyLength;  LPWSTR Scheme;  LPWSTR SchemeParams;  INT Action;
  INT reserved;
} KMIPServerBeforeGenerateKeyPairEventParams;
```

## Remarks

The class fires this event when it receives a request from the client to generate a keypair. *KeyAlgorithm*, *KeyLength*, *Scheme* and *SchemeParams* parameters specify the requested key properties.

# BeforeHash Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of the hashing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeHash(KMIPServerBeforeHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeHashEventParams;

Unicode (Windows)
virtual INT FireBeforeHash(KMIPServerBeforeHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeHashEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of a hashing operation. The optional *ObjectId* parameter contains a reference to the hashing key if HMAC-based hashing is used. The optional *CorrelationValue* parameter can be used to link consecutive steps of multi-part hash operation together.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# BeforeList Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of the list operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeList(KMIPServerBeforeListEventParams *e);
typedef struct {  int64 ConnectionId;  int ObjectType;  int ObjectStatus;  int OnlyFreshObjects;  int Action;
  int reserved;
} KMIPServerBeforeListEventParams;

Unicode (Windows)
virtual INT FireBeforeList(KMIPServerBeforeListEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT ObjectType;  INT ObjectStatus;  BOOL OnlyFreshObjects;  INT Action;
  INT reserved;
} KMIPServerBeforeListEventParams;
```

## Remarks

The component uses this event to notify the application of the received list call. The *ObjectType*, *ObjectStatus*, and *OnlyFreshObjects* parameters provide the listing criteria.

# BeforeObtainLease Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the client requesting an object lease.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeObtainLease(KMIPServerBeforeObtainLeaseEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int Action;
  int reserved;
} KMIPServerBeforeObtainLeaseEventParams;

Unicode (Windows)
virtual INT FireBeforeObtainLease(KMIPServerBeforeObtainLeaseEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT Action;
  INT reserved;
} KMIPServerBeforeObtainLeaseEventParams;
```

## Remarks

Use this event to get notified about the connected client requesting an object lease.

# BeforeReadObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the start of the object reading request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeReadObject(KMIPServerBeforeReadObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int Action;
  int reserved;
} KMIPServerBeforeReadObjectEventParams;

Unicode (Windows)
virtual INT FireBeforeReadObject(KMIPServerBeforeReadObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT Action;
  INT reserved;
} KMIPServerBeforeReadObjectEventParams;
```

## Remarks

Object "reading" consists of a number of individual attribute requests. If *fraCustom* action is returned from this event handler, the component will fire [ReadObject](#readobject-event-kmipserver-class) and [ReadAttribute](#readattribute-event-kmipserver-class) events repeatedly to request information about the object from your code.

# BeforeReCertify Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about a re-certification request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeReCertify(KMIPServerBeforeReCertifyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldCertId;  int Action;
  int reserved;
} KMIPServerBeforeReCertifyEventParams;

Unicode (Windows)
virtual INT FireBeforeReCertify(KMIPServerBeforeReCertifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldCertId;  INT Action;
  INT reserved;
} KMIPServerBeforeReCertifyEventParams;
```

## Remarks

The component uses this event to notify the application about a re-certification request (a request to re-issue an existing certificate).

The *OldCertId* parameter indicates the unique identifier of the certificate object that needs to be re-issued.

This event provides a pre-notification for the operation. If your code sets the *Action* parameter to *fraCustom*, this event will be followed by a [ReCertify](#recertify-event-kmipserver-class) call that will let you handle the actual request as required.

# BeforeReKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about a re-key request received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeReKey(KMIPServerBeforeReKeyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldKeyId;  int Action;
  int reserved;
} KMIPServerBeforeReKeyEventParams;

Unicode (Windows)
virtual INT FireBeforeReKey(KMIPServerBeforeReKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldKeyId;  INT Action;
  INT reserved;
} KMIPServerBeforeReKeyEventParams;
```

## Remarks

The component uses this event to notify the application about a key re-issue request received from the client. The *OldKeyId* parameter contains the unique identifier of the old key object.

# BeforeRekeyKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about a keypair re-key request received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRekeyKeyPair(KMIPServerBeforeRekeyKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldPrivateKeyId;  int Action;
  int reserved;
} KMIPServerBeforeRekeyKeyPairEventParams;

Unicode (Windows)
virtual INT FireBeforeRekeyKeyPair(KMIPServerBeforeRekeyKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldPrivateKeyId;  INT Action;
  INT reserved;
} KMIPServerBeforeRekeyKeyPairEventParams;
```

## Remarks

The component uses this event to notify the application about a keypair re-issue request received from the client. The *OldPrivateKeyId* parameter contains the unique identifier of the old private key object.

# BeforeRemoveObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Remove Object request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRemoveObject(KMIPServerBeforeRemoveObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int Action;
  int reserved;
} KMIPServerBeforeRemoveObjectEventParams;

Unicode (Windows)
virtual INT FireBeforeRemoveObject(KMIPServerBeforeRemoveObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT Action;
  INT reserved;
} KMIPServerBeforeRemoveObjectEventParams;
```

## Remarks

Subscribe to this event to choose the operation flow (automated/custom) for the object removal operation.

# BeforeSign Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of a signing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeSign(KMIPServerBeforeSignEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *Algorithm;  const char *HashAlgorithm;  int InputIsHash;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeSignEventParams;

Unicode (Windows)
virtual INT FireBeforeSign(KMIPServerBeforeSignEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR Algorithm;  LPCWSTR HashAlgorithm;  BOOL InputIsHash;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeSignEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of the signing operation. The *ObjectId* parameter contains a reference to the signing key. The optional *CorrelationValue* parameter can be used to link consecutive steps of multi-part signing operation together.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# BeforeVerify Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of the verify operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeVerify(KMIPServerBeforeVerifyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  int InputIsHash;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeVerifyEventParams;

Unicode (Windows)
virtual INT FireBeforeVerify(KMIPServerBeforeVerifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  BOOL InputIsHash;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeVerifyEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of the verification operation. The *ObjectId* parameter contains a reference to the verification key.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# BeforeVerifyHash Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the initiation of the hash verification operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeVerifyHash(KMIPServerBeforeVerifyHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  char *CorrelationValue;  int Action;
  int reserved;
} KMIPServerBeforeVerifyHashEventParams;

Unicode (Windows)
virtual INT FireBeforeVerifyHash(KMIPServerBeforeVerifyHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  LPWSTR CorrelationValue;  INT Action;
  INT reserved;
} KMIPServerBeforeVerifyHashEventParams;
```

## Remarks

The component fires this event to notify the application about the initiation of the hash verification operation. The *ObjectId* parameter contains a reference to the HMAC key, if MAC algorithm is used.

Use the *Action* parameter to indicate the procedure you want to use for this request. See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

# Cancel Event ([KMIPServer](#kmipserver-class) Class)

Reports a cancellation request received from the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCancel(KMIPServerCancelEventParams *e);
typedef struct {  int64 ConnectionId;  const char *AsyncCorrelationValue;  int CancellationResult;  int OperationStatus;
  int reserved;
} KMIPServerCancelEventParams;

Unicode (Windows)
virtual INT FireCancel(KMIPServerCancelEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR AsyncCorrelationValue;  INT CancellationResult;  INT OperationStatus;
  INT reserved;
} KMIPServerCancelEventParams;
```

## Remarks

The component uses this event to notify the application about the cancellation request received. The application should handle the cancellation request and set *CancellationResult* and *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| kccCancelled | 0x01 |  |
| kccUnableToCancel | 0x02 |  |
| kccCompleted | 0x03 |  |
| kccFailed | 0x04 |  |
| kccUnavailable | 0x05 |  |

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Check Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about a Check request received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCheck(KMIPServerCheckEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int64 *pUsageLimitsCount;  int CryptographicUsageMask;  int LeaseTime;  int OperationStatus;
  int reserved;
} KMIPServerCheckEventParams;

Unicode (Windows)
virtual INT FireCheck(KMIPServerCheckEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LONG64 *pUsageLimitsCount;  INT CryptographicUsageMask;  INT LeaseTime;  INT OperationStatus;
  INT reserved;
} KMIPServerCheckEventParams;
```

## Remarks

The component fires this event to notify the application about the Check request received from the client side. Applications working in virtual mode should implement the relevant logic in their event handlers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Connect Event ([KMIPServer](#kmipserver-class) Class)

Reports an accepted connection.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnect(KMIPServerConnectEventParams *e);
typedef struct {  int64 ConnectionID;  const char *RemoteAddress;  int RemotePort;
  int reserved;
} KMIPServerConnectEventParams;

Unicode (Windows)
virtual INT FireConnect(KMIPServerConnectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR RemoteAddress;  INT RemotePort;
  INT reserved;
} KMIPServerConnectEventParams;
```

## Remarks

The class fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or [AuthAttempt](#authattempt-event-kmipserver-class).

# Decrypt Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to decrypt a chunk of data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDecrypt(KMIPServerDecryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *Data;
  int lenData;  const char *IV;  int InitIndicator;  int FinalIndicator;  const char *BlockCipherMode;  int TagLength;  const char *PaddingMethod;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerDecryptEventParams;

Unicode (Windows)
virtual INT FireDecrypt(KMIPServerDecryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCSTR Data;
  INT lenData;  LPCWSTR IV;  BOOL InitIndicator;  BOOL FinalIndicator;  LPCWSTR BlockCipherMode;  INT TagLength;  LPCWSTR PaddingMethod;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerDecryptEventParams;
```

## Remarks

The server uses this event to inform the application of a decryption request submitted by the client and, optionally, request the application to decrypt the data block with the provided set of parameters. The decryption logic only needs to be implemented if the application uses the virtual storage mode.

In the event handler, use the parameters provided to decrypt *Data* with the key identified with *ObjectId*. The *InitIndicator* and *FinalIndicator* tell whether the provided block is first and/or last in a sequence of blocks forming a multi-step decryption operation. If the block is not the last one, set *CorrelationValue* to a random string to preserve continuity between consecutive block decryptions.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# DeleteAttribute Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to delete an object attribute.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDeleteAttribute(KMIPServerDeleteAttributeEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *AttributeName;  char *AttributeValue;  int OperationStatus;
  int reserved;
} KMIPServerDeleteAttributeEventParams;

Unicode (Windows)
virtual INT FireDeleteAttribute(KMIPServerDeleteAttributeEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR AttributeName;  LPWSTR AttributeValue;  INT OperationStatus;
  INT reserved;
} KMIPServerDeleteAttributeEventParams;
```

## Remarks

The server fires this event to relay the KMIP client's Delete Attribute request to the application if the application chose to use custom flow in the preceding [BeforeEdit](#beforeedit-event-kmipserver-class) event.

The event handler is expected to delete the *AttributeName* from the *ObjectId*'s attribute set, and return the (now deleted) *AttributeValue* and the *OperationStatus* back to the server.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# DeriveKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application of key derivation request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDeriveKey(KMIPServerDeriveKeyEventParams *e);
typedef struct {  int64 ConnectionId;  int ObjectType;  const char *ObjectIds;  const char *DerivationMethod;  const char *InitializationVector;
  int lenInitializationVector;  const char *DerivationData;
  int lenDerivationData;  char *NewKeyId;  int OperationStatus;
  int reserved;
} KMIPServerDeriveKeyEventParams;

Unicode (Windows)
virtual INT FireDeriveKey(KMIPServerDeriveKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT ObjectType;  LPCWSTR ObjectIds;  LPCWSTR DerivationMethod;  LPCSTR InitializationVector;
  INT lenInitializationVector;  LPCSTR DerivationData;
  INT lenDerivationData;  LPWSTR NewKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerDeriveKeyEventParams;
```

## Remarks

The server fires this event to notify the application of a received key derivation request. Applications working in virtual mode should react to this event by performing the requested operation and returning the ID of the new key via the *NewKeyId* parameter.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Disconnect Event ([KMIPServer](#kmipserver-class) Class)

Fires to report a disconnected client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDisconnect(KMIPServerDisconnectEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} KMIPServerDisconnectEventParams;

Unicode (Windows)
virtual INT FireDisconnect(KMIPServerDisconnectEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} KMIPServerDisconnectEventParams;
```

## Remarks

The class fires this event when a connected client disconnects.

# Encrypt Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to encrypt a chunk of data.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireEncrypt(KMIPServerEncryptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *Data;
  int lenData;  int InitIndicator;  int FinalIndicator;  const char *BlockCipherMode;  int TagLength;  const char *PaddingMethod;  int RandomIV;  char *IV;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerEncryptEventParams;

Unicode (Windows)
virtual INT FireEncrypt(KMIPServerEncryptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCSTR Data;
  INT lenData;  BOOL InitIndicator;  BOOL FinalIndicator;  LPCWSTR BlockCipherMode;  INT TagLength;  LPCWSTR PaddingMethod;  BOOL RandomIV;  LPWSTR IV;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerEncryptEventParams;
```

## Remarks

The server uses this event to request the application to encrypt a data block with the provided set of parameters. This event is only fired if the application chose to use a custom encryption flow in the preceding [BeforeEncrypt](#beforeencrypt-event-kmipserver-class) call.

In the event handler, use the parameters provided to encrypt *Data* with the key identified with *ObjectId*. The *InitIndicator* and *FinalIndicator* tell whether the provided block is first and/or last in a sequence of blocks forming a multi-step encryption operation. If the block is not last, set *CorrelationValue* to a random string to preserve continuity between consecutive block encryptions.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Error Event ([KMIPServer](#kmipserver-class) Class)

Information about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(KMIPServerErrorEventParams *e);
typedef struct {  int64 ConnectionID;  int ErrorCode;  int Fatal;  int Remote;  const char *Description;
  int reserved;
} KMIPServerErrorEventParams;

Unicode (Windows)
virtual INT FireError(KMIPServerErrorEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT ErrorCode;  BOOL Fatal;  BOOL Remote;  LPCWSTR Description;
  INT reserved;
} KMIPServerErrorEventParams;
```

## Remarks

The event is fired in case of exceptional conditions during message processing.

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [HTTPS](#trappable-errors-kmipserver-class) section.

# ExternalSign Event ([KMIPServer](#kmipserver-class) Class)

Handles remote or external signing initiated by the server protocol.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireExternalSign(KMIPServerExternalSignEventParams *e);
typedef struct {  int64 ConnectionID;  const char *OperationId;  const char *HashAlgorithm;  const char *Pars;  const char *Data;  char *SignedData;
  int reserved;
} KMIPServerExternalSignEventParams;

Unicode (Windows)
virtual INT FireExternalSign(KMIPServerExternalSignEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OperationId;  LPCWSTR HashAlgorithm;  LPCWSTR Pars;  LPCWSTR Data;  LPWSTR SignedData;
  INT reserved;
} KMIPServerExternalSignEventParams;
```

## Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter.

*OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:

```text
signer.OnExternalSign += (s, e) =>
{
       var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
       var key = (RSACryptoServiceProvider)cert.PrivateKey;

       var dataToSign = e.Data.FromBase16String();
       var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
       e.SignedData = signedData.ToBase16String();
};
```

# Generate Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Generate request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireGenerate(KMIPServerGenerateEventParams *e);
typedef struct {  int64 ConnectionId;  const char *PublicKeyId;  char *CertId;  int OperationStatus;
  int reserved;
} KMIPServerGenerateEventParams;

Unicode (Windows)
virtual INT FireGenerate(KMIPServerGenerateEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR PublicKeyId;  LPWSTR CertId;  INT OperationStatus;
  INT reserved;
} KMIPServerGenerateEventParams;
```

## Remarks

Subscribe to this event to get notified about incoming certificate generate requests. The *PublicKeyId* parameter specifies the public key that the new certificate should be generated over.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new *CertId* back along with *OperationStatus*.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# GenerateKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Generate request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireGenerateKey(KMIPServerGenerateKeyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *KeyAlgorithm;  int KeyLength;  const char *Group;  char *KeyId;  int OperationStatus;
  int reserved;
} KMIPServerGenerateKeyEventParams;

Unicode (Windows)
virtual INT FireGenerateKey(KMIPServerGenerateKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR KeyAlgorithm;  INT KeyLength;  LPCWSTR Group;  LPWSTR KeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerGenerateKeyEventParams;
```

## Remarks

Subscribe to this event to get notified about incoming key generation requests. The *KeyAlgorithm* and *KeyLength* parameters specify the parameters of the key to be generated. Use the *Group* parameter to arrange together keys belonging to the same set, such as private and public parts of a keypair.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new *KeyId* back along with *OperationStatus*.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# GenerateKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Generate request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireGenerateKeyPair(KMIPServerGenerateKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  const char *KeyAlgorithm;  int KeyLength;  const char *Scheme;  const char *SchemeParams;  const char *Group;  char *PrivateKeyId;  char *PublicKeyId;  int OperationStatus;
  int reserved;
} KMIPServerGenerateKeyPairEventParams;

Unicode (Windows)
virtual INT FireGenerateKeyPair(KMIPServerGenerateKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR KeyAlgorithm;  INT KeyLength;  LPCWSTR Scheme;  LPCWSTR SchemeParams;  LPCWSTR Group;  LPWSTR PrivateKeyId;  LPWSTR PublicKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerGenerateKeyPairEventParams;
```

## Remarks

Subscribe to this event to get notified about incoming keypair generation requests. The *KeyAlgorithm*, *KeyLength*, *Scheme* and *SchemeParams* parameters specify the parameters of the keypair to be generated. Use the *Group* parameter to put together keys belonging to the same set, such as private and public parts of a keypair.

Applications using the server in virtual storage mode should implement the generation logic in the event handler and return the new *PrivateKeyId* and *PublicKeyId* back along with *OperationStatus*.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# GetUsageAllocation Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Get Usage Allocation request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireGetUsageAllocation(KMIPServerGetUsageAllocationEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int UsageLimitsCount;  int OperationStatus;
  int reserved;
} KMIPServerGetUsageAllocationEventParams;

Unicode (Windows)
virtual INT FireGetUsageAllocation(KMIPServerGetUsageAllocationEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT UsageLimitsCount;  INT OperationStatus;
  INT reserved;
} KMIPServerGetUsageAllocationEventParams;
```

## Remarks

The component uses this event to tell the application about a Get Usage Allocation request received.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Hash Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to update the current hashing operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireHash(KMIPServerHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  const char *Data;
  int lenData;  int InitIndicator;  int FinalIndicator;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerHashEventParams;

Unicode (Windows)
virtual INT FireHash(KMIPServerHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  LPCSTR Data;
  INT lenData;  BOOL InitIndicator;  BOOL FinalIndicator;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerHashEventParams;
```

## Remarks

The server fires this event to pass a new chunk of data to the application for inclusion in the hash. This event is only fired if the application chose to process the hashing operation manually in the preceding [BeforeHash](#beforehash-event-kmipserver-class) event.

The *ObjectId* specifies the key object for Hash+MAC operations. The *Data* parameters contains the data buffer that needs to be added to the hash, with *InitIndicator* and *FinalIndicator* specifying the very first and very last data blocks respectively.

Return a unique *CorrelationValue* to chain pieces of a multi-block hashing operation together.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# HeadersPrepared Event ([KMIPServer](#kmipserver-class) Class)

Fires when the response headers have been formed and are ready to be sent to the server.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireHeadersPrepared(KMIPServerHeadersPreparedEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} KMIPServerHeadersPreparedEventParams;

Unicode (Windows)
virtual INT FireHeadersPrepared(KMIPServerHeadersPreparedEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} KMIPServerHeadersPreparedEventParams;
```

## Remarks

The class fires this event when the response headers are ready to be sent to the server. *ConnectionID* indicates the connection that processed the request.

Use [GetResponseHeader](#getresponseheader-method-kmipserver-class) method with an empty header name to get the whole response header.

# KMIPAuthAttempt Event ([KMIPServer](#kmipserver-class) Class)

Fires when a connected client makes an authentication attempt.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireKMIPAuthAttempt(KMIPServerKMIPAuthAttemptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *Username;  const char *Password;  int Accept;
  int reserved;
} KMIPServerKMIPAuthAttemptEventParams;

Unicode (Windows)
virtual INT FireKMIPAuthAttempt(KMIPServerKMIPAuthAttemptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR Username;  LPCWSTR Password;  BOOL Accept;
  INT reserved;
} KMIPServerKMIPAuthAttemptEventParams;
```

## Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the *Accept* parameter to let the client through.

*Username* and *Password* contain the professed credentials.

# List Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to return the list of objects that match the specified criteria.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireList(KMIPServerListEventParams *e);
typedef struct {  int64 ConnectionId;  int ObjectType;  int ObjectStatus;  int OnlyFreshObjects;  int OffsetItems;  int MaximumItems;  char *ObjectIds;  int LocatedItems;  int OperationStatus;
  int reserved;
} KMIPServerListEventParams;

Unicode (Windows)
virtual INT FireList(KMIPServerListEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT ObjectType;  INT ObjectStatus;  BOOL OnlyFreshObjects;  INT OffsetItems;  INT MaximumItems;  LPWSTR ObjectIds;  INT LocatedItems;  INT OperationStatus;
  INT reserved;
} KMIPServerListEventParams;
```

## Remarks

The server uses this event to request a list of objects in accordance with the List call received from a KMIP client. This event only fires if the application chose to follow a custom listing flow in the preceding [BeforeList](#beforelist-event-kmipserver-class) event.

The event handler should use the filtering parameters provided to form the list of IDs and return it via the *ObjectIds* parameters. Note that *ObjectType* contains a bit mask of the object types that need to be returned. If that mask is set to zero, objects of all types must be considered.

The *OnlyFreshObjects* modifier tells the server to only return the objects that were not previously exported to the client.

|  |  |  |
| --- | --- | --- |
| otUnknown | 0x00 |  |
| otCertificate | 0x01 |  |
| otSymmetricKey | 0x02 |  |
| otPublicKey | 0x04 |  |
| otPrivateKey | 0x08 |  |

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ListAttributes Event ([KMIPServer](#kmipserver-class) Class)

Requests a list of object attribute names from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireListAttributes(KMIPServerListAttributesEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  char *AttributeNames;  int OperationStatus;
  int reserved;
} KMIPServerListAttributesEventParams;

Unicode (Windows)
virtual INT FireListAttributes(KMIPServerListAttributesEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPWSTR AttributeNames;  INT OperationStatus;
  INT reserved;
} KMIPServerListAttributesEventParams;
```

## Remarks

The server fires this event to request a list of names of attributes defined for the object. This event is only fired if the application chose to use a custom flow for attribute listing in the preceding [BeforeBrowse](#beforebrowse-event-kmipserver-class) event call.

Following completion of this event, the server will call the [ReadAttribute](#readattribute-event-kmipserver-class) event for each attribute name to request the respective values.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Notification Event ([KMIPServer](#kmipserver-class) Class)

This event notifies the application about an underlying control flow event.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireNotification(KMIPServerNotificationEventParams *e);
typedef struct {  const char *EventID;  const char *EventParam;
  int reserved;
} KMIPServerNotificationEventParams;

Unicode (Windows)
virtual INT FireNotification(KMIPServerNotificationEventParams *e);
typedef struct {  LPCWSTR EventID;  LPCWSTR EventParam;
  INT reserved;
} KMIPServerNotificationEventParams;
```

## Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following *EventID* values:

|  |  |
| --- | --- |
| ListeningStarted | Notifies the application that the server has started listening for incoming connections. |
| ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. |

# ObtainLease Event ([KMIPServer](#kmipserver-class) Class)

Lets the application handle the lease request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireObtainLease(KMIPServerObtainLeaseEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int LeaseTime;  char *LastChangeDate;  int OperationStatus;
  int reserved;
} KMIPServerObtainLeaseEventParams;

Unicode (Windows)
virtual INT FireObtainLease(KMIPServerObtainLeaseEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT LeaseTime;  LPWSTR LastChangeDate;  INT OperationStatus;
  INT reserved;
} KMIPServerObtainLeaseEventParams;
```

## Remarks

Subscribe to this event to react to object lease requests in virtualized mode.

The *ObjectId* parameter indicates the object a lease for which is requested. The *LeaseTime* and *LastChangeDate* specify the requested parameters of the lease. You can adjust them as required.

Set *OperationStatus* to indicate the intended operation result to the client.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# OperationAttempt Event ([KMIPServer](#kmipserver-class) Class)

Fires when a request is received from the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireOperationAttempt(KMIPServerOperationAttemptEventParams *e);
typedef struct {  int64 ConnectionId;  const char *Operation;  const char *Username;  int Reject;
  int reserved;
} KMIPServerOperationAttemptEventParams;

Unicode (Windows)
virtual INT FireOperationAttempt(KMIPServerOperationAttemptEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR Operation;  LPCWSTR Username;  BOOL Reject;
  INT reserved;
} KMIPServerOperationAttemptEventParams;
```

## Remarks

The *Operation* parameter specifies the operation to perform, and *Username* the originator of the request. Use the *Reject* parameter to reject the request.

# Poll Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the received Poll request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FirePoll(KMIPServerPollEventParams *e);
typedef struct {  int64 ConnectionId;  const char *AsyncCorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerPollEventParams;

Unicode (Windows)
virtual INT FirePoll(KMIPServerPollEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR AsyncCorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerPollEventParams;
```

## Remarks

KMIP clients may use Poll requests to check with the server asynchronously about the progress of an operation they started earlier. Use the handler of this event to return the *OperationStatus* for the operation identified with the *AsyncCorrelationValue* parameter.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ReadAttribute Event ([KMIPServer](#kmipserver-class) Class)

Requests an object attribute value from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadAttribute(KMIPServerReadAttributeEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *AttributeName;  char *AttributeValue;  int OperationStatus;
  int reserved;
} KMIPServerReadAttributeEventParams;

Unicode (Windows)
virtual INT FireReadAttribute(KMIPServerReadAttributeEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR AttributeName;  LPWSTR AttributeValue;  INT OperationStatus;
  INT reserved;
} KMIPServerReadAttributeEventParams;
```

## Remarks

The server uses this event to request an attribute value from the application. This event is only fired if the application chose the custom object browsing flow in the preceding [BeforeBrowse](#beforebrowse-event-kmipserver-class) event.

This event is fired for every *AttributeName* in the list returned by the application from a preceding [ListAttributes](#listattributes-event-kmipserver-class) event call.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ReadObject Event ([KMIPServer](#kmipserver-class) Class)

Requests the details of the object from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadObject(KMIPServerReadObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int ObjectType;  int OperationStatus;
  int reserved;
} KMIPServerReadObjectEventParams;

Unicode (Windows)
virtual INT FireReadObject(KMIPServerReadObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT ObjectType;  INT OperationStatus;
  INT reserved;
} KMIPServerReadObjectEventParams;
```

## Remarks

The server fires this event to request the details of the object from the application. This event is only invoked if the application chose to use custom operation handling in the preceding [BeforeReadObject](#beforereadobject-event-kmipserver-class) event call.

The event handler should set the *ObjectType* and *OperationStatus* as required, and provide the relevant object via the [Certificate](#certificate-property-kmipserver-class) or [Key](#key-property-kmipserver-class) property and committing it using [SetClientCert](#setclientcert-method-kmipserver-class) or [SetClientKey](#setclientkey-method-kmipserver-class) respectively.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ReCertify Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming re-certification request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReCertify(KMIPServerReCertifyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldCertId;  int Offset;  const char *Group;  char *NewCertId;  int OperationStatus;
  int reserved;
} KMIPServerReCertifyEventParams;

Unicode (Windows)
virtual INT FireReCertify(KMIPServerReCertifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldCertId;  INT Offset;  LPCWSTR Group;  LPWSTR NewCertId;  INT OperationStatus;
  INT reserved;
} KMIPServerReCertifyEventParams;
```

## Remarks

The server uses this event to notify the application about the incoming re-certification request.

If the application uses the component in virtual mode, it should perform the requested re-certification operation in the event handler and return the identifier of the new certificate via the *NewCertId* parameter.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RecoverObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming Recover Object request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRecoverObject(KMIPServerRecoverObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerRecoverObjectEventParams;

Unicode (Windows)
virtual INT FireRecoverObject(KMIPServerRecoverObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerRecoverObjectEventParams;
```

## Remarks

Subscribe to this event to get notified about the Recover Object request. Applications that use the component in the virtual mode should handle the request in their event handler and set *OperationStatus* in accordance with the operation result.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# ReKey Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming re-key request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReKey(KMIPServerReKeyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldKeyId;  int Offset;  const char *Group;  char *NewKeyId;  int OperationStatus;
  int reserved;
} KMIPServerReKeyEventParams;

Unicode (Windows)
virtual INT FireReKey(KMIPServerReKeyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldKeyId;  INT Offset;  LPCWSTR Group;  LPWSTR NewKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerReKeyEventParams;
```

## Remarks

The server uses this event to notify the application about the incoming re-keying request.

If the application uses the component in virtual mode, it should perform the requested re-key operation in the event handler and return the identifier of the new key via the *NewKeyId* parameter.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RekeyKeyPair Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about an incoming re-key request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRekeyKeyPair(KMIPServerRekeyKeyPairEventParams *e);
typedef struct {  int64 ConnectionId;  const char *OldPrivateKeyId;  int Offset;  const char *Group;  char *NewPrivateKeyId;  char *NewPublicKeyId;  int OperationStatus;
  int reserved;
} KMIPServerRekeyKeyPairEventParams;

Unicode (Windows)
virtual INT FireRekeyKeyPair(KMIPServerRekeyKeyPairEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR OldPrivateKeyId;  INT Offset;  LPCWSTR Group;  LPWSTR NewPrivateKeyId;  LPWSTR NewPublicKeyId;  INT OperationStatus;
  INT reserved;
} KMIPServerRekeyKeyPairEventParams;
```

## Remarks

The server uses this event to notify the application about the incoming asymmetric re-keying request.

If the application uses the component in virtual mode, it should perform the requested re-certification operation in the event handler and return the identifiers of the new public and private keys via the *NewPublicKeyId* and *NewPrivateKeyId* parameters.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RemoveObject Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about the object deletion request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRemoveObject(KMIPServerRemoveObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int OperationStatus;
  int reserved;
} KMIPServerRemoveObjectEventParams;

Unicode (Windows)
virtual INT FireRemoveObject(KMIPServerRemoveObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT OperationStatus;
  INT reserved;
} KMIPServerRemoveObjectEventParams;
```

## Remarks

The server uses this event to notify the application about the incoming object removal request. Applications working in virtual mode should perform the requested operation in the event handler and set *OperationStatus* according to the outcome of the operation.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Request Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about KMIP requests being received.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRequest(KMIPServerRequestEventParams *e);
typedef struct {  int64 ConnectionId;  const char *RequestData;
  int lenRequestData;
  int reserved;
} KMIPServerRequestEventParams;

Unicode (Windows)
virtual INT FireRequest(KMIPServerRequestEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCSTR RequestData;
  INT lenRequestData;
  INT reserved;
} KMIPServerRequestEventParams;
```

## Remarks

Subscribe to this event to get notified about incoming KMIP requests. The *RequestData* parameter contains the serialized KMIP request object.

# Response Event ([KMIPServer](#kmipserver-class) Class)

Notifies the application about KMIP responses being sent back.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireResponse(KMIPServerResponseEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ResponseData;
  int lenResponseData;
  int reserved;
} KMIPServerResponseEventParams;

Unicode (Windows)
virtual INT FireResponse(KMIPServerResponseEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCSTR ResponseData;
  INT lenResponseData;
  INT reserved;
} KMIPServerResponseEventParams;
```

## Remarks

Subscribe to this event to get notified about KMIP protocol responses being sent back to KMIP clients.

# RevokeObject Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to revoke an object.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRevokeObject(KMIPServerRevokeObjectEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  int ReasonCode;  const char *ReasonMessage;  int OperationStatus;
  int reserved;
} KMIPServerRevokeObjectEventParams;

Unicode (Windows)
virtual INT FireRevokeObject(KMIPServerRevokeObjectEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  INT ReasonCode;  LPCWSTR ReasonMessage;  INT OperationStatus;
  INT reserved;
} KMIPServerRevokeObjectEventParams;
```

## Remarks

The server uses this event to relay a client's Revoke Object request to the application.

The application must mark the requested object (*ObjectId*) as revoked, providing *ReasonCode* and *ReasonMessage* as evidence.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RNGGenerate Event ([KMIPServer](#kmipserver-class) Class)

Asks the application for another block of random numbers.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRNGGenerate(KMIPServerRNGGenerateEventParams *e);
typedef struct {  int64 ConnectionId;  int DataLength;  int OperationStatus;
  int reserved;
} KMIPServerRNGGenerateEventParams;

Unicode (Windows)
virtual INT FireRNGGenerate(KMIPServerRNGGenerateEventParams *e);
typedef struct {  LONG64 ConnectionId;  INT DataLength;  INT OperationStatus;
  INT reserved;
} KMIPServerRNGGenerateEventParams;
```

## Remarks

The server uses this event to request another chunk of random data from the application, following a client's PRNG Generate request.

An application that handles this event must use its PRNG to generate *DataLength* bytes of data and pass that data buffer back to the server via the [SetClientBytes](#setclientbytes-method-kmipserver-class) method.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RNGSeed Event ([KMIPServer](#kmipserver-class) Class)

Tells the application to seed the random number generator.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRNGSeed(KMIPServerRNGSeedEventParams *e);
typedef struct {  int64 ConnectionId;  const char *Data;
  int lenData;  int BytesUsed;  int OperationStatus;
  int reserved;
} KMIPServerRNGSeedEventParams;

Unicode (Windows)
virtual INT FireRNGSeed(KMIPServerRNGSeedEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCSTR Data;
  INT lenData;  INT BytesUsed;  INT OperationStatus;
  INT reserved;
} KMIPServerRNGSeedEventParams;
```

## Remarks

The server component uses this event to notify the application about the client's RNG Seed call. The application that handles this event must seed the provided data to its PRNG and return the number of *BytesUsed* along with the *OperationStatus*.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# SetAttribute Event ([KMIPServer](#kmipserver-class) Class)

Passes a set-attribute request to the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSetAttribute(KMIPServerSetAttributeEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *AttributeName;  const char *AttributeValue;  int OperationStatus;
  int reserved;
} KMIPServerSetAttributeEventParams;

Unicode (Windows)
virtual INT FireSetAttribute(KMIPServerSetAttributeEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR AttributeName;  LPCWSTR AttributeValue;  INT OperationStatus;
  INT reserved;
} KMIPServerSetAttributeEventParams;
```

## Remarks

The server component uses this event to tell the application that a certain attribute on an object should be set. This event only fires if the application chose to handle the edit operation manually in [BeforeEdit](#beforeedit-event-kmipserver-class) event handler.

The handler of this event should attempt to set the *AttributeName* attribute of the respective object as requested and return the operation result in the *OperationStatus* parameter.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Sign Event ([KMIPServer](#kmipserver-class) Class)

Instructs the application to sign data with a private key.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSign(KMIPServerSignEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *Algorithm;  const char *HashAlgorithm;  int InputIsHash;  const char *Data;
  int lenData;  int InitIndicator;  int FinalIndicator;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerSignEventParams;

Unicode (Windows)
virtual INT FireSign(KMIPServerSignEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR Algorithm;  LPCWSTR HashAlgorithm;  BOOL InputIsHash;  LPCSTR Data;
  INT lenData;  BOOL InitIndicator;  BOOL FinalIndicator;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerSignEventParams;
```

## Remarks

The server used this event to request the application to sign the provided *Data* (or the hash of the data, subject to *InputIsHash*) with the private key identified by the *ObjectId* parameter. This event is only fired if the application chose to proceed with the custom signing flow in the preceding [BeforeSign](#beforesign-event-kmipserver-class) event.

The *InitIndicator* and *FinalIndicator* provide guidance as to whether the data block is the first or last in a sequence of blocks. For blocks that are not last, generate a unique *CorrelationValue* to ensure continuity between consecutive data blocks.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# TLSCertValidate Event ([KMIPServer](#kmipserver-class) Class)

Fires when a client certificate needs to be validated.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSCertValidate(KMIPServerTLSCertValidateEventParams *e);
typedef struct {  int64 ConnectionID;  int Accept;
  int reserved;
} KMIPServerTLSCertValidateEventParams;

Unicode (Windows)
virtual INT FireTLSCertValidate(KMIPServerTLSCertValidateEventParams *e);
typedef struct {  LONG64 ConnectionID;  BOOL Accept;
  INT reserved;
} KMIPServerTLSCertValidateEventParams;
```

## Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter.

# TLSEstablished Event ([KMIPServer](#kmipserver-class) Class)

Reports the setup of a TLS session.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSEstablished(KMIPServerTLSEstablishedEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} KMIPServerTLSEstablishedEventParams;

Unicode (Windows)
virtual INT FireTLSEstablished(KMIPServerTLSEstablishedEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} KMIPServerTLSEstablishedEventParams;
```

## Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

# TLSHandshake Event ([KMIPServer](#kmipserver-class) Class)

Fires when a newly established client connection initiates a TLS handshake.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSHandshake(KMIPServerTLSHandshakeEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ServerName;  int Abort;
  int reserved;
} KMIPServerTLSHandshakeEventParams;

Unicode (Windows)
virtual INT FireTLSHandshake(KMIPServerTLSHandshakeEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ServerName;  BOOL Abort;
  INT reserved;
} KMIPServerTLSHandshakeEventParams;
```

## Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message.

# TLSPSK Event ([KMIPServer](#kmipserver-class) Class)

Requests a pre-shared key for TLS-PSK.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSPSK(KMIPServerTLSPSKEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Identity;  char *PSK;  char *Ciphersuite;
  int reserved;
} KMIPServerTLSPSKEventParams;

Unicode (Windows)
virtual INT FireTLSPSK(KMIPServerTLSPSKEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Identity;  LPWSTR PSK;  LPWSTR Ciphersuite;
  INT reserved;
} KMIPServerTLSPSKEventParams;
```

## Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake.

Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key.

# TLSShutdown Event ([KMIPServer](#kmipserver-class) Class)

Reports closure of a TLS session.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSShutdown(KMIPServerTLSShutdownEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} KMIPServerTLSShutdownEventParams;

Unicode (Windows)
virtual INT FireTLSShutdown(KMIPServerTLSShutdownEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} KMIPServerTLSShutdownEventParams;
```

## Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [Disconnect](#disconnect-event-kmipserver-class), which marks the closure of the underlying TCP session.

# ValidateChain Event ([KMIPServer](#kmipserver-class) Class)

Passes the chain validation request to the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireValidateChain(KMIPServerValidateChainEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectIds;  int Validity;  int OperationStatus;
  int reserved;
} KMIPServerValidateChainEventParams;

Unicode (Windows)
virtual INT FireValidateChain(KMIPServerValidateChainEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectIds;  INT Validity;  INT OperationStatus;
  INT reserved;
} KMIPServerValidateChainEventParams;
```

## Remarks

The server fires this event to notify the application about the received chain validation request. The application needs to build a chain out of certificates contained in the *ObjectIds* list, validate it, and return the validation result via the *Validity* parameter, which can take one of the following values:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Verify Event ([KMIPServer](#kmipserver-class) Class)

KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireVerify(KMIPServerVerifyEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  int InputIsHash;  const char *Data;
  int lenData;  const char *SignatureData;
  int lenSignatureData;  int InitIndicator;  int FinalIndicator;  int ValidationResult;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerVerifyEventParams;

Unicode (Windows)
virtual INT FireVerify(KMIPServerVerifyEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  BOOL InputIsHash;  LPCSTR Data;
  INT lenData;  LPCSTR SignatureData;
  INT lenSignatureData;  BOOL InitIndicator;  BOOL FinalIndicator;  INT ValidationResult;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerVerifyEventParams;
```

## Remarks

Subscribe to this event to be notified about public key signature verification operations. For this event to be invoked, the *fraCustom* action needs to be previously returned from the [BeforeVerify](#beforeverify-event-kmipserver-class) event.

The parameters of this event provide the details of the verification request:

- *ObjectId*: the key object to verify the signature with.
- *HashAlgorithm*: the hash algorithm to use for verification.
- *InputIsHash*: specifies whether *Data* contains the hash of the signed object or the object itself.
- *Data*: the signed data that needs to be verified.
- *SignatureData*: the signature data.
- *InitIndicator*: whether the provided data block starts a sequence of blocks.
- *FinalIndicator*: whether the provided data block ends a sequence of blocks.

Upon processing, set the *ValidationResult* and *OperationStatus* in accordance with the operation result.

See the [Three-step Virtualization](pages.md#pg_threestepvirtualization) article for more details about handling and virtualizing requests in SecureBlackbox servers.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# VerifyHash Event ([KMIPServer](#kmipserver-class) Class)

Delegates the hash verification operation to a custom handler.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireVerifyHash(KMIPServerVerifyHashEventParams *e);
typedef struct {  int64 ConnectionId;  const char *ObjectId;  const char *HashAlgorithm;  const char *Data;
  int lenData;  const char *Hash;
  int lenHash;  int InitIndicator;  int FinalIndicator;  int IsValid;  char *CorrelationValue;  int OperationStatus;
  int reserved;
} KMIPServerVerifyHashEventParams;

Unicode (Windows)
virtual INT FireVerifyHash(KMIPServerVerifyHashEventParams *e);
typedef struct {  LONG64 ConnectionId;  LPCWSTR ObjectId;  LPCWSTR HashAlgorithm;  LPCSTR Data;
  INT lenData;  LPCSTR Hash;
  INT lenHash;  BOOL InitIndicator;  BOOL FinalIndicator;  BOOL IsValid;  LPWSTR CorrelationValue;  INT OperationStatus;
  INT reserved;
} KMIPServerVerifyHashEventParams;
```

## Remarks

This event allows the application to wiretap into the server's verification procedure. It is invoked if the *Action* parameter in the preceding [BeforeVerify](#beforeverify-event-kmipserver-class) hash call was set to *fraCustom*.

KMIPServer uses this event to delegate both hash and MAC (keyed hash) verifications.

The *ObjectId* parameter contains the identifier of the key object that should be used to calculate the MAC code. This parameter is empty if a simple hashing operation is requested. The *Data* parameter contains the data that should be verified against the hash.

The *Hash* parameter contains the hash or MAC record. The *Algorithm* parameter specifies the hash algorithm.

In this handler, the application should calculate an *Algorithm* hash over *Data*, and verify that the result matches *Hash*. If the result does match, it should set the *IsValid* parameter to true. If the hashes do not match, or if any of the call parameters are malformed or not understood by the application, it should set *IsValid* to false.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Certificate Type

Encapsulates an individual X.509 certificate.

## Syntax

 *SecureBlackboxCertificate* (declared in *secureblackbox.h*)

## Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

- [Bytes](#Certificate_f_Bytes)

- [CA](#Certificate_f_CA)

- [CAKeyID](#Certificate_f_CAKeyID)

- [CertType](#Certificate_f_CertType)

- [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints)

- [Curve](#Certificate_f_Curve)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FriendlyName](#Certificate_f_FriendlyName)

- [Handle](#Certificate_f_Handle)

- [HashAlgorithm](#Certificate_f_HashAlgorithm)

- [Issuer](#Certificate_f_Issuer)

- [IssuerRDN](#Certificate_f_IssuerRDN)

- [KeyAlgorithm](#Certificate_f_KeyAlgorithm)

- [KeyBits](#Certificate_f_KeyBits)

- [KeyFingerprint](#Certificate_f_KeyFingerprint)

- [KeyUsage](#Certificate_f_KeyUsage)

- [KeyValid](#Certificate_f_KeyValid)

- [OCSPLocations](#Certificate_f_OCSPLocations)

- [OCSPNoCheck](#Certificate_f_OCSPNoCheck)

- [Origin](#Certificate_f_Origin)

- [PolicyIDs](#Certificate_f_PolicyIDs)

- [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes)

- [PrivateKeyExists](#Certificate_f_PrivateKeyExists)

- [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable)

- [PublicKeyBytes](#Certificate_f_PublicKeyBytes)

- [Qualified](#Certificate_f_Qualified)

- [QualifiedStatements](#Certificate_f_QualifiedStatements)

- [Qualifiers](#Certificate_f_Qualifiers)

- [SelfSigned](#Certificate_f_SelfSigned)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SigAlgorithm](#Certificate_f_SigAlgorithm)

- [Source](#Certificate_f_Source)

- [Subject](#Certificate_f_Subject)

- [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName)

- [SubjectKeyID](#Certificate_f_SubjectKeyID)

- [SubjectRDN](#Certificate_f_SubjectRDN)

- [Valid](#Certificate_f_Valid)

- [ValidFrom](#Certificate_f_ValidFrom)

- [ValidTo](#Certificate_f_ValidTo)

## Fields

 **Bytes** *char* (read-only)*
*Default Value: *

Returns the raw certificate data in DER format.

 **CA** *int*
*Default Value: FALSE*

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

 **CAKeyID** *char* (read-only)*
*Default Value: *

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

 **CertType** *int (read-only)*
*Default Value: 0*

Returns the type of the entity contained in the [Certificate](#certificate-type) object.

A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects.

 **CRLDistributionPoints** *char**
*Default Value: ""*

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **Curve** *char**
*Default Value: ""*

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

 **FriendlyName** *char* (read-only)*
*Default Value: ""*

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **HashAlgorithm** *char**
*Default Value: ""*

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

 **Issuer** *char* (read-only)*
*Default Value: ""*

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN).

 **IssuerRDN** *char**
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

 **KeyAlgorithm** *char**
*Default Value: "0"*

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains.

 **KeyBits** *int (read-only)*
*Default Value: 0*

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer.

 **KeyFingerprint** *char* (read-only)*
*Default Value: ""*

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

 **KeyUsage** *int*
*Default Value: 0*

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

 **KeyValid** *int (read-only)*
*Default Value: FALSE*

Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise.

 **OCSPLocations** *char**
*Default Value: ""*

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **OCSPNoCheck** *int*
*Default Value: FALSE*

Accessor to the value of the certificate's ocsp-no-check extension.

 **Origin** *int (read-only)*
*Default Value: 0*

Returns the location that the certificate was taken or loaded from.

 **PolicyIDs** *char**
*Default Value: ""*

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

 **PrivateKeyBytes** *char* (read-only)*
*Default Value: *

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

 **PrivateKeyExists** *int (read-only)*
*Default Value: FALSE*

Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

 **PrivateKeyExtractable** *int (read-only)*
*Default Value: FALSE*

Indicates whether the private key is extractable (exportable).

 **PublicKeyBytes** *char* (read-only)*
*Default Value: *

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

 **Qualified** *int (read-only)*
*Default Value: FALSE*

Indicates whether the certificate is qualified.

This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.

 **QualifiedStatements** *int*
*Default Value: 0*

Returns a simplified qualified status of the certificate.

 **Qualifiers** *char* (read-only)*
*Default Value: ""*

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.

 **SelfSigned** *int (read-only)*
*Default Value: FALSE*

Indicates whether the certificate is self-signed (root) or signed by an external CA.

 **SerialNumber** *char**
*Default Value: *

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

 **SigAlgorithm** *char* (read-only)*
*Default Value: ""*

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.

 **Source** *int (read-only)*
*Default Value: 0*

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

 **Subject** *char* (read-only)*
*Default Value: ""*

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN).

 **SubjectAlternativeName** *char**
*Default Value: ""*

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

 **SubjectKeyID** *char**
*Default Value: *

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

 **SubjectRDN** *char**
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

 **Valid** *int (read-only)*
*Default Value: FALSE*

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

 **ValidFrom** *char**
*Default Value: ""*

The time point at which the certificate becomes valid, in UTC.

 **ValidTo** *char**
*Default Value: ""*

The time point at which the certificate expires, in UTC.

## Constructors

```text
Certificate()
```

 Creates a new object with default field values.

# CryptoKey Type

This container represents a cryptographic key.

## Syntax

 *SecureBlackboxCryptoKey* (declared in *secureblackbox.h*)

## Remarks

This type is a universal placeholder for cryptographic keys.

Version 2026 upgrade note: granular key parameter properties (RSAModulus, EdPublic, DSSP and others) have been removed from this type and are now available via the CryptoKeyManager.GetKeyParam method.

The following fields are available:

- [Algorithm](#CryptoKey_f_Algorithm)

- [Bits](#CryptoKey_f_Bits)

- [Curve](#CryptoKey_f_Curve)

- [Exportable](#CryptoKey_f_Exportable)

- [Fingerprint](#CryptoKey_f_Fingerprint)

- [Handle](#CryptoKey_f_Handle)

- [ID](#CryptoKey_f_ID)

- [IV](#CryptoKey_f_IV)

- [Nonce](#CryptoKey_f_Nonce)

- [Private](#CryptoKey_f_Private)

- [Public](#CryptoKey_f_Public)

- [Subject](#CryptoKey_f_Subject)

- [Symmetric](#CryptoKey_f_Symmetric)

- [Valid](#CryptoKey_f_Valid)

- [Value](#CryptoKey_f_Value)

## Fields

 **Algorithm** *char**
*Default Value: ""*

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH, EdDSA, ML-DSA, ML-KEM.

|  |  |  |
| --- | --- | --- |
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 |  |
| SB_SYMMETRIC_ALGORITHM_DES | DES |  |
| SB_SYMMETRIC_ALGORITHM_3DES | 3DES |  |
| SB_SYMMETRIC_ALGORITHM_RC2 | RC2 |  |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 |  |
| SB_SYMMETRIC_ALGORITHM_AES192 | AES192 |  |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |  |
| SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity |  |
| SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish |  |
| SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 |  |
| SB_SYMMETRIC_ALGORITHM_IDEA | IDEA |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 |  |
| SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 |  |
| SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 |  |
| SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 |  |
| SB_SYMMETRIC_ALGORITHM_SEED | SEED |  |
| SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit |  |
| SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic |  |
| SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 |  |
| SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |  |

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

 **Bits** *int (read-only)*
*Default Value: 0*

The length of the key in bits.

 **Curve** *char**
*Default Value: ""*

This property specifies the name of the curve the EC key is built on.

 **Exportable** *int (read-only)*
*Default Value: FALSE*

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

Contains the fingerprint (a hash imprint) of this key.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **ID** *char**
*Default Value: *

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

 **IV** *char**
*Default Value: *

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

 **Nonce** *char**
*Default Value: *

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

 **Private** *int (read-only)*
*Default Value: FALSE*

Returns True if the object hosts a private key, and False otherwise.

 **Public** *int (read-only)*
*Default Value: FALSE*

Returns True if the object hosts a public key, and False otherwise.

 **Subject** *char**
*Default Value: *

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

 **Symmetric** *int (read-only)*
*Default Value: FALSE*

Returns True if the object contains a symmetric key, and False otherwise.

 **Valid** *int (read-only)*
*Default Value: FALSE*

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

 **Value** *char* (read-only)*
*Default Value: *

The byte array representation of the key value. This may not be available for non-[Exportable](#CryptoKey_f_Exportable) keys.

This property used to be called *Key* in SecureBlackbox versions 2024 and older.

## Constructors

```text
CryptoKey()
```

 Creates an empty crypto key object.

# ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

## Syntax

 *SecureBlackboxExternalCrypto* (declared in *secureblackbox.h*)

## Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

The following fields are available:

- [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID)

- [CustomParams](#ExternalCrypto_f_CustomParams)

- [Data](#ExternalCrypto_f_Data)

- [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation)

- [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm)

- [KeyID](#ExternalCrypto_f_KeyID)

- [KeySecret](#ExternalCrypto_f_KeySecret)

- [Method](#ExternalCrypto_f_Method)

- [Mode](#ExternalCrypto_f_Mode)

- [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm)

## Fields

 **AsyncDocumentID** *char**
*Default Value: ""*

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

 **CustomParams** *char**
*Default Value: ""*

Custom parameters to be passed to the signing service (uninterpreted).

 **Data** *char**
*Default Value: ""*

Additional data to be included in the async state and mirrored back by the requestor.

 **ExternalHashCalculation** *int*
*Default Value: FALSE*

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

 **HashAlgorithm** *char**
*Default Value: "SHA256"*

Specifies the request's signature hash algorithm.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

 **KeyID** *char**
*Default Value: ""*

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [KeySecret](#ExternalCrypto_f_KeySecret) to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example:

```text
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";
```

 **KeySecret** *char**
*Default Value: ""*

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the [KeyID](#ExternalCrypto_f_KeyID) topic.

 **Method** *int*
*Default Value: 0*

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

 **Mode** *int*
*Default Value: 0*

Specifies the external cryptography mode.

Available options:

|  |  |
| --- | --- |
| ecmDefault | The default value (0) |
| ecmDisabled | Do not use DC or external signing (1) |
| ecmGeneric | Generic external signing with the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |

 **PublicKeyAlgorithm** *char**
*Default Value: ""*

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

## Constructors

```text
ExternalCrypto()
```

 Creates a new ExternalCrypto object with default field values.

# SocketSettings Type

A container for the socket settings.

## Syntax

 *SecureBlackboxSocketSettings* (declared in *secureblackbox.h*)

## Remarks

This type is a container for socket-layer parameters.

The following fields are available:

- [DNSMode](#SocketSettings_f_DNSMode)

- [DNSPort](#SocketSettings_f_DNSPort)

- [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout)

- [DNSServers](#SocketSettings_f_DNSServers)

- [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout)

- [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit)

- [LocalAddress](#SocketSettings_f_LocalAddress)

- [LocalPort](#SocketSettings_f_LocalPort)

- [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit)

- [Timeout](#SocketSettings_f_Timeout)

- [UseIPv6](#SocketSettings_f_UseIPv6)

## Fields

 **DNSMode** *int*
*Default Value: 0*

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

 **DNSPort** *int*
*Default Value: 0*

Specifies the port number to be used for sending queries to the DNS server.

 **DNSQueryTimeout** *int*
*Default Value: 0*

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

 **DNSServers** *char**
*Default Value: ""*

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

 **DNSTotalTimeout** *int*
*Default Value: 0*

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

 **IncomingSpeedLimit** *int*
*Default Value: 0*

The maximum number of bytes to read from the socket, per second.

 **LocalAddress** *char**
*Default Value: ""*

The local network interface to bind the socket to.

 **LocalPort** *int*
*Default Value: 0*

The local port number to bind the socket to.

 **OutgoingSpeedLimit** *int*
*Default Value: 0*

The maximum number of bytes to write to the socket, per second.

 **Timeout** *int*
*Default Value: 60000*

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

 **UseIPv6** *int*
*Default Value: FALSE*

Enables or disables IP protocol version 6.

## Constructors

```text
SocketSettings()
```

 Creates a new SocketSettings object.

# TLSConnectionInfo Type

Contains information about a network connection.

## Syntax

 *SecureBlackboxTLSConnectionInfo* (declared in *secureblackbox.h*)

## Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

The following fields are available:

- [AEADCipher](#TLSConnectionInfo_f_AEADCipher)

- [ChainValidationDetails](#TLSConnectionInfo_f_ChainValidationDetails)

- [ChainValidationResult](#TLSConnectionInfo_f_ChainValidationResult)

- [Ciphersuite](#TLSConnectionInfo_f_Ciphersuite)

- [ClientAuthenticated](#TLSConnectionInfo_f_ClientAuthenticated)

- [ClientAuthRequested](#TLSConnectionInfo_f_ClientAuthRequested)

- [ConnectionEstablished](#TLSConnectionInfo_f_ConnectionEstablished)

- [ConnectionID](#TLSConnectionInfo_f_ConnectionID)

- [DigestAlgorithm](#TLSConnectionInfo_f_DigestAlgorithm)

- [EncryptionAlgorithm](#TLSConnectionInfo_f_EncryptionAlgorithm)

- [Exportable](#TLSConnectionInfo_f_Exportable)

- [Group](#TLSConnectionInfo_f_Group)

- [ID](#TLSConnectionInfo_f_ID)

- [KeyExchangeAlgorithm](#TLSConnectionInfo_f_KeyExchangeAlgorithm)

- [KeyExchangeKeyBits](#TLSConnectionInfo_f_KeyExchangeKeyBits)

- [PFSCipher](#TLSConnectionInfo_f_PFSCipher)

- [PreSharedIdentity](#TLSConnectionInfo_f_PreSharedIdentity)

- [PreSharedIdentityHint](#TLSConnectionInfo_f_PreSharedIdentityHint)

- [PublicKeyBits](#TLSConnectionInfo_f_PublicKeyBits)

- [RemoteAddress](#TLSConnectionInfo_f_RemoteAddress)

- [RemotePort](#TLSConnectionInfo_f_RemotePort)

- [ResumedSession](#TLSConnectionInfo_f_ResumedSession)

- [SecureConnection](#TLSConnectionInfo_f_SecureConnection)

- [ServerAuthenticated](#TLSConnectionInfo_f_ServerAuthenticated)

- [SignatureAlgorithm](#TLSConnectionInfo_f_SignatureAlgorithm)

- [SymmetricBlockSize](#TLSConnectionInfo_f_SymmetricBlockSize)

- [SymmetricKeyBits](#TLSConnectionInfo_f_SymmetricKeyBits)

- [TotalBytesReceived](#TLSConnectionInfo_f_TotalBytesReceived)

- [TotalBytesSent](#TLSConnectionInfo_f_TotalBytesSent)

- [ValidationLog](#TLSConnectionInfo_f_ValidationLog)

- [Version](#TLSConnectionInfo_f_Version)

## Fields

 **AEADCipher** *int (read-only)*
*Default Value: FALSE*

Indicates whether the encryption algorithm used is an AEAD cipher.

 **ChainValidationDetails** *int (read-only)*
*Default Value: 0*

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

 **ChainValidationResult** *int (read-only)*
*Default Value: 0*

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

 **Ciphersuite** *char* (read-only)*
*Default Value: ""*

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

 **ClientAuthenticated** *int (read-only)*
*Default Value: FALSE*

Specifies whether client authentication was performed during this connection.

 **ClientAuthRequested** *int (read-only)*
*Default Value: FALSE*

Specifies whether client authentication was requested during this connection.

 **ConnectionEstablished** *int (read-only)*
*Default Value: FALSE*

Indicates whether the connection has been established fully.

 **ConnectionID** *char* (read-only)*
*Default Value: *

The unique identifier assigned to this connection.

 **DigestAlgorithm** *char* (read-only)*
*Default Value: ""*

The digest algorithm used in a TLS-enabled connection.

 **EncryptionAlgorithm** *char* (read-only)*
*Default Value: ""*

The symmetric encryption algorithm used in a TLS-enabled connection.

 **Exportable** *int (read-only)*
*Default Value: FALSE*

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

 **Group** *char* (read-only)*
*Default Value: ""*

The elliptic curve used in this connection.

This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions.

 **ID** *int64 (read-only)*
*Default Value: -1*

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

 **KeyExchangeAlgorithm** *char* (read-only)*
*Default Value: ""*

The key exchange algorithm used in a TLS-enabled connection.

 **KeyExchangeKeyBits** *int (read-only)*
*Default Value: 0*

The length of the key exchange key of a TLS-enabled connection.

 **PFSCipher** *int (read-only)*
*Default Value: FALSE*

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

 **PreSharedIdentity** *char**
*Default Value: ""*

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

 **PreSharedIdentityHint** *char* (read-only)*
*Default Value: ""*

A hint professed by the server to help the client select the PSK identity to use.

 **PublicKeyBits** *int (read-only)*
*Default Value: 0*

The length of the public key.

 **RemoteAddress** *char* (read-only)*
*Default Value: ""*

The client's IP address.

 **RemotePort** *int (read-only)*
*Default Value: 0*

The remote port of the client connection.

 **ResumedSession** *int (read-only)*
*Default Value: FALSE*

Indicates whether a TLS-enabled connection was spawned from another TLS connection

 **SecureConnection** *int (read-only)*
*Default Value: FALSE*

Indicates whether TLS or SSL is enabled for this connection.

 **ServerAuthenticated** *int (read-only)*
*Default Value: FALSE*

Indicates whether server authentication was performed during a TLS-enabled connection.

 **SignatureAlgorithm** *char* (read-only)*
*Default Value: ""*

The signature algorithm used in a TLS handshake.

 **SymmetricBlockSize** *int (read-only)*
*Default Value: 0*

The block size of the symmetric algorithm used.

 **SymmetricKeyBits** *int (read-only)*
*Default Value: 0*

The key length of the symmetric algorithm used.

 **TotalBytesReceived** *int64 (read-only)*
*Default Value: 0*

The total number of bytes received over this connection.

 **TotalBytesSent** *int64 (read-only)*
*Default Value: 0*

The total number of bytes sent over this connection.

 **ValidationLog** *char* (read-only)*
*Default Value: ""*

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

 **Version** *char* (read-only)*
*Default Value: ""*

Indicates the version of SSL/TLS protocol negotiated during this connection.

## Constructors

```text
TLSConnectionInfo()
```

 Creates a new TLSConnectionInfo object.

# TLSSettings Type

A container for TLS connection settings.

## Syntax

 *SecureBlackboxTLSSettings* (declared in *secureblackbox.h*)

## Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

- [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates)

- [BaseConfiguration](#TLSSettings_f_BaseConfiguration)

- [Ciphersuites](#TLSSettings_f_Ciphersuites)

- [ClientAuth](#TLSSettings_f_ClientAuth)

- [Extensions](#TLSSettings_f_Extensions)

- [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges)

- [Groups](#TLSSettings_f_Groups)

- [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity)

- [PreSharedKey](#TLSSettings_f_PreSharedKey)

- [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite)

- [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode)

- [RevocationCheck](#TLSSettings_f_RevocationCheck)

- [SSLOptions](#TLSSettings_f_SSLOptions)

- [TLSMode](#TLSSettings_f_TLSMode)

- [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret)

- [UseSessionResumption](#TLSSettings_f_UseSessionResumption)

- [Versions](#TLSSettings_f_Versions)

## Fields

 **AutoValidateCertificates** *int*
*Default Value: TRUE*

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

 **BaseConfiguration** *int*
*Default Value: 0*

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

 **Ciphersuites** *char**
*Default Value: ""*

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [BaseConfiguration](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256

 **ClientAuth** *int*
*Default Value: 0*

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

 **Extensions** *char**
*Default Value: ""*

Provides access to TLS extensions.

 **ForceResumeIfDestinationChanges** *int*
*Default Value: FALSE*

Whether to force TLS session resumption when the destination address changes.

 **Groups** *char**
*Default Value: ""*

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder:

```text
  // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
  client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";

  // Only enable the hybrid X25519/ML-KEM768 group
  client.TLSSettings.Groups = "-all;+x25519mlkem768";
```

The list of groups supported by the component is provided below. All the names are case-insensitive:

**Elliptic curve-based groups:**

- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024

Note: this property was called *ECCurves* in SecureBlackbox 2024 and older.

 **PreSharedIdentity** *char**
*Default Value: ""*

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

 **PreSharedKey** *char**
*Default Value: ""*

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

 **PreSharedKeyCiphersuite** *char**
*Default Value: ""*

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

 **RenegotiationAttackPreventionMode** *int*
*Default Value: 2*

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

 **RevocationCheck** *int*
*Default Value: 1*

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

 **SSLOptions** *int*
*Default Value: 16*

Various SSL (TLS) protocol options, set of

|  |  |  |
| --- | --- | --- |
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

 **TLSMode** *int*
*Default Value: 0*

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

 **UseExtendedMasterSecret** *int*
*Default Value: TRUE*

Enables the Extended Master Secret Extension, as defined in RFC 7627.

 **UseSessionResumption** *int*
*Default Value: FALSE*

Enables or disables the TLS session resumption capability.

 **Versions** *int*
*Default Value: 48*

The SSL/TLS versions to enable by default.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Constructors

```text
TLSSettings()
```

 Creates a new TLSSettings object.

# UserAccount Type

A container for user account information.

## Syntax

 *SecureBlackboxUserAccount* (declared in *secureblackbox.h*)

## Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

The following fields are available:

- [AssociatedData](#UserAccount_f_AssociatedData)

- [BasePath](#UserAccount_f_BasePath)

- [Certificate](#UserAccount_f_Certificate)

- [Data](#UserAccount_f_Data)

- [Email](#UserAccount_f_Email)

- [Handle](#UserAccount_f_Handle)

- [HashAlgorithm](#UserAccount_f_HashAlgorithm)

- [IncomingSpeedLimit](#UserAccount_f_IncomingSpeedLimit)

- [OtpAlgorithm](#UserAccount_f_OtpAlgorithm)

- [OTPLen](#UserAccount_f_OTPLen)

- [OtpValue](#UserAccount_f_OtpValue)

- [OutgoingSpeedLimit](#UserAccount_f_OutgoingSpeedLimit)

- [Password](#UserAccount_f_Password)

- [SharedSecret](#UserAccount_f_SharedSecret)

- [SSHKey](#UserAccount_f_SSHKey)

- [Username](#UserAccount_f_Username)

## Fields

 **AssociatedData** *char**
*Default Value: *

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

 **BasePath** *char**
*Default Value: ""*

Base path for this user in the server's file system.

 **Certificate** *char**
*Default Value: *

Contains the user's certificate.

 **Data** *char**
*Default Value: ""*

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

 **Email** *char**
*Default Value: ""*

The user's email address.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **HashAlgorithm** *char**
*Default Value: ""*

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

|  |  |  |
| --- | --- | --- |
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 |  |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 |  |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |  |

 **IncomingSpeedLimit** *int*
*Default Value: 0*

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

 **OtpAlgorithm** *int*
*Default Value: 0*

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

|  |  |  |
| --- | --- | --- |
| oaHmac | 0 |  |
| oaTime | 1 |  |

 **OTPLen** *int*
*Default Value: 0*

Specifies the length of the user's OTP password.

 **OtpValue** *int*
*Default Value: 0*

The user's time interval (TOTP) or Counter (HOTP).

 **OutgoingSpeedLimit** *int*
*Default Value: 0*

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

 **Password** *char**
*Default Value: ""*

The user's authentication password.

 **SharedSecret** *char**
*Default Value: *

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

 **SSHKey** *char**
*Default Value: *

Contains the user's SSH key.

 **Username** *char**
*Default Value: ""*

The registered name (login) of the user.

## Constructors

```text
UserAccount()
```

 Creates a new UserAccount object

# SecureBlackboxList Type

## Syntax

 *SecureBlackboxList<T>* (declared in *secureblackbox.h*)

## Remarks

 *SecureBlackboxList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the KMIPServer class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# Config Settings ([KMIPServer](#kmipserver-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-kmipserver-class) method.

### KMIPServer Config Settings

**AllowKeepAlive**: Enables or disables keep-alive mode.Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while.

**AllowOptionsResponseWithoutAuth**: Enables unauthenticated responses to OPTIONS requests.Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client.

**AuthBasic**: Turns on/off the basic authentication.When switched on, connecting clients can use the basic authentication.

**AuthDigest**: Turns on/off the digest authentication.When switched on, connecting clients can use the digest authentication.

**AuthDigestExpire**: Specifies digest expiration time for digest authentication.Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20.

**AuthRealm**: Specifies authentication realm for digest and NTLM authentication.Specifies authentication realm for digest and NTLM authentication types.

**CompressionLevel**: The default compression level to use.Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest.

**DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously.

**HomePage**: Specifies the home page resource name.Use this property to specify the home page (/) resource name.

**MajorProtocolVersion**: Major protocol version on the KMIP server.Use this property to specify the major version of KMIP used on the server.

**MinorProtocolVersion**: Minor protocol version on the KMIP server.Use this property to specify the minor version of KMIP used on the server.

**OAuthAllowAccessByDefault**: Specifies whether access to a resource is allowed by default.Use this property to enable or disable access to a resource in case if no scopes defined or the resource doesn't match any of the user's scopes.

**OAuthAutoValidateTokens**: Allows to validate OAuth 2.0 access tokens automatically.Use this property to enable or disable pre-validation of access tokens.

**OAuthIntrospectionClientID**: Specifies a client ID on the authentication service.Use this property to provide a client ID for access token introspection.

**OAuthIntrospectionClientSecret**: Specifies a client secret on the authentication service.Use this property to provide a client secret for access token introspection.

**OAuthIntrospectionURL**: Specifies the URL to be used to introspect access tokens.Use this property to provide the URL for introspection.

**OAuthTokenValidationKeys**: Specifies JW keys in JSON format for validating access token signatures.

**RequestFilter**: The request string modifier.Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request.

**SSLMode**: Whether to establish a TLS-secured connection.When SSLMode is True, the class establishes a TLS session and encrypts the data.

**UseChunkedTransfer**: Whether to use chunked encoding of the data.Set this property to true to generate chunked responses to the clients. Enables chunked transfer.Use this property to enable chunked content encoding.

**UseChunkedTransfer**: Whether to use chunked encoding of the data.Set this property to true to generate chunked responses to the clients. Enables chunked transfer.Use this property to enable chunked content encoding.

**UseCompression**: Whether to use GZip compression.Use this property to tell the class that it should use data compression when generating responses. Enables or disables server-side compression.Use this property to enable or disable server-side content compression.

**UseCompression**: Whether to use GZip compression.Use this property to tell the class that it should use data compression when generating responses. Enables or disables server-side compression.Use this property to enable or disable server-side content compression.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([KMIPServer](#kmipserver-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### KMIPServer Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |
| 20971521 | KMIP request failed ([SB_ERROR_KMIP_REQUEST_FAILED](constants.md#const_SBERRORKMIPREQUESTFAILED)) |
| 20971522 | The input file does not exist ([SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORKMIPINPUTFILENOTEXISTS)) |
| 20971523 | Unsupported key algorithm ([SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM](constants.md#const_SBERRORKMIPUNSUPPORTEDKEYALGORITHM)) |
| 20971524 | Invalid key ([SB_ERROR_KMIP_INVALID_KEY](constants.md#const_SBERRORKMIPINVALIDKEY)) |