PublicKeyCrypto Component

Properties   Methods   Events   Config Settings   Errors  

The PublicKeyCrypto component supports encrypting, decrypting, signing and verifying messages.

Syntax

TsbxPublicKeyCrypto

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.

Method List

---

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

Event List

---

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

Config Settings

---

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

CanEncrypt Property (PublicKeyCrypto Component)

Returns true if the crypto object can be used for encryption.

Syntax

__property bool CanEncrypt = { read=FCanEncrypt };

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.

Data Type

Boolean

CanSign Property (PublicKeyCrypto Component)

Returns true if the crypto object is capable of data signing.

Syntax

__property bool CanSign = { read=FCanSign };

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.

Data Type

Boolean

FIPSMode Property (PublicKeyCrypto Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (PublicKeyCrypto Component)

The hash algorithm to be used during the crypto operation.

Syntax

__property String HashAlgorithm = { read=FHashAlgorithm, write=FSetHashAlgorithm };

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.

Data Type

String

InputEncoding Property (PublicKeyCrypto Component)

The encoding to apply to the input data.

Syntax

__property TsbxPublicKeyCryptoInputEncodings InputEncoding = { read=FInputEncoding, write=FSetInputEncoding };

enum TsbxPublicKeyCryptoInputEncodings {
  cetDefault=0,
  cetBinary=1,
  cetBase64=2,
  cetCompact=3,
  cetJSON=4
};

Default Value

cetDefault

Remarks

Use this property to specify the encoding to apply to the input data.

Data Type

Integer

InputIsHash Property (PublicKeyCrypto Component)

Indicates whether the input data contains the hash or the actual data.

Syntax

__property bool InputIsHash = { read=FInputIsHash, write=FSetInputIsHash };

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.

Data Type

Boolean

JsonKeyHeaderParams Property (PublicKeyCrypto Component)

Contains key header parameters.

Syntax

__property String JsonKeyHeaderParams = { read=FJsonKeyHeaderParams, write=FSetJsonKeyHeaderParams };

Default Value

"kid"

Remarks

Contains key header parameters.

Data Type

String

JsonProtectedHeader Property (PublicKeyCrypto Component)

Provides access to the header being protected.

Syntax

__property String JsonProtectedHeader = { read=FJsonProtectedHeader, write=FSetJsonProtectedHeader };

Default Value

""

Remarks

Provides access to the header being protected.

Data Type

String

JsonUnprotectedHeader Property (PublicKeyCrypto Component)

Provides access to the unprotected part of the header.

Syntax

__property String JsonUnprotectedHeader = { read=FJsonUnprotectedHeader, write=FSetJsonUnprotectedHeader };

Default Value

""

Remarks

Provides access to the unprotected part of the header.

Data Type

String

JsonUnprotectedHeaderParams Property (PublicKeyCrypto Component)

Contains unprotected header parameters.

Syntax

__property String JsonUnprotectedHeaderParams = { read=FJsonUnprotectedHeaderParams, write=FSetJsonUnprotectedHeaderParams };

Default Value

""

Remarks

Contains unprotected header parameters.

Data Type

String

KeyAlgorithm Property (PublicKeyCrypto Component)

The algorithm of the cryptographic key.

Syntax

__property String KeyAlgorithm = { read=FKeyAlgorithm, write=FSetKeyAlgorithm };

Default Value

""

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key. Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is not available at design time.

Data Type

String

KeyBits Property (PublicKeyCrypto Component)

The length of the key in bits.

Syntax

__property int KeyBits = { read=FKeyBits };

Default Value

0

Remarks

The length of the key in bits.

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

Data Type

Integer

KeyCurve Property (PublicKeyCrypto Component)

This property specifies the name of the curve the EC key is built on.

Syntax

__property String KeyCurve = { read=FKeyCurve, write=FSetKeyCurve };

Default Value

""

Remarks

This property specifies the name of the curve the EC key is built on.

This property is not available at design time.

Data Type

String

KeyExportable Property (PublicKeyCrypto Component)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

__property bool KeyExportable = { read=FKeyExportable };

Default Value

false

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

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

Data Type

Boolean

KeyHandle Property (PublicKeyCrypto Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

KeyID Property (PublicKeyCrypto Component)

Provides access to a storage-specific key identifier.

Syntax

__property DynamicArray KeyID = { read=FKeyID, write=FSetKeyID };

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographic providers to refer to a particular key and/or distinguish between different keys. They are typically unique within a storage, but there is no guarantee that a particular cryptoprovider will conform to that (or will assign any key IDs at all).

This property is not available at design time.

Data Type

Byte Array

KeyIV Property (PublicKeyCrypto Component)

The initialization vector (IV) of a symmetric key.

Syntax

__property DynamicArray KeyIV = { read=FKeyIV, write=FSetKeyIV };

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted data and/or serve as a first block in chaining ciphers.

This property is not available at design time.

Data Type

Byte Array

KeyKey Property (PublicKeyCrypto Component)

The byte array representation of the key.

Syntax

__property DynamicArray KeyKey = { read=FKeyKey };

Remarks

The byte array representation of the key. This may not be available for non-KeyExportable keys.

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

Data Type

Byte Array

KeyNonce Property (PublicKeyCrypto Component)

A nonce value associated with a key.

Syntax

__property DynamicArray KeyNonce = { read=FKeyNonce, write=FSetKeyNonce };

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is not available at design time.

Data Type

Byte Array

KeyPrivate Property (PublicKeyCrypto Component)

Returns True if the object hosts a private key, and False otherwise.

Syntax

__property bool KeyPrivate = { read=FKeyPrivate };

Default Value

false

Remarks

Returns True if the object hosts a private key, and False otherwise.

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

Data Type

Boolean

KeyPublic Property (PublicKeyCrypto Component)

Returns True if the object hosts a public key, and False otherwise.

Syntax

__property bool KeyPublic = { read=FKeyPublic };

Default Value

false

Remarks

Returns True if the object hosts a public key, and False otherwise.

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

Data Type

Boolean

KeySubject Property (PublicKeyCrypto Component)

Returns the key subject.

Syntax

__property DynamicArray KeySubject = { read=FKeySubject, write=FSetKeySubject };

Remarks

Returns the key subject. This is a cryptoprovider-dependent value, which normally aims to provide some user-friendly insight into the key owner.

This property is not available at design time.

Data Type

Byte Array

KeySymmetric Property (PublicKeyCrypto Component)

Returns True if the object contains a symmetric key, and False otherwise.

Syntax

__property bool KeySymmetric = { read=FKeySymmetric };

Default Value

false

Remarks

Returns True if the object contains a symmetric key, and False otherwise.

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

Data Type

Boolean

KeyValid Property (PublicKeyCrypto Component)

Returns True if this key is valid.

Syntax

__property bool KeyValid = { read=FKeyValid };

Default Value

false

Remarks

Returns True if this key is valid. The term Valid highly depends on the kind of the key being stored. A symmetric key is considered valid if its length fits the algorithm being set. The validity of an RSA key also ensures that the RSA key elements (primes, exponents, and modulus) are consistent.

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

Data Type

Boolean

OutputEncoding Property (PublicKeyCrypto Component)

The encoding type to apply to the output data.

Syntax

__property TsbxPublicKeyCryptoOutputEncodings OutputEncoding = { read=FOutputEncoding, write=FSetOutputEncoding };

enum TsbxPublicKeyCryptoOutputEncodings {
  cetDefault=0,
  cetBinary=1,
  cetBase64=2,
  cetCompact=3,
  cetJSON=4
};

Default Value

cetDefault

Remarks

Use this property to specify the encoding type to apply to the protected data.

Data Type

Integer

Scheme Property (PublicKeyCrypto Component)

The algorithm scheme to use.

Syntax

__property String Scheme = { read=FScheme, write=FSetScheme };

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

Data Type

String

SchemeParams Property (PublicKeyCrypto Component)

The algorithm scheme parameters to employ.

Syntax

__property String SchemeParams = { read=FSchemeParams, write=FSetSchemeParams };

Default Value

""

Remarks

Use this property to specify the parameters of the algorithm scheme if needed.

Data Type

String

SignatureValidationResult Property (PublicKeyCrypto Component)

The signature validation result.

Syntax

__property TsbxPublicKeyCryptoSignatureValidationResults SignatureValidationResult = { read=FSignatureValidationResult };

enum TsbxPublicKeyCryptoSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4
};

Default Value

svtValid

Remarks

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

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

Data Type

Integer

Config Method (PublicKeyCrypto Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

DynamicArray<Byte> __fastcall Decrypt(DynamicArray<Byte> Buffer);

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

void __fastcall DecryptFile(String SourceFile, String DestFile);

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.

DoAction Method (PublicKeyCrypto Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

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

DynamicArray<Byte> __fastcall Encrypt(DynamicArray<Byte> Buffer);

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

void __fastcall EncryptFile(String SourceFile, String DestFile);

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.

Sign Method (PublicKeyCrypto Component)

Signs a buffer.

Syntax

DynamicArray<Byte> __fastcall Sign(DynamicArray<Byte> Buffer, bool Detached);

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

void __fastcall SignFile(String SourceFile, String DestFile, bool Detached);

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.

Verify Method (PublicKeyCrypto Component)

Verifies an enveloped or enveloping signature contained in a buffer.

Syntax

DynamicArray<Byte> __fastcall Verify(DynamicArray<Byte> Buffer);

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

void __fastcall VerifyDetached(DynamicArray<Byte> SignedData, DynamicArray<Byte> Signature);

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

void __fastcall VerifyDetachedFile(String SignedDataFile, String SignatureFile);

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.

VerifyFile Method (PublicKeyCrypto Component)

Verifies an enveloped or enveloping signature contained in a file.

Syntax

void __fastcall VerifyFile(String SourceFile, String DestFile);

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.

Error Event (PublicKeyCrypto Component)

Reports error information during a crypto operation.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxPublicKeyCryptoErrorEventParams;
typedef void __fastcall (__closure *TsbxPublicKeyCryptoErrorEvent)(System::TObject* Sender, TsbxPublicKeyCryptoErrorEventParams *e);
__property TsbxPublicKeyCryptoErrorEvent OnError = { read=FOnError, write=FOnError };

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

typedef struct {
  String EventID;
  String EventParam;
} TsbxPublicKeyCryptoNotificationEventParams;
typedef void __fastcall (__closure *TsbxPublicKeyCryptoNotificationEvent)(System::TObject* Sender, TsbxPublicKeyCryptoNotificationEventParams *e);
__property TsbxPublicKeyCryptoNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

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.

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

Base Config Settings

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)