PublicKeyCrypto Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_PublicKeyCrypto

Procedural Interface

 secureblackbox_publickeycrypto_open();
 secureblackbox_publickeycrypto_close($res);
 secureblackbox_publickeycrypto_register_callback($res, $id, $function);
 secureblackbox_publickeycrypto_get_last_error($res);
 secureblackbox_publickeycrypto_get_last_error_code($res);
 secureblackbox_publickeycrypto_set($res, $id, $index, $value);
 secureblackbox_publickeycrypto_get($res, $id, $index);
 secureblackbox_publickeycrypto_do_config($res, $configurationstring);
 secureblackbox_publickeycrypto_do_decrypt($res, $buffer);
 secureblackbox_publickeycrypto_do_decryptfile($res, $sourcefile, $destfile);
 secureblackbox_publickeycrypto_do_doaction($res, $actionid, $actionparams);
 secureblackbox_publickeycrypto_do_encrypt($res, $buffer);
 secureblackbox_publickeycrypto_do_encryptfile($res, $sourcefile, $destfile);
 secureblackbox_publickeycrypto_do_reset($res);
 secureblackbox_publickeycrypto_do_sign($res, $buffer, $detached);
 secureblackbox_publickeycrypto_do_signfile($res, $sourcefile, $destfile, $detached);
 secureblackbox_publickeycrypto_do_verify($res, $buffer);
 secureblackbox_publickeycrypto_do_verifydetached($res, $signeddata, $signature);
 secureblackbox_publickeycrypto_do_verifydetachedfile($res, $signeddatafile, $signaturefile);
 secureblackbox_publickeycrypto_do_verifyfile($res, $sourcefile, $destfile);

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 class with short descriptions. Click on the links for further details.

Method List

---

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

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.

Config Settings

---

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

CanEncrypt Property (SecureBlackbox_PublicKeyCrypto Class)

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

Object Oriented Interface

public function getCanEncrypt();

Procedural Interface

secureblackbox_publickeycrypto_get($res, 1 );

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 (SecureBlackbox_PublicKeyCrypto Class)

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

Object Oriented Interface

public function getCanSign();

Procedural Interface

secureblackbox_publickeycrypto_get($res, 2 );

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 (SecureBlackbox_PublicKeyCrypto Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 3 );
secureblackbox_publickeycrypto_set($res, 3, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_PublicKeyCrypto Class)

The hash algorithm to be used during the crypto operation.

Object Oriented Interface

public function getHashAlgorithm();
public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 4 );
secureblackbox_publickeycrypto_set($res, 4, $value );

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 (SecureBlackbox_PublicKeyCrypto Class)

The encoding to apply to the input data.

Object Oriented Interface

public function getInputEncoding();
public function setInputEncoding($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 5 );
secureblackbox_publickeycrypto_set($res, 5, $value );

Default Value

0

Remarks

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

Data Type

Integer

InputIsHash Property (SecureBlackbox_PublicKeyCrypto Class)

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

Object Oriented Interface

public function getInputIsHash();
public function setInputIsHash($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 6 );
secureblackbox_publickeycrypto_set($res, 6, $value );

Default Value

false

Remarks

Set this property to true to tell the class 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, class 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 (SecureBlackbox_PublicKeyCrypto Class)

Contains key header parameters.

Object Oriented Interface

public function getJsonKeyHeaderParams();
public function setJsonKeyHeaderParams($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 7 );
secureblackbox_publickeycrypto_set($res, 7, $value );

Default Value

'kid'

Remarks

Contains key header parameters.

Data Type

String

JsonProtectedHeader Property (SecureBlackbox_PublicKeyCrypto Class)

Provides access to the header being protected.

Object Oriented Interface

public function getJsonProtectedHeader();
public function setJsonProtectedHeader($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 8 );
secureblackbox_publickeycrypto_set($res, 8, $value );

Default Value

''

Remarks

Provides access to the header being protected.

Data Type

String

JsonUnprotectedHeader Property (SecureBlackbox_PublicKeyCrypto Class)

Provides access to the unprotected part of the header.

Object Oriented Interface

public function getJsonUnprotectedHeader();
public function setJsonUnprotectedHeader($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 9 );
secureblackbox_publickeycrypto_set($res, 9, $value );

Default Value

''

Remarks

Provides access to the unprotected part of the header.

Data Type

String

JsonUnprotectedHeaderParams Property (SecureBlackbox_PublicKeyCrypto Class)

Contains unprotected header parameters.

Object Oriented Interface

public function getJsonUnprotectedHeaderParams();
public function setJsonUnprotectedHeaderParams($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 10 );
secureblackbox_publickeycrypto_set($res, 10, $value );

Default Value

''

Remarks

Contains unprotected header parameters.

Data Type

String

KeyHandle Property (SecureBlackbox_PublicKeyCrypto Class)

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

Object Oriented Interface

public function getKeyHandle();
public function setKeyHandle($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 16 );
secureblackbox_publickeycrypto_set($res, 16, $value );

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

KeyKey Property (SecureBlackbox_PublicKeyCrypto Class)

The byte array representation of the key.

Object Oriented Interface

public function getKeyKey();

Procedural Interface

secureblackbox_publickeycrypto_get($res, 19 );

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

OutputEncoding Property (SecureBlackbox_PublicKeyCrypto Class)

The encoding type to apply to the output data.

Object Oriented Interface

public function getOutputEncoding();
public function setOutputEncoding($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 26 );
secureblackbox_publickeycrypto_set($res, 26, $value );

Default Value

0

Remarks

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

Data Type

Integer

Scheme Property (SecureBlackbox_PublicKeyCrypto Class)

The algorithm scheme to use.

Object Oriented Interface

public function getScheme();
public function setScheme($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 27 );
secureblackbox_publickeycrypto_set($res, 27, $value );

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 (SecureBlackbox_PublicKeyCrypto Class)

The algorithm scheme parameters to employ.

Object Oriented Interface

public function getSchemeParams();
public function setSchemeParams($value);

Procedural Interface

secureblackbox_publickeycrypto_get($res, 28 );
secureblackbox_publickeycrypto_set($res, 28, $value );

Default Value

''

Remarks

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

Data Type

String

SignatureValidationResult Property (SecureBlackbox_PublicKeyCrypto Class)

The signature validation result.

Object Oriented Interface

public function getSignatureValidationResult();

Procedural Interface

secureblackbox_publickeycrypto_get($res, 29 );

Default Value

0

Remarks

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

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

Data Type

Integer

Config Method (SecureBlackbox_PublicKeyCrypto Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_publickeycrypto_do_config($res, $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 (SecureBlackbox_PublicKeyCrypto Class)

Decrypts a buffer.

Object Oriented Interface

public function doDecrypt($buffer);

Procedural Interface

secureblackbox_publickeycrypto_do_decrypt($res, $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 (SecureBlackbox_PublicKeyCrypto Class)

Decrypts a file.

Object Oriented Interface

public function doDecryptFile($sourcefile, $destfile);

Procedural Interface

secureblackbox_publickeycrypto_do_decryptfile($res, $sourcefile, $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 (SecureBlackbox_PublicKeyCrypto Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_publickeycrypto_do_doaction($res, $actionid, $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 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;....

Common ActionIDs:

Encrypt Method (SecureBlackbox_PublicKeyCrypto Class)

Encrypts a buffer.

Object Oriented Interface

public function doEncrypt($buffer);

Procedural Interface

secureblackbox_publickeycrypto_do_encrypt($res, $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 (SecureBlackbox_PublicKeyCrypto Class)

Encrypts a file.

Object Oriented Interface

public function doEncryptFile($sourcefile, $destfile);

Procedural Interface

secureblackbox_publickeycrypto_do_encryptfile($res, $sourcefile, $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.

Reset Method (SecureBlackbox_PublicKeyCrypto Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_publickeycrypto_do_reset($res);

Remarks

Reset is a generic method available in every class.

Sign Method (SecureBlackbox_PublicKeyCrypto Class)

Signs a buffer.

Object Oriented Interface

public function doSign($buffer, $detached);

Procedural Interface

secureblackbox_publickeycrypto_do_sign($res, $buffer, $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 (SecureBlackbox_PublicKeyCrypto Class)

Signs a file.

Object Oriented Interface

public function doSignFile($sourcefile, $destfile, $detached);

Procedural Interface

secureblackbox_publickeycrypto_do_signfile($res, $sourcefile, $destfile, $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 (SecureBlackbox_PublicKeyCrypto Class)

Verifies an enveloped or enveloping signature contained in a buffer.

Object Oriented Interface

public function doVerify($buffer);

Procedural Interface

secureblackbox_publickeycrypto_do_verify($res, $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 (SecureBlackbox_PublicKeyCrypto Class)

Verifies a detached signature.

Object Oriented Interface

public function doVerifyDetached($signeddata, $signature);

Procedural Interface

secureblackbox_publickeycrypto_do_verifydetached($res, $signeddata, $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 (SecureBlackbox_PublicKeyCrypto Class)

Verifies a detached signature.

Object Oriented Interface

public function doVerifyDetachedFile($signeddatafile, $signaturefile);

Procedural Interface

secureblackbox_publickeycrypto_do_verifydetachedfile($res, $signeddatafile, $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 (SecureBlackbox_PublicKeyCrypto Class)

Verifies an enveloped or enveloping signature contained in a file.

Object Oriented Interface

public function doVerifyFile($sourcefile, $destfile);

Procedural Interface

secureblackbox_publickeycrypto_do_verifyfile($res, $sourcefile, $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 (SecureBlackbox_PublicKeyCrypto Class)

Reports error information during a crypto operation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_publickeycrypto_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

Class 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 (SecureBlackbox_PublicKeyCrypto Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_publickeycrypto_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

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

PublicKeyCrypto Config Settings

Base Config Settings

Trappable Errors (PublicKeyCrypto Class)

PublicKeyCrypto Errors