KMIPClient Class
Properties Methods Events Config Settings Errors
The KMIPClient class provides client-side functionality for KMIP.
Syntax
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 class 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. |
| FIPSMode | Reserved. |
| 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 class 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. |
| DoAction | Performs an additional action. |
| 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 class 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. |
| TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
| TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class 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 class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| 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. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
DataFile Property (KMIPClient Class)
A path to the file containing the unsigned data.
Syntax
public String getDataFile(); public void setDataFile(String dataFile);
Default Value
""
Remarks
When validating detached signatures, use this property to provide the unsigned data.
DataStream Property (KMIPClient Class)
A stream containing the unsigned data.
Syntax
public java.io.InputStream getDataStream(); public void setDataStream(java.io.InputStream dataStream);
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 Class)
Specifies the KMIP encoder type.
Syntax
public int getEncoderType(); public void setEncoderType(int encoderType); Enumerated values: public final static int etTTLV = 0; public final static int etXML = 1; public final static int etJSON = 2;
Default Value
0
Remarks
Use this property to specify the KMIP message encoding to be used in the communications with the server.
| etTTLV | 0 |
| etXML | 1 |
| etJSON | 2 |
ExternalCrypto Property (KMIPClient Class)
Provides access to external signing and DC parameters.
Syntax
public ExternalCrypto getExternalCrypto();
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 Class)
Reserved.
Syntax
public boolean isFIPSMode(); public void setFIPSMode(boolean FIPSMode);
Default Value
False
Remarks
This property is reserved for future use.
Host Property (KMIPClient Class)
Specifies the host name of the KMIP server.
Syntax
public String getHost(); public void setHost(String host);
Default Value
""
Remarks
Use this property to specify the address of the KMIP server.
InputFile Property (KMIPClient Class)
Path to the file containing data to be signed, verified, encrypted or decrypted.
Syntax
public String getInputFile(); public void setInputFile(String inputFile);
Default Value
""
Remarks
Provide the full path to the file containing data to be signed, verified, encrypted or decrypted.
InputStream Property (KMIPClient Class)
A stream containing data to be signed, verified, encrypted or decrypted.
Syntax
public java.io.InputStream getInputStream(); public void setInputStream(java.io.InputStream inputStream);
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 Class)
A list of objects returned by GetList .
Syntax
public KMIPObjectList getObjects();
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 Class)
Specifies the file where the signed, encrypted, or decrypted data should be saved.
Syntax
public String getOutputFile(); public void setOutputFile(String outputFile);
Default Value
""
Remarks
Provide a full path to the file where the signed, encrypted, or decrypted data should be saved.
OutputStream Property (KMIPClient Class)
The stream where the signed, encrypted, or decrypted document should be saved.
Syntax
public java.io.OutputStream getOutputStream(); public void setOutputStream(java.io.OutputStream outputStream);
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 Class)
Specifies a password to authenticate to the KMIP server.
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
Use this property to provide a password for authentication on the KMIP server.
PinnedCert Property (KMIPClient Class)
The certificate to perform operations on.
Syntax
public Certificate getPinnedCert(); public void setPinnedCert(Certificate pinnedCert);
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 Class)
The certificate request to perform operations on.
Syntax
public CertificateRequest getPinnedCertRequest(); public void setPinnedCertRequest(CertificateRequest pinnedCertRequest);
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 Class)
Specifies the port on the KMIP server to connect to.
Syntax
public int getPort(); public void setPort(int port);
Default Value
0
Remarks
Provide the port number on which the class should make requests to the KMIP server.
Proxy Property (KMIPClient Class)
The proxy server settings.
Syntax
public ProxySettings getProxy();
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
SignatureValidationResult Property (KMIPClient Class)
The signature validation result.
Syntax
public int getSignatureValidationResult(); Enumerated values: public final static int svtValid = 0; public final static int svtUnknown = 1; public final static int svtCorrupted = 2; public final static int svtSignerNotFound = 3; public final static int svtFailure = 4;
Default Value
0
Remarks
Use this property to check the result of the most recent signature validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
This property is read-only and not available at design time.
SocketSettings Property (KMIPClient Class)
Manages network connection settings.
Syntax
public SocketSettings getSocketSettings();
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
TLSClientChain Property (KMIPClient Class)
The TLS client certificate chain.
Syntax
public CertificateList getTLSClientChain(); public void setTLSClientChain(CertificateList TLSClientChain);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. 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 Class)
The TLS server's certificate chain.
Syntax
public CertificateList getTLSServerChain();
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 Class)
Manages TLS layer settings.
Syntax
public TLSSettings getTLSSettings();
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Username Property (KMIPClient Class)
The username to authenticate to the KMIP server.
Syntax
public String getUsername(); public void setUsername(String username);
Default Value
""
Remarks
Use this property to provide a username for authentication on the KMIP server.
AddCertificate Method (Kmipclient Class)
Imports a certificate to the KMIP server.
Syntax
public String addCertificate(String certPassword, boolean addPrivateKey, String id);
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 Class)
Imports a key to the KMIP server.
Syntax
public String addKey(String id);
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 Class)
Imports a certificate to the KMIP server.
Syntax
public String addPinned(boolean addPrivateKey, String id);
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 Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (Kmipclient Class)
Decrypts the provided data using a key stored on the KMIP server.
Syntax
public void decrypt(String uniqueIdentifier);
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 Class)
Performs an additional action.
Syntax
public String doAction(String actionID, String actionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case 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 Class)
Encrypts the provided data using a key stored on the KMIP server.
Syntax
public void encrypt(String uniqueIdentifier);
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 Class)
Generates a new certificate on the KMIP server.
Syntax
public String generateCert(String publicKeyUniqueIdentifier, String keyAlgorithm, String hashAlgorithm, int keyLength, String subjectRDN, String id);
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 Class)
Generates a new certificate on the KMIP server from the pinned certificate.
Syntax
public String generateCertFromPinned(String publicKeyUniqueIdentifier, String id);
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 Class)
Generates a new certificate on the KMIP server from the certificate request.
Syntax
public String generateCertFromRequest(String id);
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 Class)
Generates a symmetric key or an asymmetric key pair on the KMIP server.
Syntax
public String generateKey(String keyAlgorithm, int keyLength, String id);
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 Class)
Retrieves the list of objects of a given type.
Syntax
public void getList(int objectTypes);
Remarks
ObjectTypes is a bit mask according to which objects of one or more types can be selected. Possible values:
| otUnknown | 0x00 | |
| otCertificate | 0x01 | |
| otSymmetricKey | 0x02 | |
| otPublicKey | 0x04 | |
| otPrivateKey | 0x08 |
If ObjectTypes of 0 is provided, all objects will be requested from the server.
Remove Method (Kmipclient Class)
Removes the specified object from the server.
Syntax
public void remove(String uniqueIdentifier);
Remarks
Use this method to delete the object specified by its UniqueIdentifier from the KMIP server.
Sign Method (Kmipclient Class)
Signs the data using a key on the KMIP server.
Syntax
public void sign(String uniqueIdentifier);
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 Class)
Verifies digitally signed data.
Syntax
public void verify(String uniqueIdentifier);
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 Class)
Provides information about errors during KMIP operations.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void error(KmipclientErrorEvent e) {} ... } public class KmipclientErrorEvent { public int errorCode; public String description; }
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 Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void externalSign(KmipclientExternalSignEvent e) {} ... } public class KmipclientExternalSignEvent { public String operationId; public String hashAlgorithm; public String pars; public String data; public String signedData; }
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 Class)
This event notifies the application about an underlying control flow event.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void notification(KmipclientNotificationEvent e) {} ... } public class KmipclientNotificationEvent { public String eventID; public String eventParam; }
Remarks
The class 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 Class)
Fires when a remote TLS party requests a client certificate.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void TLSCertNeeded(KmipclientTLSCertNeededEvent e) {} ... } public class KmipclientTLSCertNeededEvent { public String host; public String CANames; }
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 Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void TLSCertValidate(KmipclientTLSCertValidateEvent e) {} ... } public class KmipclientTLSCertValidateEvent { public String serverHost; public String serverIP; public boolean accept; }
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 Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void TLSEstablished(KmipclientTLSEstablishedEvent e) {} ... } public class KmipclientTLSEstablishedEvent { public String host; public String version; public String ciphersuite; public byte[] connectionId; public boolean abort; }
Remarks
The class 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 Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void TLSHandshake(KmipclientTLSHandshakeEvent e) {} ... } public class KmipclientTLSHandshakeEvent { public String host; public boolean abort; }
Remarks
The class 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 Class)
Reports the graceful closure of a TLS connection.
Syntax
public class DefaultKmipclientEventListener implements KmipclientEventListener { ... public void TLSShutdown(KmipclientTLSShutdownEvent e) {} ... } public class KmipclientTLSShutdownEvent { public String host; }
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
|
Bytes byte[] |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID byte[] |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint byte[] |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits int |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint byte[] |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage int |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin int |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes byte[] |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes byte[] |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements int |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber byte[] |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID byte[] |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public Certificate( bytes, startIndex, count, password);
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.
public Certificate( certBytes, certStartIndex, certCount, keyBytes, keyStartIndex, keyCount, password);
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.
public Certificate( bytes, startIndex, count);
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.
public Certificate( path, password);
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.
public Certificate( certPath, keyPath, password);
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.
public Certificate( path);
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate( stream);
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate( stream, password);
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate( certStream, keyStream, password);
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.
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
|
Bytes byte[] |
Provides access to raw certificate request data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate request (such as signing).
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate request.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits int |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage int |
Indicates the purposes of the key contained in the certificate request, in the form of an OR'ed flag set. This value is a bit mask of the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes byte[] |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes byte[] |
Contains the public key incorporated in the request, in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the requestor to sign this certificate request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Valid boolean |
Indicates whether or not the signature on the request is valid and matches the public key contained in the request. |
Constructors
public CertificateRequest( bytes, startIndex, count);
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.
public CertificateRequest( path);
Loads the certificate request from a file. Path specifies the full path to the file containing the certificate request data.
public CertificateRequest( stream);
Loads the certificate request from a stream. Stream is a stream containing the certificate request data.
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
|
AsyncDocumentID String |
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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CustomParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ExternalHashCalculation boolean |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyID String |
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 extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeySecret String |
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the KeyID topic. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Method int |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Mode int |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
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
|
ID String |
Contains the value currently stored in the ID Placeholder. The ID Placeholder is a temporary variable which is used for storing a unique identifier temporarily during an operation. |
|||||||||||||||
|
KeyAlgorithm String |
The cryptographic algorithm for this object. Supported values: RSA, DSA, EC, ECDSA, DH, ECDH, DES, 3DES, AES, RC2, RC4, Idea, Blowfish, Camellia, Twofish |
|||||||||||||||
|
KeyLength int |
The length of the cryptographic key. |
|||||||||||||||
|
ObjectType int |
The type of this object.
|
|||||||||||||||
|
SigAlgorithm String |
Digital signature algorithm for this object (only for certificates). |
|||||||||||||||
|
UniqueIdentifier String |
The unique identifier of the object generated by the key management system. The identifier is required to be unique within the specific server. |
Constructors
public KMIPObject();
Creates a new KMIP object with the default field values.
public KMIPObject( AUniqueIdentifier, AObjectType, ADigitalSignatureAlgorithm, ACryptographicAlgorithm, ACryptographicLength, AID);
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
|
Address String |
The IP address of the proxy server. |
||||||||||
|
Authentication int |
The authentication type used by the proxy server.
|
||||||||||
|
Password String |
The password to authenticate to the proxy server. |
||||||||||
|
Port int |
The port on the proxy server to connect to. |
||||||||||
|
ProxyType int |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
RequestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
ResponseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
ResponseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
UseIPv6 boolean |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
UseProxy boolean |
Enables or disables proxy-driven connection. |
||||||||||
|
Username String |
Specifies the username credential for proxy authentication. |
Constructors
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
|
DNSMode int |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
DNSPort int |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
DNSQueryTimeout int |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
DNSServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
DNSTotalTimeout int |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
IncomingSpeedLimit int |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
LocalAddress String |
The local network interface to bind the socket to. |
||||||||
|
LocalPort int |
The local port number to bind the socket to. |
||||||||
|
OutgoingSpeedLimit int |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
Timeout int |
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). |
||||||||
|
UseIPv6 boolean |
Enables or disables IP protocol version 6. |
Constructors
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
|
AutoValidateCertificates boolean |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
BaseConfiguration int |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
Ciphersuites String |
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 that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ECCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
Extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
ForceResumeIfDestinationChanges boolean |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
PreSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
PreSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
RenegotiationAttackPreventionMode int |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
RevocationCheck int |
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.
This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
SSLOptions int |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode int |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
UseExtendedMasterSecret boolean |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
UseSessionResumption boolean |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
Versions int |
Th SSL/TLS versions to enable by default.
|
Constructors
public TLSSettings();
Creates a new TLSSettings object.
Config Settings (Kmipclient Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.KMIPClient Config Settings | ||||||||||||||||||||||||||||||
| BlockCipherMode: Block cipher mode to use for encrypting or decrypting.Use this property to specify the block cipher mode to use for encrypting or decrypting. | ||||||||||||||||||||||||||||||
| BlockSize: Block size of data for encrypting, decrypting or signing.Use this property to specify the Block size in bytes of data to use for send on encrypting, decrypting or signing. | ||||||||||||||||||||||||||||||
| Curve: Name of the curve of the newly added elliptic cryptography (EC) key.This property specifies the name of the curve used by the EC key. | ||||||||||||||||||||||||||||||
| HashAlgorithm: Hash algorithm to use for signing or verifying.Use this property to specify the hash algorithm to use for signing or verifying. | ||||||||||||||||||||||||||||||
| IVCounterNonce: Initialization vector, counter or nonce for encrypting or decrypting.Depending on the setup, this property contains one of the following: initialization vector, counter, or nonce, to use for encrypting or decrypting. | ||||||||||||||||||||||||||||||
| MajorProtocolVersion: Major protocol version of the KMIP server.Use this property to specify the major protocol version of the KMIP server. | ||||||||||||||||||||||||||||||
| MaximumItems: The maximum number of items to be returned on getting the object list.Use this property to limit the maximum number of items returned in the object list. | ||||||||||||||||||||||||||||||
| MinorProtocolVersion: Minor protocol version of the KMIP server.Use this property to specify the minor protocol version of the KMIP server. | ||||||||||||||||||||||||||||||
| OffsetItems: The number of items to skip on getting the object list.Defines how many items in the beginning of the object list should be omitted. Only the objects following OffsetItems will be returned upon requesting the objects list. | ||||||||||||||||||||||||||||||
| PaddingMethod: Padding method to use for encrypting or decrypting.Use this property to specify the padding method to use for encrypting or decrypting. | ||||||||||||||||||||||||||||||
| RandomIV: Whether to generate the initialization vector automatically.Set this property to true to tell the class to generate a random IV to be used in encryption or decryption. | ||||||||||||||||||||||||||||||
| TagLength: Tag length to use for encrypting or decrypting.Use this property to specify the tag length to use for encrypting or decrypting. | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| StaticDNS:
Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
|
||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | ||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. | ||||||||||||||||||||||||||||||
| TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). | ||||||||||||||||||||||||||||||
| TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). | ||||||||||||||||||||||||||||||
| UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (Kmipclient Class)
KMIPClient Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 20971521 Request failed (SB_ERROR_KMIP_REQUEST_FAILED) | |
| 20971522 Input file does not exist (SB_ERROR_KMIP_INPUTFILE_NOT_EXISTS) | |
| 20971523 Unsupported key algorithm (SB_ERROR_KMIP_UNSUPPORTED_KEY_ALGORITHM) | |
| 20971524 Unsupported extraction mode (SB_ERROR_KMIP_INVALID_KEY) |