PGPReader Class
Properties Methods Events Configuration Settings Errors
The PGPReader class reads and unprotects protected PGP files.
Syntax
PGPReader
Remarks
PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" data.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Armored | Indicates if the processed message had been base64-armored. |
Compressed | Indicates if the processed message had been compressed. |
DataBytes | Use this property to pass the original signed data to class in the byte array form. |
DataFile | The name of the file containing the original signed data. |
DecryptingKeyCount | The number of records in the DecryptingKey arrays. |
DecryptingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
DecryptingKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
DecryptingKeyKeyID | Contains a 8-byte key identifier. |
DecryptingKeyPassphrase | The key protection password. |
DecryptingKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
DecryptingKeyUsername | Specifies the name of the user bound to this key. |
ExternalCryptoAsyncDocumentID | Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
InputBytes | Use this property to pass the input to class in the byte array form. |
InputFile | Provides a filename of a file to process. |
KeyPassphrase | Specifies a passphrase for the decryption key. |
OutputBytes | Use this property to read the output the class object has produced. |
OutputFile | The file where the encrypted and/or signed data will be saved. |
Passphrase | Specifies a message decryption password. |
ProcessedLength | Reports the number of bytes processed. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
SignatureCount | The number of records in the Signature arrays. |
SignatureCertificationType | Specifies the type of a UserID signature. |
SignatureCreationTime | The time when the signature was created, in Universal Coordinated Time (UTC). |
SignatureExpirationTime | Specifies signature expiration time, in seconds since its creation time (CreationTime). |
SignatureExportable | Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer. |
SignatureHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SignatureHashAlgorithm | Specifies the hash algorithm used in the signature. |
SignatureKeyExpirationTime | The number of seconds after which the signed key will expire. |
SignatureLegacyFormat | Indicates whether signature uses PGP 2. |
SignaturePolicyURL | Contains the URL of the signature policy. |
SignaturePrimaryUserID | Indicates whether the UserID covered by the signature is the main user id for this key. |
SignatureReasonForRevocation | Describes the reason why the key or the certificate was revoked. |
SignatureRevocable | Specifies whether the signature can be revoked. |
SignatureRevocation | Indicates whether or not the signature is a revocation signature. |
SignatureSignatureClass | Indicates the signature class. |
SignatureSignerKeyID | Indicates the KeyID of the signing key. |
SignatureSignerUserID | Indicates the UserID associated with the signing key. |
SignatureStrictlyValid | Returns True if this signature is valid in a strict way (no compatibility relaxations). |
SignatureTextSignature | Indicates whether or not the signature is made over a text document. |
SignatureTrustAmount | Specifies the amount of trust assigned by this signature. |
SignatureTrustLevel | The trust level assigned by this signature. |
SignatureValidated | Whether the signature has been validated. |
SignatureValidity | Provides the validity status of the signature if the signature has been validated. |
SignatureVersion | Indicates the signature version. |
VerifyingKeyCount | The number of records in the VerifyingKey arrays. |
VerifyingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
VerifyingKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
VerifyingKeyKeyID | Contains a 8-byte key identifier. |
VerifyingKeyUsername | Specifies the name of the user bound to this key. |
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. |
DecryptAndVerify | Decrypts and verifies a protected message. |
DoAction | Performs an additional action. |
VerifyDetached | Verifies a detached signature. |
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.
EncryptionInfo | Reports early information on encryption parameters. |
Error | Information about errors during PGP decryption/verification. |
ExternalDecrypt | Handles remote or external decryption. |
FileExtractionFinish | Reports the ending of file extraction process. |
FileExtractionStart | Reports the beginning of file extraction process. |
KeyPassphraseNeeded | Requests a key protection password from the application. |
MultipleFilesFound | Fires if the PGP message is recognized to contain multiple files. |
Notification | This event notifies the application about an underlying control flow event. |
PassphraseNeeded | Requests a data protection password from the application. |
Progress | Reports the progress of the decryption operation. |
Signed | Notifies the application about a signed message. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
IgnoreDataPacketLengths | Whether to check the length of input data packets. |
PasswordAttempts | The number of attempts allowed for entering password. |
TempPath | Path for storing temporary files. |
UndefInputLength | Set this property if you are working with non-seekable streams. |
UseGreedyMemoryConsumption | Whether to limit memory consumption for the cost of speed. |
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. |
Armored Property (PGPReader Class)
Indicates if the processed message had been base64-armored.
Syntax
bool GetArmored();
Default Value
false
Remarks
This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.
This property is read-only and not available at design time.
Data Type
Boolean
Compressed Property (PGPReader Class)
Indicates if the processed message had been compressed.
Syntax
bool GetCompressed();
Default Value
false
Remarks
This property is set to true if the supplied message was compressed by its creator.
This property is read-only and not available at design time.
Data Type
Boolean
DataBytes Property (PGPReader Class)
Use this property to pass the original signed data to class in the byte array form.
Syntax
QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);
Remarks
When validating detached signatures, assign a byte array containing the signed data to this property.
This property is not available at design time.
Data Type
Byte Array
DataFile Property (PGPReader Class)
The name of the file containing the original signed data.
Syntax
QString GetDataFile();
int SetDataFile(QString qsDataFile);
Default Value
""
Remarks
Use this property to provide the original data when validating detached signatures with VerifyDetached.
Data Type
String
DecryptingKeyCount Property (PGPReader Class)
The number of records in the DecryptingKey arrays.
Syntax
int GetDecryptingKeyCount();
int SetDecryptingKeyCount(int iDecryptingKeyCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- DecryptingKeyHandle
- DecryptingKeyKeyFP
- DecryptingKeyKeyID
- DecryptingKeyPassphrase
- DecryptingKeyPassphraseValid
- DecryptingKeyUsername
This property is not available at design time.
Data Type
Integer
DecryptingKeyHandle Property (PGPReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetDecryptingKeyHandle(int iDecryptingKeyIndex);
int SetDecryptingKeyHandle(int iDecryptingKeyIndex, qint64 lDecryptingKeyHandle);
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());
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is not available at design time.
Data Type
Long64
DecryptingKeyKeyFP Property (PGPReader Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetDecryptingKeyKeyFP(int iDecryptingKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
DecryptingKeyKeyID Property (PGPReader Class)
Contains a 8-byte key identifier.
Syntax
QString GetDecryptingKeyKeyID(int iDecryptingKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
DecryptingKeyPassphrase Property (PGPReader Class)
The key protection password.
Syntax
QString GetDecryptingKeyPassphrase(int iDecryptingKeyIndex);
int SetDecryptingKeyPassphrase(int iDecryptingKeyIndex, QString qsDecryptingKeyPassphrase);
Default Value
""
Remarks
The key protection password.
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is not available at design time.
Data Type
String
DecryptingKeyPassphraseValid Property (PGPReader Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetDecryptingKeyPassphraseValid(int iDecryptingKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified DecryptingKeyPassphrase is valid and can be used to unlock the secret key.
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
DecryptingKeyUsername Property (PGPReader Class)
Specifies the name of the user bound to this key.
Syntax
QString GetDecryptingKeyUsername(int iDecryptingKeyIndex);
int SetDecryptingKeyUsername(int iDecryptingKeyIndex, QString qsDecryptingKeyUsername);
Default Value
""
Remarks
Specifies the name of the user bound to this key.
The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.
The DecryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.
This property is not available at design time.
Data Type
String
ExternalCryptoAsyncDocumentID Property (PGPReader Class)
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
Syntax
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies the document ID for SignAsyncEnd() call
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (PGPReader Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (PGPReader Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (PGPReader Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (PGPReader Class)
Specifies the request's signature hash algorithm.
Syntax
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
Default Value
"SHA256"
Remarks
Specifies the request's signature hash algorithm.
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
ExternalCryptoKeyID Property (PGPReader Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
ExternalCryptoKeySecret Property (PGPReader Class)
The pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
Default Value
""
Remarks
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (PGPReader Class)
Specifies the asynchronous signing method.
Syntax
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (PGPReader Class)
Specifies the external cryptography mode.
Syntax
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
Default Value
0
Remarks
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (PGPReader Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Data Type
String
FIPSMode Property (PGPReader Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
InputBytes Property (PGPReader Class)
Use this property to pass the input to class in the byte array form.
Syntax
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
Data Type
Byte Array
InputFile Property (PGPReader Class)
Provides a filename of a file to process.
Syntax
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Use this property to provide a path to the file to be encrypted and/or signed.
Data Type
String
KeyPassphrase Property (PGPReader Class)
Specifies a passphrase for the decryption key.
Syntax
QString GetKeyPassphrase();
int SetKeyPassphrase(QString qsKeyPassphrase);
Default Value
""
Remarks
Use this property to provide a passphrase for the decryption secret key.
If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.
Data Type
String
OutputBytes Property (PGPReader Class)
Use this property to read the output the class object has produced.
Syntax
QByteArray GetOutputBytes();
Remarks
Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only and not available at design time.
Data Type
Byte Array
OutputFile Property (PGPReader Class)
The file where the encrypted and/or signed data will be saved.
Syntax
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Use this property to provide a path to the file where the class should store the encrypted and/or signed data.
Data Type
String
Passphrase Property (PGPReader Class)
Specifies a message decryption password.
Syntax
QString GetPassphrase();
int SetPassphrase(QString qsPassphrase);
Default Value
""
Remarks
Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.
Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.
If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.
Data Type
String
ProcessedLength Property (PGPReader Class)
Reports the number of bytes processed.
Syntax
qint64 GetProcessedLength();
Default Value
0
Remarks
Use this property to check the number of bytes that the component has read when processing the protected message.
This property is read-only and not available at design time.
Data Type
Long64
Profile Property (PGPReader Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
QString GetProfile();
int SetProfile(QString qsProfile);
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
String
SignatureCount Property (PGPReader Class)
The number of records in the Signature arrays.
Syntax
int GetSignatureCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignatureCertificationType
- SignatureCreationTime
- SignatureExpirationTime
- SignatureExportable
- SignatureHandle
- SignatureHashAlgorithm
- SignatureKeyExpirationTime
- SignatureLegacyFormat
- SignaturePolicyURL
- SignaturePrimaryUserID
- SignatureReasonForRevocation
- SignatureRevocable
- SignatureRevocation
- SignatureSignatureClass
- SignatureSignerKeyID
- SignatureSignerUserID
- SignatureStrictlyValid
- SignatureTextSignature
- SignatureTrustAmount
- SignatureTrustLevel
- SignatureValidated
- SignatureValidity
- SignatureVersion
This property is read-only and not available at design time.
Data Type
Integer
SignatureCertificationType Property (PGPReader Class)
Specifies the type of a UserID signature.
Syntax
int GetSignatureCertificationType(int iSignatureIndex);
Possible Values
PCT_GENERIC(0),
PCT_PERSONA(1),
PCT_CASUAL(2),
PCT_POSITIVE(3)
Default Value
0
Remarks
Specifies the type of a UserID signature.
pctGeneric | 0 | Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type. |
pctPersona | 1 | Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID. |
pctCasual | 2 | Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity. |
pctPositive | 3 | Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity. |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureCreationTime Property (PGPReader Class)
The time when the signature was created, in Universal Coordinated Time (UTC).
Syntax
QString GetSignatureCreationTime(int iSignatureIndex);
Default Value
""
Remarks
The time when the signature was created, in Universal Coordinated Time (UTC).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureExpirationTime Property (PGPReader Class)
Specifies signature expiration time, in seconds since its creation time (CreationTime).
Syntax
int GetSignatureExpirationTime(int iSignatureIndex);
Default Value
0
Remarks
Specifies signature expiration time, in seconds since its creation time (CreationTime).
Ths property set to 0 indicates that the signature never expires.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureExportable Property (PGPReader Class)
Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
Syntax
bool GetSignatureExportable(int iSignatureIndex);
Default Value
false
Remarks
Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureHandle Property (PGPReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSignatureHandle(int iSignatureIndex);
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());
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Long64
SignatureHashAlgorithm Property (PGPReader Class)
Specifies the hash algorithm used in the signature.
Syntax
QString GetSignatureHashAlgorithm(int iSignatureIndex);
Default Value
""
Remarks
Specifies the hash algorithm used in the signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureKeyExpirationTime Property (PGPReader Class)
The number of seconds after which the signed key will expire.
Syntax
int GetSignatureKeyExpirationTime(int iSignatureIndex);
Default Value
0
Remarks
The number of seconds after which the signed key will expire.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureLegacyFormat Property (PGPReader Class)
Indicates whether signature uses PGP 2.
Syntax
bool GetSignatureLegacyFormat(int iSignatureIndex);
Default Value
false
Remarks
Indicates whether signature uses PGP 2.6.x-compatible packet format.
The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignaturePolicyURL Property (PGPReader Class)
Contains the URL of the signature policy.
Syntax
QString GetSignaturePolicyURL(int iSignatureIndex);
Default Value
""
Remarks
Contains the URL of the signature policy.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignaturePrimaryUserID Property (PGPReader Class)
Indicates whether the UserID covered by the signature is the main user id for this key.
Syntax
bool GetSignaturePrimaryUserID(int iSignatureIndex);
Default Value
false
Remarks
Indicates whether the UserID covered by the signature is the main user id for this key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureReasonForRevocation Property (PGPReader Class)
Describes the reason why the key or the certificate was revoked.
Syntax
QString GetSignatureReasonForRevocation(int iSignatureIndex);
Default Value
""
Remarks
Describes the reason why the key or the certificate was revoked.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureRevocable Property (PGPReader Class)
Specifies whether the signature can be revoked.
Syntax
bool GetSignatureRevocable(int iSignatureIndex);
Default Value
false
Remarks
Specifies whether the signature can be revoked.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureRevocation Property (PGPReader Class)
Indicates whether or not the signature is a revocation signature.
Syntax
bool GetSignatureRevocation(int iSignatureIndex);
Default Value
false
Remarks
Indicates whether or not the signature is a revocation signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureSignatureClass Property (PGPReader Class)
Indicates the signature class.
Syntax
int GetSignatureSignatureClass(int iSignatureIndex);
Possible Values
PSC_DOCUMENT(0),
PSC_TEXT_DOCUMENT(1),
PSC_STANDALONE(2),
PSC_UIDGENERIC(3),
PSC_UIDPERSONA(4),
PSC_UIDCASUAL(5),
PSC_UIDPOSITIVE(6),
PSC_SUBKEY_BINDING(7),
PSC_PUBLIC_KEY_BINDING(8),
PSC_DIRECT_KEY(9),
PSC_KEY_REVOCATION(10),
PSC_SUBKEY_REVOCATION(11),
PSC_CERT_REVOCATION(12),
PSC_TIMESTAMP(13),
PSC_THIRD_PARTY(14),
PSC_NOT_SPECIFIED(15)
Default Value
0
Remarks
Indicates the signature class.
pscDocument | 0 | Signature over binary file |
pscTextDocument | 1 | Signature over text |
pscStandalone | 2 | A standalone signature |
pscUIDGeneric | 3 | User certification signature |
pscUIDPersona | 4 | User certification signature (persona) |
pscUIDCasual | 5 | User certification signature (casual) |
pscUIDPositive | 6 | User certification signature (positive) |
pscSubkeyBinding | 7 | Subkey binding signature |
pscPublicKeyBinding | 8 | Public key binding signature |
pscDirectKey | 9 | Direct signature over a public key |
pscKeyRevocation | 10 | Key revocation |
pscSubkeyRevocation | 11 | Subkey revocation |
pscCertRevocation | 12 | User revocation |
pscTimestamp | 13 | Timestamp signature |
pscThirdParty | 14 | Third-party signature |
pscNotSpecified | 15 | Signature type not provided |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureSignerKeyID Property (PGPReader Class)
Indicates the KeyID of the signing key.
Syntax
QString GetSignatureSignerKeyID(int iSignatureIndex);
Default Value
""
Remarks
Indicates the KeyID of the signing key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureSignerUserID Property (PGPReader Class)
Indicates the UserID associated with the signing key.
Syntax
QString GetSignatureSignerUserID(int iSignatureIndex);
Default Value
""
Remarks
Indicates the UserID associated with the signing key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
String
SignatureStrictlyValid Property (PGPReader Class)
Returns True if this signature is valid in a strict way (no compatibility relaxations).
Syntax
bool GetSignatureStrictlyValid(int iSignatureIndex);
Default Value
false
Remarks
Returns True if this signature is valid in a strict way (no compatibility relaxations).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureTextSignature Property (PGPReader Class)
Indicates whether or not the signature is made over a text document.
Syntax
bool GetSignatureTextSignature(int iSignatureIndex);
Default Value
false
Remarks
Indicates whether or not the signature is made over a text document.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureTrustAmount Property (PGPReader Class)
Specifies the amount of trust assigned by this signature.
Syntax
int GetSignatureTrustAmount(int iSignatureIndex);
Default Value
0
Remarks
Specifies the amount of trust assigned by this signature.
Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureTrustLevel Property (PGPReader Class)
The trust level assigned by this signature.
Syntax
int GetSignatureTrustLevel(int iSignatureIndex);
Default Value
0
Remarks
The trust level assigned by this signature.
Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureValidated Property (PGPReader Class)
Whether the signature has been validated.
Syntax
bool GetSignatureValidated(int iSignatureIndex);
Default Value
false
Remarks
Whether the signature has been validated.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SignatureValidity Property (PGPReader Class)
Provides the validity status of the signature if the signature has been validated.
Syntax
int GetSignatureValidity(int iSignatureIndex);
Possible Values
PSV_VALID(0),
PSV_CORRUPTED(1),
PSV_UNKNOWN_ALGORITHM(2),
PSV_NO_KEY(3),
PSV_UNKNOWN(4)
Default Value
0
Remarks
Provides the validity status of the signature if the signature has been validated.
psvValid | 0 | Valid |
psvCorrupted | 1 | Corrupted |
psvUnknownAlgorithm | 2 | Unknown signature algorithm |
psvNoKey | 3 | Signing key not found, cannot verify |
psvUnknown | 4" | Unknown |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
SignatureVersion Property (PGPReader Class)
Indicates the signature version.
Syntax
int GetSignatureVersion(int iSignatureIndex);
Default Value
0
Remarks
Indicates the signature version.
RFC 4880 defines two versions for PGP signatures: 3 and 4.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only and not available at design time.
Data Type
Integer
VerifyingKeyCount Property (PGPReader Class)
The number of records in the VerifyingKey arrays.
Syntax
int GetVerifyingKeyCount();
int SetVerifyingKeyCount(int iVerifyingKeyCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at VerifyingKeyCount - 1.This property is not available at design time.
Data Type
Integer
VerifyingKeyHandle Property (PGPReader Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetVerifyingKeyHandle(int iVerifyingKeyIndex);
int SetVerifyingKeyHandle(int iVerifyingKeyIndex, qint64 lVerifyingKeyHandle);
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());
The VerifyingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.
This property is not available at design time.
Data Type
Long64
VerifyingKeyKeyFP Property (PGPReader Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetVerifyingKeyKeyFP(int iVerifyingKeyIndex);
Default Value
""
Remarks
The 20-byte fingerprint (hash value) of this key.
KeyFP could be used to distinguish two keys with the same KeyID.
The VerifyingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
VerifyingKeyKeyID Property (PGPReader Class)
Contains a 8-byte key identifier.
Syntax
QString GetVerifyingKeyKeyID(int iVerifyingKeyIndex);
Default Value
""
Remarks
Contains a 8-byte key identifier.
It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.
The VerifyingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
VerifyingKeyUsername Property (PGPReader Class)
Specifies the name of the user bound to this key.
Syntax
QString GetVerifyingKeyUsername(int iVerifyingKeyIndex);
int SetVerifyingKeyUsername(int iVerifyingKeyIndex, QString qsVerifyingKeyUsername);
Default Value
""
Remarks
Specifies the name of the user bound to this key.
The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.
The VerifyingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.
This property is not available at design time.
Data Type
String
Config Method (PGPReader 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.
DecryptAndVerify Method (PGPReader Class)
Decrypts and verifies a protected message.
Syntax
int DecryptAndVerify();
Remarks
Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).
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 (PGPReader 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.
VerifyDetached Method (PGPReader Class)
Verifies a detached signature.
Syntax
int VerifyDetached();
Remarks
Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).
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.)
EncryptionInfo Event (PGPReader Class)
Reports early information on encryption parameters.
Syntax
class PGPReaderEncryptionInfoEventParams { public: const QString &KeyIDs(); bool IntegrityProtected(); bool PassphraseUsed(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EncryptionInfo(PGPReaderEncryptionInfoEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireEncryptionInfo(PGPReaderEncryptionInfoEventParams *e) {...}
Remarks
The class fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.
KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.
IntegrityProtected parameter specifies whether the message includes a modification detection record.
Error Event (PGPReader Class)
Information about errors during PGP decryption/verification.
Syntax
class PGPReaderErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PGPReaderErrorEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireError(PGPReaderErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during decryption/verification of protected data.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalDecrypt Event (PGPReader Class)
Handles remote or external decryption.
Syntax
class PGPReaderExternalDecryptEventParams { public: const QString &OperationId(); const QString &Algorithm(); const QString &Pars(); const QString &EncryptedData(); const QString &Data(); void SetData(const QString &qsData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalDecrypt(PGPReaderExternalDecryptEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireExternalDecrypt(PGPReaderExternalDecryptEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives a encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.
A sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
FileExtractionFinish Event (PGPReader Class)
Reports the ending of file extraction process.
Syntax
class PGPReaderFileExtractionFinishEventParams { public: const QString &Filename(); const QString &Timestamp(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireFileExtractionFinish(PGPReaderFileExtractionFinishEventParams *e) {...}
Remarks
This event informs about the ending of extraction of the next available file. Filename parameter indicates the original file name, and the Timestamp its last modification time.
In the handler, the user can take away the output stream or store the file data from OutputBytes.
FileExtractionStart Event (PGPReader Class)
Reports the beginning of file extraction process.
Syntax
class PGPReaderFileExtractionStartEventParams { public: const QString &Filename(); const QString &Timestamp(); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileExtractionStart(PGPReaderFileExtractionStartEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireFileExtractionStart(PGPReaderFileExtractionStartEventParams *e) {...}
Remarks
This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. Filename parameter indicates the original file name, and the Timestamp its last modification time.
The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.
KeyPassphraseNeeded Event (PGPReader Class)
Requests a key protection password from the application.
Syntax
class PGPReaderKeyPassphraseNeededEventParams { public: const QString &KeyID(); const QString &UserID(); bool MainKey(); const QString &Passphrase(); void SetPassphrase(const QString &qsPassphrase); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void KeyPassphraseNeeded(PGPReaderKeyPassphraseNeededEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireKeyPassphraseNeeded(PGPReaderKeyPassphraseNeededEventParams *e) {...}
Remarks
The class fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase (which is requested via PassphraseNeeded). The class fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.
If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.
The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.
For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.
MultipleFilesFound Event (PGPReader Class)
Fires if the PGP message is recognized to contain multiple files.
Syntax
class PGPReaderMultipleFilesFoundEventParams { public: const QString &TarFilename(); bool Proceed(); void SetProceed(bool bProceed); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void MultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireMultipleFilesFound(PGPReaderMultipleFilesFoundEventParams *e) {...}
Remarks
The class fires this event to report that there is more than one file in the PGP message.
The TarFilename specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.
Notification Event (PGPReader Class)
This event notifies the application about an underlying control flow event.
Syntax
class PGPReaderNotificationEventParams { 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(PGPReaderNotificationEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireNotification(PGPReaderNotificationEventParams *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.
PassphraseNeeded Event (PGPReader Class)
Requests a data protection password from the application.
Syntax
class PGPReaderPassphraseNeededEventParams { public: const QString &Passphrase(); void SetPassphrase(const QString &qsPassphrase); bool Skip(); void SetSkip(bool bSkip); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void PassphraseNeeded(PGPReaderPassphraseNeededEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FirePassphraseNeeded(PGPReaderPassphraseNeededEventParams *e) {...}
Remarks
The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.
The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.
Progress Event (PGPReader Class)
Reports the progress of the decryption operation.
Syntax
class PGPReaderProgressEventParams { public: qint64 Current(); qint64 Total(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(PGPReaderProgressEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireProgress(PGPReaderProgressEventParams *e) {...}
Remarks
The class fires this event repeatedly to report the progress of the file extraction operation.
Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.
Signed Event (PGPReader Class)
Notifies the application about a signed message.
Syntax
class PGPReaderSignedEventParams { public: const QString &KeyIDs(); int SignatureType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Signed(PGPReaderSignedEventParams *e);
// Or, subclass PGPReader and override this emitter function. virtual int FireSigned(PGPReaderSignedEventParams *e) {...}
Remarks
The class fires this event when it identifies a signed message to allow the application to prepare the component for verification.
Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.
SignatureType indicates the signature type:
pstNormal | 0 | A traditional signature, compatible (algorithm permitting) with PGP 2.6.x |
pstOnePass | 1 | A newer one-pass signature |
pstDetached | 2 | A detached signature, i.e., a signature contained in a separate file from the data it covers |
pstCleartext | 3 | A signature made over textual data and appended to it |
Configuration Settings (PGPReader 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.PGPReader Configuration Settings | ||||||||||||||||||||||||||||||
IgnoreDataPacketLengths: Whether to check the length of input data packets.Set this property to True to prevent the class from checking input packet lengths. | ||||||||||||||||||||||||||||||
PasswordAttempts: The number of attempts allowed for entering password.Use this property to specify how many times a wrong password may be entered. | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
UndefInputLength: Set this property if you are working with non-seekable streams.Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the class from checking input stream length or position. | ||||||||||||||||||||||||||||||
UseGreedyMemoryConsumption: Whether to limit memory consumption for the cost of speed.When this property is True, the class uses more memory, but decrypts data faster. Otherwise, less memory is consumed, but the decryption is slower. | ||||||||||||||||||||||||||||||
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 (PGPReader Class)
PGPReader 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) | |
27262977 File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS) | |
27262978 Invalid key (SB_ERROR_PGP_INVALID_KEY) | |
27262979 No public key (SB_ERROR_PGP_NO_PUBLIC_KEY) | |
27262980 No secret key (SB_ERROR_PGP_NO_SECRET_KEY) | |
27262981 Not found (SB_ERROR_PGP_NOT_FOUND) | |
27262982 Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY) |