PublicKeyCrypto Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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.

 
 Copy
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 (PublicKeyCrypto Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCanEncrypt();

Unicode (Windows)
BOOL GetCanEncrypt();

int secureblackbox_publickeycrypto_getcanencrypt(void* lpObj);

bool GetCanEncrypt();

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCanSign();

Unicode (Windows)
BOOL GetCanSign();

int secureblackbox_publickeycrypto_getcansign(void* lpObj);

bool GetCanSign();

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

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_publickeycrypto_getfipsmode(void* lpObj);
int secureblackbox_publickeycrypto_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (PublicKeyCrypto Class)

The hash algorithm to be used during the crypto operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_publickeycrypto_gethashalgorithm(void* lpObj);
int secureblackbox_publickeycrypto_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

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

The encoding to apply to the input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputEncoding();
int SetInputEncoding(int iInputEncoding);

Unicode (Windows)
INT GetInputEncoding();
INT SetInputEncoding(INT iInputEncoding);

CET_DEFAULT(0), 
CET_BINARY(1), 
CET_BASE_64(2), 
CET_COMPACT(3), 
CET_JSON(4)

int secureblackbox_publickeycrypto_getinputencoding(void* lpObj);
int secureblackbox_publickeycrypto_setinputencoding(void* lpObj, int iInputEncoding);

int GetInputEncoding();
int SetInputEncoding(int iInputEncoding);

Default Value

0

Remarks

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

Data Type

Integer

InputIsHash Property (PublicKeyCrypto Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputIsHash();
int SetInputIsHash(int bInputIsHash);

Unicode (Windows)
BOOL GetInputIsHash();
INT SetInputIsHash(BOOL bInputIsHash);

int secureblackbox_publickeycrypto_getinputishash(void* lpObj);
int secureblackbox_publickeycrypto_setinputishash(void* lpObj, int bInputIsHash);

bool GetInputIsHash();
int SetInputIsHash(bool bInputIsHash);

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

JsonDetails Property (PublicKeyCrypto Class)

Provides a container for JSON settings.

Syntax

• C++
• C
• Qt

SecureBlackboxJWSettings* GetJsonDetails();

char* secureblackbox_publickeycrypto_getjsonkeyheaderparams(void* lpObj);
int secureblackbox_publickeycrypto_setjsonkeyheaderparams(void* lpObj, const char* lpszJsonKeyHeaderParams);

char* secureblackbox_publickeycrypto_getjsonprotectedheader(void* lpObj);
int secureblackbox_publickeycrypto_setjsonprotectedheader(void* lpObj, const char* lpszJsonProtectedHeader);

char* secureblackbox_publickeycrypto_getjsonunprotectedheader(void* lpObj);
int secureblackbox_publickeycrypto_setjsonunprotectedheader(void* lpObj, const char* lpszJsonUnprotectedHeader);

char* secureblackbox_publickeycrypto_getjsonunprotectedheaderparams(void* lpObj);
int secureblackbox_publickeycrypto_setjsonunprotectedheaderparams(void* lpObj, const char* lpszJsonUnprotectedHeaderParams);

QString GetJsonKeyHeaderParams();
int SetJsonKeyHeaderParams(QString qsJsonKeyHeaderParams);

QString GetJsonProtectedHeader();
int SetJsonProtectedHeader(QString qsJsonProtectedHeader);

QString GetJsonUnprotectedHeader();
int SetJsonUnprotectedHeader(QString qsJsonUnprotectedHeader);

QString GetJsonUnprotectedHeaderParams();
int SetJsonUnprotectedHeaderParams(QString qsJsonUnprotectedHeaderParams);

Remarks

Use this property when using JSON Web Encryption/Signature to tune up the JSON parameters.

This property is read-only.

Data Type

SecureBlackboxJWSettings

Key Property (PublicKeyCrypto Class)

The key to employ for the crypto operation.

Syntax

• C++
• C
• Qt

SecureBlackboxCryptoKey* GetKey();
int SetKey(SecureBlackboxCryptoKey* val);

int64 secureblackbox_publickeycrypto_getkeyhandle(void* lpObj);
int secureblackbox_publickeycrypto_setkeyhandle(void* lpObj, int64 lKeyHandle);

int secureblackbox_publickeycrypto_getkeykey(void* lpObj, char** lpKeyKey, int* lenKeyKey);

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

QByteArray GetKeyKey();

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.

Data Type

SecureBlackboxCryptoKey

OutputEncoding Property (PublicKeyCrypto Class)

The encoding type to apply to the output data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

Unicode (Windows)
INT GetOutputEncoding();
INT SetOutputEncoding(INT iOutputEncoding);

CET_DEFAULT(0), 
CET_BINARY(1), 
CET_BASE_64(2), 
CET_COMPACT(3), 
CET_JSON(4)

int secureblackbox_publickeycrypto_getoutputencoding(void* lpObj);
int secureblackbox_publickeycrypto_setoutputencoding(void* lpObj, int iOutputEncoding);

int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);

Default Value

0

Remarks

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

Data Type

Integer

Scheme Property (PublicKeyCrypto Class)

The algorithm scheme to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetScheme();
int SetScheme(const char* lpszScheme);

Unicode (Windows)
LPWSTR GetScheme();
INT SetScheme(LPCWSTR lpszScheme);

char* secureblackbox_publickeycrypto_getscheme(void* lpObj);
int secureblackbox_publickeycrypto_setscheme(void* lpObj, const char* lpszScheme);

QString GetScheme();
int SetScheme(QString qsScheme);

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

The algorithm scheme parameters to employ.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSchemeParams();
int SetSchemeParams(const char* lpszSchemeParams);

Unicode (Windows)
LPWSTR GetSchemeParams();
INT SetSchemeParams(LPCWSTR lpszSchemeParams);

char* secureblackbox_publickeycrypto_getschemeparams(void* lpObj);
int secureblackbox_publickeycrypto_setschemeparams(void* lpObj, const char* lpszSchemeParams);

QString GetSchemeParams();
int SetSchemeParams(QString qsSchemeParams);

Default Value

""

Remarks

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

Data Type

String

SignatureValidationResult Property (PublicKeyCrypto Class)

The signature validation result.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureValidationResult();

Unicode (Windows)
INT GetSignatureValidationResult();

SVT_VALID(0), 
SVT_UNKNOWN(1), 
SVT_CORRUPTED(2), 
SVT_SIGNER_NOT_FOUND(3), 
SVT_FAILURE(4), 
SVT_REFERENCE_CORRUPTED(5)

int secureblackbox_publickeycrypto_getsignaturevalidationresult(void* lpObj);

int GetSignatureValidationResult();

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_publickeycrypto_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Decrypt Method (PublicKeyCrypto Class)

Decrypts a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Decrypt(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Decrypt(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_publickeycrypto_decrypt(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Decrypt(QByteArray& qbaBuffer);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DecryptFile Method (PublicKeyCrypto Class)

Decrypts a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT DecryptFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);

int secureblackbox_publickeycrypto_decryptfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);

int DecryptFile(const QString& qsSourceFile, const QString& qsDestFile);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecryptStream Method (PublicKeyCrypto Class)

Decrypts a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Unicode (Windows)
INT DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int secureblackbox_publickeycrypto_decryptstream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int DecryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoAction Method (PublicKeyCrypto Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_publickeycrypto_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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:

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Encrypt Method (PublicKeyCrypto Class)

Encrypts a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Encrypt(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Encrypt(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_publickeycrypto_encrypt(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Encrypt(QByteArray& qbaBuffer);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EncryptFile Method (PublicKeyCrypto Class)

Encrypts a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT EncryptFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);

int secureblackbox_publickeycrypto_encryptfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);

int EncryptFile(const QString& qsSourceFile, const QString& qsDestFile);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EncryptStream Method (PublicKeyCrypto Class)

Encrypts a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Unicode (Windows)
INT EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int secureblackbox_publickeycrypto_encryptstream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int EncryptStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PublicKeyCrypto Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_publickeycrypto_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (PublicKeyCrypto Class)

Signs a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Sign(const char* lpBuffer, int lenBuffer, int bDetached, int *lpSize = NULL);

Unicode (Windows)
LPSTR Sign(LPCSTR lpBuffer, INT lenBuffer, BOOL bDetached, LPINT lpSize = NULL);

char* secureblackbox_publickeycrypto_sign(void* lpObj, const char* lpBuffer, int lenBuffer, int bDetached, int *lpSize);

QByteArray Sign(QByteArray& qbaBuffer, bool bDetached);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SignFile Method (PublicKeyCrypto Class)

Signs a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignFile(const char* lpszSourceFile, const char* lpszDestFile, int bDetached);

Unicode (Windows)
INT SignFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile, BOOL bDetached);

int secureblackbox_publickeycrypto_signfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile, int bDetached);

int SignFile(const QString& qsSourceFile, const QString& qsDestFile, bool bDetached);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SignStream Method (PublicKeyCrypto Class)

Signs a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream, int bDetached);

Unicode (Windows)
INT SignStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream, BOOL bDetached);

int secureblackbox_publickeycrypto_signstream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream, int bDetached);

int SignStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream, bool bDetached);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Verify Method (PublicKeyCrypto Class)

Verifies an enveloped or enveloping signature contained in a buffer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Verify(const char* lpBuffer, int lenBuffer, int *lpSize = NULL);

Unicode (Windows)
LPSTR Verify(LPCSTR lpBuffer, INT lenBuffer, LPINT lpSize = NULL);

char* secureblackbox_publickeycrypto_verify(void* lpObj, const char* lpBuffer, int lenBuffer, int *lpSize);

QByteArray Verify(QByteArray& qbaBuffer);

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.

Error Handling (C++)

This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

VerifyDetached Method (PublicKeyCrypto Class)

Verifies a detached signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyDetached(const char* lpSignedData, int lenSignedData, const char* lpSignature, int lenSignature);

Unicode (Windows)
INT VerifyDetached(LPCSTR lpSignedData, INT lenSignedData, LPCSTR lpSignature, INT lenSignature);

int secureblackbox_publickeycrypto_verifydetached(void* lpObj, const char* lpSignedData, int lenSignedData, const char* lpSignature, int lenSignature);

int VerifyDetached(QByteArray& qbaSignedData, QByteArray& qbaSignature);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyDetachedFile Method (PublicKeyCrypto Class)

Verifies a detached signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyDetachedFile(const char* lpszSignedDataFile, const char* lpszSignatureFile);

Unicode (Windows)
INT VerifyDetachedFile(LPCWSTR lpszSignedDataFile, LPCWSTR lpszSignatureFile);

int secureblackbox_publickeycrypto_verifydetachedfile(void* lpObj, const char* lpszSignedDataFile, const char* lpszSignatureFile);

int VerifyDetachedFile(const QString& qsSignedDataFile, const QString& qsSignatureFile);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyDetachedStream Method (PublicKeyCrypto Class)

Verifies a detached signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyDetachedStream(SecureBlackboxStream* sSignedDataStream, SecureBlackboxStream* sSignatureStream);

Unicode (Windows)
INT VerifyDetachedStream(SecureBlackboxStream* sSignedDataStream, SecureBlackboxStream* sSignatureStream);

int secureblackbox_publickeycrypto_verifydetachedstream(void* lpObj, SecureBlackboxStream* sSignedDataStream, SecureBlackboxStream* sSignatureStream);

int VerifyDetachedStream(SecureBlackboxStream* sSignedDataStream, SecureBlackboxStream* sSignatureStream);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyFile Method (PublicKeyCrypto Class)

Verifies an enveloped or enveloping signature contained in a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyFile(const char* lpszSourceFile, const char* lpszDestFile);

Unicode (Windows)
INT VerifyFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);

int secureblackbox_publickeycrypto_verifyfile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);

int VerifyFile(const QString& qsSourceFile, const QString& qsDestFile);

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 Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyStream Method (PublicKeyCrypto Class)

Verifies an enveloping or enveloped signature contained in a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifyStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

Unicode (Windows)
INT VerifyStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int secureblackbox_publickeycrypto_verifystream(void* lpObj, SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

int VerifyStream(SecureBlackboxStream* sSourceStream, SecureBlackboxStream* sDestStream);

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 Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (PublicKeyCrypto Class)

Reports error information during a crypto operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PublicKeyCryptoErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PublicKeyCryptoErrorEventParams;


Unicode (Windows)
virtual INT FireError(PublicKeyCryptoErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PublicKeyCryptoErrorEventParams;

#define EID_PUBLICKEYCRYPTO_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PublicKeyCryptoErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PublicKeyCryptoErrorEventParams *e);

// Or, subclass PublicKeyCrypto and override this emitter function.
virtual int FireError(PublicKeyCryptoErrorEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(PublicKeyCryptoNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} PublicKeyCryptoNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(PublicKeyCryptoNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} PublicKeyCryptoNotificationEventParams;

#define EID_PUBLICKEYCRYPTO_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class PublicKeyCryptoNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(PublicKeyCryptoNotificationEventParams *e);

// Or, subclass PublicKeyCrypto and override this emitter function.
virtual int FireNotification(PublicKeyCryptoNotificationEventParams *e) {...}

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.

CryptoKey Type

This container represents a cryptographic key.

Syntax

SecureBlackboxCryptoKey (declared in secureblackbox.h)

Remarks

This type is a universal placeholder for cryptographic keys.

• Algorithm
• Bits
• Curve
• Exportable
• Fingerprint
• Handle
• ID
• IV
• Key
• Nonce
• Private
• Public
• Subject
• Symmetric
• Valid

Fields

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Constructors

CryptoKey()

JWSettings Type

This container represents JSON web security settings.

Syntax

SecureBlackboxJWSettings (declared in secureblackbox.h)

Remarks

This type contains properties specific to JSON Web Security.

• KeyHeaderParams
• ProtectedHeader
• UnprotectedHeader
• UnprotectedHeaderParams

Fields

Constructors

JWSettings()

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The PublicKeyCrypto class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the PublicKeyCrypto class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (PublicKeyCrypto Class)

PublicKeyCrypto Config Settings

Base Config Settings

 
 Copy
PKICache=certificate,crl,ocsp

 
 Copy
PKICachePath=C:\Temp\cache

 
 Copy
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

 
 Copy
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

 
 Copy
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

Trappable Errors (PublicKeyCrypto Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PublicKeyCrypto Errors