SymmetricCrypto Component

Properties   Methods   Events   Config Settings   Errors  

The SymmetricCrypto component supports encrypting and decrypting messages.

Syntax

TsbxSymmetricCrypto

Remarks

SymmetricCrypto allows you to encrypt and decrypt messages.

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.

AssociatedData Property (SymmetricCrypto Component)

Provides Associated Data for AEAD algorithms.

Syntax

__property DynamicArray AssociatedData = { read=FAssociatedData, write=FSetAssociatedData };

Remarks

Use this property to set up Associated Data for AEAD encryption algorithms.

This property is not available at design time.

Data Type

Byte Array

BlockSize Property (SymmetricCrypto Component)

The block size of the chosen symmetric cipher.

Syntax

__property int BlockSize = { read=FBlockSize };

Default Value

0

Remarks

This property returns the block size of the chosen symmetric cipher.

Modern symmetric algorithms typically use blocks of 16 bytes. Some older algorithms, such as DES or Blowfish, use 8-byte blocks.

This property is read-only.

Data Type

Integer

EncryptionAlgorithm Property (SymmetricCrypto Component)

The encryption algorithm to use for encrypting the data.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

Default Value

"AES256"

Remarks

This property specifies the base symmetric algorithm to use (e.g. AES128). Use it in conjunction with Mode to set up the complete encryption scheme (such as AES128-CBC or AES128-GCM).

Data Type

String

FIPSMode Property (SymmetricCrypto 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 (SymmetricCrypto Component)

The hash algorithm to use during encryption.

Syntax

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

Default Value

"SHA256"

Remarks

Use this property to provide the hash algorithm to be used with the encryption operation. This only applies to certain encryption algorithms/modes.

Data Type

String

InputEncoding Property (SymmetricCrypto Component)

The encoding to apply to the input data.

Syntax

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

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

Default Value

cetDefault

Remarks

Data Type

Integer

KeyAlgorithm Property (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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 (SymmetricCrypto 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

KeySize Property (SymmetricCrypto Component)

Returns the cryptographic key size in bytes.

Syntax

__property int KeySize = { read=FKeySize };

Default Value

0

Remarks

Use this property to read the cryptographic key size. For the majority of the symmetric algorithms this is hard-coded in the algorithm itself (such as 16 bytes for AES128), but may be variable for certain exceptions, such as Blowfish or RC4.

This property is read-only.

Data Type

Integer

MACAlgorithm Property (SymmetricCrypto Component)

The (H)MAC algorithm to use during encryption.

Syntax

__property String MACAlgorithm = { read=FMACAlgorithm, write=FSetMACAlgorithm };

Default Value

""

Remarks

Use this property to configure the HMAC algorithm to use with the encryption operation. This only applies to a small subset of algorithms/modes.

Data Type

String

Mode Property (SymmetricCrypto Component)

Specifies the symmetric cipher mode of operation.

Syntax

__property TsbxSymmetricCryptoModes Mode = { read=FMode, write=FSetMode };

enum TsbxSymmetricCryptoModes {
  scmDefault=0,
  scmECB=1,
  scmCBC=2,
  scmCTR=3,
  scmCFB8=4,
  scmGCM=5,
  scmCCM=6,
  scmPoly1305=7
};

Default Value

scmDefault

Remarks

Use this property to specify the mode of operation as required by your environment. The default setting is CBC.

Data Type

Integer

Nonce Property (SymmetricCrypto Component)

Specifies the Nonce value to employ.

Syntax

__property DynamicArray Nonce = { read=FNonce, write=FSetNonce };

Remarks

Use this property to specify the Nonce value for the symmetric operation. Not every algorithm or mode uses nonce.

This property is not available at design time.

Data Type

Byte Array

OutputEncoding Property (SymmetricCrypto Component)

The encoding to apply to the output data.

Syntax

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

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

Default Value

cetDefault

Remarks

Data Type

Integer

Padding Property (SymmetricCrypto Component)

The padding type to apply to the encrypted data.

Syntax

__property TsbxSymmetricCryptoPaddings Padding = { read=FPadding, write=FSetPadding };

enum TsbxSymmetricCryptoPaddings {
  scpNone=0,
  scpPKCS5=1,
  scpANSIX923=2
};

Default Value

scpPKCS5

Remarks

Use this property to specify the padding type to use with the encrypted data. A padding type commonly used in modern security environments is PKCS#5.

Data Type

Integer

PayloadSize Property (SymmetricCrypto Component)

Specifies the payload size, in bytes.

Syntax

__property int PayloadSize = { read=FPayloadSize, write=FSetPayloadSize };

Default Value

0

Remarks

Use this property to specify the size of the input data in bytes. This is only used by a subset of algorithms/modes, such as CCM.

Data Type

Integer

StreamCipher Property (SymmetricCrypto Component)

Returns true if the selected algorithms works as a stream cipher.

Syntax

__property bool StreamCipher = { read=FStreamCipher };

Default Value

false

Remarks

This property returns true if the selected algorithm processes data as a stream (byte-by-byte), rather than block-by-block. This affects the need to use a proper padding settings.

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

Data Type

Boolean

TagSize Property (SymmetricCrypto Component)

Specifies the AEAD tag size, in bytes.

Syntax

__property int TagSize = { read=FTagSize, write=FSetTagSize };

Default Value

16

Remarks

Use this property to specify/customize the tag size for AEAD encryption.

Data Type

Integer

Config Method (SymmetricCrypto 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 (SymmetricCrypto 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.

DecryptFile Method (SymmetricCrypto 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.

DecryptFinal Method (SymmetricCrypto Component)

Finalization of decryption by blocks.

Syntax

DynamicArray<Byte> __fastcall DecryptFinal();

Remarks

Use this method to finalize of decryption by blocks.

Specify decryption key in Key property.

DecryptInit Method (SymmetricCrypto Component)

Initializes a per-block decryption process.

Syntax

void __fastcall DecryptInit();

Remarks

Use this method to start a block-by-block decryption process.

Specify the decryption key in Key property before starting the decryption.

DecryptUpdate Method (SymmetricCrypto Component)

Decrypts the next block of encrypted data.

Syntax

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

Remarks

When using block-by-block decryption, pass every subsequent block of the encrypted message to this method until the entire message is processed. For each encrypted block the method returns a piece of decrypted data.

Please note that in general case there is no direct correspondence between the data actually contained in the encrypted block with the output of this method. The component may choose to cache a piece of the provided buffer internally if it doesn't constitute a full block of encrypted data.

Remember to call DecryptInit before calling this method to prepare the control for the decryption process.

DoAction Method (SymmetricCrypto 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 (SymmetricCrypto 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 Key property before calling this method.

This is a one-off encryption method. Don't use it with granular per-block methods (EncryptInit, EncryptUpdate, EncryptFinal).

EncryptFile Method (SymmetricCrypto 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 in another file.

Specify the encryption key in Key property before commencing encryption.

EncryptFinal Method (SymmetricCrypto Component)

Finalization of encryption by blocks.

Syntax

DynamicArray<Byte> __fastcall EncryptFinal();

Remarks

Use this method to finalize of encryption by blocks.

Specify encryption key in Key property.

EncryptInit Method (SymmetricCrypto Component)

Initializes a per-block encryption process.

Syntax

void __fastcall EncryptInit();

Remarks

Use this method to initialize a block-by-block encryption process. Follow it with calls to EncryptUpdate (as many as needed), and complete the encryption with an EncryptFinal call.

Specify the encryption key in Key property before calling this method.

EncryptUpdate Method (SymmetricCrypto Component)

Encrypts the next block of data.

Syntax

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

Remarks

Use this method to encrypt the next block of data contained in Buffer.

Call this method after calling EncryptInit for as many times as needed, until the whole volume of data is processed. Having done that, call EncryptFinal to complete the encryption and get the terminating encrypted trailer.

Error Event (SymmetricCrypto Component)

Reports errors during encryption or decryption.

Syntax

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

Remarks

component fires this event in case of exceptional conditions during a cryptographic operation.

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

Notification Event (SymmetricCrypto Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSymmetricCryptoNotificationEventParams;
typedef void __fastcall (__closure *TsbxSymmetricCryptoNotificationEvent)(System::TObject* Sender, TsbxSymmetricCryptoNotificationEventParams *e);
__property TsbxSymmetricCryptoNotificationEvent 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.

Progress Event (SymmetricCrypto Component)

Reports the data encryption/decryption progress.

Syntax

typedef struct {
  __int64 Total;
  __int64 Current;
  bool Cancel;
} TsbxSymmetricCryptoProgressEventParams;
typedef void __fastcall (__closure *TsbxSymmetricCryptoProgressEvent)(System::TObject* Sender, TsbxSymmetricCryptoProgressEventParams *e);
__property TsbxSymmetricCryptoProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

This event fires periodically during a file encrypt/decrypt operation to report its progress.

Use the Cancel parameter to terminate the encryption/decryption if needed.

Config Settings (SymmetricCrypto 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.

SymmetricCrypto Config Settings

Base Config Settings

Trappable Errors (SymmetricCrypto Component)

SymmetricCrypto 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)