PGPWriter Class
Properties Methods Events Configuration Settings Errors
The PGPWriter class protects data using PGP keys and certificates.
Syntax
PGPWriter
Remarks
PGPWriter allows you to encrypt, sign, armor, and compress the input 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.
Armor | Specifies whether the data should be armored. |
ArmorBoundary | A boundary to put around the base64 armor. |
ArmorHeaders | Additional headers to include with the armored message. |
Compress | Whether to compress the data before encrypting it. |
CompressionAlgorithm | The compression algorithm to use. |
CompressionLevel | The compression level to use. |
EncryptingKeyCount | The number of records in the EncryptingKey arrays. |
EncryptingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
EncryptingKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
EncryptingKeyKeyID | Contains a 8-byte key identifier. |
EncryptingKeyUsername | Specifies the name of the user bound to this key. |
EncryptionAlgorithm | A symmetric algorithm to use for data encryption. |
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. |
Filename | Specifies the name of the file being protected. |
FIPSMode | Reserved. |
HashAlgorithm | The hash algorithm to use for signing. |
InputBytes | Use this property to pass the input to class in the byte array form. |
InputFile | Provides a filename of a file to process. |
InputIsText | Whether the input data is text. |
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 | The encryption password. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
Protection | Specifies a password protection level. |
SigningKeyCount | The number of records in the SigningKey arrays. |
SigningKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningKeyKeyFP | The 20-byte fingerprint (hash value) of this key. |
SigningKeyKeyID | Contains a 8-byte key identifier. |
SigningKeyPassphrase | The key protection password. |
SigningKeyPassphraseValid | Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key. |
SigningKeyUsername | Specifies the name of the user bound to this key. |
Timestamp | The date and time of the last modification of the protected data file (in UTC). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
ClearTextSign | Creates a cleartext signature over the provided data. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Encrypt | Encrypts data. |
EncryptAndSign | Encrypts and signs data. |
Sign | Signs data. |
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 | Information about errors during PGP encryption. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
KeyPassphraseNeeded | Requests a key protection password from the application. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the progress of the decryption operation. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
PasswordAttempts | The number of attempts allowed for entering password. |
PreserveFilePaths | Whether to preserve full file names when saving the PGP file. |
SignBufferingMethod | The type of buffering used during signing. |
TempPath | Path for storing temporary files. |
TextCompatibilityMode | Whether whitespaces must be trimmed from the signature. |
UndefInputLength | Set this property if you are working with non-seekable streams. |
UseNewFeatures | Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed. |
UseOldPackets | Whether signature packets of old format, compatible with PGP 2.6.3, should be used. |
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. |
Armor Property (PGPWriter Class)
Specifies whether the data should be armored.
Syntax
bool GetArmor();
int SetArmor(bool bArmor);
Default Value
false
Remarks
Switch this property on to armor the protected data by encoding it in base64 and enveloping with BEGIN and END markings.
Data Type
Boolean
ArmorBoundary Property (PGPWriter Class)
A boundary to put around the base64 armor.
Syntax
QString GetArmorBoundary();
int SetArmorBoundary(QString qsArmorBoundary);
Default Value
""
Remarks
Use this property to specify the boundary to put around the base64 armor. If set to 'PGP MESSAGE', the armored data will be enveloped with '-----BEGIN PGP MESSAGE-----' and '-----END PGP MESSAGE-----' lines.
This property only makes sense if Armor is set True.
Data Type
String
ArmorHeaders Property (PGPWriter Class)
Additional headers to include with the armored message.
Syntax
QString GetArmorHeaders();
int SetArmorHeaders(QString qsArmorHeaders);
Default Value
""
Remarks
Use this property to specify additional headers to be included with the armored message.
Assign this property with a multi-line text, with each line being of "header: value" form (without quotes).
Data Type
String
Compress Property (PGPWriter Class)
Whether to compress the data before encrypting it.
Syntax
bool GetCompress();
int SetCompress(bool bCompress);
Default Value
false
Remarks
Set this property to True to compress the data before encryption. Use CompressionAlgorithm and CompressionLevel to tune up compression parameters.
Data Type
Boolean
CompressionAlgorithm Property (PGPWriter Class)
The compression algorithm to use.
Syntax
QString GetCompressionAlgorithm();
int SetCompressionAlgorithm(QString qsCompressionAlgorithm);
Default Value
"Uncompressed"
Remarks
Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if Compress is True.
SB_PGP_COMPRESSION_ALGORITHM_NONE | Uncompressed | |
SB_PGP_COMPRESSION_ALGORITHM_ZIP | ZIP | |
SB_PGP_COMPRESSION_ALGORITHM_ZLIB | Zlib | |
SB_PGP_COMPRESSION_ALGORITHM_BZIP2 | Bzip2 |
Data Type
String
CompressionLevel Property (PGPWriter Class)
The compression level to use.
Syntax
int GetCompressionLevel();
int SetCompressionLevel(int iCompressionLevel);
Default Value
0
Remarks
Use this property to specify the compression level, from 1 (fastest) to 9 (best).
Data Type
Integer
EncryptingKeyCount Property (PGPWriter Class)
The number of records in the EncryptingKey arrays.
Syntax
int GetEncryptingKeyCount();
int SetEncryptingKeyCount(int iEncryptingKeyCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at EncryptingKeyCount - 1.This property is not available at design time.
Data Type
Integer
EncryptingKeyHandle Property (PGPWriter Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetEncryptingKeyHandle(int iEncryptingKeyIndex);
int SetEncryptingKeyHandle(int iEncryptingKeyIndex, qint64 lEncryptingKeyHandle);
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 EncryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptingKeyCount property.
This property is not available at design time.
Data Type
Long64
EncryptingKeyKeyFP Property (PGPWriter Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetEncryptingKeyKeyFP(int iEncryptingKeyIndex);
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 EncryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptingKeyKeyID Property (PGPWriter Class)
Contains a 8-byte key identifier.
Syntax
QString GetEncryptingKeyKeyID(int iEncryptingKeyIndex);
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 EncryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptingKeyCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptingKeyUsername Property (PGPWriter Class)
Specifies the name of the user bound to this key.
Syntax
QString GetEncryptingKeyUsername(int iEncryptingKeyIndex);
int SetEncryptingKeyUsername(int iEncryptingKeyIndex, QString qsEncryptingKeyUsername);
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 EncryptingKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptingKeyCount property.
This property is not available at design time.
Data Type
String
EncryptionAlgorithm Property (PGPWriter Class)
A symmetric algorithm to use for data encryption.
Syntax
QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);
Default Value
"CAST5"
Remarks
Use this property to specify a symmetric algorithm to use for data encryption.
SB_PGP_SYMMETRIC_ALGORITHM_PLAINTEXT | Plaintext | |
SB_PGP_SYMMETRIC_ALGORITHM_IDEA | Idea | |
SB_PGP_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_PGP_SYMMETRIC_ALGORITHM_CAST5 | CAST5 | |
SB_PGP_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish | |
SB_PGP_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_PGP_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_PGP_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_PGP_SYMMETRIC_ALGORITHM_TWOFISH256 | Twofish256 |
Data Type
String
ExternalCryptoAsyncDocumentID Property (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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 (PGPWriter 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
Filename Property (PGPWriter Class)
Specifies the name of the file being protected.
Syntax
QString GetFilename();
int SetFilename(QString qsFilename);
Default Value
""
Remarks
Use this property to set the name of the file being protected, such as 'document.txt'. If Filename is empty or its value is "_CONSOLE", the data will be protected for-your-eyes-only, meaning the decryptor will only be able to read it on their screen, but not save.
Data Type
String
FIPSMode Property (PGPWriter 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 (PGPWriter Class)
The hash algorithm to use for signing.
Syntax
QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);
Default Value
""
Remarks
Use this property to specify the hash algorithm to use for calculating signatures.
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
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_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
Data Type
String
InputBytes Property (PGPWriter 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 (PGPWriter 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
InputIsText Property (PGPWriter Class)
Whether the input data is text.
Syntax
bool GetInputIsText();
int SetInputIsText(bool bInputIsText);
Default Value
false
Remarks
Set this property to true to indicate that the supplied data should be treated as text.
Data Type
Boolean
OutputBytes Property (PGPWriter 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 (PGPWriter 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 (PGPWriter Class)
The encryption password.
Syntax
QString GetPassphrase();
int SetPassphrase(QString qsPassphrase);
Default Value
""
Remarks
Use this property to provide the encryption password. If an encryption password is used, no key will be needed to decrypt the data.
Data Type
String
Profile Property (PGPWriter 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
Protection Property (PGPWriter Class)
Specifies a password protection level.
Syntax
int GetProtection();
int SetProtection(int iProtection);
Possible Values
PPT_NONE(0),
PPT_LOW(1),
PPT_NORMAL(2),
PPT_HIGH(3)
Default Value
0
Remarks
This property specifies the complexity of key derivation function for password-protected documents.
Allowed values:
pptNone | 0 | Key is not encrypted |
pptLow | 1 | Only the password hash is used to derive the secret key |
pptNormal | 2 | Password hash with salt is used to derive the secret key |
pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation |
Data Type
Integer
SigningKeyCount Property (PGPWriter Class)
The number of records in the SigningKey arrays.
Syntax
int GetSigningKeyCount();
int SetSigningKeyCount(int iSigningKeyCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- SigningKeyHandle
- SigningKeyKeyFP
- SigningKeyKeyID
- SigningKeyPassphrase
- SigningKeyPassphraseValid
- SigningKeyUsername
This property is not available at design time.
Data Type
Integer
SigningKeyHandle Property (PGPWriter Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningKeyHandle(int iSigningKeyIndex);
int SetSigningKeyHandle(int iSigningKeyIndex, qint64 lSigningKeyHandle);
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 SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is not available at design time.
Data Type
Long64
SigningKeyKeyFP Property (PGPWriter Class)
The 20-byte fingerprint (hash value) of this key.
Syntax
QString GetSigningKeyKeyFP(int iSigningKeyIndex);
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 SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SigningKeyKeyID Property (PGPWriter Class)
Contains a 8-byte key identifier.
Syntax
QString GetSigningKeyKeyID(int iSigningKeyIndex);
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 SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is read-only and not available at design time.
Data Type
String
SigningKeyPassphrase Property (PGPWriter Class)
The key protection password.
Syntax
QString GetSigningKeyPassphrase(int iSigningKeyIndex);
int SetSigningKeyPassphrase(int iSigningKeyIndex, QString qsSigningKeyPassphrase);
Default Value
""
Remarks
The key protection password.
The SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is not available at design time.
Data Type
String
SigningKeyPassphraseValid Property (PGPWriter Class)
Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.
Syntax
bool GetSigningKeyPassphraseValid(int iSigningKeyIndex);
Default Value
false
Remarks
Use this property to check whether the specified SigningKeyPassphrase is valid and can be used to unlock the secret key.
The SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SigningKeyUsername Property (PGPWriter Class)
Specifies the name of the user bound to this key.
Syntax
QString GetSigningKeyUsername(int iSigningKeyIndex);
int SetSigningKeyUsername(int iSigningKeyIndex, QString qsSigningKeyUsername);
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 SigningKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningKeyCount property.
This property is not available at design time.
Data Type
String
Timestamp Property (PGPWriter Class)
The date and time of the last modification of the protected data file (in UTC).
Syntax
QString GetTimestamp();
int SetTimestamp(QString qsTimestamp);
Default Value
""
Remarks
Use this property to set a timestamp for the data being protected.
Data Type
String
ClearTextSign Method (PGPWriter Class)
Creates a cleartext signature over the provided data.
Syntax
int ClearTextSign();
Remarks
Call this method to create a cleartext signature over the provided data buffer (InputBytes). Only textual data can be signed in cleartext.
Pass the signing key(s) via SigningKeys 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.)
Config Method (PGPWriter 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.
DoAction Method (PGPWriter 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 (PGPWriter Class)
Encrypts data.
Syntax
int Encrypt();
Remarks
Use this method to encrypt input data from a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).
Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase 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.)
EncryptAndSign Method (PGPWriter Class)
Encrypts and signs data.
Syntax
int EncryptAndSign();
Remarks
Use this method to encrypt and sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the protected message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).
Specify encryption keys in EncryptingKeys property, and/or encryption password via Passphrase property. Use SigningKeys to provide the signing keys.
Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase 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.)
Sign Method (PGPWriter Class)
Signs data.
Syntax
int Sign(bool bDetached);
Remarks
Use this method to sign a byte array (InputBytes), a file (InputFile) or a stream (InputStream) and get the signed message in another byte array (OutputBytes), or another file (OutputFile), or another stream (OutputStream).
Use SigningKeys to provide the signing keys.
Please note that you might need to provide a passphrase to decrypt your signing key. This can be done via KeyPassphraseNeeded event, or by assigning the passphrase to the key object's Passphrase 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.)
Error Event (PGPWriter Class)
Information about errors during PGP encryption.
Syntax
class PGPWriterErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(PGPWriterErrorEventParams *e);
// Or, subclass PGPWriter and override this emitter function. virtual int FireError(PGPWriterErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during data encryption or signing.
ErrorCode contains an error code and Description contains a textual description of the error.
ExternalSign Event (PGPWriter Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
class PGPWriterExternalSignEventParams { public: const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(PGPWriterExternalSignEventParams *e);
// Or, subclass PGPWriter and override this emitter function. virtual int FireExternalSign(PGPWriterExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
KeyPassphraseNeeded Event (PGPWriter Class)
Requests a key protection password from the application.
Syntax
class PGPWriterKeyPassphraseNeededEventParams { 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(PGPWriterKeyPassphraseNeededEventParams *e);
// Or, subclass PGPWriter and override this emitter function. virtual int FireKeyPassphraseNeeded(PGPWriterKeyPassphraseNeededEventParams *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. The class fires it when it attempts to use a secret key to sign the data.
This event is fired for every protected secret key residing in SigningKeys. 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.
Notification Event (PGPWriter Class)
This event notifies the application about an underlying control flow event.
Syntax
class PGPWriterNotificationEventParams { 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(PGPWriterNotificationEventParams *e);
// Or, subclass PGPWriter and override this emitter function. virtual int FireNotification(PGPWriterNotificationEventParams *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.
Progress Event (PGPWriter Class)
Reports the progress of the decryption operation.
Syntax
class PGPWriterProgressEventParams { 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(PGPWriterProgressEventParams *e);
// Or, subclass PGPWriter and override this emitter function. virtual int FireProgress(PGPWriterProgressEventParams *e) {...}
Remarks
The class fires this event repeatedly to report the progress of the file protection 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 protection process.
Configuration Settings (PGPWriter 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.PGPWriter Configuration Settings | ||||||||||||||||||||||||||||||
PasswordAttempts: The number of attempts allowed for entering password.Use this property to specify how many times a wrong password may be entered. | ||||||||||||||||||||||||||||||
PreserveFilePaths:
Whether to preserve full file names when saving the PGP file.When this property is False, the Encrypt and Sign methods save only the
file names (without full paths) to the PGP file.
When this property is True, the file names are saved exactly as they are passed to the above mentioned methods, including full paths. This lets you to save directory structures to the encrypted and/or signed PGP files. |
||||||||||||||||||||||||||||||
SignBufferingMethod: The type of buffering used during signing.Specifies the behaviour of the signer when operating with the input stream. Allowed values are: 0 - create a temporary stream and copy all data into it; 1 - rewind the input stream. The last option is useful when you have a stream which doesn't support seek operation such as a network stream or a decompressor stream. | ||||||||||||||||||||||||||||||
TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TextCompatibilityMode: Whether whitespaces must be trimmed from the signature.Several versions of PGP have a bug in their implementations which results in creation of incorrect text signatures because they only remove trailing whitespaces from cleartext signatures. Technically, such signatures are not OpenPGP-compliant. Set this property to True if you want to interoperate with these implementations. Set this property to False if you need to create only OpenPGP-compliant messages. | ||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||
UseNewFeatures: Whether the new algorithms, or only the algorithms compatible with PGP 2.6.x, are allowed.Use this property for compatibility with old versions of PGP-compatible software. If this property is set to True, then newer and stronger algorithms will be used. In this case ClearTextSign and Sign will be compatible with PGP 2.6.x, while Encrypt and EncryptAndSign will not. If the property is set to False, then the result will be compatible with PGP 2.6.x, while the keys are compatible (i.e. don't use features not supported by PGP 2.6.x). | ||||||||||||||||||||||||||||||
UseOldPackets: Whether signature packets of old format, compatible with PGP 2.6.3, should be used.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. | ||||||||||||||||||||||||||||||
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 (PGPWriter Class)
PGPWriter 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) |