PublicKeyCrypto Component
Properties Methods Events Config Settings Errors
The PublicKeyCrypto component supports encrypting, decrypting, signing and verifying messages.
Syntax
nsoftware.SecureBlackbox.Publickeycrypto
Remarks
PublicKeyCrypto allows you to encrypt, decrypt, sign and verify uninterpreted data. It implements low-level, or "raw" cryptographic primitives, such as RSA-PKCS1. The cryptographic primitives are typically used internally in higher-level protocols, such as CMS or PGP.
Cryptographic primitives work on small quantities of data (up to a few kilobytes). If you are looking to encrypt or sign large blobs of data, it is very likely that you need to use higher-level classes, such as MessageEncryptor, CAdESSigner, or PGPWriter.
A code snippet below illustrates the use of PublicKeyCrypto to encrypt (and decrypt) a data piece with OpenSSL-generated RSA keypair.
procedure TForm1.HandleKeyPasswordNeeded(Sender: TObject; const NeededFor: String;
var Password: String; var Cancel: Boolean);
begin
Password := 'key-password';
end;
procedure TForm1.btnRSAEncryptClick(Sender: TObject);
var
Crypto : TsbxPublicKeyCrypto;
KeyMgr : TsbxCryptoKeyManager;
Plaintext, Ciphertext, Decrypted : TBytes;
begin
// prep
Plaintext := TEncoding.UTF8.GetBytes('Hello, World!');
// encryption
KeyMgr := TsbxCryptoKeyManager.Create(nil);
try
KeyMgr.ImportFromFile('public.pem', kffPEM, '', '', '', ktPublic);
Crypto := TsbxPublicKeyCrypto.Create(nil);
try
Crypto.Key := KeyMgr.Key;
Ciphertext := Crypto.Encrypt(Plaintext);
finally
FreeAndNil(Crypto);
end;
finally
FreeAndNil(KeyMgr);
end;
// decryption
KeyMgr := TsbxCryptoKeyManager.Create(nil);
try
KeyMgr.OnPasswordNeeded := HandleKeyPasswordNeeded;
KeyMgr.ImportFromFile('private.pem', kffPEM, '', '', '', ktSecret);
Crypto := TsbxPublicKeyCrypto.Create(nil);
try
Crypto.Key := KeyMgr.Key;
Decrypted := Crypto.Decrypt(Ciphertext);
finally
FreeAndNil(Crypto);
end;
finally
FreeAndNil(KeyMgr);
end;
ShowMessage(TEncoding.UTF8.GetString(Decrypted));
end;
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
CanEncrypt | Returns true if the crypto object can be used for encryption. |
CanSign | Returns true if the crypto object is capable of data signing. |
FIPSMode | Reserved. |
HashAlgorithm | The hash algorithm to be used during the crypto operation. |
InputEncoding | The encoding to apply to the input data. |
InputIsHash | Indicates whether the input data contains the hash or the actual data. |
JsonDetails | Provides a container for JSON settings. |
Key | The key to employ for the crypto operation. |
OutputEncoding | The encoding type to apply to the output data. |
Scheme | The algorithm scheme to use. |
SchemeParams | The algorithm scheme parameters to employ. |
SignatureValidationResult | The signature validation result. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts a buffer. |
DecryptFile | Decrypts a file. |
DecryptStream | Decrypts a stream. |
DoAction | Performs an additional action. |
Encrypt | Encrypts a buffer. |
EncryptFile | Encrypts a file. |
EncryptStream | Encrypts a stream. |
Sign | Signs a buffer. |
SignFile | Signs a file. |
SignStream | Signs a stream. |
Verify | Verifies an enveloped or enveloping signature contained in a buffer. |
VerifyDetached | Verifies a detached signature. |
VerifyDetachedFile | Verifies a detached signature. |
VerifyDetachedStream | Verifies a detached signature. |
VerifyFile | Verifies an enveloped or enveloping signature contained in a file. |
VerifyStream | Verifies an enveloping or enveloped signature contained in a stream. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Reports error information during a crypto operation. |
Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the component. |
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 components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
CanEncrypt Property (PublicKeyCrypto Component)
Returns true if the crypto object can be used for encryption.
Syntax
Default Value
False
Remarks
This property returns true if the crypto object can be used for encryption and decryption. This capability depends on the cryptographic algorithm.
This property is read-only and not available at design time.
CanSign Property (PublicKeyCrypto Component)
Returns true if the crypto object is capable of data signing.
Syntax
Default Value
False
Remarks
This property returns true if the crypto object can be used for signing data and validating signatures. This capability depends on the cryptographic algorithm.
This property is read-only and not available at design time.
FIPSMode Property (PublicKeyCrypto Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
HashAlgorithm Property (PublicKeyCrypto Component)
The hash algorithm to be used during the crypto operation.
Syntax
Default Value
"SHA256"
Remarks
Use this property to adjust the hash to be used during the cryptographic operation. This typically applies to signing and verification, but can also apply to more complex encryption primitives, such as RSA-OEAP.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
InputEncoding Property (PublicKeyCrypto Component)
The encoding to apply to the input data.
Syntax
public PublickeycryptoInputEncodings InputEncoding { get; set; }
enum PublickeycryptoInputEncodings { cetDefault, cetBinary, cetBase64, cetCompact, cetJSON }
Public Property InputEncoding As PublickeycryptoInputEncodings
Enum PublickeycryptoInputEncodings cetDefault cetBinary cetBase64 cetCompact cetJSON End Enum
Default Value
0
Remarks
Use this property to specify the encoding to apply to the input data.
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
InputIsHash Property (PublicKeyCrypto Component)
Indicates whether the input data contains the hash or the actual data.
Syntax
Default Value
False
Remarks
Set this property to true to tell the component that the data you are passing to it is the hash of the data, rather than the actual (unhashed) data. If this property is set to false, component will hash the provided data internally if it is assumed by the algorithm.
This property is not available at design time.
JsonDetails Property (PublicKeyCrypto Component)
Provides a container for JSON settings.
Syntax
public JWSettings JsonDetails { get; }
Public ReadOnly Property JsonDetails As JWSettings
Remarks
Use this property when using JSON Web Encryption/Signature to tune up the JSON parameters.
This property is read-only.
Please refer to the JWSettings type for a complete list of fields.Key Property (PublicKeyCrypto Component)
The key to employ for the crypto operation.
Syntax
Remarks
Use this property to specify the key to perform the crypto operation with.
Please note that the key assigned should be of a proper type (a public key, not a symmetric key), have a proper set of capabilities (signing and/or encryption), and include its private part for signing and decryption operations.
This property is not available at design time.
Please refer to the CryptoKey type for a complete list of fields.OutputEncoding Property (PublicKeyCrypto Component)
The encoding type to apply to the output data.
Syntax
public PublickeycryptoOutputEncodings OutputEncoding { get; set; }
enum PublickeycryptoOutputEncodings { cetDefault, cetBinary, cetBase64, cetCompact, cetJSON }
Public Property OutputEncoding As PublickeycryptoOutputEncodings
Enum PublickeycryptoOutputEncodings cetDefault cetBinary cetBase64 cetCompact cetJSON End Enum
Default Value
0
Remarks
Use this property to specify the encoding type to apply to the protected data.
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
Scheme Property (PublicKeyCrypto Component)
The algorithm scheme to use.
Syntax
Default Value
""
Remarks
Certain asymmetric algorithms are often accompanied with a specific algorithm scheme. Two typical examples are RSA's own OAEP and PSS schemes. Use this property to tune up the scheme to use. Leave it empty to proceed with the standard scheme (such as PKCS#1-v1.5 for RSA). Supported schemes:
RSA: PKCS#1, PSS, OAEP, SSL3
ECDSA: ed25519, ed448, ed25519ph, ed448ph
SchemeParams Property (PublicKeyCrypto Component)
The algorithm scheme parameters to employ.
Syntax
Default Value
""
Remarks
Use this property to specify the parameters of the algorithm scheme if needed.
SignatureValidationResult Property (PublicKeyCrypto Component)
The signature validation result.
Syntax
public PublickeycryptoSignatureValidationResults SignatureValidationResult { get; }
enum PublickeycryptoSignatureValidationResults { svtValid, svtUnknown, svtCorrupted, svtSignerNotFound, svtFailure }
Public ReadOnly Property SignatureValidationResult As PublickeycryptoSignatureValidationResults
Enum PublickeycryptoSignatureValidationResults svtValid svtUnknown svtCorrupted svtSignerNotFound svtFailure End Enum
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.
Config Method (PublicKeyCrypto Component)
Sets or retrieves a configuration setting.
Syntax
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 (PublicKeyCrypto Component)
Decrypts a buffer.
Syntax
Remarks
Use this method to decrypt a byte array and get the encrypted message in another byte array.
Specify the decryption key in Key property before calling this method.
DecryptFile Method (PublicKeyCrypto Component)
Decrypts a file.
Syntax
Remarks
Use this method to decrypt an encrypted file and save the decrypted data to another file.
Specify the decryption key in Key property before calling this method.
DecryptStream Method (PublicKeyCrypto Component)
Decrypts a stream.
Syntax
public void DecryptStream(System.IO.Stream sourceStream, System.IO.Stream destStream);
Public Sub DecryptStream(ByVal SourceStream As System.IO.Stream, ByVal DestStream As System.IO.Stream)
Remarks
Use this method to decrypt a stream and save the decrypted message into another stream.
Specify the decryption key in Key property before calling this method.
DoAction Method (PublicKeyCrypto Component)
Performs an additional action.
Syntax
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 insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Encrypt Method (PublicKeyCrypto Component)
Encrypts a buffer.
Syntax
Remarks
Use this method to encrypt a byte array and get the protected message in another byte array.
Specify the encryption key in the Key property before commencing encryption.
EncryptFile Method (PublicKeyCrypto Component)
Encrypts a file.
Syntax
Remarks
Use this method to encrypt a file and save the protected message to another file.
Specify the encryption key in Key property before commencing encryption.
EncryptStream Method (PublicKeyCrypto Component)
Encrypts a stream.
Syntax
public void EncryptStream(System.IO.Stream sourceStream, System.IO.Stream destStream);
Public Sub EncryptStream(ByVal SourceStream As System.IO.Stream, ByVal DestStream As System.IO.Stream)
Remarks
Use this method to encrypt a stream and save the protected message into another stream.
Specify the encryption key in Key property before commencing encryption.
Sign Method (PublicKeyCrypto Component)
Signs a buffer.
Syntax
Remarks
Use this method to sign a byte array and get the protected message in another byte array. Set the Detached parameter to false to create an enveloped/enveloping, rather than detached signature. Please note that certain signature algorithms/kinds only support detached signing.
Specify the signing key in Key property before commencing the signing.
Please note that the key assigned must have a private key part.
SignFile Method (PublicKeyCrypto Component)
Signs a file.
Syntax
Remarks
Use this method to sign a file and save the protected message to another file.
Specify the signing key in Key property before the signing. Please make sure the assigned key has a private key associated with it.
Set Detached parameter to false to create an enveloped/enveloping signature. This may not be supported by certain algorithms or encryption modes.
SignStream Method (PublicKeyCrypto Component)
Signs a stream.
Syntax
public void SignStream(System.IO.Stream sourceStream, System.IO.Stream destStream, bool detached);
Public Sub SignStream(ByVal SourceStream As System.IO.Stream, ByVal DestStream As System.IO.Stream, ByVal Detached As Boolean)
Remarks
Use this method to sign a stream and save the protected message to another stream.
Specify the signing key in Key property before commencing the signing. Note that the signing key must come with its private key.
Set Detached parameter to false to produce enveloped/enveloping, and not detached signature. Many encryption algorithms/modes do not support non-detached signatures.
Verify Method (PublicKeyCrypto Component)
Verifies an enveloped or enveloping signature contained in a buffer.
Syntax
Remarks
Use this method to verify an enveloped or enveloping signature contained in a byte array. The method verifies the signature and extracts the original signed content into another byte array.
The validation result is stored in SignatureValidationResult property.
Use VerifyDetached to verify detached signatures.
Specify the verification key in the Key property before commencing verification.
VerifyDetached Method (PublicKeyCrypto Component)
Verifies a detached signature.
Syntax
Remarks
Use this method to verify a detached signature. Pass the original message via the SignedData parameter, and the signature via the Signature parameter.
The validation result is stored in SignatureValidationResult property.
Provide the verification key in Key property before commencing verification.
VerifyDetachedFile Method (PublicKeyCrypto Component)
Verifies a detached signature.
Syntax
Remarks
Use this method to verify a detached signature. Pass the original data via the SignedDataFile parameter, and the signature via the SignatureFile parameter.
The validation result is stored in SignatureValidationResult property.
Provide the verification key in Key property.
VerifyDetachedStream Method (PublicKeyCrypto Component)
Verifies a detached signature.
Syntax
public void VerifyDetachedStream(System.IO.Stream signedDataStream, System.IO.Stream signatureStream);
Public Sub VerifyDetachedStream(ByVal SignedDataStream As System.IO.Stream, ByVal SignatureStream As System.IO.Stream)
Remarks
Use this method to verify a detached signature. Provide the original signed data via the SignedDataStream parameter, and the signature via the SignatureStream parameter.
The validation result will be stored in SignatureValidationResult property.
Specify the verification public key in Key property before commencing validation.
VerifyFile Method (PublicKeyCrypto Component)
Verifies an enveloped or enveloping signature contained in a file.
Syntax
Remarks
Use this method to verify an enveloped or enveloping signature and extract the original signed message to another file.
The validation result is stored in SignatureValidationResult property.
Specify the public verification key in Key property before commencing the validation.
VerifyStream Method (PublicKeyCrypto Component)
Verifies an enveloping or enveloped signature contained in a stream.
Syntax
public void VerifyStream(System.IO.Stream sourceStream, System.IO.Stream destStream);
Public Sub VerifyStream(ByVal SourceStream As System.IO.Stream, ByVal DestStream As System.IO.Stream)
Remarks
Use this method to verify an enveloping or enveloped signature and extract the original data into a stream.
The outcome of the validation is stored in SignatureValidationResult property.
Provide the public verification key via the Key property before commencing the validation.
Error Event (PublicKeyCrypto Component)
Reports error information during a crypto operation.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, PublickeycryptoErrorEventArgs e); public class PublickeycryptoErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As PublickeycryptoErrorEventArgs) Public Class PublickeycryptoErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
Component fires this event if an error is encountered during a cryptographic operation.
ErrorCode contains an error code and Description contains a textual description of the error that happened.
Notification Event (PublicKeyCrypto Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, PublickeycryptoNotificationEventArgs e); public class PublickeycryptoNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As PublickeycryptoNotificationEventArgs) Public Class PublickeycryptoNotificationEventArgs 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 the 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.
CryptoKey Type
This container represents a cryptographic key.
Remarks
This type is a universal placeholder for cryptographic keys.
Fields
Algorithm
string
Default Value: ""
The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Bits
int (read-only)
Default Value: 0
The length of the key in bits.
Curve
string
Default Value: ""
This property specifies the name of the curve the EC key is built on.
Exportable
bool (read-only)
Default Value: False
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
ID
byte[]
Default Value: ""
Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).
IV
byte[]
Default Value: ""
The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.
Key
byte[] (read-only)
Default Value: ""
The byte array representation of the key. This may not be available for non-Exportable keys.
Nonce
byte[]
Default Value: ""
A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.
Private
bool (read-only)
Default Value: False
Returns True if the object hosts a private key, and False otherwise.
Public
bool (read-only)
Default Value: False
Returns True if the object hosts a public key, and False otherwise.
Subject
byte[]
Default Value: ""
Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.
Symmetric
bool (read-only)
Default Value: False
Returns True if the object contains a symmetric key, and False otherwise.
Valid
bool (read-only)
Default Value: False
Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.
Constructors
Creates an empty crypto key object.
JWSettings Type
This container represents JSON web security settings.
Remarks
This type contains properties specific to JSON Web Security.
Fields
KeyHeaderParams
string
Default Value: "kid"
Contains key header parameters.
ProtectedHeader
string
Default Value: ""
Provides access to the header being protected.
UnprotectedHeader
string
Default Value: ""
Provides access to the unprotected part of the header.
UnprotectedHeaderParams
string
Default Value: ""
Contains unprotected header parameters.
Constructors
public JWSettings();
Public JWSettings()
Creates an json settings object.
Config Settings (PublicKeyCrypto Component)
The component 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 component, access to these internal properties is provided through the Config method.PublicKeyCrypto Config Settings
This setting specifies an absolute path to the location on disk where temporary files are stored.
Base Config Settings
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.
Set this property to enable or disable cookies caching for the component.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.
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.
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.
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 components that have its CookieCaching property set to "global".
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 components.
Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Use this property to provide a path to the log file.
Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
Use this property to set the log flush mode. The following values are defined:
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Use this property to provide the desired debug log level.
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
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.
Use this property to set the log rotation mode. The following values are defined:
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
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.
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.
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.
Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
Use this property to get or set an IP address for the specified domain name in the internal (of the component) 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.
Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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.
Use this config property to store any custom data.
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 components.
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).
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).
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.
Set this global property to false to make each validation run use its own copy of system certificate stores.
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.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
Trappable Errors (PublicKeyCrypto Component)
PublicKeyCrypto Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Component 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) |