KMIPServer Component
Properties Methods Events Config Settings Errors
The KMIPServer class provides server-side functionality for Key Management Interoperability Protocol (KMIP).
Syntax
secureblackbox.KMIPServer
Remarks
The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between 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 component with short descriptions. Click on the links for further details.
| Active | Indicates if the KMIP server is active and listening to incoming connections. |
| AllowKeepAlive | Enables or disables keep-alive mode. |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
| AuthTypes | Defines allowed HTTP authentication types. |
| BoundPort | Indicates the bound listening port. |
| CACertBytes | Returns the raw certificate data in DER format. |
| CACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CertificateBytes | Returns the raw certificate data in DER format. |
| CertificateHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| CompressionLevel | The default compression level to use. |
| ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| ExternalCryptoMethod | Specifies the asynchronous signing method. |
| ExternalCryptoMode | Specifies the external cryptography mode. |
| ExternalCryptoPublicKeyAlgorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| FIPSMode | Reserved. |
| HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
| Host | Specifies the host name of the KMIP server. |
| KeyAlgorithm | The algorithm of the cryptographic key. |
| KeyBits | The length of the key in bits. |
| KeyCurve | This property specifies the name of the curve the EC key is built on. |
| KeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
| KeyFingerprint | Contains the fingerprint (a hash imprint) of this key. |
| KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| KeyID | Provides access to a storage-specific key identifier. |
| KeyIV | The initialization vector (IV) of a symmetric key. |
| KeyNonce | A nonce value associated with a key. |
| KeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
| KeyPublic | Returns True if the object hosts a public key, and False otherwise. |
| KeySubject | Returns the key subject. |
| KeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
| KeyValid | Returns True if this key is valid. |
| KeyValue | The byte array representation of the key value. |
| PinnedClientAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
| PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
| PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
| PinnedClientCiphersuite | The cipher suite employed by this connection. |
| PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
| PinnedClientClientAuthRequested | Specifies whether client authentication was requested during this connection. |
| PinnedClientConnectionEstablished | Indicates whether the connection has been established fully. |
| PinnedClientConnectionID | The unique identifier assigned to this connection. |
| PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
| PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| PinnedClientExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
| PinnedClientGroup | The elliptic curve used in this connection. |
| PinnedClientID | The client connection's unique identifier. |
| PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
| PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
| PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| PinnedClientPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
| PinnedClientPublicKeyBits | The length of the public key. |
| PinnedClientRemoteAddress | The client's IP address. |
| PinnedClientRemotePort | The remote port of the client connection. |
| PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
| PinnedClientServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
| PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
| PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
| PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
| PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
| PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
| PinnedClientValidationLog | Contains the server certificate's chain validation log. |
| PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
| PinnedClientCertBytes | Returns the raw certificate data in DER format. |
| PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| PinnedClientCertIssuerRDN | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| PinnedClientCertKeyBits | Returns the length of the public key in bits. |
| PinnedClientCertKeyFingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| PinnedClientCertSerialNumber | Returns the certificate's serial number. |
| PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| PinnedClientCertSubjectKeyID | Contains a unique identifier of the certificate's cryptographic key. |
| PinnedClientCertSubjectRDN | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
| Port | A port to listen for connections on. |
| ReadOnly | Controls whether the server works in read-only mode. |
| SessionTimeout | Specifies the default session timeout value in milliseconds. |
| SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| SocketLocalAddress | The local network interface to bind the socket to. |
| SocketLocalPort | The local port number to bind the socket to. |
| SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| SocketUseIPv6 | Enables or disables IP protocol version 6. |
| StorageFileName | A path to the KMIP object database. |
| TLSServerCertCount | The number of records in the TLSServerCert arrays. |
| TLSServerCertBytes | Returns the raw certificate data in DER format. |
| TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| TLSClientAuth | Enables or disables certificate-based client authentication. |
| TLSExtensions | Provides access to TLS extensions. |
| TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| TLSGroups | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
| TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| TLSSSLOptions | 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. |
| TLSMode | Specifies the TLS mode to use. |
| TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
| TLSVersions | The SSL/TLS versions to enable by default. |
| UseChunkedTransfer | Enables chunked transfer. |
| UseCompression | Enables or disables server-side compression. |
| UseHTTP | Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS. |
| UserCount | The number of records in the User arrays. |
| UserAssociatedData | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
| UserBasePath | Base path for this user in the server's file system. |
| UserCertificate | Contains the user's certificate. |
| UserData | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
| UserEmail | The user's email address. |
| UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| UserHashAlgorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
| UserIncomingSpeedLimit | Specifies the incoming speed limit for this user. |
| UserOtpAlgorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
| UserOTPLen | Specifies the length of the user's OTP password. |
| UserOtpValue | The user's time interval (TOTP) or Counter (HOTP). |
| UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
| UserPassword | The user's authentication password. |
| UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
| UserSSHKey | Contains the user's SSH key. |
| Username | The registered name (login) of the user. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| DropClient | Terminates a client connection. |
| GetClientCert | Populates the per-connection certificate object. |
| GetClientKey | Populates the per-connection key object. |
| GetRequestHeader | Returns a request header value. |
| GetResponseHeader | Returns a response header value. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| ProcessGenericRequest | Processes a generic HTTP request. |
| Reset | Resets the class settings. |
| SetClientBytes | Commits a data buffer to the connection. |
| SetClientCert | Commits the per-connection certificate object to the connection context. |
| SetClientKey | Commits the per-connection key object to the connection context. |
| SetResponseHeader | Sets a response header. |
| Start | Start the KMIP server. |
| Stop | Stops the KMIP server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Accept | Reports an incoming connection. |
| ActivateObject | Notifies the application about the object activation request. |
| Add | Passes the certificate import request to the application. |
| AddKey | Expects the application to handle the key import request. |
| AfterAdd | Notifies the application about completion of the certificate import operation. |
| AfterAddKey | Reports the completion of the key import procedure. |
| AfterBrowse | KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation. |
| AfterDecrypt | Notifies the application about completion of the decryption call. |
| AfterDeriveKey | Notifies the application about completion of the key derivation request. |
| AfterEdit | Notifies the application of completion of the object editing operation. |
| AfterEncrypt | Notifies the application about the completion of the encryption call. |
| AfterGenerate | Signifies completion of certificate generation. |
| AfterGenerateKey | Notifies the application of the completion of key generation procedure. |
| AfterGenerateKeyPair | Notifies the application of the completion of keypair generation. |
| AfterHash | Notifies the application about completion of the hashing call. |
| AfterList | Notifies the application about completion of the list command. |
| AfterObtainLease | Reports the completion of lease allocation operation. |
| AfterReadObject | Notifies the application of the completion of the read operation on the object. |
| AfterReCertify | Notifies the application about the completion of the re-certify operation. |
| AfterReKey | Notifies the application about the completion of the re-key operation. |
| AfterRekeyKeyPair | Notifies the application about the completion of the re-key keypair operation. |
| AfterRemoveObject | Notifies the application about completion of the object removal request. |
| AfterSign | Notifies the application of completion of a signing operation. |
| AfterVerify | Notifies the application about completion of the Verify operation. |
| AfterVerifyHash | Notifies the application about completion of the hash verification. |
| ArchiveObject | Notifies the application about the received object archival request. |
| AuthAttempt | Fires when a connected client makes an authentication attempt. |
| BeforeAdd | Fires when a certificate import request is received from a client. |
| BeforeAddKey | Fires when a key import request is received from the client. |
| BeforeBrowse | Notifies the application about the browse request being received. |
| BeforeDecrypt | Notifies the application about the initiation of the decryption operation. |
| BeforeDeriveKey | Fires when a derive key request is received. |
| BeforeEdit | Notifies the application about the start of the object editing operation. |
| BeforeEncrypt | Notifies the application about the initiation of an encryption operation. |
| BeforeGenerate | Fires when a certificate generation request is received. |
| BeforeGenerateKey | Fires when a key generation request is received. |
| BeforeGenerateKeyPair | Fires when a key generation request is received. |
| BeforeHash | Notifies the application about the initiation of the hashing operation. |
| BeforeList | Notifies the application about the initiation of the list operation. |
| BeforeObtainLease | Notifies the application about the client requesting an object lease. |
| BeforeReadObject | Notifies the application about the start of the object reading request. |
| BeforeReCertify | Notifies the application about a re-certification request. |
| BeforeReKey | Notifies the application about a re-key request received. |
| BeforeRekeyKeyPair | Notifies the application about a keypair re-key request received. |
| BeforeRemoveObject | Notifies the application about an incoming Remove Object request. |
| BeforeSign | Notifies the application about the initiation of a signing operation. |
| BeforeVerify | Notifies the application about the initiation of the verify operation. |
| BeforeVerifyHash | Notifies the application about the initiation of the hash verification operation. |
| Cancel | Reports a cancellation request received from the client. |
| Check | Notifies the application about a Check request received. |
| Connect | Reports an accepted connection. |
| Decrypt | Instructs the application to decrypt a chunk of data. |
| DeleteAttribute | Instructs the application to delete an object attribute. |
| DeriveKey | Notifies the application of key derivation request. |
| Disconnect | Fires to report a disconnected client. |
| Encrypt | Instructs the application to encrypt a chunk of data. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the server protocol. |
| Generate | Notifies the application about an incoming Generate request. |
| GenerateKey | Notifies the application about an incoming Generate request. |
| GenerateKeyPair | Notifies the application about an incoming Generate request. |
| GetUsageAllocation | Notifies the application about an incoming Get Usage Allocation request. |
| Hash | Instructs the application to update the current hashing operation. |
| HeadersPrepared | Fires when the response headers have been formed and are ready to be sent to the server. |
| KMIPAuthAttempt | Fires when a connected client makes an authentication attempt. |
| List | Instructs the application to return the list of objects that match the specified criteria. |
| ListAttributes | Requests a list of object attribute names from the application. |
| Notification | This event notifies the application about an underlying control flow event. |
| ObtainLease | Lets the application handle the lease request. |
| OperationAttempt | Fires when a request is received from the client. |
| Poll | Notifies the application about the received Poll request. |
| ReadAttribute | Requests an object attribute value from the application. |
| ReadObject | Requests the details of the object from the application. |
| ReCertify | Notifies the application about an incoming re-certification request. |
| RecoverObject | Notifies the application about an incoming Recover Object request. |
| ReKey | Notifies the application about an incoming re-key request. |
| RekeyKeyPair | Notifies the application about an incoming re-key request. |
| RemoveObject | Notifies the application about the object deletion request. |
| Request | Notifies the application about KMIP requests being received. |
| Response | Notifies the application about KMIP responses being sent back. |
| RevokeObject | Instructs the application to revoke an object. |
| RNGGenerate | Asks the application for another block of random numbers. |
| RNGSeed | Tells the application to seed the random number generator. |
| SetAttribute | Passes a set-attribute request to the application. |
| Sign | Instructs the application to sign data with a private key. |
| TLSCertValidate | Fires when a client certificate needs to be validated. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
| ValidateChain | Passes the chain validation request to the application. |
| Verify | KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it. |
| VerifyHash | Delegates the hash verification operation to a custom handler. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| AllowKeepAlive | Enables or disables keep-alive mode. |
| AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
| AuthBasic | Turns on/off the basic authentication. |
| AuthDigest | Turns on/off the digest authentication. |
| AuthDigestExpire | Specifies digest expiration time for digest authentication. |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
| CompressionLevel | The default compression level to use. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| HomePage | Specifies the home page resource name. |
| MajorProtocolVersion | Major protocol version on the KMIP server. |
| MinorProtocolVersion | Minor protocol version on the KMIP server. |
| OAuthAllowAccessByDefault | Specifies whether access to a resource is allowed by default. |
| OAuthAutoValidateTokens | Allows to validate OAuth 2.0 access tokens automatically. |
| OAuthIntrospectionClientID | Specifies a client ID on the authentication service. |
| OAuthIntrospectionClientSecret | Specifies a client secret on the authentication service. |
| OAuthIntrospectionURL | Specifies the URL to be used to introspect access tokens. |
| OAuthTokenValidationKeys | Specifies JW keys in JSON format for validating access token signatures. |
| RequestFilter | The request string modifier. |
| SSLMode | Whether to establish a TLS-secured connection. |
| UseChunkedTransfer | Whether to use chunked encoding of the data. |
| UseChunkedTransfer | Enables chunked transfer. |
| UseCompression | Whether to use GZip compression. |
| UseCompression | Enables or disables server-side compression. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
Active Property (KMIPServer Component)
Indicates if the KMIP server is active and listening to incoming connections.
Syntax
func (obj *KMIPServer) Active() (bool, error)
Default Value
false
Remarks
Check this property to find out if the KMIP server is in an active state. Use Start and Stop methods to launch and stop the server.
This property is read-only.
Data Type
bool
AllowKeepAlive Property (KMIPServer Component)
Enables or disables keep-alive mode.
Syntax
func (obj *KMIPServer) AllowKeepAlive() (bool, error)
func (obj *KMIPServer) SetAllowKeepAlive(value bool) error
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
bool
AuthRealm Property (KMIPServer Component)
Specifies authentication realm for digest and NTLM authentication.
Syntax
func (obj *KMIPServer) AuthRealm() (string, error)
func (obj *KMIPServer) SetAuthRealm(value string) error
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
Data Type
string
AuthTypes Property (KMIPServer Component)
Defines allowed HTTP authentication types.
Syntax
func (obj *KMIPServer) AuthTypes() (int32, error)
func (obj *KMIPServer) SetAuthTypes(value int32) error
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
int32
BoundPort Property (KMIPServer Component)
Indicates the bound listening port.
Syntax
func (obj *KMIPServer) BoundPort() (int32, error)
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 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.
Data Type
int32
CACertBytes Property (KMIPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *KMIPServer) CACertBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
CACertHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) CACertHandle() (int64, error)
func (obj *KMIPServer) SetCACertHandle(value int64) error
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
CertificateBytes Property (KMIPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *KMIPServer) CertificateBytes() ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
[]byte
CertificateHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) CertificateHandle() (int64, error)
func (obj *KMIPServer) SetCertificateHandle(value int64) error
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
CompressionLevel Property (KMIPServer Component)
The default compression level to use.
Syntax
func (obj *KMIPServer) CompressionLevel() (int32, error)
func (obj *KMIPServer) SetCompressionLevel(value int32) error
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
int32
ExternalCryptoAsyncDocumentID Property (KMIPServer Component)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
func (obj *KMIPServer) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *KMIPServer) SetExternalCryptoAsyncDocumentID(value string) error
Default Value
""
Remarks
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.
Data Type
string
ExternalCryptoCustomParams Property (KMIPServer Component)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
func (obj *KMIPServer) ExternalCryptoCustomParams() (string, error)
func (obj *KMIPServer) SetExternalCryptoCustomParams(value string) error
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
Data Type
string
ExternalCryptoData Property (KMIPServer Component)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
func (obj *KMIPServer) ExternalCryptoData() (string, error)
func (obj *KMIPServer) SetExternalCryptoData(value string) error
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
Data Type
string
ExternalCryptoExternalHashCalculation Property (KMIPServer Component)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
func (obj *KMIPServer) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *KMIPServer) SetExternalCryptoExternalHashCalculation(value bool) error
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.
If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
Data Type
bool
ExternalCryptoHashAlgorithm Property (KMIPServer Component)
Specifies the request's signature hash algorithm.
Syntax
func (obj *KMIPServer) ExternalCryptoHashAlgorithm() (string, error)
func (obj *KMIPServer) SetExternalCryptoHashAlgorithm(value string) error
Default Value
"SHA256"
Remarks
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 |
Data Type
string
ExternalCryptoKeyID Property (KMIPServer Component)
The ID of the pre-shared key used for DC request authentication.
Syntax
func (obj *KMIPServer) ExternalCryptoKeyID() (string, error)
func (obj *KMIPServer) SetExternalCryptoKeyID(value string) error
Default Value
""
Remarks
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 ExternalCryptoKeySecret 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:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
string
ExternalCryptoKeySecret Property (KMIPServer Component)
The pre-shared key used for DC request authentication.
Syntax
func (obj *KMIPServer) ExternalCryptoKeySecret() (string, error)
func (obj *KMIPServer) SetExternalCryptoKeySecret(value string) error
Default Value
""
Remarks
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 ExternalCryptoKeyID topic.
Data Type
string
ExternalCryptoMethod Property (KMIPServer Component)
Specifies the asynchronous signing method.
Syntax
func (obj *KMIPServer) ExternalCryptoMethod() (int32, error)
func (obj *KMIPServer) SetExternalCryptoMethod(value int32) error
Possible Values
0 // PKCS1
1 // PKCS7
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
Data Type
int32
ExternalCryptoMode Property (KMIPServer Component)
Specifies the external cryptography mode.
Syntax
func (obj *KMIPServer) ExternalCryptoMode() (int32, error)
func (obj *KMIPServer) SetExternalCryptoMode(value int32) error
Possible Values
0 // Default
1 // Disabled
2 // Generic
3 // DCAuth
4 // DCAuthJSON
Default Value
0
Remarks
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) |
Data Type
int32
ExternalCryptoPublicKeyAlgorithm Property (KMIPServer Component)
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
func (obj *KMIPServer) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *KMIPServer) SetExternalCryptoPublicKeyAlgorithm(value string) error
Default Value
""
Remarks
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 |
Data Type
string
FIPSMode Property (KMIPServer Component)
Reserved.
Syntax
func (obj *KMIPServer) FIPSMode() (bool, error)
func (obj *KMIPServer) SetFIPSMode(value bool) error
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
HandshakeTimeout Property (KMIPServer Component)
Specifies the handshake timeout in milliseconds.
Syntax
func (obj *KMIPServer) HandshakeTimeout() (int32, error)
func (obj *KMIPServer) SetHandshakeTimeout(value int32) error
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Data Type
int32
Host Property (KMIPServer Component)
Specifies the host name of the KMIP server.
Syntax
func (obj *KMIPServer) Host() (string, error)
func (obj *KMIPServer) SetHost(value string) error
Default Value
""
Remarks
Use this property to specify the address of the KMIP server.
Data Type
string
KeyAlgorithm Property (KMIPServer Component)
The algorithm of the cryptographic key.
Syntax
func (obj *KMIPServer) KeyAlgorithm() (string, error)
func (obj *KMIPServer) SetKeyAlgorithm(value string) error
Default Value
""
Remarks
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 |
Data Type
string
KeyBits Property (KMIPServer Component)
The length of the key in bits.
Syntax
func (obj *KMIPServer) KeyBits() (int32, error)
Default Value
0
Remarks
The length of the key in bits.
This property is read-only.
Data Type
int32
KeyCurve Property (KMIPServer Component)
This property specifies the name of the curve the EC key is built on.
Syntax
func (obj *KMIPServer) KeyCurve() (string, error)
func (obj *KMIPServer) SetKeyCurve(value string) error
Default Value
""
Remarks
This property specifies the name of the curve the EC key is built on.
Data Type
string
KeyExportable Property (KMIPServer Component)
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Syntax
func (obj *KMIPServer) KeyExportable() (bool, error)
Default Value
false
Remarks
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
This property is read-only.
Data Type
bool
KeyFingerprint Property (KMIPServer Component)
Contains the fingerprint (a hash imprint) of this key.
Syntax
func (obj *KMIPServer) KeyFingerprint() (string, error)
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this key.
This property is read-only.
Data Type
string
KeyHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) KeyHandle() (int64, error)
func (obj *KMIPServer) SetKeyHandle(value int64) error
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
int64
KeyID Property (KMIPServer Component)
Provides access to a storage-specific key identifier.
Syntax
func (obj *KMIPServer) KeyID() ([]byte, error)
func (obj *KMIPServer) SetKeyID(value []byte) error
Remarks
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).
Data Type
[]byte
KeyIV Property (KMIPServer Component)
The initialization vector (IV) of a symmetric key.
Syntax
func (obj *KMIPServer) KeyIV() ([]byte, error)
func (obj *KMIPServer) SetKeyIV(value []byte) error
Remarks
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.
Data Type
[]byte
KeyNonce Property (KMIPServer Component)
A nonce value associated with a key.
Syntax
func (obj *KMIPServer) KeyNonce() ([]byte, error)
func (obj *KMIPServer) SetKeyNonce(value []byte) error
Remarks
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
Data Type
[]byte
KeyPrivate Property (KMIPServer Component)
Returns True if the object hosts a private key, and False otherwise.
Syntax
func (obj *KMIPServer) KeyPrivate() (bool, error)
Default Value
false
Remarks
Returns True if the object hosts a private key, and False otherwise.
This property is read-only.
Data Type
bool
KeyPublic Property (KMIPServer Component)
Returns True if the object hosts a public key, and False otherwise.
Syntax
func (obj *KMIPServer) KeyPublic() (bool, error)
Default Value
false
Remarks
Returns True if the object hosts a public key, and False otherwise.
This property is read-only.
Data Type
bool
KeySubject Property (KMIPServer Component)
Returns the key subject.
Syntax
func (obj *KMIPServer) KeySubject() ([]byte, error)
func (obj *KMIPServer) SetKeySubject(value []byte) error
Remarks
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
Data Type
[]byte
KeySymmetric Property (KMIPServer Component)
Returns True if the object contains a symmetric key, and False otherwise.
Syntax
func (obj *KMIPServer) KeySymmetric() (bool, error)
Default Value
false
Remarks
Returns True if the object contains a symmetric key, and False otherwise.
This property is read-only.
Data Type
bool
KeyValid Property (KMIPServer Component)
Returns True if this key is valid.
Syntax
func (obj *KMIPServer) KeyValid() (bool, error)
Default Value
false
Remarks
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.
This property is read-only.
Data Type
bool
KeyValue Property (KMIPServer Component)
The byte array representation of the key value.
Syntax
func (obj *KMIPServer) KeyValue() ([]byte, error)
Remarks
The byte array representation of the key value. This may not be available for non-KeyExportable keys.
This property used to be called Key in SecureBlackbox versions 2024 and older.
This property is read-only.
Data Type
[]byte
PinnedClientAEADCipher Property (KMIPServer Component)
Indicates whether the encryption algorithm used is an AEAD cipher.
Syntax
func (obj *KMIPServer) PinnedClientAEADCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the encryption algorithm used is an AEAD cipher.
This property is read-only.
Data Type
bool
PinnedClientChainValidationDetails Property (KMIPServer Component)
The details of a certificate chain validation outcome.
Syntax
func (obj *KMIPServer) PinnedClientChainValidationDetails() (int32, error)
Default Value
0
Remarks
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 |
This property is read-only.
Data Type
int32
PinnedClientChainValidationResult Property (KMIPServer Component)
The outcome of a certificate chain validation routine.
Syntax
func (obj *KMIPServer) PinnedClientChainValidationResult() (int32, error)
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
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.
This property is read-only.
Data Type
int32
PinnedClientCiphersuite Property (KMIPServer Component)
The cipher suite employed by this connection.
Syntax
func (obj *KMIPServer) PinnedClientCiphersuite() (string, error)
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only.
Data Type
string
PinnedClientClientAuthenticated Property (KMIPServer Component)
Specifies whether client authentication was performed during this connection.
Syntax
func (obj *KMIPServer) PinnedClientClientAuthenticated() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only.
Data Type
bool
PinnedClientClientAuthRequested Property (KMIPServer Component)
Specifies whether client authentication was requested during this connection.
Syntax
func (obj *KMIPServer) PinnedClientClientAuthRequested() (bool, error)
Default Value
false
Remarks
Specifies whether client authentication was requested during this connection.
This property is read-only.
Data Type
bool
PinnedClientConnectionEstablished Property (KMIPServer Component)
Indicates whether the connection has been established fully.
Syntax
func (obj *KMIPServer) PinnedClientConnectionEstablished() (bool, error)
Default Value
false
Remarks
Indicates whether the connection has been established fully.
This property is read-only.
Data Type
bool
PinnedClientConnectionID Property (KMIPServer Component)
The unique identifier assigned to this connection.
Syntax
func (obj *KMIPServer) PinnedClientConnectionID() ([]byte, error)
Remarks
The unique identifier assigned to this connection.
This property is read-only.
Data Type
[]byte
PinnedClientDigestAlgorithm Property (KMIPServer Component)
The digest algorithm used in a TLS-enabled connection.
Syntax
func (obj *KMIPServer) PinnedClientDigestAlgorithm() (string, error)
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientEncryptionAlgorithm Property (KMIPServer Component)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
func (obj *KMIPServer) PinnedClientEncryptionAlgorithm() (string, error)
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientExportable Property (KMIPServer Component)
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
Syntax
func (obj *KMIPServer) PinnedClientExportable() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
This property is read-only.
Data Type
bool
PinnedClientGroup Property (KMIPServer Component)
The elliptic curve used in this connection.
Syntax
func (obj *KMIPServer) PinnedClientGroup() (string, error)
Default Value
""
Remarks
The elliptic curve used in this connection.
This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.
This property is read-only.
Data Type
string
PinnedClientID Property (KMIPServer Component)
The client connection's unique identifier.
Syntax
func (obj *KMIPServer) PinnedClientID() (int64, error)
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only.
Data Type
int64
PinnedClientKeyExchangeAlgorithm Property (KMIPServer Component)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
func (obj *KMIPServer) PinnedClientKeyExchangeAlgorithm() (string, error)
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only.
Data Type
string
PinnedClientKeyExchangeKeyBits Property (KMIPServer Component)
The length of the key exchange key of a TLS-enabled connection.
Syntax
func (obj *KMIPServer) PinnedClientKeyExchangeKeyBits() (int32, error)
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only.
Data Type
int32
PinnedClientPFSCipher Property (KMIPServer Component)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
func (obj *KMIPServer) PinnedClientPFSCipher() (bool, error)
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only.
Data Type
bool
PinnedClientPreSharedIdentity Property (KMIPServer Component)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *KMIPServer) PinnedClientPreSharedIdentity() (string, error)
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only.
Data Type
string
PinnedClientPreSharedIdentityHint Property (KMIPServer Component)
A hint professed by the server to help the client select the PSK identity to use.
Syntax
func (obj *KMIPServer) PinnedClientPreSharedIdentityHint() (string, error)
Default Value
""
Remarks
A hint professed by the server to help the client select the PSK identity to use.
This property is read-only.
Data Type
string
PinnedClientPublicKeyBits Property (KMIPServer Component)
The length of the public key.
Syntax
func (obj *KMIPServer) PinnedClientPublicKeyBits() (int32, error)
Default Value
0
Remarks
The length of the public key.
This property is read-only.
Data Type
int32
PinnedClientRemoteAddress Property (KMIPServer Component)
The client's IP address.
Syntax
func (obj *KMIPServer) PinnedClientRemoteAddress() (string, error)
Default Value
""
Remarks
The client's IP address.
This property is read-only.
Data Type
string
PinnedClientRemotePort Property (KMIPServer Component)
The remote port of the client connection.
Syntax
func (obj *KMIPServer) PinnedClientRemotePort() (int32, error)
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only.
Data Type
int32
PinnedClientResumedSession Property (KMIPServer Component)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
func (obj *KMIPServer) PinnedClientResumedSession() (bool, error)
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only.
Data Type
bool
PinnedClientSecureConnection Property (KMIPServer Component)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
func (obj *KMIPServer) PinnedClientSecureConnection() (bool, error)
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only.
Data Type
bool
PinnedClientServerAuthenticated Property (KMIPServer Component)
Indicates whether server authentication was performed during a TLS-enabled connection.
Syntax
func (obj *KMIPServer) PinnedClientServerAuthenticated() (bool, error)
Default Value
false
Remarks
Indicates whether server authentication was performed during a TLS-enabled connection.
This property is read-only.
Data Type
bool
PinnedClientSignatureAlgorithm Property (KMIPServer Component)
The signature algorithm used in a TLS handshake.
Syntax
func (obj *KMIPServer) PinnedClientSignatureAlgorithm() (string, error)
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only.
Data Type
string
PinnedClientSymmetricBlockSize Property (KMIPServer Component)
The block size of the symmetric algorithm used.
Syntax
func (obj *KMIPServer) PinnedClientSymmetricBlockSize() (int32, error)
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientSymmetricKeyBits Property (KMIPServer Component)
The key length of the symmetric algorithm used.
Syntax
func (obj *KMIPServer) PinnedClientSymmetricKeyBits() (int32, error)
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only.
Data Type
int32
PinnedClientTotalBytesReceived Property (KMIPServer Component)
The total number of bytes received over this connection.
Syntax
func (obj *KMIPServer) PinnedClientTotalBytesReceived() (int64, error)
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only.
Data Type
int64
PinnedClientTotalBytesSent Property (KMIPServer Component)
The total number of bytes sent over this connection.
Syntax
func (obj *KMIPServer) PinnedClientTotalBytesSent() (int64, error)
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only.
Data Type
int64
PinnedClientValidationLog Property (KMIPServer Component)
Contains the server certificate's chain validation log.
Syntax
func (obj *KMIPServer) PinnedClientValidationLog() (string, error)
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only.
Data Type
string
PinnedClientVersion Property (KMIPServer Component)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
func (obj *KMIPServer) PinnedClientVersion() (string, error)
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only.
Data Type
string
PinnedClientCertCount Property (KMIPServer Component)
The number of records in the PinnedClientCert arrays.
Syntax
func (obj *KMIPServer) PinnedClientCertCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCAKeyID
- PinnedClientCertFingerprint
- PinnedClientCertHandle
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertPublicKeyBytes
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only.
Data Type
int32
PinnedClientCertBytes Property (KMIPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *KMIPServer) PinnedClientCertBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertCAKeyID Property (KMIPServer Component)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
func (obj *KMIPServer) PinnedClientCertCAKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
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 generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertFingerprint Property (KMIPServer Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
func (obj *KMIPServer) PinnedClientCertFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) PinnedClientCertHandle(PinnedClientCertIndex int32) (int64, error)
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int64
PinnedClientCertIssuer Property (KMIPServer Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
func (obj *KMIPServer) PinnedClientCertIssuer(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertIssuerRDN Property (KMIPServer Component)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
func (obj *KMIPServer) PinnedClientCertIssuerRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyAlgorithm Property (KMIPServer Component)
Specifies the public key algorithm of this certificate.
Syntax
func (obj *KMIPServer) PinnedClientCertKeyAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
"0"
Remarks
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 PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyBits Property (KMIPServer Component)
Returns the length of the public key in bits.
Syntax
func (obj *KMIPServer) PinnedClientCertKeyBits(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
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 PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertKeyFingerprint Property (KMIPServer Component)
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
func (obj *KMIPServer) PinnedClientCertKeyFingerprint(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
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 PinnedClientCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertKeyUsage Property (KMIPServer Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
func (obj *KMIPServer) PinnedClientCertKeyUsage(PinnedClientCertIndex int32) (int32, error)
Default Value
0
Remarks
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 property before generating the certificate to propagate the key usage flags to the new certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
int32
PinnedClientCertPublicKeyBytes Property (KMIPServer Component)
Contains the certificate's public key in DER format.
Syntax
func (obj *KMIPServer) PinnedClientCertPublicKeyBytes(PinnedClientCertIndex int32) ([]byte, error)
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSelfSigned Property (KMIPServer Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
func (obj *KMIPServer) PinnedClientCertSelfSigned(PinnedClientCertIndex int32) (bool, error)
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
bool
PinnedClientCertSerialNumber Property (KMIPServer Component)
Returns the certificate's serial number.
Syntax
func (obj *KMIPServer) PinnedClientCertSerialNumber(PinnedClientCertIndex int32) ([]byte, error)
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSigAlgorithm Property (KMIPServer Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
func (obj *KMIPServer) PinnedClientCertSigAlgorithm(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubject Property (KMIPServer Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
func (obj *KMIPServer) PinnedClientCertSubject(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
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 PinnedClientCertSubjectRDN.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertSubjectKeyID Property (KMIPServer Component)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
func (obj *KMIPServer) PinnedClientCertSubjectKeyID(PinnedClientCertIndex int32) ([]byte, error)
Remarks
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 PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
[]byte
PinnedClientCertSubjectRDN Property (KMIPServer Component)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
func (obj *KMIPServer) PinnedClientCertSubjectRDN(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidFrom Property (KMIPServer Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
func (obj *KMIPServer) PinnedClientCertValidFrom(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
PinnedClientCertValidTo Property (KMIPServer Component)
The time point at which the certificate expires, in UTC.
Syntax
func (obj *KMIPServer) PinnedClientCertValidTo(PinnedClientCertIndex int32) (string, error)
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only.
Data Type
string
Port Property (KMIPServer Component)
A port to listen for connections on.
Syntax
func (obj *KMIPServer) Port() (int32, error)
func (obj *KMIPServer) SetPort(value int32) error
Default Value
5696
Remarks
Use this property to specify the listening port.
Data Type
int32
ReadOnly Property (KMIPServer Component)
Controls whether the server works in read-only mode.
Syntax
func (obj *KMIPServer) ReadOnly() (bool, error)
func (obj *KMIPServer) SetReadOnly(value bool) error
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.
Data Type
bool
SessionTimeout Property (KMIPServer Component)
Specifies the default session timeout value in milliseconds.
Syntax
func (obj *KMIPServer) SessionTimeout() (int32, error)
func (obj *KMIPServer) SetSessionTimeout(value int32) error
Default Value
360000
Remarks
Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.
Data Type
int32
SocketIncomingSpeedLimit Property (KMIPServer Component)
The maximum number of bytes to read from the socket, per second.
Syntax
func (obj *KMIPServer) SocketIncomingSpeedLimit() (int32, error)
func (obj *KMIPServer) SetSocketIncomingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
int32
SocketLocalAddress Property (KMIPServer Component)
The local network interface to bind the socket to.
Syntax
func (obj *KMIPServer) SocketLocalAddress() (string, error)
func (obj *KMIPServer) SetSocketLocalAddress(value string) error
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
string
SocketLocalPort Property (KMIPServer Component)
The local port number to bind the socket to.
Syntax
func (obj *KMIPServer) SocketLocalPort() (int32, error)
func (obj *KMIPServer) SetSocketLocalPort(value int32) error
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
int32
SocketOutgoingSpeedLimit Property (KMIPServer Component)
The maximum number of bytes to write to the socket, per second.
Syntax
func (obj *KMIPServer) SocketOutgoingSpeedLimit() (int32, error)
func (obj *KMIPServer) SetSocketOutgoingSpeedLimit(value int32) error
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
int32
SocketTimeout Property (KMIPServer Component)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
func (obj *KMIPServer) SocketTimeout() (int32, error)
func (obj *KMIPServer) SetSocketTimeout(value int32) error
Default Value
60000
Remarks
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).
Data Type
int32
SocketUseIPv6 Property (KMIPServer Component)
Enables or disables IP protocol version 6.
Syntax
func (obj *KMIPServer) SocketUseIPv6() (bool, error)
func (obj *KMIPServer) SetSocketUseIPv6(value bool) error
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
bool
StorageFileName Property (KMIPServer Component)
A path to the KMIP object database.
Syntax
func (obj *KMIPServer) StorageFileName() (string, error)
func (obj *KMIPServer) SetStorageFileName(value string) error
Default Value
""
Remarks
Assign the path to the database of objects managed by the KMIP server to this property.
Data Type
string
TLSServerCertCount Property (KMIPServer Component)
The number of records in the TLSServerCert arrays.
Syntax
func (obj *KMIPServer) TLSServerCertCount() (int32, error)
func (obj *KMIPServer) SetTLSServerCertCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.Data Type
int32
TLSServerCertBytes Property (KMIPServer Component)
Returns the raw certificate data in DER format.
Syntax
func (obj *KMIPServer) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)
Remarks
Returns the raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
[]byte
TLSServerCertHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)
func (obj *KMIPServer) SetTLSServerCertHandle(TLSServerCertIndex int32, value int64) error
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
Data Type
int64
TLSAutoValidateCertificates Property (KMIPServer Component)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
func (obj *KMIPServer) TLSAutoValidateCertificates() (bool, error)
func (obj *KMIPServer) SetTLSAutoValidateCertificates(value bool) error
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
bool
TLSBaseConfiguration Property (KMIPServer Component)
Selects the base configuration for the TLS settings.
Syntax
func (obj *KMIPServer) TLSBaseConfiguration() (int32, error)
func (obj *KMIPServer) SetTLSBaseConfiguration(value int32) error
Possible Values
0 // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure
Default Value
0
Remarks
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 |
Data Type
int32
TLSCiphersuites Property (KMIPServer Component)
A list of ciphersuites separated with commas or semicolons.
Syntax
func (obj *KMIPServer) TLSCiphersuites() (string, error)
func (obj *KMIPServer) SetTLSCiphersuites(value string) error
Default Value
""
Remarks
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 TLSBaseConfiguration. 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
Data Type
string
TLSClientAuth Property (KMIPServer Component)
Enables or disables certificate-based client authentication.
Syntax
func (obj *KMIPServer) TLSClientAuth() (int32, error)
func (obj *KMIPServer) SetTLSClientAuth(value int32) error
Possible Values
0 // NoAuth
1 // RequestCert
2 // RequireCert
Default Value
0
Remarks
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 |
Data Type
int32
TLSExtensions Property (KMIPServer Component)
Provides access to TLS extensions.
Syntax
func (obj *KMIPServer) TLSExtensions() (string, error)
func (obj *KMIPServer) SetTLSExtensions(value string) error
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
string
TLSForceResumeIfDestinationChanges Property (KMIPServer Component)
Whether to force TLS session resumption when the destination address changes.
Syntax
func (obj *KMIPServer) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *KMIPServer) SetTLSForceResumeIfDestinationChanges(value bool) error
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
bool
TLSGroups Property (KMIPServer Component)
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Syntax
func (obj *KMIPServer) TLSGroups() (string, error)
func (obj *KMIPServer) SetTLSGroups(value string) error
Default Value
""
Remarks
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:
// 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.
Data Type
string
TLSPreSharedIdentity Property (KMIPServer Component)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
func (obj *KMIPServer) TLSPreSharedIdentity() (string, error)
func (obj *KMIPServer) SetTLSPreSharedIdentity(value string) error
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Data Type
string
TLSPreSharedKey Property (KMIPServer Component)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
func (obj *KMIPServer) TLSPreSharedKey() (string, error)
func (obj *KMIPServer) SetTLSPreSharedKey(value string) error
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Data Type
string
TLSPreSharedKeyCiphersuite Property (KMIPServer Component)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
func (obj *KMIPServer) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *KMIPServer) SetTLSPreSharedKeyCiphersuite(value string) error
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
string
TLSRenegotiationAttackPreventionMode Property (KMIPServer Component)
Selects the renegotiation attack prevention mechanism.
Syntax
func (obj *KMIPServer) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *KMIPServer) SetTLSRenegotiationAttackPreventionMode(value int32) error
Possible Values
0 // Compatible
1 // Strict
2 // Auto
Default Value
2
Remarks
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. |
Data Type
int32
TLSRevocationCheck Property (KMIPServer Component)
Specifies the kind(s) of revocation check to perform.
Syntax
func (obj *KMIPServer) TLSRevocationCheck() (int32, error)
func (obj *KMIPServer) SetTLSRevocationCheck(value int32) error
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
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.
Data Type
int32
TLSSSLOptions Property (KMIPServer Component)
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.
Syntax
func (obj *KMIPServer) TLSSSLOptions() (int32, error)
func (obj *KMIPServer) SetTLSSSLOptions(value int32) error
Default Value
16
Remarks
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 |
Data Type
int32
TLSMode Property (KMIPServer Component)
Specifies the TLS mode to use.
Syntax
func (obj *KMIPServer) TLSMode() (int32, error)
func (obj *KMIPServer) SetTLSMode(value int32) error
Possible Values
0 // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // MixedTLS
Default Value
0
Remarks
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. |
Data Type
int32
TLSUseExtendedMasterSecret Property (KMIPServer Component)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
func (obj *KMIPServer) TLSUseExtendedMasterSecret() (bool, error)
func (obj *KMIPServer) SetTLSUseExtendedMasterSecret(value bool) error
Default Value
true
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
bool
TLSUseSessionResumption Property (KMIPServer Component)
Enables or disables the TLS session resumption capability.
Syntax
func (obj *KMIPServer) TLSUseSessionResumption() (bool, error)
func (obj *KMIPServer) SetTLSUseSessionResumption(value bool) error
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
bool
TLSVersions Property (KMIPServer Component)
The SSL/TLS versions to enable by default.
Syntax
func (obj *KMIPServer) TLSVersions() (int32, error)
func (obj *KMIPServer) SetTLSVersions(value int32) error
Default Value
48
Remarks
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 |
Data Type
int32
UseChunkedTransfer Property (KMIPServer Component)
Enables chunked transfer.
Syntax
func (obj *KMIPServer) UseChunkedTransfer() (bool, error)
func (obj *KMIPServer) SetUseChunkedTransfer(value bool) error
Default Value
false
Remarks
Use this property to enable chunked content encoding.
Data Type
bool
UseCompression Property (KMIPServer Component)
Enables or disables server-side compression.
Syntax
func (obj *KMIPServer) UseCompression() (bool, error)
func (obj *KMIPServer) SetUseCompression(value bool) error
Default Value
false
Remarks
Use this property to enable or disable server-side content compression.
Data Type
bool
UseHTTP Property (KMIPServer Component)
Specifies whether the server should use HTTP instead of KMIP-over-TCP/TLS.
Syntax
func (obj *KMIPServer) UseHTTP() (bool, error)
func (obj *KMIPServer) SetUseHTTP(value bool) error
Default Value
false
Remarks
Set this property to true to tell the server to expect HTTP(S) connections instead of TCP-based KMIP requests.
Data Type
bool
UserCount Property (KMIPServer Component)
The number of records in the User arrays.
Syntax
func (obj *KMIPServer) UserCount() (int32, error)
func (obj *KMIPServer) SetUserCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
- UserAssociatedData
- UserBasePath
- UserCertificate
- UserData
- UserEmail
- UserHandle
- UserHashAlgorithm
- UserIncomingSpeedLimit
- Username
- UserOtpAlgorithm
- UserOTPLen
- UserOtpValue
- UserOutgoingSpeedLimit
- UserPassword
- UserSharedSecret
- UserSSHKey
Data Type
int32
UserAssociatedData Property (KMIPServer Component)
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
func (obj *KMIPServer) UserAssociatedData(UserIndex int32) ([]byte, error)
func (obj *KMIPServer) SetUserAssociatedData(UserIndex int32, value []byte) error
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
UserBasePath Property (KMIPServer Component)
Base path for this user in the server's file system.
Syntax
func (obj *KMIPServer) UserBasePath(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUserBasePath(UserIndex int32, value string) error
Default Value
""
Remarks
Base path for this user in the server's file system.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserCertificate Property (KMIPServer Component)
Contains the user's certificate.
Syntax
func (obj *KMIPServer) UserCertificate(UserIndex int32) ([]byte, error)
func (obj *KMIPServer) SetUserCertificate(UserIndex int32, value []byte) error
Remarks
Contains the user's certificate.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
UserData Property (KMIPServer Component)
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
func (obj *KMIPServer) UserData(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUserData(UserIndex int32, value string) error
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserEmail Property (KMIPServer Component)
The user's email address.
Syntax
func (obj *KMIPServer) UserEmail(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUserEmail(UserIndex int32, value string) error
Default Value
""
Remarks
The user's email address.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserHandle Property (KMIPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
func (obj *KMIPServer) UserHandle(UserIndex int32) (int64, error)
func (obj *KMIPServer) SetUserHandle(UserIndex int32, value int64) error
Default Value
0
Remarks
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.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int64
UserHashAlgorithm Property (KMIPServer Component)
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
func (obj *KMIPServer) UserHashAlgorithm(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUserHashAlgorithm(UserIndex int32, value string) error
Default Value
""
Remarks
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 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserIncomingSpeedLimit Property (KMIPServer Component)
Specifies the incoming speed limit for this user.
Syntax
func (obj *KMIPServer) UserIncomingSpeedLimit(UserIndex int32) (int32, error)
func (obj *KMIPServer) SetUserIncomingSpeedLimit(UserIndex int32, value int32) error
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserOtpAlgorithm Property (KMIPServer Component)
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
func (obj *KMIPServer) UserOtpAlgorithm(UserIndex int32) (int32, error)
func (obj *KMIPServer) SetUserOtpAlgorithm(UserIndex int32, value int32) error
Possible Values
0 // None
1 // Hmac
2 // Time
Default Value
0
Remarks
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 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserOTPLen Property (KMIPServer Component)
Specifies the length of the user's OTP password.
Syntax
func (obj *KMIPServer) UserOTPLen(UserIndex int32) (int32, error)
func (obj *KMIPServer) SetUserOTPLen(UserIndex int32, value int32) error
Default Value
0
Remarks
Specifies the length of the user's OTP password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserOtpValue Property (KMIPServer Component)
The user's time interval (TOTP) or Counter (HOTP).
Syntax
func (obj *KMIPServer) UserOtpValue(UserIndex int32) (int32, error)
func (obj *KMIPServer) SetUserOtpValue(UserIndex int32, value int32) error
Default Value
0
Remarks
The user's time interval (TOTP) or Counter (HOTP).
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserOutgoingSpeedLimit Property (KMIPServer Component)
Specifies the outgoing speed limit for this user.
Syntax
func (obj *KMIPServer) UserOutgoingSpeedLimit(UserIndex int32) (int32, error)
func (obj *KMIPServer) SetUserOutgoingSpeedLimit(UserIndex int32, value int32) error
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
int32
UserPassword Property (KMIPServer Component)
The user's authentication password.
Syntax
func (obj *KMIPServer) UserPassword(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUserPassword(UserIndex int32, value string) error
Default Value
""
Remarks
The user's authentication password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
UserSharedSecret Property (KMIPServer Component)
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
func (obj *KMIPServer) UserSharedSecret(UserIndex int32) ([]byte, error)
func (obj *KMIPServer) SetUserSharedSecret(UserIndex int32, value []byte) error
Remarks
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.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
UserSSHKey Property (KMIPServer Component)
Contains the user's SSH key.
Syntax
func (obj *KMIPServer) UserSSHKey(UserIndex int32) ([]byte, error)
func (obj *KMIPServer) SetUserSSHKey(UserIndex int32, value []byte) error
Remarks
Contains the user's SSH key.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
[]byte
Username Property (KMIPServer Component)
The registered name (login) of the user.
Syntax
func (obj *KMIPServer) Username(UserIndex int32) (string, error)
func (obj *KMIPServer) SetUsername(UserIndex int32, value string) error
Default Value
""
Remarks
The registered name (login) of the user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
Data Type
string
Cleanup Method (KMIPServer Component)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
func (obj *KMIPServer) Cleanup() error
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.
Config Method (KMIPServer Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *KMIPServer) Config(ConfigurationString string) (string, error)
Remarks
Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (KMIPServer Component)
Performs an additional action.
Syntax
func (obj *KMIPServer) DoAction(ActionID string, ActionParams string) (string, error)
Remarks
DoAction is a generic method available in every struct. 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. |
DropClient Method (KMIPServer Component)
Terminates a client connection.
Syntax
func (obj *KMIPServer) DropClient(ConnectionId int64, Forced bool) error
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
GetClientCert Method (KMIPServer Component)
Populates the per-connection certificate object.
Syntax
func (obj *KMIPServer) GetClientCert(ConnectionID int64) error
Remarks
This method populates the certificate template/object received with the certificate generation request in Certificate property.
Call this method from your BeforeGenerate 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 event handler to populate the certificate that has been generated.
GetClientKey Method (KMIPServer Component)
Populates the per-connection key object.
Syntax
func (obj *KMIPServer) GetClientKey(ConnectionID int64) error
Remarks
This method populates the key template/object received with the key generation request in Key property.
Call this method from your BeforeGenerateKey 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 event handler to populate the key that has been generated.
GetRequestHeader Method (KMIPServer Component)
Returns a request header value.
Syntax
func (obj *KMIPServer) GetRequestHeader(ConnectionId int64, HeaderName string) (string, error)
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.
GetResponseHeader Method (KMIPServer Component)
Returns a response header value.
Syntax
func (obj *KMIPServer) GetResponseHeader(ConnectionId int64, HeaderName string) (string, error)
Remarks
Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.
ListClients Method (KMIPServer Component)
Enumerates the connected clients.
Syntax
func (obj *KMIPServer) ListClients() (string, error)
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.
PinClient Method (KMIPServer Component)
Takes a snapshot of the connection's properties.
Syntax
func (obj *KMIPServer) PinClient(ConnectionId int64) error
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
ProcessGenericRequest Method (KMIPServer Component)
Processes a generic HTTP request.
Syntax
func (obj *KMIPServer) ProcessGenericRequest(ConnectionId int64, RequestBytes []byte) ([]byte, error)
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.
Reset Method (KMIPServer Component)
Resets the class settings.
Syntax
func (obj *KMIPServer) Reset() error
Remarks
Reset is a generic method available in every struct.
SetClientBytes Method (KMIPServer Component)
Commits a data buffer to the connection.
Syntax
func (obj *KMIPServer) SetClientBytes(ConnectionID int64, Value []byte) error
Remarks
Use this method from your Response Encrypt AfterEncrypt Decrypt AfterDecrypt Sign AfterSign events handler to commit a new data to the server component.
SetClientCert Method (KMIPServer Component)
Commits the per-connection certificate object to the connection context.
Syntax
func (obj *KMIPServer) SetClientCert(ConnectionID int64) error
Remarks
This method commits the certificate object stored in Certificate to the connection context.
SetClientKey Method (KMIPServer Component)
Commits the per-connection key object to the connection context.
Syntax
func (obj *KMIPServer) SetClientKey(ConnectionID int64) error
Remarks
This method commits the key object stored in Key to the connection context.
SetResponseHeader Method (KMIPServer Component)
Sets a response header.
Syntax
func (obj *KMIPServer) SetResponseHeader(ConnectionId int64, HeaderName string, Value string) error
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.
Start Method (KMIPServer Component)
Start the KMIP server.
Syntax
func (obj *KMIPServer) Start() error
Remarks
Call this method to activate the KMIP server and start listening to incoming connections.
Stop Method (KMIPServer Component)
Stops the KMIP server.
Syntax
func (obj *KMIPServer) Stop() error
Remarks
Call this method to stop the KMIP server.
Accept Event (KMIPServer Component)
Reports an incoming connection.
Syntax
// KMIPServerAcceptEventArgs carries the KMIPServer Accept event's parameters.
type KMIPServerAcceptEventArgs struct {...}
func (args *KMIPServerAcceptEventArgs) RemoteAddress() string
func (args *KMIPServerAcceptEventArgs) RemotePort() int32
func (args *KMIPServerAcceptEventArgs) Accept() bool
func (args *KMIPServerAcceptEventArgs) SetAccept(value bool)
// KMIPServerAcceptEvent defines the signature of the KMIPServer Accept event's handler function.
type KMIPServerAcceptEvent func(sender *KMIPServer, args *KMIPServerAcceptEventArgs)
func (obj *KMIPServer) GetOnAcceptHandler() KMIPServerAcceptEvent
func (obj *KMIPServer) SetOnAcceptHandler(handlerFunc KMIPServerAcceptEvent)
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 event to be notified of every connection that has been set up.
ActivateObject Event (KMIPServer Component)
Notifies the application about the object activation request.
Syntax
// KMIPServerActivateObjectEventArgs carries the KMIPServer ActivateObject event's parameters.
type KMIPServerActivateObjectEventArgs struct {...}
func (args *KMIPServerActivateObjectEventArgs) ConnectionId() int64
func (args *KMIPServerActivateObjectEventArgs) ObjectId() string
func (args *KMIPServerActivateObjectEventArgs) OperationStatus() int32
func (args *KMIPServerActivateObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerActivateObjectEvent defines the signature of the KMIPServer ActivateObject event's handler function.
type KMIPServerActivateObjectEvent func(sender *KMIPServer, args *KMIPServerActivateObjectEventArgs)
func (obj *KMIPServer) GetOnActivateObjectHandler() KMIPServerActivateObjectEvent
func (obj *KMIPServer) SetOnActivateObjectHandler(handlerFunc KMIPServerActivateObjectEvent)
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 Component)
Passes the certificate import request to the application.
Syntax
// KMIPServerAddEventArgs carries the KMIPServer Add event's parameters.
type KMIPServerAddEventArgs struct {...}
func (args *KMIPServerAddEventArgs) ConnectionId() int64
func (args *KMIPServerAddEventArgs) Group() string
func (args *KMIPServerAddEventArgs) SetGroup(value string)
func (args *KMIPServerAddEventArgs) CertId() string
func (args *KMIPServerAddEventArgs) SetCertId(value string)
func (args *KMIPServerAddEventArgs) OperationStatus() int32
func (args *KMIPServerAddEventArgs) SetOperationStatus(value int32)
// KMIPServerAddEvent defines the signature of the KMIPServer Add event's handler function.
type KMIPServerAddEvent func(sender *KMIPServer, args *KMIPServerAddEventArgs)
func (obj *KMIPServer) GetOnAddHandler() KMIPServerAddEvent
func (obj *KMIPServer) SetOnAddHandler(handlerFunc KMIPServerAddEvent)
Remarks
The server uses this event to allow the application to customize a certificate import request. This request fires after BeforeAdd 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 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 Component)
Expects the application to handle the key import request.
Syntax
// KMIPServerAddKeyEventArgs carries the KMIPServer AddKey event's parameters.
type KMIPServerAddKeyEventArgs struct {...}
func (args *KMIPServerAddKeyEventArgs) ConnectionId() int64
func (args *KMIPServerAddKeyEventArgs) Group() string
func (args *KMIPServerAddKeyEventArgs) SetGroup(value string)
func (args *KMIPServerAddKeyEventArgs) KeyId() string
func (args *KMIPServerAddKeyEventArgs) SetKeyId(value string)
func (args *KMIPServerAddKeyEventArgs) OperationStatus() int32
func (args *KMIPServerAddKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerAddKeyEvent defines the signature of the KMIPServer AddKey event's handler function.
type KMIPServerAddKeyEvent func(sender *KMIPServer, args *KMIPServerAddKeyEventArgs)
func (obj *KMIPServer) GetOnAddKeyHandler() KMIPServerAddKeyEvent
func (obj *KMIPServer) SetOnAddKeyHandler(handlerFunc KMIPServerAddKeyEvent)
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 event.
The handler of this event should process the key data provided via the Key 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 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 Component)
Notifies the application about completion of the certificate import operation.
Syntax
// KMIPServerAfterAddEventArgs carries the KMIPServer AfterAdd event's parameters.
type KMIPServerAfterAddEventArgs struct {...}
func (args *KMIPServerAfterAddEventArgs) ConnectionId() int64
func (args *KMIPServerAfterAddEventArgs) Group() string
func (args *KMIPServerAfterAddEventArgs) SetGroup(value string)
func (args *KMIPServerAfterAddEventArgs) CertId() string
func (args *KMIPServerAfterAddEventArgs) SetCertId(value string)
func (args *KMIPServerAfterAddEventArgs) OperationStatus() int32
func (args *KMIPServerAfterAddEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterAddEvent defines the signature of the KMIPServer AfterAdd event's handler function.
type KMIPServerAfterAddEvent func(sender *KMIPServer, args *KMIPServerAfterAddEventArgs)
func (obj *KMIPServer) GetOnAfterAddHandler() KMIPServerAfterAddEvent
func (obj *KMIPServer) SetOnAfterAddHandler(handlerFunc KMIPServerAfterAddEvent)
Remarks
The struct fires this event upon completion of certificate import routine. The certificate object that has been generated can be read from the Certificate 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 Component)
Reports the completion of the key import procedure.
Syntax
// KMIPServerAfterAddKeyEventArgs carries the KMIPServer AfterAddKey event's parameters.
type KMIPServerAfterAddKeyEventArgs struct {...}
func (args *KMIPServerAfterAddKeyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterAddKeyEventArgs) Group() string
func (args *KMIPServerAfterAddKeyEventArgs) SetGroup(value string)
func (args *KMIPServerAfterAddKeyEventArgs) KeyId() string
func (args *KMIPServerAfterAddKeyEventArgs) SetKeyId(value string)
func (args *KMIPServerAfterAddKeyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterAddKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterAddKeyEvent defines the signature of the KMIPServer AfterAddKey event's handler function.
type KMIPServerAfterAddKeyEvent func(sender *KMIPServer, args *KMIPServerAfterAddKeyEventArgs)
func (obj *KMIPServer) GetOnAfterAddKeyHandler() KMIPServerAfterAddKeyEvent
func (obj *KMIPServer) SetOnAfterAddKeyHandler(handlerFunc KMIPServerAfterAddKeyEvent)
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 event. See the Three-step Virtualization 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 Component)
KMIP server uses this event to notify the application about the completion of the browsing (attribute request) operation.
Syntax
// KMIPServerAfterBrowseEventArgs carries the KMIPServer AfterBrowse event's parameters.
type KMIPServerAfterBrowseEventArgs struct {...}
func (args *KMIPServerAfterBrowseEventArgs) ConnectionID() int64
func (args *KMIPServerAfterBrowseEventArgs) ObjectId() string
func (args *KMIPServerAfterBrowseEventArgs) OperationStatus() int32
func (args *KMIPServerAfterBrowseEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterBrowseEvent defines the signature of the KMIPServer AfterBrowse event's handler function.
type KMIPServerAfterBrowseEvent func(sender *KMIPServer, args *KMIPServerAfterBrowseEventArgs)
func (obj *KMIPServer) GetOnAfterBrowseHandler() KMIPServerAfterBrowseEvent
func (obj *KMIPServer) SetOnAfterBrowseHandler(handlerFunc KMIPServerAfterBrowseEvent)
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 and ReadAttribute 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 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 Component)
Notifies the application about completion of the decryption call.
Syntax
// KMIPServerAfterDecryptEventArgs carries the KMIPServer AfterDecrypt event's parameters.
type KMIPServerAfterDecryptEventArgs struct {...}
func (args *KMIPServerAfterDecryptEventArgs) ConnectionId() int64
func (args *KMIPServerAfterDecryptEventArgs) ObjectId() string
func (args *KMIPServerAfterDecryptEventArgs) DecryptedData() []byte
func (args *KMIPServerAfterDecryptEventArgs) CorrelationValue() string
func (args *KMIPServerAfterDecryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterDecryptEventArgs) OperationStatus() int32
func (args *KMIPServerAfterDecryptEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterDecryptEvent defines the signature of the KMIPServer AfterDecrypt event's handler function.
type KMIPServerAfterDecryptEvent func(sender *KMIPServer, args *KMIPServerAfterDecryptEventArgs)
func (obj *KMIPServer) GetOnAfterDecryptHandler() KMIPServerAfterDecryptEvent
func (obj *KMIPServer) SetOnAfterDecryptHandler(handlerFunc KMIPServerAfterDecryptEvent)
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 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 Component)
Notifies the application about completion of the key derivation request.
Syntax
// KMIPServerAfterDeriveKeyEventArgs carries the KMIPServer AfterDeriveKey event's parameters.
type KMIPServerAfterDeriveKeyEventArgs struct {...}
func (args *KMIPServerAfterDeriveKeyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterDeriveKeyEventArgs) NewKeyId() string
func (args *KMIPServerAfterDeriveKeyEventArgs) SetNewKeyId(value string)
func (args *KMIPServerAfterDeriveKeyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterDeriveKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterDeriveKeyEvent defines the signature of the KMIPServer AfterDeriveKey event's handler function.
type KMIPServerAfterDeriveKeyEvent func(sender *KMIPServer, args *KMIPServerAfterDeriveKeyEventArgs)
func (obj *KMIPServer) GetOnAfterDeriveKeyHandler() KMIPServerAfterDeriveKeyEvent
func (obj *KMIPServer) SetOnAfterDeriveKeyHandler(handlerFunc KMIPServerAfterDeriveKeyEvent)
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 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 Component)
Notifies the application of completion of the object editing operation.
Syntax
// KMIPServerAfterEditEventArgs carries the KMIPServer AfterEdit event's parameters.
type KMIPServerAfterEditEventArgs struct {...}
func (args *KMIPServerAfterEditEventArgs) ConnectionID() int64
func (args *KMIPServerAfterEditEventArgs) ObjectId() string
func (args *KMIPServerAfterEditEventArgs) OperationStatus() int32
func (args *KMIPServerAfterEditEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterEditEvent defines the signature of the KMIPServer AfterEdit event's handler function.
type KMIPServerAfterEditEvent func(sender *KMIPServer, args *KMIPServerAfterEditEventArgs)
func (obj *KMIPServer) GetOnAfterEditHandler() KMIPServerAfterEditEvent
func (obj *KMIPServer) SetOnAfterEditHandler(handlerFunc KMIPServerAfterEditEvent)
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 Component)
Notifies the application about the completion of the encryption call.
Syntax
// KMIPServerAfterEncryptEventArgs carries the KMIPServer AfterEncrypt event's parameters.
type KMIPServerAfterEncryptEventArgs struct {...}
func (args *KMIPServerAfterEncryptEventArgs) ConnectionId() int64
func (args *KMIPServerAfterEncryptEventArgs) ObjectId() string
func (args *KMIPServerAfterEncryptEventArgs) EncryptedData() []byte
func (args *KMIPServerAfterEncryptEventArgs) CorrelationValue() string
func (args *KMIPServerAfterEncryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterEncryptEventArgs) OperationStatus() int32
func (args *KMIPServerAfterEncryptEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterEncryptEvent defines the signature of the KMIPServer AfterEncrypt event's handler function.
type KMIPServerAfterEncryptEvent func(sender *KMIPServer, args *KMIPServerAfterEncryptEventArgs)
func (obj *KMIPServer) GetOnAfterEncryptHandler() KMIPServerAfterEncryptEvent
func (obj *KMIPServer) SetOnAfterEncryptHandler(handlerFunc KMIPServerAfterEncryptEvent)
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 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 Component)
Signifies completion of certificate generation.
Syntax
// KMIPServerAfterGenerateEventArgs carries the KMIPServer AfterGenerate event's parameters.
type KMIPServerAfterGenerateEventArgs struct {...}
func (args *KMIPServerAfterGenerateEventArgs) ConnectionId() int64
func (args *KMIPServerAfterGenerateEventArgs) CertId() string
func (args *KMIPServerAfterGenerateEventArgs) SetCertId(value string)
func (args *KMIPServerAfterGenerateEventArgs) OperationStatus() int32
func (args *KMIPServerAfterGenerateEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterGenerateEvent defines the signature of the KMIPServer AfterGenerate event's handler function.
type KMIPServerAfterGenerateEvent func(sender *KMIPServer, args *KMIPServerAfterGenerateEventArgs)
func (obj *KMIPServer) GetOnAfterGenerateHandler() KMIPServerAfterGenerateEvent
func (obj *KMIPServer) SetOnAfterGenerateHandler(handlerFunc KMIPServerAfterGenerateEvent)
Remarks
The struct fires this event upon completion of certificate generation routine. The generated certificate can be read from Certificate.
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
AfterGenerateKey Event (KMIPServer Component)
Notifies the application of the completion of key generation procedure.
Syntax
// KMIPServerAfterGenerateKeyEventArgs carries the KMIPServer AfterGenerateKey event's parameters.
type KMIPServerAfterGenerateKeyEventArgs struct {...}
func (args *KMIPServerAfterGenerateKeyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterGenerateKeyEventArgs) KeyId() string
func (args *KMIPServerAfterGenerateKeyEventArgs) SetKeyId(value string)
func (args *KMIPServerAfterGenerateKeyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterGenerateKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterGenerateKeyEvent defines the signature of the KMIPServer AfterGenerateKey event's handler function.
type KMIPServerAfterGenerateKeyEvent func(sender *KMIPServer, args *KMIPServerAfterGenerateKeyEventArgs)
func (obj *KMIPServer) GetOnAfterGenerateKeyHandler() KMIPServerAfterGenerateKeyEvent
func (obj *KMIPServer) SetOnAfterGenerateKeyHandler(handlerFunc KMIPServerAfterGenerateKeyEvent)
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, GenerateKey, and the AfterGenerateKey events. See the Three-step Virtualization 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 Component)
Notifies the application of the completion of keypair generation.
Syntax
// KMIPServerAfterGenerateKeyPairEventArgs carries the KMIPServer AfterGenerateKeyPair event's parameters.
type KMIPServerAfterGenerateKeyPairEventArgs struct {...}
func (args *KMIPServerAfterGenerateKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerAfterGenerateKeyPairEventArgs) PrivateKeyId() string
func (args *KMIPServerAfterGenerateKeyPairEventArgs) SetPrivateKeyId(value string)
func (args *KMIPServerAfterGenerateKeyPairEventArgs) PublicKeyId() string
func (args *KMIPServerAfterGenerateKeyPairEventArgs) SetPublicKeyId(value string)
func (args *KMIPServerAfterGenerateKeyPairEventArgs) OperationStatus() int32
func (args *KMIPServerAfterGenerateKeyPairEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterGenerateKeyPairEvent defines the signature of the KMIPServer AfterGenerateKeyPair event's handler function.
type KMIPServerAfterGenerateKeyPairEvent func(sender *KMIPServer, args *KMIPServerAfterGenerateKeyPairEventArgs)
func (obj *KMIPServer) GetOnAfterGenerateKeyPairHandler() KMIPServerAfterGenerateKeyPairEvent
func (obj *KMIPServer) SetOnAfterGenerateKeyPairHandler(handlerFunc KMIPServerAfterGenerateKeyPairEvent)
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 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 Component)
Notifies the application about completion of the hashing call.
Syntax
// KMIPServerAfterHashEventArgs carries the KMIPServer AfterHash event's parameters.
type KMIPServerAfterHashEventArgs struct {...}
func (args *KMIPServerAfterHashEventArgs) ConnectionId() int64
func (args *KMIPServerAfterHashEventArgs) ObjectId() string
func (args *KMIPServerAfterHashEventArgs) HashData() []byte
func (args *KMIPServerAfterHashEventArgs) CorrelationValue() string
func (args *KMIPServerAfterHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterHashEventArgs) OperationStatus() int32
func (args *KMIPServerAfterHashEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterHashEvent defines the signature of the KMIPServer AfterHash event's handler function.
type KMIPServerAfterHashEvent func(sender *KMIPServer, args *KMIPServerAfterHashEventArgs)
func (obj *KMIPServer) GetOnAfterHashHandler() KMIPServerAfterHashEvent
func (obj *KMIPServer) SetOnAfterHashHandler(handlerFunc KMIPServerAfterHashEvent)
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 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 Component)
Notifies the application about completion of the list command.
Syntax
// KMIPServerAfterListEventArgs carries the KMIPServer AfterList event's parameters.
type KMIPServerAfterListEventArgs struct {...}
func (args *KMIPServerAfterListEventArgs) ConnectionId() int64
func (args *KMIPServerAfterListEventArgs) ObjectType() int32
func (args *KMIPServerAfterListEventArgs) ObjectStatus() int32
func (args *KMIPServerAfterListEventArgs) OnlyFreshObjects() bool
func (args *KMIPServerAfterListEventArgs) ObjectIds() string
func (args *KMIPServerAfterListEventArgs) SetObjectIds(value string)
func (args *KMIPServerAfterListEventArgs) OperationStatus() int32
func (args *KMIPServerAfterListEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterListEvent defines the signature of the KMIPServer AfterList event's handler function.
type KMIPServerAfterListEvent func(sender *KMIPServer, args *KMIPServerAfterListEventArgs)
func (obj *KMIPServer) GetOnAfterListHandler() KMIPServerAfterListEvent
func (obj *KMIPServer) SetOnAfterListHandler(handlerFunc KMIPServerAfterListEvent)
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 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 Component)
Reports the completion of lease allocation operation.
Syntax
// KMIPServerAfterObtainLeaseEventArgs carries the KMIPServer AfterObtainLease event's parameters.
type KMIPServerAfterObtainLeaseEventArgs struct {...}
func (args *KMIPServerAfterObtainLeaseEventArgs) ConnectionId() int64
func (args *KMIPServerAfterObtainLeaseEventArgs) ObjectId() string
func (args *KMIPServerAfterObtainLeaseEventArgs) LeaseTime() int32
func (args *KMIPServerAfterObtainLeaseEventArgs) SetLeaseTime(value int32)
func (args *KMIPServerAfterObtainLeaseEventArgs) LastChangeDate() string
func (args *KMIPServerAfterObtainLeaseEventArgs) SetLastChangeDate(value string)
func (args *KMIPServerAfterObtainLeaseEventArgs) OperationStatus() int32
func (args *KMIPServerAfterObtainLeaseEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterObtainLeaseEvent defines the signature of the KMIPServer AfterObtainLease event's handler function.
type KMIPServerAfterObtainLeaseEvent func(sender *KMIPServer, args *KMIPServerAfterObtainLeaseEventArgs)
func (obj *KMIPServer) GetOnAfterObtainLeaseHandler() KMIPServerAfterObtainLeaseEvent
func (obj *KMIPServer) SetOnAfterObtainLeaseHandler(handlerFunc KMIPServerAfterObtainLeaseEvent)
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 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 Component)
Notifies the application of the completion of the read operation on the object.
Syntax
// KMIPServerAfterReadObjectEventArgs carries the KMIPServer AfterReadObject event's parameters.
type KMIPServerAfterReadObjectEventArgs struct {...}
func (args *KMIPServerAfterReadObjectEventArgs) ConnectionId() int64
func (args *KMIPServerAfterReadObjectEventArgs) ObjectId() string
func (args *KMIPServerAfterReadObjectEventArgs) ObjectType() int32
func (args *KMIPServerAfterReadObjectEventArgs) OperationStatus() int32
func (args *KMIPServerAfterReadObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterReadObjectEvent defines the signature of the KMIPServer AfterReadObject event's handler function.
type KMIPServerAfterReadObjectEvent func(sender *KMIPServer, args *KMIPServerAfterReadObjectEventArgs)
func (obj *KMIPServer) GetOnAfterReadObjectHandler() KMIPServerAfterReadObjectEvent
func (obj *KMIPServer) SetOnAfterReadObjectHandler(handlerFunc KMIPServerAfterReadObjectEvent)
Remarks
Use this event to be notified about completion of the read operation.
See the Three-step Virtualization 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 Component)
Notifies the application about the completion of the re-certify operation.
Syntax
// KMIPServerAfterReCertifyEventArgs carries the KMIPServer AfterReCertify event's parameters.
type KMIPServerAfterReCertifyEventArgs struct {...}
func (args *KMIPServerAfterReCertifyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterReCertifyEventArgs) NewCertId() string
func (args *KMIPServerAfterReCertifyEventArgs) SetNewCertId(value string)
func (args *KMIPServerAfterReCertifyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterReCertifyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterReCertifyEvent defines the signature of the KMIPServer AfterReCertify event's handler function.
type KMIPServerAfterReCertifyEvent func(sender *KMIPServer, args *KMIPServerAfterReCertifyEventArgs)
func (obj *KMIPServer) GetOnAfterReCertifyHandler() KMIPServerAfterReCertifyEvent
func (obj *KMIPServer) SetOnAfterReCertifyHandler(handlerFunc KMIPServerAfterReCertifyEvent)
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 Component)
Notifies the application about the completion of the re-key operation.
Syntax
// KMIPServerAfterReKeyEventArgs carries the KMIPServer AfterReKey event's parameters.
type KMIPServerAfterReKeyEventArgs struct {...}
func (args *KMIPServerAfterReKeyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterReKeyEventArgs) NewKeyId() string
func (args *KMIPServerAfterReKeyEventArgs) SetNewKeyId(value string)
func (args *KMIPServerAfterReKeyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterReKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterReKeyEvent defines the signature of the KMIPServer AfterReKey event's handler function.
type KMIPServerAfterReKeyEvent func(sender *KMIPServer, args *KMIPServerAfterReKeyEventArgs)
func (obj *KMIPServer) GetOnAfterReKeyHandler() KMIPServerAfterReKeyEvent
func (obj *KMIPServer) SetOnAfterReKeyHandler(handlerFunc KMIPServerAfterReKeyEvent)
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 Component)
Notifies the application about the completion of the re-key keypair operation.
Syntax
// KMIPServerAfterRekeyKeyPairEventArgs carries the KMIPServer AfterRekeyKeyPair event's parameters.
type KMIPServerAfterRekeyKeyPairEventArgs struct {...}
func (args *KMIPServerAfterRekeyKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerAfterRekeyKeyPairEventArgs) NewPrivateKeyId() string
func (args *KMIPServerAfterRekeyKeyPairEventArgs) SetNewPrivateKeyId(value string)
func (args *KMIPServerAfterRekeyKeyPairEventArgs) NewPublicKeyId() string
func (args *KMIPServerAfterRekeyKeyPairEventArgs) SetNewPublicKeyId(value string)
func (args *KMIPServerAfterRekeyKeyPairEventArgs) OperationStatus() int32
func (args *KMIPServerAfterRekeyKeyPairEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterRekeyKeyPairEvent defines the signature of the KMIPServer AfterRekeyKeyPair event's handler function.
type KMIPServerAfterRekeyKeyPairEvent func(sender *KMIPServer, args *KMIPServerAfterRekeyKeyPairEventArgs)
func (obj *KMIPServer) GetOnAfterRekeyKeyPairHandler() KMIPServerAfterRekeyKeyPairEvent
func (obj *KMIPServer) SetOnAfterRekeyKeyPairHandler(handlerFunc KMIPServerAfterRekeyKeyPairEvent)
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 Component)
Notifies the application about completion of the object removal request.
Syntax
// KMIPServerAfterRemoveObjectEventArgs carries the KMIPServer AfterRemoveObject event's parameters.
type KMIPServerAfterRemoveObjectEventArgs struct {...}
func (args *KMIPServerAfterRemoveObjectEventArgs) ConnectionId() int64
func (args *KMIPServerAfterRemoveObjectEventArgs) ObjectId() string
func (args *KMIPServerAfterRemoveObjectEventArgs) OperationStatus() int32
func (args *KMIPServerAfterRemoveObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterRemoveObjectEvent defines the signature of the KMIPServer AfterRemoveObject event's handler function.
type KMIPServerAfterRemoveObjectEvent func(sender *KMIPServer, args *KMIPServerAfterRemoveObjectEventArgs)
func (obj *KMIPServer) GetOnAfterRemoveObjectHandler() KMIPServerAfterRemoveObjectEvent
func (obj *KMIPServer) SetOnAfterRemoveObjectHandler(handlerFunc KMIPServerAfterRemoveObjectEvent)
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 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 Component)
Notifies the application of completion of a signing operation.
Syntax
// KMIPServerAfterSignEventArgs carries the KMIPServer AfterSign event's parameters.
type KMIPServerAfterSignEventArgs struct {...}
func (args *KMIPServerAfterSignEventArgs) ConnectionId() int64
func (args *KMIPServerAfterSignEventArgs) ObjectId() string
func (args *KMIPServerAfterSignEventArgs) InputIsHash() bool
func (args *KMIPServerAfterSignEventArgs) SignatureData() []byte
func (args *KMIPServerAfterSignEventArgs) CorrelationValue() string
func (args *KMIPServerAfterSignEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterSignEventArgs) OperationStatus() int32
func (args *KMIPServerAfterSignEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterSignEvent defines the signature of the KMIPServer AfterSign event's handler function.
type KMIPServerAfterSignEvent func(sender *KMIPServer, args *KMIPServerAfterSignEventArgs)
func (obj *KMIPServer) GetOnAfterSignHandler() KMIPServerAfterSignEvent
func (obj *KMIPServer) SetOnAfterSignHandler(handlerFunc KMIPServerAfterSignEvent)
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 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 Component)
Notifies the application about completion of the Verify operation.
Syntax
// KMIPServerAfterVerifyEventArgs carries the KMIPServer AfterVerify event's parameters.
type KMIPServerAfterVerifyEventArgs struct {...}
func (args *KMIPServerAfterVerifyEventArgs) ConnectionId() int64
func (args *KMIPServerAfterVerifyEventArgs) ObjectId() string
func (args *KMIPServerAfterVerifyEventArgs) InputIsHash() bool
func (args *KMIPServerAfterVerifyEventArgs) ValidationResult() int32
func (args *KMIPServerAfterVerifyEventArgs) SetValidationResult(value int32)
func (args *KMIPServerAfterVerifyEventArgs) CorrelationValue() string
func (args *KMIPServerAfterVerifyEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterVerifyEventArgs) OperationStatus() int32
func (args *KMIPServerAfterVerifyEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterVerifyEvent defines the signature of the KMIPServer AfterVerify event's handler function.
type KMIPServerAfterVerifyEvent func(sender *KMIPServer, args *KMIPServerAfterVerifyEventArgs)
func (obj *KMIPServer) GetOnAfterVerifyHandler() KMIPServerAfterVerifyEvent
func (obj *KMIPServer) SetOnAfterVerifyHandler(handlerFunc KMIPServerAfterVerifyEvent)
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 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 Component)
Notifies the application about completion of the hash verification.
Syntax
// KMIPServerAfterVerifyHashEventArgs carries the KMIPServer AfterVerifyHash event's parameters.
type KMIPServerAfterVerifyHashEventArgs struct {...}
func (args *KMIPServerAfterVerifyHashEventArgs) ConnectionId() int64
func (args *KMIPServerAfterVerifyHashEventArgs) ObjectId() string
func (args *KMIPServerAfterVerifyHashEventArgs) IsValid() bool
func (args *KMIPServerAfterVerifyHashEventArgs) SetIsValid(value bool)
func (args *KMIPServerAfterVerifyHashEventArgs) CorrelationValue() string
func (args *KMIPServerAfterVerifyHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerAfterVerifyHashEventArgs) OperationStatus() int32
func (args *KMIPServerAfterVerifyHashEventArgs) SetOperationStatus(value int32)
// KMIPServerAfterVerifyHashEvent defines the signature of the KMIPServer AfterVerifyHash event's handler function.
type KMIPServerAfterVerifyHashEvent func(sender *KMIPServer, args *KMIPServerAfterVerifyHashEventArgs)
func (obj *KMIPServer) GetOnAfterVerifyHashHandler() KMIPServerAfterVerifyHashEvent
func (obj *KMIPServer) SetOnAfterVerifyHashHandler(handlerFunc KMIPServerAfterVerifyHashEvent)
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 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 Component)
Notifies the application about the received object archival request.
Syntax
// KMIPServerArchiveObjectEventArgs carries the KMIPServer ArchiveObject event's parameters.
type KMIPServerArchiveObjectEventArgs struct {...}
func (args *KMIPServerArchiveObjectEventArgs) ConnectionId() int64
func (args *KMIPServerArchiveObjectEventArgs) ObjectId() string
func (args *KMIPServerArchiveObjectEventArgs) OperationStatus() int32
func (args *KMIPServerArchiveObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerArchiveObjectEvent defines the signature of the KMIPServer ArchiveObject event's handler function.
type KMIPServerArchiveObjectEvent func(sender *KMIPServer, args *KMIPServerArchiveObjectEventArgs)
func (obj *KMIPServer) GetOnArchiveObjectHandler() KMIPServerArchiveObjectEvent
func (obj *KMIPServer) SetOnArchiveObjectHandler(handlerFunc KMIPServerArchiveObjectEvent)
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 Component)
Fires when a connected client makes an authentication attempt.
Syntax
// KMIPServerAuthAttemptEventArgs carries the KMIPServer AuthAttempt event's parameters.
type KMIPServerAuthAttemptEventArgs struct {...}
func (args *KMIPServerAuthAttemptEventArgs) ConnectionID() int64
func (args *KMIPServerAuthAttemptEventArgs) HTTPMethod() string
func (args *KMIPServerAuthAttemptEventArgs) URI() string
func (args *KMIPServerAuthAttemptEventArgs) AuthMethod() string
func (args *KMIPServerAuthAttemptEventArgs) Username() string
func (args *KMIPServerAuthAttemptEventArgs) Password() string
func (args *KMIPServerAuthAttemptEventArgs) Allow() bool
func (args *KMIPServerAuthAttemptEventArgs) SetAllow(value bool)
// KMIPServerAuthAttemptEvent defines the signature of the KMIPServer AuthAttempt event's handler function.
type KMIPServerAuthAttemptEvent func(sender *KMIPServer, args *KMIPServerAuthAttemptEventArgs)
func (obj *KMIPServer) GetOnAuthAttemptHandler() KMIPServerAuthAttemptEvent
func (obj *KMIPServer) SetOnAuthAttemptHandler(handlerFunc KMIPServerAuthAttemptEvent)
Remarks
The struct 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 Component)
Fires when a certificate import request is received from a client.
Syntax
// KMIPServerBeforeAddEventArgs carries the KMIPServer BeforeAdd event's parameters.
type KMIPServerBeforeAddEventArgs struct {...}
func (args *KMIPServerBeforeAddEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeAddEventArgs) Group() string
func (args *KMIPServerBeforeAddEventArgs) SetGroup(value string)
func (args *KMIPServerBeforeAddEventArgs) Action() int32
func (args *KMIPServerBeforeAddEventArgs) SetAction(value int32)
// KMIPServerBeforeAddEvent defines the signature of the KMIPServer BeforeAdd event's handler function.
type KMIPServerBeforeAddEvent func(sender *KMIPServer, args *KMIPServerBeforeAddEventArgs)
func (obj *KMIPServer) GetOnBeforeAddHandler() KMIPServerBeforeAddEvent
func (obj *KMIPServer) SetOnBeforeAddHandler(handlerFunc KMIPServerBeforeAddEvent)
Remarks
The struct 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 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 Component)
Fires when a key import request is received from the client.
Syntax
// KMIPServerBeforeAddKeyEventArgs carries the KMIPServer BeforeAddKey event's parameters.
type KMIPServerBeforeAddKeyEventArgs struct {...}
func (args *KMIPServerBeforeAddKeyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeAddKeyEventArgs) Group() string
func (args *KMIPServerBeforeAddKeyEventArgs) SetGroup(value string)
func (args *KMIPServerBeforeAddKeyEventArgs) Action() int32
func (args *KMIPServerBeforeAddKeyEventArgs) SetAction(value int32)
// KMIPServerBeforeAddKeyEvent defines the signature of the KMIPServer BeforeAddKey event's handler function.
type KMIPServerBeforeAddKeyEvent func(sender *KMIPServer, args *KMIPServerBeforeAddKeyEventArgs)
func (obj *KMIPServer) GetOnBeforeAddKeyHandler() KMIPServerBeforeAddKeyEvent
func (obj *KMIPServer) SetOnBeforeAddKeyHandler(handlerFunc KMIPServerBeforeAddKeyEvent)
Remarks
The struct 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 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 Component)
Notifies the application about the browse request being received.
Syntax
// KMIPServerBeforeBrowseEventArgs carries the KMIPServer BeforeBrowse event's parameters.
type KMIPServerBeforeBrowseEventArgs struct {...}
func (args *KMIPServerBeforeBrowseEventArgs) ConnectionID() int64
func (args *KMIPServerBeforeBrowseEventArgs) ObjectId() string
func (args *KMIPServerBeforeBrowseEventArgs) Action() int32
func (args *KMIPServerBeforeBrowseEventArgs) SetAction(value int32)
// KMIPServerBeforeBrowseEvent defines the signature of the KMIPServer BeforeBrowse event's handler function.
type KMIPServerBeforeBrowseEvent func(sender *KMIPServer, args *KMIPServerBeforeBrowseEventArgs)
func (obj *KMIPServer) GetOnBeforeBrowseHandler() KMIPServerBeforeBrowseEvent
func (obj *KMIPServer) SetOnBeforeBrowseHandler(handlerFunc KMIPServerBeforeBrowseEvent)
Remarks
The component uses this event to notify the application about a browse request received for an object ObjectId.
BeforeDecrypt Event (KMIPServer Component)
Notifies the application about the initiation of the decryption operation.
Syntax
// KMIPServerBeforeDecryptEventArgs carries the KMIPServer BeforeDecrypt event's parameters.
type KMIPServerBeforeDecryptEventArgs struct {...}
func (args *KMIPServerBeforeDecryptEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeDecryptEventArgs) ObjectId() string
func (args *KMIPServerBeforeDecryptEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeDecryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeDecryptEventArgs) Action() int32
func (args *KMIPServerBeforeDecryptEventArgs) SetAction(value int32)
// KMIPServerBeforeDecryptEvent defines the signature of the KMIPServer BeforeDecrypt event's handler function.
type KMIPServerBeforeDecryptEvent func(sender *KMIPServer, args *KMIPServerBeforeDecryptEventArgs)
func (obj *KMIPServer) GetOnBeforeDecryptHandler() KMIPServerBeforeDecryptEvent
func (obj *KMIPServer) SetOnBeforeDecryptHandler(handlerFunc KMIPServerBeforeDecryptEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
BeforeDeriveKey Event (KMIPServer Component)
Fires when a derive key request is received.
Syntax
// KMIPServerBeforeDeriveKeyEventArgs carries the KMIPServer BeforeDeriveKey event's parameters.
type KMIPServerBeforeDeriveKeyEventArgs struct {...}
func (args *KMIPServerBeforeDeriveKeyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeDeriveKeyEventArgs) ObjectType() int32
func (args *KMIPServerBeforeDeriveKeyEventArgs) ObjectIds() string
func (args *KMIPServerBeforeDeriveKeyEventArgs) DerivationMethod() string
func (args *KMIPServerBeforeDeriveKeyEventArgs) Action() int32
func (args *KMIPServerBeforeDeriveKeyEventArgs) SetAction(value int32)
// KMIPServerBeforeDeriveKeyEvent defines the signature of the KMIPServer BeforeDeriveKey event's handler function.
type KMIPServerBeforeDeriveKeyEvent func(sender *KMIPServer, args *KMIPServerBeforeDeriveKeyEventArgs)
func (obj *KMIPServer) GetOnBeforeDeriveKeyHandler() KMIPServerBeforeDeriveKeyEvent
func (obj *KMIPServer) SetOnBeforeDeriveKeyHandler(handlerFunc KMIPServerBeforeDeriveKeyEvent)
Remarks
The struct fires this event when it receives a request from the client to derive a key. The supplied certificate is available in Key.
BeforeEdit Event (KMIPServer Component)
Notifies the application about the start of the object editing operation.
Syntax
// KMIPServerBeforeEditEventArgs carries the KMIPServer BeforeEdit event's parameters.
type KMIPServerBeforeEditEventArgs struct {...}
func (args *KMIPServerBeforeEditEventArgs) ConnectionID() int64
func (args *KMIPServerBeforeEditEventArgs) ObjectId() string
func (args *KMIPServerBeforeEditEventArgs) Action() int32
func (args *KMIPServerBeforeEditEventArgs) SetAction(value int32)
// KMIPServerBeforeEditEvent defines the signature of the KMIPServer BeforeEdit event's handler function.
type KMIPServerBeforeEditEvent func(sender *KMIPServer, args *KMIPServerBeforeEditEventArgs)
func (obj *KMIPServer) GetOnBeforeEditHandler() KMIPServerBeforeEditEvent
func (obj *KMIPServer) SetOnBeforeEditHandler(handlerFunc KMIPServerBeforeEditEvent)
Remarks
The editing operation consists of a sequence of attribute update requests. Each attribute is provided to the application via an individual SetAttribute call. When the list of supplied attributes has been exhausted, the AfterEdit event call follows.
The ObjectId parameter specifies the identifier of the object being edited.
BeforeEncrypt Event (KMIPServer Component)
Notifies the application about the initiation of an encryption operation.
Syntax
// KMIPServerBeforeEncryptEventArgs carries the KMIPServer BeforeEncrypt event's parameters.
type KMIPServerBeforeEncryptEventArgs struct {...}
func (args *KMIPServerBeforeEncryptEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeEncryptEventArgs) ObjectId() string
func (args *KMIPServerBeforeEncryptEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeEncryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeEncryptEventArgs) Action() int32
func (args *KMIPServerBeforeEncryptEventArgs) SetAction(value int32)
// KMIPServerBeforeEncryptEvent defines the signature of the KMIPServer BeforeEncrypt event's handler function.
type KMIPServerBeforeEncryptEvent func(sender *KMIPServer, args *KMIPServerBeforeEncryptEventArgs)
func (obj *KMIPServer) GetOnBeforeEncryptHandler() KMIPServerBeforeEncryptEvent
func (obj *KMIPServer) SetOnBeforeEncryptHandler(handlerFunc KMIPServerBeforeEncryptEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
BeforeGenerate Event (KMIPServer Component)
Fires when a certificate generation request is received.
Syntax
// KMIPServerBeforeGenerateEventArgs carries the KMIPServer BeforeGenerate event's parameters.
type KMIPServerBeforeGenerateEventArgs struct {...}
func (args *KMIPServerBeforeGenerateEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeGenerateEventArgs) PublicKeyId() string
func (args *KMIPServerBeforeGenerateEventArgs) Action() int32
func (args *KMIPServerBeforeGenerateEventArgs) SetAction(value int32)
// KMIPServerBeforeGenerateEvent defines the signature of the KMIPServer BeforeGenerate event's handler function.
type KMIPServerBeforeGenerateEvent func(sender *KMIPServer, args *KMIPServerBeforeGenerateEventArgs)
func (obj *KMIPServer) GetOnBeforeGenerateHandler() KMIPServerBeforeGenerateEvent
func (obj *KMIPServer) SetOnBeforeGenerateHandler(handlerFunc KMIPServerBeforeGenerateEvent)
Remarks
The struct fires this event when it receives a request from the client to generate a certificate. The supplied certificate template is available in Certificate.
BeforeGenerateKey Event (KMIPServer Component)
Fires when a key generation request is received.
Syntax
// KMIPServerBeforeGenerateKeyEventArgs carries the KMIPServer BeforeGenerateKey event's parameters.
type KMIPServerBeforeGenerateKeyEventArgs struct {...}
func (args *KMIPServerBeforeGenerateKeyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeGenerateKeyEventArgs) KeyAlgorithm() string
func (args *KMIPServerBeforeGenerateKeyEventArgs) SetKeyAlgorithm(value string)
func (args *KMIPServerBeforeGenerateKeyEventArgs) KeyLength() int32
func (args *KMIPServerBeforeGenerateKeyEventArgs) SetKeyLength(value int32)
func (args *KMIPServerBeforeGenerateKeyEventArgs) Action() int32
func (args *KMIPServerBeforeGenerateKeyEventArgs) SetAction(value int32)
// KMIPServerBeforeGenerateKeyEvent defines the signature of the KMIPServer BeforeGenerateKey event's handler function.
type KMIPServerBeforeGenerateKeyEvent func(sender *KMIPServer, args *KMIPServerBeforeGenerateKeyEventArgs)
func (obj *KMIPServer) GetOnBeforeGenerateKeyHandler() KMIPServerBeforeGenerateKeyEvent
func (obj *KMIPServer) SetOnBeforeGenerateKeyHandler(handlerFunc KMIPServerBeforeGenerateKeyEvent)
Remarks
The struct 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 Component)
Fires when a key generation request is received.
Syntax
// KMIPServerBeforeGenerateKeyPairEventArgs carries the KMIPServer BeforeGenerateKeyPair event's parameters.
type KMIPServerBeforeGenerateKeyPairEventArgs struct {...}
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) KeyAlgorithm() string
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SetKeyAlgorithm(value string)
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) KeyLength() int32
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SetKeyLength(value int32)
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) Scheme() string
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SetScheme(value string)
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SchemeParams() string
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SetSchemeParams(value string)
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) Action() int32
func (args *KMIPServerBeforeGenerateKeyPairEventArgs) SetAction(value int32)
// KMIPServerBeforeGenerateKeyPairEvent defines the signature of the KMIPServer BeforeGenerateKeyPair event's handler function.
type KMIPServerBeforeGenerateKeyPairEvent func(sender *KMIPServer, args *KMIPServerBeforeGenerateKeyPairEventArgs)
func (obj *KMIPServer) GetOnBeforeGenerateKeyPairHandler() KMIPServerBeforeGenerateKeyPairEvent
func (obj *KMIPServer) SetOnBeforeGenerateKeyPairHandler(handlerFunc KMIPServerBeforeGenerateKeyPairEvent)
Remarks
The struct 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 Component)
Notifies the application about the initiation of the hashing operation.
Syntax
// KMIPServerBeforeHashEventArgs carries the KMIPServer BeforeHash event's parameters.
type KMIPServerBeforeHashEventArgs struct {...}
func (args *KMIPServerBeforeHashEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeHashEventArgs) ObjectId() string
func (args *KMIPServerBeforeHashEventArgs) HashAlgorithm() string
func (args *KMIPServerBeforeHashEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeHashEventArgs) Action() int32
func (args *KMIPServerBeforeHashEventArgs) SetAction(value int32)
// KMIPServerBeforeHashEvent defines the signature of the KMIPServer BeforeHash event's handler function.
type KMIPServerBeforeHashEvent func(sender *KMIPServer, args *KMIPServerBeforeHashEventArgs)
func (obj *KMIPServer) GetOnBeforeHashHandler() KMIPServerBeforeHashEvent
func (obj *KMIPServer) SetOnBeforeHashHandler(handlerFunc KMIPServerBeforeHashEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
BeforeList Event (KMIPServer Component)
Notifies the application about the initiation of the list operation.
Syntax
// KMIPServerBeforeListEventArgs carries the KMIPServer BeforeList event's parameters.
type KMIPServerBeforeListEventArgs struct {...}
func (args *KMIPServerBeforeListEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeListEventArgs) ObjectType() int32
func (args *KMIPServerBeforeListEventArgs) ObjectStatus() int32
func (args *KMIPServerBeforeListEventArgs) OnlyFreshObjects() bool
func (args *KMIPServerBeforeListEventArgs) Action() int32
func (args *KMIPServerBeforeListEventArgs) SetAction(value int32)
// KMIPServerBeforeListEvent defines the signature of the KMIPServer BeforeList event's handler function.
type KMIPServerBeforeListEvent func(sender *KMIPServer, args *KMIPServerBeforeListEventArgs)
func (obj *KMIPServer) GetOnBeforeListHandler() KMIPServerBeforeListEvent
func (obj *KMIPServer) SetOnBeforeListHandler(handlerFunc KMIPServerBeforeListEvent)
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 Component)
Notifies the application about the client requesting an object lease.
Syntax
// KMIPServerBeforeObtainLeaseEventArgs carries the KMIPServer BeforeObtainLease event's parameters.
type KMIPServerBeforeObtainLeaseEventArgs struct {...}
func (args *KMIPServerBeforeObtainLeaseEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeObtainLeaseEventArgs) ObjectId() string
func (args *KMIPServerBeforeObtainLeaseEventArgs) Action() int32
func (args *KMIPServerBeforeObtainLeaseEventArgs) SetAction(value int32)
// KMIPServerBeforeObtainLeaseEvent defines the signature of the KMIPServer BeforeObtainLease event's handler function.
type KMIPServerBeforeObtainLeaseEvent func(sender *KMIPServer, args *KMIPServerBeforeObtainLeaseEventArgs)
func (obj *KMIPServer) GetOnBeforeObtainLeaseHandler() KMIPServerBeforeObtainLeaseEvent
func (obj *KMIPServer) SetOnBeforeObtainLeaseHandler(handlerFunc KMIPServerBeforeObtainLeaseEvent)
Remarks
Use this event to get notified about the connected client requesting an object lease.
BeforeReadObject Event (KMIPServer Component)
Notifies the application about the start of the object reading request.
Syntax
// KMIPServerBeforeReadObjectEventArgs carries the KMIPServer BeforeReadObject event's parameters.
type KMIPServerBeforeReadObjectEventArgs struct {...}
func (args *KMIPServerBeforeReadObjectEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeReadObjectEventArgs) ObjectId() string
func (args *KMIPServerBeforeReadObjectEventArgs) Action() int32
func (args *KMIPServerBeforeReadObjectEventArgs) SetAction(value int32)
// KMIPServerBeforeReadObjectEvent defines the signature of the KMIPServer BeforeReadObject event's handler function.
type KMIPServerBeforeReadObjectEvent func(sender *KMIPServer, args *KMIPServerBeforeReadObjectEventArgs)
func (obj *KMIPServer) GetOnBeforeReadObjectHandler() KMIPServerBeforeReadObjectEvent
func (obj *KMIPServer) SetOnBeforeReadObjectHandler(handlerFunc KMIPServerBeforeReadObjectEvent)
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 and ReadAttribute events repeatedly to request information about the object from your code.
BeforeReCertify Event (KMIPServer Component)
Notifies the application about a re-certification request.
Syntax
// KMIPServerBeforeReCertifyEventArgs carries the KMIPServer BeforeReCertify event's parameters.
type KMIPServerBeforeReCertifyEventArgs struct {...}
func (args *KMIPServerBeforeReCertifyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeReCertifyEventArgs) OldCertId() string
func (args *KMIPServerBeforeReCertifyEventArgs) Action() int32
func (args *KMIPServerBeforeReCertifyEventArgs) SetAction(value int32)
// KMIPServerBeforeReCertifyEvent defines the signature of the KMIPServer BeforeReCertify event's handler function.
type KMIPServerBeforeReCertifyEvent func(sender *KMIPServer, args *KMIPServerBeforeReCertifyEventArgs)
func (obj *KMIPServer) GetOnBeforeReCertifyHandler() KMIPServerBeforeReCertifyEvent
func (obj *KMIPServer) SetOnBeforeReCertifyHandler(handlerFunc KMIPServerBeforeReCertifyEvent)
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 call that will let you handle the actual request as required.
BeforeReKey Event (KMIPServer Component)
Notifies the application about a re-key request received.
Syntax
// KMIPServerBeforeReKeyEventArgs carries the KMIPServer BeforeReKey event's parameters.
type KMIPServerBeforeReKeyEventArgs struct {...}
func (args *KMIPServerBeforeReKeyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeReKeyEventArgs) OldKeyId() string
func (args *KMIPServerBeforeReKeyEventArgs) Action() int32
func (args *KMIPServerBeforeReKeyEventArgs) SetAction(value int32)
// KMIPServerBeforeReKeyEvent defines the signature of the KMIPServer BeforeReKey event's handler function.
type KMIPServerBeforeReKeyEvent func(sender *KMIPServer, args *KMIPServerBeforeReKeyEventArgs)
func (obj *KMIPServer) GetOnBeforeReKeyHandler() KMIPServerBeforeReKeyEvent
func (obj *KMIPServer) SetOnBeforeReKeyHandler(handlerFunc KMIPServerBeforeReKeyEvent)
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 Component)
Notifies the application about a keypair re-key request received.
Syntax
// KMIPServerBeforeRekeyKeyPairEventArgs carries the KMIPServer BeforeRekeyKeyPair event's parameters.
type KMIPServerBeforeRekeyKeyPairEventArgs struct {...}
func (args *KMIPServerBeforeRekeyKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeRekeyKeyPairEventArgs) OldPrivateKeyId() string
func (args *KMIPServerBeforeRekeyKeyPairEventArgs) Action() int32
func (args *KMIPServerBeforeRekeyKeyPairEventArgs) SetAction(value int32)
// KMIPServerBeforeRekeyKeyPairEvent defines the signature of the KMIPServer BeforeRekeyKeyPair event's handler function.
type KMIPServerBeforeRekeyKeyPairEvent func(sender *KMIPServer, args *KMIPServerBeforeRekeyKeyPairEventArgs)
func (obj *KMIPServer) GetOnBeforeRekeyKeyPairHandler() KMIPServerBeforeRekeyKeyPairEvent
func (obj *KMIPServer) SetOnBeforeRekeyKeyPairHandler(handlerFunc KMIPServerBeforeRekeyKeyPairEvent)
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 Component)
Notifies the application about an incoming Remove Object request.
Syntax
// KMIPServerBeforeRemoveObjectEventArgs carries the KMIPServer BeforeRemoveObject event's parameters.
type KMIPServerBeforeRemoveObjectEventArgs struct {...}
func (args *KMIPServerBeforeRemoveObjectEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeRemoveObjectEventArgs) ObjectId() string
func (args *KMIPServerBeforeRemoveObjectEventArgs) Action() int32
func (args *KMIPServerBeforeRemoveObjectEventArgs) SetAction(value int32)
// KMIPServerBeforeRemoveObjectEvent defines the signature of the KMIPServer BeforeRemoveObject event's handler function.
type KMIPServerBeforeRemoveObjectEvent func(sender *KMIPServer, args *KMIPServerBeforeRemoveObjectEventArgs)
func (obj *KMIPServer) GetOnBeforeRemoveObjectHandler() KMIPServerBeforeRemoveObjectEvent
func (obj *KMIPServer) SetOnBeforeRemoveObjectHandler(handlerFunc KMIPServerBeforeRemoveObjectEvent)
Remarks
Subscribe to this event to choose the operation flow (automated/custom) for the object removal operation.
BeforeSign Event (KMIPServer Component)
Notifies the application about the initiation of a signing operation.
Syntax
// KMIPServerBeforeSignEventArgs carries the KMIPServer BeforeSign event's parameters.
type KMIPServerBeforeSignEventArgs struct {...}
func (args *KMIPServerBeforeSignEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeSignEventArgs) ObjectId() string
func (args *KMIPServerBeforeSignEventArgs) Algorithm() string
func (args *KMIPServerBeforeSignEventArgs) HashAlgorithm() string
func (args *KMIPServerBeforeSignEventArgs) InputIsHash() bool
func (args *KMIPServerBeforeSignEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeSignEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeSignEventArgs) Action() int32
func (args *KMIPServerBeforeSignEventArgs) SetAction(value int32)
// KMIPServerBeforeSignEvent defines the signature of the KMIPServer BeforeSign event's handler function.
type KMIPServerBeforeSignEvent func(sender *KMIPServer, args *KMIPServerBeforeSignEventArgs)
func (obj *KMIPServer) GetOnBeforeSignHandler() KMIPServerBeforeSignEvent
func (obj *KMIPServer) SetOnBeforeSignHandler(handlerFunc KMIPServerBeforeSignEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
BeforeVerify Event (KMIPServer Component)
Notifies the application about the initiation of the verify operation.
Syntax
// KMIPServerBeforeVerifyEventArgs carries the KMIPServer BeforeVerify event's parameters.
type KMIPServerBeforeVerifyEventArgs struct {...}
func (args *KMIPServerBeforeVerifyEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeVerifyEventArgs) ObjectId() string
func (args *KMIPServerBeforeVerifyEventArgs) HashAlgorithm() string
func (args *KMIPServerBeforeVerifyEventArgs) InputIsHash() bool
func (args *KMIPServerBeforeVerifyEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeVerifyEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeVerifyEventArgs) Action() int32
func (args *KMIPServerBeforeVerifyEventArgs) SetAction(value int32)
// KMIPServerBeforeVerifyEvent defines the signature of the KMIPServer BeforeVerify event's handler function.
type KMIPServerBeforeVerifyEvent func(sender *KMIPServer, args *KMIPServerBeforeVerifyEventArgs)
func (obj *KMIPServer) GetOnBeforeVerifyHandler() KMIPServerBeforeVerifyEvent
func (obj *KMIPServer) SetOnBeforeVerifyHandler(handlerFunc KMIPServerBeforeVerifyEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
BeforeVerifyHash Event (KMIPServer Component)
Notifies the application about the initiation of the hash verification operation.
Syntax
// KMIPServerBeforeVerifyHashEventArgs carries the KMIPServer BeforeVerifyHash event's parameters.
type KMIPServerBeforeVerifyHashEventArgs struct {...}
func (args *KMIPServerBeforeVerifyHashEventArgs) ConnectionId() int64
func (args *KMIPServerBeforeVerifyHashEventArgs) ObjectId() string
func (args *KMIPServerBeforeVerifyHashEventArgs) HashAlgorithm() string
func (args *KMIPServerBeforeVerifyHashEventArgs) CorrelationValue() string
func (args *KMIPServerBeforeVerifyHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerBeforeVerifyHashEventArgs) Action() int32
func (args *KMIPServerBeforeVerifyHashEventArgs) SetAction(value int32)
// KMIPServerBeforeVerifyHashEvent defines the signature of the KMIPServer BeforeVerifyHash event's handler function.
type KMIPServerBeforeVerifyHashEvent func(sender *KMIPServer, args *KMIPServerBeforeVerifyHashEventArgs)
func (obj *KMIPServer) GetOnBeforeVerifyHashHandler() KMIPServerBeforeVerifyHashEvent
func (obj *KMIPServer) SetOnBeforeVerifyHashHandler(handlerFunc KMIPServerBeforeVerifyHashEvent)
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 article for more details about handling and virtualizing requests in SecureBlackbox servers.
Cancel Event (KMIPServer Component)
Reports a cancellation request received from the client.
Syntax
// KMIPServerCancelEventArgs carries the KMIPServer Cancel event's parameters.
type KMIPServerCancelEventArgs struct {...}
func (args *KMIPServerCancelEventArgs) ConnectionId() int64
func (args *KMIPServerCancelEventArgs) AsyncCorrelationValue() string
func (args *KMIPServerCancelEventArgs) CancellationResult() int32
func (args *KMIPServerCancelEventArgs) SetCancellationResult(value int32)
func (args *KMIPServerCancelEventArgs) OperationStatus() int32
func (args *KMIPServerCancelEventArgs) SetOperationStatus(value int32)
// KMIPServerCancelEvent defines the signature of the KMIPServer Cancel event's handler function.
type KMIPServerCancelEvent func(sender *KMIPServer, args *KMIPServerCancelEventArgs)
func (obj *KMIPServer) GetOnCancelHandler() KMIPServerCancelEvent
func (obj *KMIPServer) SetOnCancelHandler(handlerFunc KMIPServerCancelEvent)
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 Component)
Notifies the application about a Check request received.
Syntax
// KMIPServerCheckEventArgs carries the KMIPServer Check event's parameters.
type KMIPServerCheckEventArgs struct {...}
func (args *KMIPServerCheckEventArgs) ConnectionId() int64
func (args *KMIPServerCheckEventArgs) ObjectId() string
func (args *KMIPServerCheckEventArgs) UsageLimitsCount() int64
func (args *KMIPServerCheckEventArgs) SetUsageLimitsCount(value int64)
func (args *KMIPServerCheckEventArgs) CryptographicUsageMask() int32
func (args *KMIPServerCheckEventArgs) SetCryptographicUsageMask(value int32)
func (args *KMIPServerCheckEventArgs) LeaseTime() int32
func (args *KMIPServerCheckEventArgs) SetLeaseTime(value int32)
func (args *KMIPServerCheckEventArgs) OperationStatus() int32
func (args *KMIPServerCheckEventArgs) SetOperationStatus(value int32)
// KMIPServerCheckEvent defines the signature of the KMIPServer Check event's handler function.
type KMIPServerCheckEvent func(sender *KMIPServer, args *KMIPServerCheckEventArgs)
func (obj *KMIPServer) GetOnCheckHandler() KMIPServerCheckEvent
func (obj *KMIPServer) SetOnCheckHandler(handlerFunc KMIPServerCheckEvent)
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 Component)
Reports an accepted connection.
Syntax
// KMIPServerConnectEventArgs carries the KMIPServer Connect event's parameters.
type KMIPServerConnectEventArgs struct {...}
func (args *KMIPServerConnectEventArgs) ConnectionID() int64
func (args *KMIPServerConnectEventArgs) RemoteAddress() string
func (args *KMIPServerConnectEventArgs) RemotePort() int32
// KMIPServerConnectEvent defines the signature of the KMIPServer Connect event's handler function.
type KMIPServerConnectEvent func(sender *KMIPServer, args *KMIPServerConnectEventArgs)
func (obj *KMIPServer) GetOnConnectHandler() KMIPServerConnectEvent
func (obj *KMIPServer) SetOnConnectHandler(handlerFunc KMIPServerConnectEvent)
Remarks
The struct 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.
Decrypt Event (KMIPServer Component)
Instructs the application to decrypt a chunk of data.
Syntax
// KMIPServerDecryptEventArgs carries the KMIPServer Decrypt event's parameters.
type KMIPServerDecryptEventArgs struct {...}
func (args *KMIPServerDecryptEventArgs) ConnectionId() int64
func (args *KMIPServerDecryptEventArgs) ObjectId() string
func (args *KMIPServerDecryptEventArgs) Data() []byte
func (args *KMIPServerDecryptEventArgs) IV() string
func (args *KMIPServerDecryptEventArgs) InitIndicator() bool
func (args *KMIPServerDecryptEventArgs) FinalIndicator() bool
func (args *KMIPServerDecryptEventArgs) BlockCipherMode() string
func (args *KMIPServerDecryptEventArgs) TagLength() int32
func (args *KMIPServerDecryptEventArgs) PaddingMethod() string
func (args *KMIPServerDecryptEventArgs) CorrelationValue() string
func (args *KMIPServerDecryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerDecryptEventArgs) OperationStatus() int32
func (args *KMIPServerDecryptEventArgs) SetOperationStatus(value int32)
// KMIPServerDecryptEvent defines the signature of the KMIPServer Decrypt event's handler function.
type KMIPServerDecryptEvent func(sender *KMIPServer, args *KMIPServerDecryptEventArgs)
func (obj *KMIPServer) GetOnDecryptHandler() KMIPServerDecryptEvent
func (obj *KMIPServer) SetOnDecryptHandler(handlerFunc KMIPServerDecryptEvent)
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 Component)
Instructs the application to delete an object attribute.
Syntax
// KMIPServerDeleteAttributeEventArgs carries the KMIPServer DeleteAttribute event's parameters.
type KMIPServerDeleteAttributeEventArgs struct {...}
func (args *KMIPServerDeleteAttributeEventArgs) ConnectionId() int64
func (args *KMIPServerDeleteAttributeEventArgs) ObjectId() string
func (args *KMIPServerDeleteAttributeEventArgs) AttributeName() string
func (args *KMIPServerDeleteAttributeEventArgs) AttributeValue() string
func (args *KMIPServerDeleteAttributeEventArgs) SetAttributeValue(value string)
func (args *KMIPServerDeleteAttributeEventArgs) OperationStatus() int32
func (args *KMIPServerDeleteAttributeEventArgs) SetOperationStatus(value int32)
// KMIPServerDeleteAttributeEvent defines the signature of the KMIPServer DeleteAttribute event's handler function.
type KMIPServerDeleteAttributeEvent func(sender *KMIPServer, args *KMIPServerDeleteAttributeEventArgs)
func (obj *KMIPServer) GetOnDeleteAttributeHandler() KMIPServerDeleteAttributeEvent
func (obj *KMIPServer) SetOnDeleteAttributeHandler(handlerFunc KMIPServerDeleteAttributeEvent)
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 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 Component)
Notifies the application of key derivation request.
Syntax
// KMIPServerDeriveKeyEventArgs carries the KMIPServer DeriveKey event's parameters.
type KMIPServerDeriveKeyEventArgs struct {...}
func (args *KMIPServerDeriveKeyEventArgs) ConnectionId() int64
func (args *KMIPServerDeriveKeyEventArgs) ObjectType() int32
func (args *KMIPServerDeriveKeyEventArgs) ObjectIds() string
func (args *KMIPServerDeriveKeyEventArgs) DerivationMethod() string
func (args *KMIPServerDeriveKeyEventArgs) InitializationVector() []byte
func (args *KMIPServerDeriveKeyEventArgs) DerivationData() []byte
func (args *KMIPServerDeriveKeyEventArgs) NewKeyId() string
func (args *KMIPServerDeriveKeyEventArgs) SetNewKeyId(value string)
func (args *KMIPServerDeriveKeyEventArgs) OperationStatus() int32
func (args *KMIPServerDeriveKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerDeriveKeyEvent defines the signature of the KMIPServer DeriveKey event's handler function.
type KMIPServerDeriveKeyEvent func(sender *KMIPServer, args *KMIPServerDeriveKeyEventArgs)
func (obj *KMIPServer) GetOnDeriveKeyHandler() KMIPServerDeriveKeyEvent
func (obj *KMIPServer) SetOnDeriveKeyHandler(handlerFunc KMIPServerDeriveKeyEvent)
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 Component)
Fires to report a disconnected client.
Syntax
// KMIPServerDisconnectEventArgs carries the KMIPServer Disconnect event's parameters.
type KMIPServerDisconnectEventArgs struct {...}
func (args *KMIPServerDisconnectEventArgs) ConnectionID() int64
// KMIPServerDisconnectEvent defines the signature of the KMIPServer Disconnect event's handler function.
type KMIPServerDisconnectEvent func(sender *KMIPServer, args *KMIPServerDisconnectEventArgs)
func (obj *KMIPServer) GetOnDisconnectHandler() KMIPServerDisconnectEvent
func (obj *KMIPServer) SetOnDisconnectHandler(handlerFunc KMIPServerDisconnectEvent)
Remarks
The struct fires this event when a connected client disconnects.
Encrypt Event (KMIPServer Component)
Instructs the application to encrypt a chunk of data.
Syntax
// KMIPServerEncryptEventArgs carries the KMIPServer Encrypt event's parameters.
type KMIPServerEncryptEventArgs struct {...}
func (args *KMIPServerEncryptEventArgs) ConnectionId() int64
func (args *KMIPServerEncryptEventArgs) ObjectId() string
func (args *KMIPServerEncryptEventArgs) Data() []byte
func (args *KMIPServerEncryptEventArgs) InitIndicator() bool
func (args *KMIPServerEncryptEventArgs) FinalIndicator() bool
func (args *KMIPServerEncryptEventArgs) BlockCipherMode() string
func (args *KMIPServerEncryptEventArgs) TagLength() int32
func (args *KMIPServerEncryptEventArgs) PaddingMethod() string
func (args *KMIPServerEncryptEventArgs) RandomIV() bool
func (args *KMIPServerEncryptEventArgs) IV() string
func (args *KMIPServerEncryptEventArgs) SetIV(value string)
func (args *KMIPServerEncryptEventArgs) CorrelationValue() string
func (args *KMIPServerEncryptEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerEncryptEventArgs) OperationStatus() int32
func (args *KMIPServerEncryptEventArgs) SetOperationStatus(value int32)
// KMIPServerEncryptEvent defines the signature of the KMIPServer Encrypt event's handler function.
type KMIPServerEncryptEvent func(sender *KMIPServer, args *KMIPServerEncryptEventArgs)
func (obj *KMIPServer) GetOnEncryptHandler() KMIPServerEncryptEvent
func (obj *KMIPServer) SetOnEncryptHandler(handlerFunc KMIPServerEncryptEvent)
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 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 Component)
Information about errors during data delivery.
Syntax
// KMIPServerErrorEventArgs carries the KMIPServer Error event's parameters.
type KMIPServerErrorEventArgs struct {...}
func (args *KMIPServerErrorEventArgs) ConnectionID() int64
func (args *KMIPServerErrorEventArgs) ErrorCode() int32
func (args *KMIPServerErrorEventArgs) Fatal() bool
func (args *KMIPServerErrorEventArgs) Remote() bool
func (args *KMIPServerErrorEventArgs) Description() string
// KMIPServerErrorEvent defines the signature of the KMIPServer Error event's handler function.
type KMIPServerErrorEvent func(sender *KMIPServer, args *KMIPServerErrorEventArgs)
func (obj *KMIPServer) GetOnErrorHandler() KMIPServerErrorEvent
func (obj *KMIPServer) SetOnErrorHandler(handlerFunc KMIPServerErrorEvent)
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 section.
ExternalSign Event (KMIPServer Component)
Handles remote or external signing initiated by the server protocol.
Syntax
// KMIPServerExternalSignEventArgs carries the KMIPServer ExternalSign event's parameters.
type KMIPServerExternalSignEventArgs struct {...}
func (args *KMIPServerExternalSignEventArgs) ConnectionID() int64
func (args *KMIPServerExternalSignEventArgs) OperationId() string
func (args *KMIPServerExternalSignEventArgs) HashAlgorithm() string
func (args *KMIPServerExternalSignEventArgs) Pars() string
func (args *KMIPServerExternalSignEventArgs) Data() string
func (args *KMIPServerExternalSignEventArgs) SignedData() string
func (args *KMIPServerExternalSignEventArgs) SetSignedData(value string)
// KMIPServerExternalSignEvent defines the signature of the KMIPServer ExternalSign event's handler function.
type KMIPServerExternalSignEvent func(sender *KMIPServer, args *KMIPServerExternalSignEventArgs)
func (obj *KMIPServer) GetOnExternalSignHandler() KMIPServerExternalSignEvent
func (obj *KMIPServer) SetOnExternalSignHandler(handlerFunc KMIPServerExternalSignEvent)
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 struct via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The struct 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:
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 Component)
Notifies the application about an incoming Generate request.
Syntax
// KMIPServerGenerateEventArgs carries the KMIPServer Generate event's parameters.
type KMIPServerGenerateEventArgs struct {...}
func (args *KMIPServerGenerateEventArgs) ConnectionId() int64
func (args *KMIPServerGenerateEventArgs) PublicKeyId() string
func (args *KMIPServerGenerateEventArgs) CertId() string
func (args *KMIPServerGenerateEventArgs) SetCertId(value string)
func (args *KMIPServerGenerateEventArgs) OperationStatus() int32
func (args *KMIPServerGenerateEventArgs) SetOperationStatus(value int32)
// KMIPServerGenerateEvent defines the signature of the KMIPServer Generate event's handler function.
type KMIPServerGenerateEvent func(sender *KMIPServer, args *KMIPServerGenerateEventArgs)
func (obj *KMIPServer) GetOnGenerateHandler() KMIPServerGenerateEvent
func (obj *KMIPServer) SetOnGenerateHandler(handlerFunc KMIPServerGenerateEvent)
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 Component)
Notifies the application about an incoming Generate request.
Syntax
// KMIPServerGenerateKeyEventArgs carries the KMIPServer GenerateKey event's parameters.
type KMIPServerGenerateKeyEventArgs struct {...}
func (args *KMIPServerGenerateKeyEventArgs) ConnectionId() int64
func (args *KMIPServerGenerateKeyEventArgs) KeyAlgorithm() string
func (args *KMIPServerGenerateKeyEventArgs) KeyLength() int32
func (args *KMIPServerGenerateKeyEventArgs) Group() string
func (args *KMIPServerGenerateKeyEventArgs) KeyId() string
func (args *KMIPServerGenerateKeyEventArgs) SetKeyId(value string)
func (args *KMIPServerGenerateKeyEventArgs) OperationStatus() int32
func (args *KMIPServerGenerateKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerGenerateKeyEvent defines the signature of the KMIPServer GenerateKey event's handler function.
type KMIPServerGenerateKeyEvent func(sender *KMIPServer, args *KMIPServerGenerateKeyEventArgs)
func (obj *KMIPServer) GetOnGenerateKeyHandler() KMIPServerGenerateKeyEvent
func (obj *KMIPServer) SetOnGenerateKeyHandler(handlerFunc KMIPServerGenerateKeyEvent)
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 Component)
Notifies the application about an incoming Generate request.
Syntax
// KMIPServerGenerateKeyPairEventArgs carries the KMIPServer GenerateKeyPair event's parameters.
type KMIPServerGenerateKeyPairEventArgs struct {...}
func (args *KMIPServerGenerateKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerGenerateKeyPairEventArgs) KeyAlgorithm() string
func (args *KMIPServerGenerateKeyPairEventArgs) KeyLength() int32
func (args *KMIPServerGenerateKeyPairEventArgs) Scheme() string
func (args *KMIPServerGenerateKeyPairEventArgs) SchemeParams() string
func (args *KMIPServerGenerateKeyPairEventArgs) Group() string
func (args *KMIPServerGenerateKeyPairEventArgs) PrivateKeyId() string
func (args *KMIPServerGenerateKeyPairEventArgs) SetPrivateKeyId(value string)
func (args *KMIPServerGenerateKeyPairEventArgs) PublicKeyId() string
func (args *KMIPServerGenerateKeyPairEventArgs) SetPublicKeyId(value string)
func (args *KMIPServerGenerateKeyPairEventArgs) OperationStatus() int32
func (args *KMIPServerGenerateKeyPairEventArgs) SetOperationStatus(value int32)
// KMIPServerGenerateKeyPairEvent defines the signature of the KMIPServer GenerateKeyPair event's handler function.
type KMIPServerGenerateKeyPairEvent func(sender *KMIPServer, args *KMIPServerGenerateKeyPairEventArgs)
func (obj *KMIPServer) GetOnGenerateKeyPairHandler() KMIPServerGenerateKeyPairEvent
func (obj *KMIPServer) SetOnGenerateKeyPairHandler(handlerFunc KMIPServerGenerateKeyPairEvent)
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 Component)
Notifies the application about an incoming Get Usage Allocation request.
Syntax
// KMIPServerGetUsageAllocationEventArgs carries the KMIPServer GetUsageAllocation event's parameters.
type KMIPServerGetUsageAllocationEventArgs struct {...}
func (args *KMIPServerGetUsageAllocationEventArgs) ConnectionId() int64
func (args *KMIPServerGetUsageAllocationEventArgs) ObjectId() string
func (args *KMIPServerGetUsageAllocationEventArgs) UsageLimitsCount() int32
func (args *KMIPServerGetUsageAllocationEventArgs) OperationStatus() int32
func (args *KMIPServerGetUsageAllocationEventArgs) SetOperationStatus(value int32)
// KMIPServerGetUsageAllocationEvent defines the signature of the KMIPServer GetUsageAllocation event's handler function.
type KMIPServerGetUsageAllocationEvent func(sender *KMIPServer, args *KMIPServerGetUsageAllocationEventArgs)
func (obj *KMIPServer) GetOnGetUsageAllocationHandler() KMIPServerGetUsageAllocationEvent
func (obj *KMIPServer) SetOnGetUsageAllocationHandler(handlerFunc KMIPServerGetUsageAllocationEvent)
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 Component)
Instructs the application to update the current hashing operation.
Syntax
// KMIPServerHashEventArgs carries the KMIPServer Hash event's parameters.
type KMIPServerHashEventArgs struct {...}
func (args *KMIPServerHashEventArgs) ConnectionId() int64
func (args *KMIPServerHashEventArgs) ObjectId() string
func (args *KMIPServerHashEventArgs) HashAlgorithm() string
func (args *KMIPServerHashEventArgs) Data() []byte
func (args *KMIPServerHashEventArgs) InitIndicator() bool
func (args *KMIPServerHashEventArgs) FinalIndicator() bool
func (args *KMIPServerHashEventArgs) CorrelationValue() string
func (args *KMIPServerHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerHashEventArgs) OperationStatus() int32
func (args *KMIPServerHashEventArgs) SetOperationStatus(value int32)
// KMIPServerHashEvent defines the signature of the KMIPServer Hash event's handler function.
type KMIPServerHashEvent func(sender *KMIPServer, args *KMIPServerHashEventArgs)
func (obj *KMIPServer) GetOnHashHandler() KMIPServerHashEvent
func (obj *KMIPServer) SetOnHashHandler(handlerFunc KMIPServerHashEvent)
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 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 Component)
Fires when the response headers have been formed and are ready to be sent to the server.
Syntax
// KMIPServerHeadersPreparedEventArgs carries the KMIPServer HeadersPrepared event's parameters.
type KMIPServerHeadersPreparedEventArgs struct {...}
func (args *KMIPServerHeadersPreparedEventArgs) ConnectionID() int64
// KMIPServerHeadersPreparedEvent defines the signature of the KMIPServer HeadersPrepared event's handler function.
type KMIPServerHeadersPreparedEvent func(sender *KMIPServer, args *KMIPServerHeadersPreparedEventArgs)
func (obj *KMIPServer) GetOnHeadersPreparedHandler() KMIPServerHeadersPreparedEvent
func (obj *KMIPServer) SetOnHeadersPreparedHandler(handlerFunc KMIPServerHeadersPreparedEvent)
Remarks
The struct 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 method with an empty header name to get the whole response header.
KMIPAuthAttempt Event (KMIPServer Component)
Fires when a connected client makes an authentication attempt.
Syntax
// KMIPServerKMIPAuthAttemptEventArgs carries the KMIPServer KMIPAuthAttempt event's parameters.
type KMIPServerKMIPAuthAttemptEventArgs struct {...}
func (args *KMIPServerKMIPAuthAttemptEventArgs) ConnectionId() int64
func (args *KMIPServerKMIPAuthAttemptEventArgs) Username() string
func (args *KMIPServerKMIPAuthAttemptEventArgs) Password() string
func (args *KMIPServerKMIPAuthAttemptEventArgs) Accept() bool
func (args *KMIPServerKMIPAuthAttemptEventArgs) SetAccept(value bool)
// KMIPServerKMIPAuthAttemptEvent defines the signature of the KMIPServer KMIPAuthAttempt event's handler function.
type KMIPServerKMIPAuthAttemptEvent func(sender *KMIPServer, args *KMIPServerKMIPAuthAttemptEventArgs)
func (obj *KMIPServer) GetOnKMIPAuthAttemptHandler() KMIPServerKMIPAuthAttemptEvent
func (obj *KMIPServer) SetOnKMIPAuthAttemptHandler(handlerFunc KMIPServerKMIPAuthAttemptEvent)
Remarks
The struct 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 Component)
Instructs the application to return the list of objects that match the specified criteria.
Syntax
// KMIPServerListEventArgs carries the KMIPServer List event's parameters.
type KMIPServerListEventArgs struct {...}
func (args *KMIPServerListEventArgs) ConnectionId() int64
func (args *KMIPServerListEventArgs) ObjectType() int32
func (args *KMIPServerListEventArgs) ObjectStatus() int32
func (args *KMIPServerListEventArgs) OnlyFreshObjects() bool
func (args *KMIPServerListEventArgs) OffsetItems() int32
func (args *KMIPServerListEventArgs) MaximumItems() int32
func (args *KMIPServerListEventArgs) ObjectIds() string
func (args *KMIPServerListEventArgs) SetObjectIds(value string)
func (args *KMIPServerListEventArgs) LocatedItems() int32
func (args *KMIPServerListEventArgs) SetLocatedItems(value int32)
func (args *KMIPServerListEventArgs) OperationStatus() int32
func (args *KMIPServerListEventArgs) SetOperationStatus(value int32)
// KMIPServerListEvent defines the signature of the KMIPServer List event's handler function.
type KMIPServerListEvent func(sender *KMIPServer, args *KMIPServerListEventArgs)
func (obj *KMIPServer) GetOnListHandler() KMIPServerListEvent
func (obj *KMIPServer) SetOnListHandler(handlerFunc KMIPServerListEvent)
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 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 Component)
Requests a list of object attribute names from the application.
Syntax
// KMIPServerListAttributesEventArgs carries the KMIPServer ListAttributes event's parameters.
type KMIPServerListAttributesEventArgs struct {...}
func (args *KMIPServerListAttributesEventArgs) ConnectionId() int64
func (args *KMIPServerListAttributesEventArgs) ObjectId() string
func (args *KMIPServerListAttributesEventArgs) AttributeNames() string
func (args *KMIPServerListAttributesEventArgs) SetAttributeNames(value string)
func (args *KMIPServerListAttributesEventArgs) OperationStatus() int32
func (args *KMIPServerListAttributesEventArgs) SetOperationStatus(value int32)
// KMIPServerListAttributesEvent defines the signature of the KMIPServer ListAttributes event's handler function.
type KMIPServerListAttributesEvent func(sender *KMIPServer, args *KMIPServerListAttributesEventArgs)
func (obj *KMIPServer) GetOnListAttributesHandler() KMIPServerListAttributesEvent
func (obj *KMIPServer) SetOnListAttributesHandler(handlerFunc KMIPServerListAttributesEvent)
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 event call.
Following completion of this event, the server will call the ReadAttribute 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 Component)
This event notifies the application about an underlying control flow event.
Syntax
// KMIPServerNotificationEventArgs carries the KMIPServer Notification event's parameters.
type KMIPServerNotificationEventArgs struct {...}
func (args *KMIPServerNotificationEventArgs) EventID() string
func (args *KMIPServerNotificationEventArgs) EventParam() string
// KMIPServerNotificationEvent defines the signature of the KMIPServer Notification event's handler function.
type KMIPServerNotificationEvent func(sender *KMIPServer, args *KMIPServerNotificationEventArgs)
func (obj *KMIPServer) GetOnNotificationHandler() KMIPServerNotificationEvent
func (obj *KMIPServer) SetOnNotificationHandler(handlerFunc KMIPServerNotificationEvent)
Remarks
The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.
This struct 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 Component)
Lets the application handle the lease request.
Syntax
// KMIPServerObtainLeaseEventArgs carries the KMIPServer ObtainLease event's parameters.
type KMIPServerObtainLeaseEventArgs struct {...}
func (args *KMIPServerObtainLeaseEventArgs) ConnectionId() int64
func (args *KMIPServerObtainLeaseEventArgs) ObjectId() string
func (args *KMIPServerObtainLeaseEventArgs) LeaseTime() int32
func (args *KMIPServerObtainLeaseEventArgs) SetLeaseTime(value int32)
func (args *KMIPServerObtainLeaseEventArgs) LastChangeDate() string
func (args *KMIPServerObtainLeaseEventArgs) SetLastChangeDate(value string)
func (args *KMIPServerObtainLeaseEventArgs) OperationStatus() int32
func (args *KMIPServerObtainLeaseEventArgs) SetOperationStatus(value int32)
// KMIPServerObtainLeaseEvent defines the signature of the KMIPServer ObtainLease event's handler function.
type KMIPServerObtainLeaseEvent func(sender *KMIPServer, args *KMIPServerObtainLeaseEventArgs)
func (obj *KMIPServer) GetOnObtainLeaseHandler() KMIPServerObtainLeaseEvent
func (obj *KMIPServer) SetOnObtainLeaseHandler(handlerFunc KMIPServerObtainLeaseEvent)
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 Component)
Fires when a request is received from the client.
Syntax
// KMIPServerOperationAttemptEventArgs carries the KMIPServer OperationAttempt event's parameters.
type KMIPServerOperationAttemptEventArgs struct {...}
func (args *KMIPServerOperationAttemptEventArgs) ConnectionId() int64
func (args *KMIPServerOperationAttemptEventArgs) Operation() string
func (args *KMIPServerOperationAttemptEventArgs) Username() string
func (args *KMIPServerOperationAttemptEventArgs) Reject() bool
func (args *KMIPServerOperationAttemptEventArgs) SetReject(value bool)
// KMIPServerOperationAttemptEvent defines the signature of the KMIPServer OperationAttempt event's handler function.
type KMIPServerOperationAttemptEvent func(sender *KMIPServer, args *KMIPServerOperationAttemptEventArgs)
func (obj *KMIPServer) GetOnOperationAttemptHandler() KMIPServerOperationAttemptEvent
func (obj *KMIPServer) SetOnOperationAttemptHandler(handlerFunc KMIPServerOperationAttemptEvent)
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 Component)
Notifies the application about the received Poll request.
Syntax
// KMIPServerPollEventArgs carries the KMIPServer Poll event's parameters.
type KMIPServerPollEventArgs struct {...}
func (args *KMIPServerPollEventArgs) ConnectionId() int64
func (args *KMIPServerPollEventArgs) AsyncCorrelationValue() string
func (args *KMIPServerPollEventArgs) OperationStatus() int32
func (args *KMIPServerPollEventArgs) SetOperationStatus(value int32)
// KMIPServerPollEvent defines the signature of the KMIPServer Poll event's handler function.
type KMIPServerPollEvent func(sender *KMIPServer, args *KMIPServerPollEventArgs)
func (obj *KMIPServer) GetOnPollHandler() KMIPServerPollEvent
func (obj *KMIPServer) SetOnPollHandler(handlerFunc KMIPServerPollEvent)
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 Component)
Requests an object attribute value from the application.
Syntax
// KMIPServerReadAttributeEventArgs carries the KMIPServer ReadAttribute event's parameters.
type KMIPServerReadAttributeEventArgs struct {...}
func (args *KMIPServerReadAttributeEventArgs) ConnectionId() int64
func (args *KMIPServerReadAttributeEventArgs) ObjectId() string
func (args *KMIPServerReadAttributeEventArgs) AttributeName() string
func (args *KMIPServerReadAttributeEventArgs) AttributeValue() string
func (args *KMIPServerReadAttributeEventArgs) SetAttributeValue(value string)
func (args *KMIPServerReadAttributeEventArgs) OperationStatus() int32
func (args *KMIPServerReadAttributeEventArgs) SetOperationStatus(value int32)
// KMIPServerReadAttributeEvent defines the signature of the KMIPServer ReadAttribute event's handler function.
type KMIPServerReadAttributeEvent func(sender *KMIPServer, args *KMIPServerReadAttributeEventArgs)
func (obj *KMIPServer) GetOnReadAttributeHandler() KMIPServerReadAttributeEvent
func (obj *KMIPServer) SetOnReadAttributeHandler(handlerFunc KMIPServerReadAttributeEvent)
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 event.
This event is fired for every AttributeName in the list returned by the application from a preceding ListAttributes event call.
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
ReadObject Event (KMIPServer Component)
Requests the details of the object from the application.
Syntax
// KMIPServerReadObjectEventArgs carries the KMIPServer ReadObject event's parameters.
type KMIPServerReadObjectEventArgs struct {...}
func (args *KMIPServerReadObjectEventArgs) ConnectionId() int64
func (args *KMIPServerReadObjectEventArgs) ObjectId() string
func (args *KMIPServerReadObjectEventArgs) ObjectType() int32
func (args *KMIPServerReadObjectEventArgs) SetObjectType(value int32)
func (args *KMIPServerReadObjectEventArgs) OperationStatus() int32
func (args *KMIPServerReadObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerReadObjectEvent defines the signature of the KMIPServer ReadObject event's handler function.
type KMIPServerReadObjectEvent func(sender *KMIPServer, args *KMIPServerReadObjectEventArgs)
func (obj *KMIPServer) GetOnReadObjectHandler() KMIPServerReadObjectEvent
func (obj *KMIPServer) SetOnReadObjectHandler(handlerFunc KMIPServerReadObjectEvent)
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 event call.
The event handler should set the ObjectType and OperationStatus as required, and provide the relevant object via the Certificate or Key property and committing it using SetClientCert or SetClientKey respectively.
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
ReCertify Event (KMIPServer Component)
Notifies the application about an incoming re-certification request.
Syntax
// KMIPServerReCertifyEventArgs carries the KMIPServer ReCertify event's parameters.
type KMIPServerReCertifyEventArgs struct {...}
func (args *KMIPServerReCertifyEventArgs) ConnectionId() int64
func (args *KMIPServerReCertifyEventArgs) OldCertId() string
func (args *KMIPServerReCertifyEventArgs) Offset() int32
func (args *KMIPServerReCertifyEventArgs) Group() string
func (args *KMIPServerReCertifyEventArgs) NewCertId() string
func (args *KMIPServerReCertifyEventArgs) SetNewCertId(value string)
func (args *KMIPServerReCertifyEventArgs) OperationStatus() int32
func (args *KMIPServerReCertifyEventArgs) SetOperationStatus(value int32)
// KMIPServerReCertifyEvent defines the signature of the KMIPServer ReCertify event's handler function.
type KMIPServerReCertifyEvent func(sender *KMIPServer, args *KMIPServerReCertifyEventArgs)
func (obj *KMIPServer) GetOnReCertifyHandler() KMIPServerReCertifyEvent
func (obj *KMIPServer) SetOnReCertifyHandler(handlerFunc KMIPServerReCertifyEvent)
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 Component)
Notifies the application about an incoming Recover Object request.
Syntax
// KMIPServerRecoverObjectEventArgs carries the KMIPServer RecoverObject event's parameters.
type KMIPServerRecoverObjectEventArgs struct {...}
func (args *KMIPServerRecoverObjectEventArgs) ConnectionId() int64
func (args *KMIPServerRecoverObjectEventArgs) ObjectId() string
func (args *KMIPServerRecoverObjectEventArgs) OperationStatus() int32
func (args *KMIPServerRecoverObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerRecoverObjectEvent defines the signature of the KMIPServer RecoverObject event's handler function.
type KMIPServerRecoverObjectEvent func(sender *KMIPServer, args *KMIPServerRecoverObjectEventArgs)
func (obj *KMIPServer) GetOnRecoverObjectHandler() KMIPServerRecoverObjectEvent
func (obj *KMIPServer) SetOnRecoverObjectHandler(handlerFunc KMIPServerRecoverObjectEvent)
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 Component)
Notifies the application about an incoming re-key request.
Syntax
// KMIPServerReKeyEventArgs carries the KMIPServer ReKey event's parameters.
type KMIPServerReKeyEventArgs struct {...}
func (args *KMIPServerReKeyEventArgs) ConnectionId() int64
func (args *KMIPServerReKeyEventArgs) OldKeyId() string
func (args *KMIPServerReKeyEventArgs) Offset() int32
func (args *KMIPServerReKeyEventArgs) Group() string
func (args *KMIPServerReKeyEventArgs) NewKeyId() string
func (args *KMIPServerReKeyEventArgs) SetNewKeyId(value string)
func (args *KMIPServerReKeyEventArgs) OperationStatus() int32
func (args *KMIPServerReKeyEventArgs) SetOperationStatus(value int32)
// KMIPServerReKeyEvent defines the signature of the KMIPServer ReKey event's handler function.
type KMIPServerReKeyEvent func(sender *KMIPServer, args *KMIPServerReKeyEventArgs)
func (obj *KMIPServer) GetOnReKeyHandler() KMIPServerReKeyEvent
func (obj *KMIPServer) SetOnReKeyHandler(handlerFunc KMIPServerReKeyEvent)
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 Component)
Notifies the application about an incoming re-key request.
Syntax
// KMIPServerRekeyKeyPairEventArgs carries the KMIPServer RekeyKeyPair event's parameters.
type KMIPServerRekeyKeyPairEventArgs struct {...}
func (args *KMIPServerRekeyKeyPairEventArgs) ConnectionId() int64
func (args *KMIPServerRekeyKeyPairEventArgs) OldPrivateKeyId() string
func (args *KMIPServerRekeyKeyPairEventArgs) Offset() int32
func (args *KMIPServerRekeyKeyPairEventArgs) Group() string
func (args *KMIPServerRekeyKeyPairEventArgs) NewPrivateKeyId() string
func (args *KMIPServerRekeyKeyPairEventArgs) SetNewPrivateKeyId(value string)
func (args *KMIPServerRekeyKeyPairEventArgs) NewPublicKeyId() string
func (args *KMIPServerRekeyKeyPairEventArgs) SetNewPublicKeyId(value string)
func (args *KMIPServerRekeyKeyPairEventArgs) OperationStatus() int32
func (args *KMIPServerRekeyKeyPairEventArgs) SetOperationStatus(value int32)
// KMIPServerRekeyKeyPairEvent defines the signature of the KMIPServer RekeyKeyPair event's handler function.
type KMIPServerRekeyKeyPairEvent func(sender *KMIPServer, args *KMIPServerRekeyKeyPairEventArgs)
func (obj *KMIPServer) GetOnRekeyKeyPairHandler() KMIPServerRekeyKeyPairEvent
func (obj *KMIPServer) SetOnRekeyKeyPairHandler(handlerFunc KMIPServerRekeyKeyPairEvent)
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 Component)
Notifies the application about the object deletion request.
Syntax
// KMIPServerRemoveObjectEventArgs carries the KMIPServer RemoveObject event's parameters.
type KMIPServerRemoveObjectEventArgs struct {...}
func (args *KMIPServerRemoveObjectEventArgs) ConnectionId() int64
func (args *KMIPServerRemoveObjectEventArgs) ObjectId() string
func (args *KMIPServerRemoveObjectEventArgs) OperationStatus() int32
func (args *KMIPServerRemoveObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerRemoveObjectEvent defines the signature of the KMIPServer RemoveObject event's handler function.
type KMIPServerRemoveObjectEvent func(sender *KMIPServer, args *KMIPServerRemoveObjectEventArgs)
func (obj *KMIPServer) GetOnRemoveObjectHandler() KMIPServerRemoveObjectEvent
func (obj *KMIPServer) SetOnRemoveObjectHandler(handlerFunc KMIPServerRemoveObjectEvent)
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 Component)
Notifies the application about KMIP requests being received.
Syntax
// KMIPServerRequestEventArgs carries the KMIPServer Request event's parameters.
type KMIPServerRequestEventArgs struct {...}
func (args *KMIPServerRequestEventArgs) ConnectionId() int64
func (args *KMIPServerRequestEventArgs) RequestData() []byte
// KMIPServerRequestEvent defines the signature of the KMIPServer Request event's handler function.
type KMIPServerRequestEvent func(sender *KMIPServer, args *KMIPServerRequestEventArgs)
func (obj *KMIPServer) GetOnRequestHandler() KMIPServerRequestEvent
func (obj *KMIPServer) SetOnRequestHandler(handlerFunc KMIPServerRequestEvent)
Remarks
Subscribe to this event to get notified about incoming KMIP requests. The RequestData parameter contains the serialized KMIP request object.
Response Event (KMIPServer Component)
Notifies the application about KMIP responses being sent back.
Syntax
// KMIPServerResponseEventArgs carries the KMIPServer Response event's parameters.
type KMIPServerResponseEventArgs struct {...}
func (args *KMIPServerResponseEventArgs) ConnectionId() int64
func (args *KMIPServerResponseEventArgs) ResponseData() []byte
// KMIPServerResponseEvent defines the signature of the KMIPServer Response event's handler function.
type KMIPServerResponseEvent func(sender *KMIPServer, args *KMIPServerResponseEventArgs)
func (obj *KMIPServer) GetOnResponseHandler() KMIPServerResponseEvent
func (obj *KMIPServer) SetOnResponseHandler(handlerFunc KMIPServerResponseEvent)
Remarks
Subscribe to this event to get notified about KMIP protocol responses being sent back to KMIP clients.
RevokeObject Event (KMIPServer Component)
Instructs the application to revoke an object.
Syntax
// KMIPServerRevokeObjectEventArgs carries the KMIPServer RevokeObject event's parameters.
type KMIPServerRevokeObjectEventArgs struct {...}
func (args *KMIPServerRevokeObjectEventArgs) ConnectionId() int64
func (args *KMIPServerRevokeObjectEventArgs) ObjectId() string
func (args *KMIPServerRevokeObjectEventArgs) ReasonCode() int32
func (args *KMIPServerRevokeObjectEventArgs) ReasonMessage() string
func (args *KMIPServerRevokeObjectEventArgs) OperationStatus() int32
func (args *KMIPServerRevokeObjectEventArgs) SetOperationStatus(value int32)
// KMIPServerRevokeObjectEvent defines the signature of the KMIPServer RevokeObject event's handler function.
type KMIPServerRevokeObjectEvent func(sender *KMIPServer, args *KMIPServerRevokeObjectEventArgs)
func (obj *KMIPServer) GetOnRevokeObjectHandler() KMIPServerRevokeObjectEvent
func (obj *KMIPServer) SetOnRevokeObjectHandler(handlerFunc KMIPServerRevokeObjectEvent)
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 Component)
Asks the application for another block of random numbers.
Syntax
// KMIPServerRNGGenerateEventArgs carries the KMIPServer RNGGenerate event's parameters.
type KMIPServerRNGGenerateEventArgs struct {...}
func (args *KMIPServerRNGGenerateEventArgs) ConnectionId() int64
func (args *KMIPServerRNGGenerateEventArgs) DataLength() int32
func (args *KMIPServerRNGGenerateEventArgs) OperationStatus() int32
func (args *KMIPServerRNGGenerateEventArgs) SetOperationStatus(value int32)
// KMIPServerRNGGenerateEvent defines the signature of the KMIPServer RNGGenerate event's handler function.
type KMIPServerRNGGenerateEvent func(sender *KMIPServer, args *KMIPServerRNGGenerateEventArgs)
func (obj *KMIPServer) GetOnRNGGenerateHandler() KMIPServerRNGGenerateEvent
func (obj *KMIPServer) SetOnRNGGenerateHandler(handlerFunc KMIPServerRNGGenerateEvent)
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 method.
| ostOk | 1 | |
| ostNoSuchFile | 2 | |
| ostAccessDenied | 3 | |
| ostWriteProtect | 4 | |
| ostUnsupported | 5 | |
| ostInvalidParameter | 6 | |
| ostEOF | 7 |
RNGSeed Event (KMIPServer Component)
Tells the application to seed the random number generator.
Syntax
// KMIPServerRNGSeedEventArgs carries the KMIPServer RNGSeed event's parameters.
type KMIPServerRNGSeedEventArgs struct {...}
func (args *KMIPServerRNGSeedEventArgs) ConnectionId() int64
func (args *KMIPServerRNGSeedEventArgs) Data() []byte
func (args *KMIPServerRNGSeedEventArgs) BytesUsed() int32
func (args *KMIPServerRNGSeedEventArgs) SetBytesUsed(value int32)
func (args *KMIPServerRNGSeedEventArgs) OperationStatus() int32
func (args *KMIPServerRNGSeedEventArgs) SetOperationStatus(value int32)
// KMIPServerRNGSeedEvent defines the signature of the KMIPServer RNGSeed event's handler function.
type KMIPServerRNGSeedEvent func(sender *KMIPServer, args *KMIPServerRNGSeedEventArgs)
func (obj *KMIPServer) GetOnRNGSeedHandler() KMIPServerRNGSeedEvent
func (obj *KMIPServer) SetOnRNGSeedHandler(handlerFunc KMIPServerRNGSeedEvent)
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 Component)
Passes a set-attribute request to the application.
Syntax
// KMIPServerSetAttributeEventArgs carries the KMIPServer SetAttribute event's parameters.
type KMIPServerSetAttributeEventArgs struct {...}
func (args *KMIPServerSetAttributeEventArgs) ConnectionId() int64
func (args *KMIPServerSetAttributeEventArgs) ObjectId() string
func (args *KMIPServerSetAttributeEventArgs) AttributeName() string
func (args *KMIPServerSetAttributeEventArgs) AttributeValue() string
func (args *KMIPServerSetAttributeEventArgs) OperationStatus() int32
func (args *KMIPServerSetAttributeEventArgs) SetOperationStatus(value int32)
// KMIPServerSetAttributeEvent defines the signature of the KMIPServer SetAttribute event's handler function.
type KMIPServerSetAttributeEvent func(sender *KMIPServer, args *KMIPServerSetAttributeEventArgs)
func (obj *KMIPServer) GetOnSetAttributeHandler() KMIPServerSetAttributeEvent
func (obj *KMIPServer) SetOnSetAttributeHandler(handlerFunc KMIPServerSetAttributeEvent)
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 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 Component)
Instructs the application to sign data with a private key.
Syntax
// KMIPServerSignEventArgs carries the KMIPServer Sign event's parameters.
type KMIPServerSignEventArgs struct {...}
func (args *KMIPServerSignEventArgs) ConnectionId() int64
func (args *KMIPServerSignEventArgs) ObjectId() string
func (args *KMIPServerSignEventArgs) Algorithm() string
func (args *KMIPServerSignEventArgs) HashAlgorithm() string
func (args *KMIPServerSignEventArgs) InputIsHash() bool
func (args *KMIPServerSignEventArgs) Data() []byte
func (args *KMIPServerSignEventArgs) InitIndicator() bool
func (args *KMIPServerSignEventArgs) FinalIndicator() bool
func (args *KMIPServerSignEventArgs) CorrelationValue() string
func (args *KMIPServerSignEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerSignEventArgs) OperationStatus() int32
func (args *KMIPServerSignEventArgs) SetOperationStatus(value int32)
// KMIPServerSignEvent defines the signature of the KMIPServer Sign event's handler function.
type KMIPServerSignEvent func(sender *KMIPServer, args *KMIPServerSignEventArgs)
func (obj *KMIPServer) GetOnSignHandler() KMIPServerSignEvent
func (obj *KMIPServer) SetOnSignHandler(handlerFunc KMIPServerSignEvent)
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 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 Component)
Fires when a client certificate needs to be validated.
Syntax
// KMIPServerTLSCertValidateEventArgs carries the KMIPServer TLSCertValidate event's parameters.
type KMIPServerTLSCertValidateEventArgs struct {...}
func (args *KMIPServerTLSCertValidateEventArgs) ConnectionID() int64
func (args *KMIPServerTLSCertValidateEventArgs) Accept() bool
func (args *KMIPServerTLSCertValidateEventArgs) SetAccept(value bool)
// KMIPServerTLSCertValidateEvent defines the signature of the KMIPServer TLSCertValidate event's handler function.
type KMIPServerTLSCertValidateEvent func(sender *KMIPServer, args *KMIPServerTLSCertValidateEventArgs)
func (obj *KMIPServer) GetOnTLSCertValidateHandler() KMIPServerTLSCertValidateEvent
func (obj *KMIPServer) SetOnTLSCertValidateHandler(handlerFunc KMIPServerTLSCertValidateEvent)
Remarks
The struct 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 Component)
Reports the setup of a TLS session.
Syntax
// KMIPServerTLSEstablishedEventArgs carries the KMIPServer TLSEstablished event's parameters.
type KMIPServerTLSEstablishedEventArgs struct {...}
func (args *KMIPServerTLSEstablishedEventArgs) ConnectionID() int64
// KMIPServerTLSEstablishedEvent defines the signature of the KMIPServer TLSEstablished event's handler function.
type KMIPServerTLSEstablishedEvent func(sender *KMIPServer, args *KMIPServerTLSEstablishedEventArgs)
func (obj *KMIPServer) GetOnTLSEstablishedHandler() KMIPServerTLSEstablishedEvent
func (obj *KMIPServer) SetOnTLSEstablishedHandler(handlerFunc KMIPServerTLSEstablishedEvent)
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (KMIPServer Component)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
// KMIPServerTLSHandshakeEventArgs carries the KMIPServer TLSHandshake event's parameters.
type KMIPServerTLSHandshakeEventArgs struct {...}
func (args *KMIPServerTLSHandshakeEventArgs) ConnectionID() int64
func (args *KMIPServerTLSHandshakeEventArgs) ServerName() string
func (args *KMIPServerTLSHandshakeEventArgs) Abort() bool
func (args *KMIPServerTLSHandshakeEventArgs) SetAbort(value bool)
// KMIPServerTLSHandshakeEvent defines the signature of the KMIPServer TLSHandshake event's handler function.
type KMIPServerTLSHandshakeEvent func(sender *KMIPServer, args *KMIPServerTLSHandshakeEventArgs)
func (obj *KMIPServer) GetOnTLSHandshakeHandler() KMIPServerTLSHandshakeEvent
func (obj *KMIPServer) SetOnTLSHandshakeHandler(handlerFunc KMIPServerTLSHandshakeEvent)
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 Component)
Requests a pre-shared key for TLS-PSK.
Syntax
// KMIPServerTLSPSKEventArgs carries the KMIPServer TLSPSK event's parameters.
type KMIPServerTLSPSKEventArgs struct {...}
func (args *KMIPServerTLSPSKEventArgs) ConnectionID() int64
func (args *KMIPServerTLSPSKEventArgs) Identity() string
func (args *KMIPServerTLSPSKEventArgs) PSK() string
func (args *KMIPServerTLSPSKEventArgs) SetPSK(value string)
func (args *KMIPServerTLSPSKEventArgs) Ciphersuite() string
func (args *KMIPServerTLSPSKEventArgs) SetCiphersuite(value string)
// KMIPServerTLSPSKEvent defines the signature of the KMIPServer TLSPSK event's handler function.
type KMIPServerTLSPSKEvent func(sender *KMIPServer, args *KMIPServerTLSPSKEventArgs)
func (obj *KMIPServer) GetOnTLSPSKHandler() KMIPServerTLSPSKEvent
func (obj *KMIPServer) SetOnTLSPSKHandler(handlerFunc KMIPServerTLSPSKEvent)
Remarks
The struct 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 Component)
Reports closure of a TLS session.
Syntax
// KMIPServerTLSShutdownEventArgs carries the KMIPServer TLSShutdown event's parameters.
type KMIPServerTLSShutdownEventArgs struct {...}
func (args *KMIPServerTLSShutdownEventArgs) ConnectionID() int64
// KMIPServerTLSShutdownEvent defines the signature of the KMIPServer TLSShutdown event's handler function.
type KMIPServerTLSShutdownEvent func(sender *KMIPServer, args *KMIPServerTLSShutdownEventArgs)
func (obj *KMIPServer) GetOnTLSShutdownHandler() KMIPServerTLSShutdownEvent
func (obj *KMIPServer) SetOnTLSShutdownHandler(handlerFunc KMIPServerTLSShutdownEvent)
Remarks
The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
ValidateChain Event (KMIPServer Component)
Passes the chain validation request to the application.
Syntax
// KMIPServerValidateChainEventArgs carries the KMIPServer ValidateChain event's parameters.
type KMIPServerValidateChainEventArgs struct {...}
func (args *KMIPServerValidateChainEventArgs) ConnectionId() int64
func (args *KMIPServerValidateChainEventArgs) ObjectIds() string
func (args *KMIPServerValidateChainEventArgs) Validity() int32
func (args *KMIPServerValidateChainEventArgs) SetValidity(value int32)
func (args *KMIPServerValidateChainEventArgs) OperationStatus() int32
func (args *KMIPServerValidateChainEventArgs) SetOperationStatus(value int32)
// KMIPServerValidateChainEvent defines the signature of the KMIPServer ValidateChain event's handler function.
type KMIPServerValidateChainEvent func(sender *KMIPServer, args *KMIPServerValidateChainEventArgs)
func (obj *KMIPServer) GetOnValidateChainHandler() KMIPServerValidateChainEvent
func (obj *KMIPServer) SetOnValidateChainHandler(handlerFunc KMIPServerValidateChainEvent)
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 Component)
KMIPServer fires this event to notify the application about a verification operation request, and expects the application to perform it.
Syntax
// KMIPServerVerifyEventArgs carries the KMIPServer Verify event's parameters.
type KMIPServerVerifyEventArgs struct {...}
func (args *KMIPServerVerifyEventArgs) ConnectionId() int64
func (args *KMIPServerVerifyEventArgs) ObjectId() string
func (args *KMIPServerVerifyEventArgs) HashAlgorithm() string
func (args *KMIPServerVerifyEventArgs) InputIsHash() bool
func (args *KMIPServerVerifyEventArgs) Data() []byte
func (args *KMIPServerVerifyEventArgs) SignatureData() []byte
func (args *KMIPServerVerifyEventArgs) InitIndicator() bool
func (args *KMIPServerVerifyEventArgs) FinalIndicator() bool
func (args *KMIPServerVerifyEventArgs) ValidationResult() int32
func (args *KMIPServerVerifyEventArgs) SetValidationResult(value int32)
func (args *KMIPServerVerifyEventArgs) CorrelationValue() string
func (args *KMIPServerVerifyEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerVerifyEventArgs) OperationStatus() int32
func (args *KMIPServerVerifyEventArgs) SetOperationStatus(value int32)
// KMIPServerVerifyEvent defines the signature of the KMIPServer Verify event's handler function.
type KMIPServerVerifyEvent func(sender *KMIPServer, args *KMIPServerVerifyEventArgs)
func (obj *KMIPServer) GetOnVerifyHandler() KMIPServerVerifyEvent
func (obj *KMIPServer) SetOnVerifyHandler(handlerFunc KMIPServerVerifyEvent)
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 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 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 Component)
Delegates the hash verification operation to a custom handler.
Syntax
// KMIPServerVerifyHashEventArgs carries the KMIPServer VerifyHash event's parameters.
type KMIPServerVerifyHashEventArgs struct {...}
func (args *KMIPServerVerifyHashEventArgs) ConnectionId() int64
func (args *KMIPServerVerifyHashEventArgs) ObjectId() string
func (args *KMIPServerVerifyHashEventArgs) HashAlgorithm() string
func (args *KMIPServerVerifyHashEventArgs) Data() []byte
func (args *KMIPServerVerifyHashEventArgs) Hash() []byte
func (args *KMIPServerVerifyHashEventArgs) InitIndicator() bool
func (args *KMIPServerVerifyHashEventArgs) FinalIndicator() bool
func (args *KMIPServerVerifyHashEventArgs) IsValid() bool
func (args *KMIPServerVerifyHashEventArgs) SetIsValid(value bool)
func (args *KMIPServerVerifyHashEventArgs) CorrelationValue() string
func (args *KMIPServerVerifyHashEventArgs) SetCorrelationValue(value string)
func (args *KMIPServerVerifyHashEventArgs) OperationStatus() int32
func (args *KMIPServerVerifyHashEventArgs) SetOperationStatus(value int32)
// KMIPServerVerifyHashEvent defines the signature of the KMIPServer VerifyHash event's handler function.
type KMIPServerVerifyHashEvent func(sender *KMIPServer, args *KMIPServerVerifyHashEventArgs)
func (obj *KMIPServer) GetOnVerifyHashHandler() KMIPServerVerifyHashEvent
func (obj *KMIPServer) SetOnVerifyHashHandler(handlerFunc KMIPServerVerifyHashEvent)
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 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 |
Config Settings (KMIPServer Component)
The struct 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 struct, access to these internal properties is provided through the Config method.KMIPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
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. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
| 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) |
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):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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:
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:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (KMIPServer Component)
KMIPServer Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 20971521 | KMIP request failed (SB_ERROR_KMIP_REQUEST_FAILED) |
| 20971522 | The input file does not exist (SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS) |
| 20971523 | Unsupported key algorithm (SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM) |
| 20971524 | Invalid key (SB_ERROR_KMIP_INVALID_KEY) |