PublicKeyCrypto Class
Properties Methods Events Configuration Settings Errors
The PublicKeyCrypto class supports encrypting, decrypting, signing and verifying messages.
Syntax
PublicKeyCrypto
Remarks
PublicKeyCrypto allows you to encrypt, decrypt, sign and verify messages.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CanEncrypt | Returns true if the crypto object can be used for encryption. |
CanSign | Returns true if the crypto object is capable of data signing. |
FIPSMode | Reserved. |
HashAlgorithm | The hash algorithm to be used during the crypto operation. |
InputEncoding | The encoding to apply to the input data. |
InputIsHash | Indicates whether the input data contains the hash or the actual data. |
JsonKeyHeaderParams | Contains key header parameters. |
JsonProtectedHeader | Provides access to the header being protected. |
JsonUnprotectedHeader | Provides access to the unprotected part of the header. |
JsonUnprotectedHeaderParams | Contains unprotected header parameters. |
KeyAlgorithm | The algorithm of the cryptographic key. |
KeyBits | The length of the key in bits. |
KeyCurve | This property specifies the name of the curve the EC key is built on. |
KeyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
KeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KeyID | Provides access to a storage-specific key identifier. |
KeyIV | The initialization vector (IV) of a symmetric key. |
KeyKey | The byte array representation of the key. |
KeyNonce | A nonce value associated with a key. |
KeyPrivate | Returns True if the object hosts a private key, and False otherwise. |
KeyPublic | Returns True if the object hosts a public key, and False otherwise. |
KeySubject | Returns the key subject. |
KeySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
KeyValid | Returns True if this key is valid. |
OutputEncoding | The encoding type to apply to the output data. |
Scheme | The algorithm scheme to use. |
SchemeParams | The algorithm scheme parameters to employ. |
SignatureValidationResult | The signature validation result. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts a buffer. |
DecryptFile | Decrypts a file. |
DoAction | Performs an additional action. |
Encrypt | Encrypts a buffer. |
EncryptFile | Encrypts a file. |
Sign | Signs a buffer. |
SignFile | Signs a file. |
Verify | Verifies an enveloped or enveloping signature contained in a buffer. |
VerifyDetached | Verifies a detached signature. |
VerifyDetachedFile | Verifies a detached signature. |
VerifyFile | Verifies an enveloped or enveloping signature contained in a file. |
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.
Error | Reports error information during a crypto operation. |
Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
Tag | Allows to store any custom data. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
CanEncrypt Property (PublicKeyCrypto Class)
Returns true if the crypto object can be used for encryption.
Syntax
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
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
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
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.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
InputEncoding Property (PublicKeyCrypto Class)
The encoding to apply to the input data.
Syntax
int GetInputEncoding();
int SetInputEncoding(int iInputEncoding);
Possible Values
CET_DEFAULT(0),
CET_BINARY(1),
CET_BASE_64(2),
CET_COMPACT(3),
CET_JSON(4)
Default Value
0
Remarks
Use this property to specify the encoding to apply to the input data.
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
Data Type
Integer
InputIsHash Property (PublicKeyCrypto Class)
Indicates whether the input data contains the hash or the actual data.
Syntax
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
JsonKeyHeaderParams Property (PublicKeyCrypto Class)
Contains key header parameters.
Syntax
QString GetJsonKeyHeaderParams();
int SetJsonKeyHeaderParams(QString qsJsonKeyHeaderParams);
Default Value
"kid"
Remarks
Contains key header parameters.
Data Type
String
JsonProtectedHeader Property (PublicKeyCrypto Class)
Provides access to the header being protected.
Syntax
QString GetJsonProtectedHeader();
int SetJsonProtectedHeader(QString qsJsonProtectedHeader);
Default Value
""
Remarks
Provides access to the header being protected.
Data Type
String
JsonUnprotectedHeader Property (PublicKeyCrypto Class)
Provides access to the unprotected part of the header.
Syntax
QString GetJsonUnprotectedHeader();
int SetJsonUnprotectedHeader(QString qsJsonUnprotectedHeader);
Default Value
""
Remarks
Provides access to the unprotected part of the header.
Data Type
String
JsonUnprotectedHeaderParams Property (PublicKeyCrypto Class)
Contains unprotected header parameters.
Syntax
QString GetJsonUnprotectedHeaderParams();
int SetJsonUnprotectedHeaderParams(QString qsJsonUnprotectedHeaderParams);
Default Value
""
Remarks
Contains unprotected header parameters.
Data Type
String
KeyAlgorithm Property (PublicKeyCrypto Class)
The algorithm of the cryptographic key.
Syntax
QString GetKeyAlgorithm();
int SetKeyAlgorithm(QString qsKeyAlgorithm);
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.
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_IDENTITY | Identity | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_SYMMETRIC_ALGORITHM_CAST128 | CAST128 | |
SB_SYMMETRIC_ALGORITHM_IDEA | IDEA | |
SB_SYMMETRIC_ALGORITHM_TWOFISH | Twofish | |
SB_SYMMETRIC_ALGORITHM_TWOFISH128 | Twofish128 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH192 | Twofish192 | |
SB_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA | Camellia | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_SYMMETRIC_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_SYMMETRIC_ALGORITHM_SERPENT | Serpent | |
SB_SYMMETRIC_ALGORITHM_SERPENT128 | Serpent128 | |
SB_SYMMETRIC_ALGORITHM_SERPENT192 | Serpent192 | |
SB_SYMMETRIC_ALGORITHM_SERPENT256 | Serpent256 | |
SB_SYMMETRIC_ALGORITHM_SEED | SEED | |
SB_SYMMETRIC_ALGORITHM_RABBIT | Rabbit | |
SB_SYMMETRIC_ALGORITHM_SYMMETRIC | Generic | |
SB_SYMMETRIC_ALGORITHM_GOST_28147_1989 | GOST-28147-1989 | |
SB_SYMMETRIC_ALGORITHM_CHACHA20 | ChaCha20 |
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is not available at design time.
Data Type
String
KeyBits Property (PublicKeyCrypto Class)
The length of the key in bits.
Syntax
int GetKeyBits();
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 Class)
This property specifies the name of the curve the EC key is built on.
Syntax
QString GetKeyCurve();
int SetKeyCurve(QString qsKeyCurve);
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 Class)
Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
Syntax
bool GetKeyExportable();
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 Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);
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 Class)
Provides access to a storage-specific key identifier.
Syntax
QByteArray GetKeyID();
int SetKeyID(QByteArray qbaKeyID);
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 Class)
The initialization vector (IV) of a symmetric key.
Syntax
QByteArray GetKeyIV();
int SetKeyIV(QByteArray qbaKeyIV);
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 Class)
The byte array representation of the key.
Syntax
QByteArray GetKeyKey();
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 Class)
A nonce value associated with a key.
Syntax
QByteArray GetKeyNonce();
int SetKeyNonce(QByteArray qbaKeyNonce);
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 Class)
Returns True if the object hosts a private key, and False otherwise.
Syntax
bool GetKeyPrivate();
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 Class)
Returns True if the object hosts a public key, and False otherwise.
Syntax
bool GetKeyPublic();
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 Class)
Returns the key subject.
Syntax
QByteArray GetKeySubject();
int SetKeySubject(QByteArray qbaKeySubject);
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 Class)
Returns True if the object contains a symmetric key, and False otherwise.
Syntax
bool GetKeySymmetric();
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 Class)
Returns True if this key is valid.
Syntax
bool GetKeyValid();
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 Class)
The encoding type to apply to the output data.
Syntax
int GetOutputEncoding();
int SetOutputEncoding(int iOutputEncoding);
Possible Values
CET_DEFAULT(0),
CET_BINARY(1),
CET_BASE_64(2),
CET_COMPACT(3),
CET_JSON(4)
Default Value
0
Remarks
Use this property to specify the encoding type to apply to the protected data.
cetDefault | 0 | The default encoding type in current circumstances. This depends on the operation and the type of the key being used. |
cetBinary | 1 | Raw binary encoding (no encoding) |
cetBase64 | 2 | Base64 encoding (armouring) |
cetCompact | 3 | JSON compact encoding |
cetJSON | 4 | JSON standard encoding |
Data Type
Integer
Scheme Property (PublicKeyCrypto Class)
The algorithm scheme to use.
Syntax
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
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
int GetSignatureValidationResult();
Possible Values
SVT_VALID(0),
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
Default Value
0
Remarks
Use this property to check the result of the most recent signature validation.
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
This property is read-only and not available at design time.
Data Type
Integer
Config Method (PublicKeyCrypto Class)
Sets or retrieves a configuration setting.
Syntax
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
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
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
This method returns a Byte Array 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.
DecryptFile Method (PublicKeyCrypto Class)
Decrypts a file.
Syntax
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
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
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
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
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
This method returns a Byte Array 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.
EncryptFile Method (PublicKeyCrypto Class)
Encrypts a file.
Syntax
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
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
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
This method returns a Byte Array 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.
SignFile Method (PublicKeyCrypto Class)
Signs a file.
Syntax
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
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
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
This method returns a Byte Array 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.
VerifyDetached Method (PublicKeyCrypto Class)
Verifies a detached signature.
Syntax
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
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
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
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
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
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
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
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 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 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.
Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (PublicKeyCrypto Class)
PublicKeyCrypto Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Class 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) |