KMIPClient Component
Properties Methods Events Configuration Settings Errors
The KMIPClient component provides client-side functionality for KMIP.
Syntax
nsoftware.SecureBlackbox.Kmipclient
Remarks
The Key Management Interoperability Protocol (KMIP) is an OASIS standard for communication between different key management servers and clients.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
DataFile | A path to the file containing the unsigned data. |
DataStream | A stream containing the unsigned data. |
EncoderType | Specifies the KMIP encoder type. |
ExternalCrypto | Provides access to external signing and DC parameters. |
Host | Specifies the host name of the KMIP server. |
InputFile | Path to the file containing data to be signed, verified, encrypted or decrypted. |
InputStream | A stream containing data to be signed, verified, encrypted or decrypted. |
Objects | A list of objects returned by GetList . |
OutputFile | Specifies the file where the signed, encrypted, or decrypted data should be saved. |
OutputStream | The stream where the signed, encrypted, or decrypted document should be saved. |
Password | Specifies a password to authenticate to the KMIP server. |
PinnedCert | The certificate to perform operations on. |
PinnedCertRequest | The certificate request to perform operations on. |
Port | Specifies the port on the KMIP server to connect to. |
Proxy | The proxy server settings. |
SignatureValidationResult | The signature validation result. |
SocketSettings | Manages network connection settings. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
TLSSettings | Manages TLS layer settings. |
Username | The username to authenticate to the KMIP server. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddCertificate | Imports a certificate to the KMIP server. |
AddKey | Imports a key to the KMIP server. |
AddPinned | Imports a certificate to the KMIP server. |
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts the provided data using a key stored on the KMIP server. |
Encrypt | Encrypts the provided data using a key stored on the KMIP server. |
GenerateCert | Generates a new certificate on the KMIP server. |
GenerateCertFromPinned | Generates a new certificate on the KMIP server from the pinned certificate. |
GenerateCertFromRequest | Generates a new certificate on the KMIP server from the certificate request. |
GenerateKey | Generates a symmetric key or an asymmetric key pair on the KMIP server. |
GetList | Retrieves the list of objects of a given type. |
Remove | Removes the specified object from the server. |
Sign | Signs the data using a key on the KMIP server. |
Verify | Verifies digitally signed data. |
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.
Error | Provides information about errors during KMIP operations. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
Notification | This event notifies the application about an underlying control flow event. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
BlockCipherMode | Block cipher mode to use for encrypting or decrypting. |
BlockSize | Block size of data for encrypting, decrypting or signing. |
Curve | Name of the curve of the newly added elliptic cryptography (EC) key. |
HashAlgorithm | Hash algorithm to use for signing or verifying. |
IVCounterNonce | Initialization vector, counter or nonce for encrypting or decrypting. |
MajorProtocolVersion | Major protocol version of the KMIP server. |
MaximumItems | The maximum number of items to be returned on getting the object list. |
MinorProtocolVersion | Minor protocol version of the KMIP server. |
OffsetItems | The number of items to skip on getting the object list. |
PaddingMethod | Padding method to use for encrypting or decrypting. |
RandomIV | Whether to generate the initialization vector automatically. |
TagLength | Tag length to use for encrypting or decrypting. |
TempPath | Path for storing temporary files. |
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 component (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |