KMIPClient Component

Properties   Methods   Events   Config 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.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

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.

Config Settings

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

DataFile Property (KMIPClient Component)

A path to the file containing the unsigned data.

Syntax

• C#
• VB.NET

public string DataFile { get; set; }

Public Property DataFile As String

Default Value

""

Remarks

When validating detached signatures, use this property to provide the unsigned data.

DataStream Property (KMIPClient Component)

A stream containing the unsigned data.

Syntax

• C#
• VB.NET

public System.IO.Stream DataStream { get; set; }

Public Property DataStream As System.IO.Stream

Default Value

null

Remarks

When validating detached signatures, use this property to provide the unsigned data.

This property is not available at design time.

EncoderType Property (KMIPClient Component)

Specifies the KMIP encoder type.

Syntax

• C#
• VB.NET

public KmipclientEncoderTypes EncoderType { get; set; }

enum KmipclientEncoderTypes {
  etTTLV,
  etXML,
  etJSON
}

Public Property EncoderType As KmipclientEncoderTypes

Enum KmipclientEncoderTypes
  etTTLV
  etXML
  etJSON
End Enum

Default Value

0

Remarks

Use this property to specify the KMIP message encoding to be used in the communications with the server.

ExternalCrypto Property (KMIPClient Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

FIPSMode Property (KMIPClient Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Host Property (KMIPClient Component)

Specifies the host name of the KMIP server.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

Default Value

""

Remarks

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

InputFile Property (KMIPClient Component)

Path to the file containing data to be signed, verified, encrypted or decrypted.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

Provide the full path to the file containing data to be signed, verified, encrypted or decrypted.

InputStream Property (KMIPClient Component)

A stream containing data to be signed, verified, encrypted or decrypted.

Syntax

• C#
• VB.NET

public System.IO.Stream InputStream { get; set; }

Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to provide the stream containing the data to be processed.

This property is not available at design time.

Objects Property (KMIPClient Component)

A list of objects returned by GetList .

Syntax

• C#
• VB.NET

public KMIPObjectList Objects { get; }

Public ReadOnly Property Objects As KMIPObjectList

Remarks

This property provides access to the list of objects returned by GetList.

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

OutputFile Property (KMIPClient Component)

Specifies the file where the signed, encrypted, or decrypted data should be saved.

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

Provide a full path to the file where the signed, encrypted, or decrypted data should be saved.

OutputStream Property (KMIPClient Component)

The stream where the signed, encrypted, or decrypted document should be saved.

Syntax

• C#
• VB.NET

public System.IO.Stream OutputStream { get; set; }

Public Property OutputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to provide the stream to write the signed, encrypted, or decrypted data to.

This property is not available at design time.

Password Property (KMIPClient Component)

Specifies a password to authenticate to the KMIP server.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

Use this property to provide a password for authentication on the KMIP server.

PinnedCert Property (KMIPClient Component)

The certificate to perform operations on.

Syntax

• C#
• VB.NET

public Certificate PinnedCert { get; set; }

Public Property PinnedCert As Certificate

Remarks

Use this property to provide the certificate object on which a subsequent operation should be performed.

This property is not available at design time.

PinnedCertRequest Property (KMIPClient Component)

The certificate request to perform operations on.

Syntax

• C#
• VB.NET

public CertificateRequest PinnedCertRequest { get; set; }

Public Property PinnedCertRequest As CertificateRequest

Remarks

Use this property to provide the certificate request object on which a subsequent operation should be performed.

This property is not available at design time.

Port Property (KMIPClient Component)

Specifies the port on the KMIP server to connect to.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

Default Value

0

Remarks

Provide the port number on which the component should make requests to the KMIP server.

Proxy Property (KMIPClient Component)

The proxy server settings.

Syntax

• C#
• VB.NET

public ProxySettings Proxy { get; }

Public ReadOnly Property Proxy As ProxySettings

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

SignatureValidationResult Property (KMIPClient Component)

The signature validation result.

Syntax

• C#
• VB.NET

public KmipclientSignatureValidationResults SignatureValidationResult { get; }

enum KmipclientSignatureValidationResults {
  svtValid,
  svtUnknown,
  svtCorrupted,
  svtSignerNotFound,
  svtFailure
}

Public ReadOnly Property SignatureValidationResult As KmipclientSignatureValidationResults

Enum KmipclientSignatureValidationResults
  svtValid
  svtUnknown
  svtCorrupted
  svtSignerNotFound
  svtFailure
End Enum

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

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

SocketSettings Property (KMIPClient Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

TLSClientChain Property (KMIPClient Component)

The TLS client certificate chain.

Syntax

• C#
• VB.NET

public CertificateList TLSClientChain { get; }

Public Property TLSClientChain As CertificateList

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it.

This property is not available at design time.

TLSServerChain Property (KMIPClient Component)

The TLS server's certificate chain.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public ReadOnly Property TLSServerChain As CertificateList

Remarks

Use this property to access the certificate chain sent by the TLS server.

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

TLSSettings Property (KMIPClient Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Username Property (KMIPClient Component)

The username to authenticate to the KMIP server.

Syntax

• C#
• VB.NET

public string Username { get; set; }

Public Property Username As String

Default Value

""

Remarks

Use this property to provide a username for authentication on the KMIP server.

AddCertificate Method (KMIPClient Component)

Imports a certificate to the KMIP server.

Syntax

• C#
• VB.NET

public string AddCertificate(string certPassword, bool addPrivateKey, string id);

Public Function AddCertificate(ByVal CertPassword As String, ByVal AddPrivateKey As Boolean, ByVal Id As String) As String

Remarks

Call this method to import a certificate to the KMIP server. Provide the key via InputFile or InputStream property.

Use the Id parameter to supply a unique certificate object identifier. AddPrivateKey instructs the component to import the private key as well. The method returns the actual ID of the new object, which may differ from the supplied one.

AddKey Method (KMIPClient Component)

Imports a key to the KMIP server.

Syntax

• C#
• VB.NET

public string AddKey(string id);

Public Function AddKey(ByVal Id As String) As String

Remarks

Call this method to import a key to the KMIP server. Provide the key via InputFile or InputStream property.

Use the Id parameter to supply a unique certificate object identifier. The method returns the actual ID of the new object, which may differ from the supplied one.

AddPinned Method (KMIPClient Component)

Imports a certificate to the KMIP server.

Syntax

• C#
• VB.NET

public string AddPinned(bool addPrivateKey, string id);

Public Function AddPinned(ByVal AddPrivateKey As Boolean, ByVal Id As String) As String

Remarks

Call this method to import a certificate to the KMIP server. Provide the certificate in PinnedCert property.

Use the Id parameter to supply a unique certificate object identifier. AddPrivateKey instructs the component to import the private key as well. The method returns the actual ID of the new object, which may differ from the supplied one.

Config Method (KMIPClient Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

Decrypt Method (KMIPClient Component)

Decrypts the provided data using a key stored on the KMIP server.

Syntax

• C#
• VB.NET

public void Decrypt(string uniqueIdentifier);

Public Sub Decrypt(ByVal UniqueIdentifier As String)

Remarks

Use this method to decrypt the data using the key with the specified UniqueIdentifier. Provide the encrypted data via InputFile (or InputStream). The decrypted data will be saved to OutputFile (or OutputStream).

DoAction Method (KMIPClient Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. 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 insencitive) 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;....

Encrypt Method (KMIPClient Component)

Encrypts the provided data using a key stored on the KMIP server.

Syntax

• C#
• VB.NET

public void Encrypt(string uniqueIdentifier);

Public Sub Encrypt(ByVal UniqueIdentifier As String)

Remarks

Use this method to encrypt the data using the key with the specified UniqueIdentifier. Provide the data to be encrypted via InputFile or InputStream. The encrypted data will be saved to OutputFile (or OutputStream).

GenerateCert Method (KMIPClient Component)

Generates a new certificate on the KMIP server.

Syntax

• C#
• VB.NET

public string GenerateCert(string publicKeyUniqueIdentifier, string keyAlgorithm, string hashAlgorithm, int keyLength, string subjectRDN, string id);

Public Function GenerateCert(ByVal PublicKeyUniqueIdentifier As String, ByVal KeyAlgorithm As String, ByVal HashAlgorithm As String, ByVal KeyLength As Integer, ByVal SubjectRDN As String, ByVal Id As String) As String

Remarks

Use KeyAlgorithm, HashAlgorithm, and KeyLength to specify the desired algorithms and key length. SubjectRDN should identify the new certificate's owner.

Use the Id parameter to suggest a unique identifier for the certificate object. The method returns the actual Id assigned to the new certificate (it may differ from the one you supplied).

GenerateCertFromPinned Method (KMIPClient Component)

Generates a new certificate on the KMIP server from the pinned certificate.

Syntax

• C#
• VB.NET

public string GenerateCertFromPinned(string publicKeyUniqueIdentifier, string id);

Public Function GenerateCertFromPinned(ByVal PublicKeyUniqueIdentifier As String, ByVal Id As String) As String

Remarks

Use the Id parameter to provide a unique identifier for the new certificate. The method will return the actual Id assigned to the new certificate, which may differ from the one you provided.

GenerateCertFromRequest Method (KMIPClient Component)

Generates a new certificate on the KMIP server from the certificate request

Syntax

• C#
• VB.NET

public string GenerateCertFromRequest(string id);

Public Function GenerateCertFromRequest(ByVal Id As String) As String

Remarks

Provide the certificate request via PinnedCertRequest property. The returned value contains the Id assigned to the certificate, which may differ from the one you supplied.

GenerateKey Method (KMIPClient Component)

Generates a symmetric key or an asymmetric key pair on the KMIP server.

Syntax

• C#
• VB.NET

public string GenerateKey(string keyAlgorithm, int keyLength, string id);

Public Function GenerateKey(ByVal KeyAlgorithm As String, ByVal KeyLength As Integer, ByVal Id As String) As String

Remarks

Use KeyAlgorithm and KeyLength to indicate the desired algorithm and key length. Provide an identifier (name) of the new key via the Id parameter.

The method returns the Id assigned by the server to the new key object. This may differ from the one you supplied.

GetList Method (KMIPClient Component)

Retrieves the list of objects of a given type.

Syntax

• C#
• VB.NET

public void GetList(int objectTypes);

Public Sub GetList(ByVal ObjectTypes As Integer)

Remarks

ObjectTypes is a bit mask according to which objects of one or more types can be selected. Possible values:

If ObjectTypes of 0 is provided, all objects will be requested from the server.

Remove Method (KMIPClient Component)

Removes the specified object from the server.

Syntax

• C#
• VB.NET

public void Remove(string uniqueIdentifier);

Public Sub Remove(ByVal UniqueIdentifier As String)

Remarks

Use this method to delete the object specified by its UniqueIdentifier from the KMIP server.

Sign Method (KMIPClient Component)

Signs the data using a key on the KMIP server.

Syntax

• C#
• VB.NET

public void Sign(string uniqueIdentifier);

Public Sub Sign(ByVal UniqueIdentifier As String)

Remarks

Use this method to sign the data using the key with the specified UniqueIdentifier. Pass the data to be signed via InputFile (or InputStream) property. The resulting signed data will be written to OutputFile (or OutputStream).

Verify Method (KMIPClient Component)

Verifies digitally signed data.

Syntax

• C#
• VB.NET

public void Verify(string uniqueIdentifier);

Public Sub Verify(ByVal UniqueIdentifier As String)

Remarks

Use this method to verify the integrity of the signature using a server-side key.

Please provide the signature via InputFile (or InputStream) property. For detached signatures, please also provide the data that was signed via DataFile (or DataStream) property.

Error Event (KMIPClient Component)

Provides information about errors during KMIP operations.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, KmipclientErrorEventArgs e);

public class KmipclientErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As KmipclientErrorEventArgs)

Public Class KmipclientErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired in case of exceptional conditions occured during KMIP operations.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (KMIPClient Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, KmipclientExternalSignEventArgs e);

public class KmipclientExternalSignEventArgs : EventArgs {
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As KmipclientExternalSignEventArgs)

Public Class KmipclientExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

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 component via SignedData parameter.

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

The component uses base16 (hex) encoding for 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 a .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(); };

Notification Event (KMIPClient Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, KmipclientNotificationEventArgs e);

public class KmipclientNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As KmipclientNotificationEventArgs)

Public Class KmipclientNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

TLSCertNeeded Event (KMIPClient Component)

Fires when a remote TLS party requests a client certificate.

Syntax

• C#
• VB.NET

public event OnTLSCertNeededHandler OnTLSCertNeeded;

public delegate void OnTLSCertNeededHandler(object sender, KmipclientTLSCertNeededEventArgs e);

public class KmipclientTLSCertNeededEventArgs : EventArgs {
  public string Host { get; }
  public string CANames { get; }
}

Public Event OnTLSCertNeeded As OnTLSCertNeededHandler

Public Delegate Sub OnTLSCertNeededHandler(sender As Object, e As KmipclientTLSCertNeededEventArgs)

Public Class KmipclientTLSCertNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property CANames As String
End Class

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (KMIPClient Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, KmipclientTLSCertValidateEventArgs e);

public class KmipclientTLSCertValidateEventArgs : EventArgs {
  public string ServerHost { get; }
  public string ServerIP { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As KmipclientTLSCertValidateEventArgs)

Public Class KmipclientTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ServerHost As String
  Public ReadOnly Property ServerIP As String
  Public Property Accept As Boolean
End Class

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.

TLSEstablished Event (KMIPClient Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, KmipclientTLSEstablishedEventArgs e);

public class KmipclientTLSEstablishedEventArgs : EventArgs {
  public string Host { get; }
  public string Version { get; }
  public string Ciphersuite { get; }
  public byte[] ConnectionId { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As KmipclientTLSEstablishedEventArgs)

Public Class KmipclientTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property Version As String
  Public ReadOnly Property Ciphersuite As String
  Public ReadOnly Property ConnectionId As Byte()
  Public Property Abort As Boolean
End Class

Remarks

The component uses this event to notify the application about successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (KMIPClient Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

• C#
• VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, KmipclientTLSHandshakeEventArgs e);

public class KmipclientTLSHandshakeEventArgs : EventArgs {
  public string Host { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As KmipclientTLSHandshakeEventArgs)

Public Class KmipclientTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public Property Abort As Boolean
End Class

Remarks

The component uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSShutdown Event (KMIPClient Component)

Reports the graceful closure of a TLS connection.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, KmipclientTLSShutdownEventArgs e);

public class KmipclientTLSShutdownEventArgs : EventArgs {
  public string Host { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As KmipclientTLSShutdownEventArgs)

Public Class KmipclientTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
End Class

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

CertificateRequest Type

Provides access to details of an individual certificate request (CSR).

Remarks

This type represents a certificate request as defined in PKCS#10.

Fields

• C#
• VB.NET

public CertificateRequest(byte[] bytes, int startIndex, int count);

Public CertificateRequest(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the certificate request from a memory buffer. Bytes is a buffer containing raw certificate request data, StartIndex and Count specify the starting position and number of bytes to be read from the buffer.

• C#
• VB.NET

public CertificateRequest(string path);

Public CertificateRequest(ByVal Path As String)

Loads the certificate request from a file. Path specifies the full path to the file containing the certificate request data.

• C#
• VB.NET

public CertificateRequest(System.IO.Stream stream);

Public CertificateRequest(ByVal Stream As System.IO.Stream)

Loads the certificate request from a stream. Stream is a stream containing the certificate request data.

• C#
• VB.NET

public CertificateRequest();

Public CertificateRequest()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

KMIPObject Type

A container representing a KMIP object.

Remarks

KMIPObject represents an object stored on the KMIP server. Certificates, certificate requests, and keys are examples of KMIP objects.

Fields

• C#
• VB.NET

public KMIPObject();

Public KMIPObject()

Creates a new KMIP object with the default field values.

• C#
• VB.NET

public KMIPObject(string AUniqueIdentifier, int AObjectType, int ADigitalSignatureAlgorithm, int ACryptographicAlgorithm, int ACryptographicLength, string AID);

Public KMIPObject(ByVal AUniqueIdentifier As String, ByVal AObjectType As Integer, ByVal ADigitalSignatureAlgorithm As Integer, ByVal ACryptographicAlgorithm As Integer, ByVal ACryptographicLength As Integer, ByVal AID As String)

Creates a new KMIP object with the specified field values. Supported object types: otCertificate 0x01 otSymmetricKey 0x02 otPublicKey 0x04 otPrivateKey 0x08 .

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

• C#
• VB.NET

public ProxySettings();

Public ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

• C#
• VB.NET

public SocketSettings();

Public SocketSettings()

Creates a new SocketSettings object.

TLSSettings Type

A container for TLS connection settings.

Remarks

TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

• C#
• VB.NET

public TLSSettings();

Public TLSSettings()

Creates a new TLSSettings object.

Config Settings (KMIPClient Component)

KMIPClient Config Settings

Base Config Settings