PDFEncryptor Class
Properties Methods Events Configuration Settings Errors
The PDFEncryptor class encrypts PDF documents.
Syntax
PDFEncryptor
Remarks
PDFEncryptor encrypts PDF documents with passwords or certificates.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| EncryptionAlgorithm | The encryption algorithm to encrypt the document with. |
| EncryptionCertificateBytes | Returns raw certificate data in DER format. |
| EncryptionCertificateCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| EncryptionCertificateCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| EncryptionCertificateCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| EncryptionCertificateCurve | Specifies the elliptic curve of the EC public key. |
| EncryptionCertificateFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| EncryptionCertificateFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| EncryptionCertificateHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| EncryptionCertificateHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| EncryptionCertificateIssuer | The common name of the certificate issuer (CA), typically a company name. |
| EncryptionCertificateIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| EncryptionCertificateKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| EncryptionCertificateKeyBits | Returns the length of the public key. |
| EncryptionCertificateKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| EncryptionCertificateKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| EncryptionCertificateKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| EncryptionCertificateOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| EncryptionCertificateOCSPNoCheck | TBD. |
| EncryptionCertificateOrigin | Returns the origin of this certificate. |
| EncryptionCertificatePolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| EncryptionCertificatePrivateKeyBytes | Contains the certificate's private key. |
| EncryptionCertificatePrivateKeyExists | Indicates whether the certificate has an associated private key. |
| EncryptionCertificatePrivateKeyExtractable | Indicates whether the private key is extractable. |
| EncryptionCertificatePublicKeyBytes | Contains the certificate's public key in DER format. |
| EncryptionCertificateQualifiedStatements | TBD. |
| EncryptionCertificateSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| EncryptionCertificateSerialNumber | Returns the certificate's serial number. |
| EncryptionCertificateSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| EncryptionCertificateSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| EncryptionCertificateSubjectAlternativeName | TBD. |
| EncryptionCertificateSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| EncryptionCertificateSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| EncryptionCertificateValidFrom | The time point at which the certificate becomes valid, in UTC. |
| EncryptionCertificateValidTo | The time point at which the certificate expires, in UTC. |
| EncryptionCertCount | The number of records in the EncryptionCert arrays. |
| EncryptionCertBytes | Returns raw certificate data in DER format. |
| EncryptionCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| EncryptionCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| EncryptionCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| EncryptionCertCurve | Specifies the elliptic curve of the EC public key. |
| EncryptionCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| EncryptionCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| EncryptionCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| EncryptionCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| EncryptionCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| EncryptionCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| EncryptionCertKeyBits | Returns the length of the public key. |
| EncryptionCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| EncryptionCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| EncryptionCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| EncryptionCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| EncryptionCertOCSPNoCheck | TBD. |
| EncryptionCertOrigin | Returns the origin of this certificate. |
| EncryptionCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| EncryptionCertPrivateKeyBytes | Contains the certificate's private key. |
| EncryptionCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
| EncryptionCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
| EncryptionCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| EncryptionCertQualifiedStatements | TBD. |
| EncryptionCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| EncryptionCertSerialNumber | Returns the certificate's serial number. |
| EncryptionCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| EncryptionCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| EncryptionCertSubjectAlternativeName | TBD. |
| EncryptionCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| EncryptionCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| EncryptionCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| EncryptionCertValidTo | The time point at which the certificate expires, in UTC. |
| EncryptionType | The encryption type. |
| EncryptMetadata | Specifies whether to encrypt the document metadata. |
| FIPSMode | Reserved. |
| InputBytes | Use this property to pass the input to class in the byte array form. |
| InputFile | The PDF file to be encrypted. |
| OutputBytes | Use this property to read the output the class object has produced. |
| OutputFile | The file to save the encrypted document to. |
| OwnerPassword | The owner password. |
| PermsAnnotations | Indicates whether the viewer may add annotations to the document. |
| PermsAssemble | Indicates if the viewer may assemble a new document on the basis of the encrypted one. |
| PermsExtract | Indicates if the user may extract (copy) pictures and text from the encrypted document. |
| PermsExtractAcc | Indicates if the user may extract pictures/text from the document for accessibility purposes. |
| PermsFillInForms | Indicates if the user may fill in forms in the document. |
| PermsHighQualityPrint | Indicates if the document may be printed in high quality. |
| PermsLowQualityPrint | Indicates if the document may be printed in low quality. |
| PermsModify | Indicates if the document may be modified. |
| UserPassword | The user password. |
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. |
| DoAction | Performs an additional action. |
| Encrypt | Encrypts the PDF document. |
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 encryption. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
| TempPath | Location where the temporary files are stored. |
| 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. |
EncryptionAlgorithm Property (PDFEncryptor Class)
The encryption algorithm to encrypt the document with.
Syntax
QString GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(QString qsEncryptionAlgorithm);
Default Value
"AES256"
Remarks
Use this property to specify the encryption algorithm to encrypt the PDF document with.
Supported values:
| SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
| SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
| SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
Data Type
String
EncryptionCertificateBytes Property (PDFEncryptor Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetEncryptionCertificateBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificateCA Property (PDFEncryptor Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetEncryptionCertificateCA();
int SetEncryptionCertificateCA(bool bEncryptionCertificateCA);
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
This property is not available at design time.
Data Type
Boolean
EncryptionCertificateCAKeyID Property (PDFEncryptor Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetEncryptionCertificateCAKeyID();
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificateCRLDistributionPoints Property (PDFEncryptor Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetEncryptionCertificateCRLDistributionPoints();
int SetEncryptionCertificateCRLDistributionPoints(QString qsEncryptionCertificateCRLDistributionPoints);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is not available at design time.
Data Type
String
EncryptionCertificateCurve Property (PDFEncryptor Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetEncryptionCertificateCurve();
int SetEncryptionCertificateCurve(QString qsEncryptionCertificateCurve);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is not available at design time.
Data Type
String
EncryptionCertificateFingerprint Property (PDFEncryptor Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetEncryptionCertificateFingerprint();
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificateFriendlyName Property (PDFEncryptor Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetEncryptionCertificateFriendlyName();
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertificateHandle Property (PDFEncryptor Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetEncryptionCertificateHandle();
int SetEncryptionCertificateHandle(qint64 lEncryptionCertificateHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
EncryptionCertificateHashAlgorithm Property (PDFEncryptor Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
Syntax
QString GetEncryptionCertificateHashAlgorithm();
int SetEncryptionCertificateHashAlgorithm(QString qsEncryptionCertificateHashAlgorithm);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is not available at design time.
Data Type
String
EncryptionCertificateIssuer Property (PDFEncryptor Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetEncryptionCertificateIssuer();
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertificateIssuerRDN Property (PDFEncryptor Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetEncryptionCertificateIssuerRDN();
int SetEncryptionCertificateIssuerRDN(QString qsEncryptionCertificateIssuerRDN);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is not available at design time.
Data Type
String
EncryptionCertificateKeyAlgorithm Property (PDFEncryptor Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetEncryptionCertificateKeyAlgorithm();
int SetEncryptionCertificateKeyAlgorithm(QString qsEncryptionCertificateKeyAlgorithm);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| 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 |
This property is not available at design time.
Data Type
String
EncryptionCertificateKeyBits Property (PDFEncryptor Class)
Returns the length of the public key.
Syntax
int GetEncryptionCertificateKeyBits();
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
EncryptionCertificateKeyFingerprint Property (PDFEncryptor Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetEncryptionCertificateKeyFingerprint();
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificateKeyUsage Property (PDFEncryptor Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetEncryptionCertificateKeyUsage();
int SetEncryptionCertificateKeyUsage(int iEncryptionCertificateKeyUsage);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is not available at design time.
Data Type
Integer
EncryptionCertificateKeyValid Property (PDFEncryptor Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetEncryptionCertificateKeyValid();
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertificateOCSPLocations Property (PDFEncryptor Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetEncryptionCertificateOCSPLocations();
int SetEncryptionCertificateOCSPLocations(QString qsEncryptionCertificateOCSPLocations);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is not available at design time.
Data Type
String
EncryptionCertificateOCSPNoCheck Property (PDFEncryptor Class)
TBD.
Syntax
bool GetEncryptionCertificateOCSPNoCheck();
int SetEncryptionCertificateOCSPNoCheck(bool bEncryptionCertificateOCSPNoCheck);
Default Value
false
Remarks
TBD.
This property is not available at design time.
Data Type
Boolean
EncryptionCertificateOrigin Property (PDFEncryptor Class)
Returns the origin of this certificate.
Syntax
int GetEncryptionCertificateOrigin();
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
EncryptionCertificatePolicyIDs Property (PDFEncryptor Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetEncryptionCertificatePolicyIDs();
int SetEncryptionCertificatePolicyIDs(QString qsEncryptionCertificatePolicyIDs);
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is not available at design time.
Data Type
String
EncryptionCertificatePrivateKeyBytes Property (PDFEncryptor Class)
Contains the certificate's private key.
Syntax
QByteArray GetEncryptionCertificatePrivateKeyBytes();
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificatePrivateKeyExists Property (PDFEncryptor Class)
Indicates whether the certificate has an associated private key.
Syntax
bool GetEncryptionCertificatePrivateKeyExists();
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertificatePrivateKeyExtractable Property (PDFEncryptor Class)
Indicates whether the private key is extractable.
Syntax
bool GetEncryptionCertificatePrivateKeyExtractable();
Default Value
false
Remarks
Indicates whether the private key is extractable
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertificatePublicKeyBytes Property (PDFEncryptor Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetEncryptionCertificatePublicKeyBytes();
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertificateQualifiedStatements Property (PDFEncryptor Class)
TBD.
Syntax
int GetEncryptionCertificateQualifiedStatements();
int SetEncryptionCertificateQualifiedStatements(int iEncryptionCertificateQualifiedStatements);
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
Default Value
0
Remarks
TBD
This property is not available at design time.
Data Type
Integer
EncryptionCertificateSelfSigned Property (PDFEncryptor Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetEncryptionCertificateSelfSigned();
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertificateSerialNumber Property (PDFEncryptor Class)
Returns the certificate's serial number.
Syntax
QByteArray GetEncryptionCertificateSerialNumber();
int SetEncryptionCertificateSerialNumber(QByteArray qbaEncryptionCertificateSerialNumber);
Remarks
Returns the certificate's serial number.
This property is not available at design time.
Data Type
Byte Array
EncryptionCertificateSigAlgorithm Property (PDFEncryptor Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetEncryptionCertificateSigAlgorithm();
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertificateSubject Property (PDFEncryptor Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetEncryptionCertificateSubject();
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertificateSubjectAlternativeName Property (PDFEncryptor Class)
TBD.
Syntax
QString GetEncryptionCertificateSubjectAlternativeName();
int SetEncryptionCertificateSubjectAlternativeName(QString qsEncryptionCertificateSubjectAlternativeName);
Default Value
""
Remarks
TBD.
This property is not available at design time.
Data Type
String
EncryptionCertificateSubjectKeyID Property (PDFEncryptor Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetEncryptionCertificateSubjectKeyID();
int SetEncryptionCertificateSubjectKeyID(QByteArray qbaEncryptionCertificateSubjectKeyID);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is not available at design time.
Data Type
Byte Array
EncryptionCertificateSubjectRDN Property (PDFEncryptor Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetEncryptionCertificateSubjectRDN();
int SetEncryptionCertificateSubjectRDN(QString qsEncryptionCertificateSubjectRDN);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is not available at design time.
Data Type
String
EncryptionCertificateValidFrom Property (PDFEncryptor Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetEncryptionCertificateValidFrom();
int SetEncryptionCertificateValidFrom(QString qsEncryptionCertificateValidFrom);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is not available at design time.
Data Type
String
EncryptionCertificateValidTo Property (PDFEncryptor Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetEncryptionCertificateValidTo();
int SetEncryptionCertificateValidTo(QString qsEncryptionCertificateValidTo);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is not available at design time.
Data Type
String
EncryptionCertCount Property (PDFEncryptor Class)
The number of records in the EncryptionCert arrays.
Syntax
int GetEncryptionCertCount();
int SetEncryptionCertCount(int iEncryptionCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- EncryptionCertBytes
- EncryptionCertCA
- EncryptionCertCAKeyID
- EncryptionCertCRLDistributionPoints
- EncryptionCertCurve
- EncryptionCertFingerprint
- EncryptionCertFriendlyName
- EncryptionCertHandle
- EncryptionCertHashAlgorithm
- EncryptionCertificateBytes
- EncryptionCertificateCA
- EncryptionCertificateCAKeyID
- EncryptionCertificateCRLDistributionPoints
- EncryptionCertificateCurve
- EncryptionCertificateFingerprint
- EncryptionCertificateFriendlyName
- EncryptionCertificateHandle
- EncryptionCertificateHashAlgorithm
- EncryptionCertificateIssuer
- EncryptionCertificateIssuerRDN
- EncryptionCertificateKeyAlgorithm
- EncryptionCertificateKeyBits
- EncryptionCertificateKeyFingerprint
- EncryptionCertificateKeyUsage
- EncryptionCertificateKeyValid
- EncryptionCertificateOCSPLocations
- EncryptionCertificateOCSPNoCheck
- EncryptionCertificateOrigin
- EncryptionCertificatePolicyIDs
- EncryptionCertificatePrivateKeyBytes
- EncryptionCertificatePrivateKeyExists
- EncryptionCertificatePrivateKeyExtractable
- EncryptionCertificatePublicKeyBytes
- EncryptionCertificateQualifiedStatements
- EncryptionCertificateSelfSigned
- EncryptionCertificateSerialNumber
- EncryptionCertificateSigAlgorithm
- EncryptionCertificateSubject
- EncryptionCertificateSubjectAlternativeName
- EncryptionCertificateSubjectKeyID
- EncryptionCertificateSubjectRDN
- EncryptionCertificateValidFrom
- EncryptionCertificateValidTo
- EncryptionCertIssuer
- EncryptionCertIssuerRDN
- EncryptionCertKeyAlgorithm
- EncryptionCertKeyBits
- EncryptionCertKeyFingerprint
- EncryptionCertKeyUsage
- EncryptionCertKeyValid
- EncryptionCertOCSPLocations
- EncryptionCertOCSPNoCheck
- EncryptionCertOrigin
- EncryptionCertPolicyIDs
- EncryptionCertPrivateKeyBytes
- EncryptionCertPrivateKeyExists
- EncryptionCertPrivateKeyExtractable
- EncryptionCertPublicKeyBytes
- EncryptionCertQualifiedStatements
- EncryptionCertSelfSigned
- EncryptionCertSerialNumber
- EncryptionCertSigAlgorithm
- EncryptionCertSubject
- EncryptionCertSubjectAlternativeName
- EncryptionCertSubjectKeyID
- EncryptionCertSubjectRDN
- EncryptionCertValidFrom
- EncryptionCertValidTo
This property is not available at design time.
Data Type
Integer
EncryptionCertBytes Property (PDFEncryptor Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetEncryptionCertBytes(int iEncryptionCertIndex);
Remarks
Returns raw certificate data in DER format.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertCA Property (PDFEncryptor Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetEncryptionCertCA(int iEncryptionCertIndex);
int SetEncryptionCertCA(int iEncryptionCertIndex, bool bEncryptionCertCA);
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Boolean
EncryptionCertCAKeyID Property (PDFEncryptor Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetEncryptionCertCAKeyID(int iEncryptionCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertCRLDistributionPoints Property (PDFEncryptor Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetEncryptionCertCRLDistributionPoints(int iEncryptionCertIndex);
int SetEncryptionCertCRLDistributionPoints(int iEncryptionCertIndex, QString qsEncryptionCertCRLDistributionPoints);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertCurve Property (PDFEncryptor Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetEncryptionCertCurve(int iEncryptionCertIndex);
int SetEncryptionCertCurve(int iEncryptionCertIndex, QString qsEncryptionCertCurve);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertFingerprint Property (PDFEncryptor Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetEncryptionCertFingerprint(int iEncryptionCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertFriendlyName Property (PDFEncryptor Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetEncryptionCertFriendlyName(int iEncryptionCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertHandle Property (PDFEncryptor Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetEncryptionCertHandle(int iEncryptionCertIndex);
int SetEncryptionCertHandle(int iEncryptionCertIndex, qint64 lEncryptionCertHandle);
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 EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Long64
EncryptionCertHashAlgorithm Property (PDFEncryptor Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
Syntax
QString GetEncryptionCertHashAlgorithm(int iEncryptionCertIndex);
int SetEncryptionCertHashAlgorithm(int iEncryptionCertIndex, QString qsEncryptionCertHashAlgorithm);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| 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 |
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertIssuer Property (PDFEncryptor Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetEncryptionCertIssuer(int iEncryptionCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertIssuerRDN Property (PDFEncryptor Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetEncryptionCertIssuerRDN(int iEncryptionCertIndex);
int SetEncryptionCertIssuerRDN(int iEncryptionCertIndex, QString qsEncryptionCertIssuerRDN);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertKeyAlgorithm Property (PDFEncryptor Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetEncryptionCertKeyAlgorithm(int iEncryptionCertIndex);
int SetEncryptionCertKeyAlgorithm(int iEncryptionCertIndex, QString qsEncryptionCertKeyAlgorithm);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
| 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 |
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertKeyBits Property (PDFEncryptor Class)
Returns the length of the public key.
Syntax
int GetEncryptionCertKeyBits(int iEncryptionCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
EncryptionCertKeyFingerprint Property (PDFEncryptor Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetEncryptionCertKeyFingerprint(int iEncryptionCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertKeyUsage Property (PDFEncryptor Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetEncryptionCertKeyUsage(int iEncryptionCertIndex);
int SetEncryptionCertKeyUsage(int iEncryptionCertIndex, int iEncryptionCertKeyUsage);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Integer
EncryptionCertKeyValid Property (PDFEncryptor Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetEncryptionCertKeyValid(int iEncryptionCertIndex);
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertOCSPLocations Property (PDFEncryptor Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetEncryptionCertOCSPLocations(int iEncryptionCertIndex);
int SetEncryptionCertOCSPLocations(int iEncryptionCertIndex, QString qsEncryptionCertOCSPLocations);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertOCSPNoCheck Property (PDFEncryptor Class)
TBD.
Syntax
bool GetEncryptionCertOCSPNoCheck(int iEncryptionCertIndex);
int SetEncryptionCertOCSPNoCheck(int iEncryptionCertIndex, bool bEncryptionCertOCSPNoCheck);
Default Value
false
Remarks
TBD.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Boolean
EncryptionCertOrigin Property (PDFEncryptor Class)
Returns the origin of this certificate.
Syntax
int GetEncryptionCertOrigin(int iEncryptionCertIndex);
Default Value
0
Remarks
Returns the origin of this certificate.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
EncryptionCertPolicyIDs Property (PDFEncryptor Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetEncryptionCertPolicyIDs(int iEncryptionCertIndex);
int SetEncryptionCertPolicyIDs(int iEncryptionCertIndex, QString qsEncryptionCertPolicyIDs);
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertPrivateKeyBytes Property (PDFEncryptor Class)
Contains the certificate's private key.
Syntax
QByteArray GetEncryptionCertPrivateKeyBytes(int iEncryptionCertIndex);
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertPrivateKeyExists Property (PDFEncryptor Class)
Indicates whether the certificate has an associated private key.
Syntax
bool GetEncryptionCertPrivateKeyExists(int iEncryptionCertIndex);
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertPrivateKeyExtractable Property (PDFEncryptor Class)
Indicates whether the private key is extractable.
Syntax
bool GetEncryptionCertPrivateKeyExtractable(int iEncryptionCertIndex);
Default Value
false
Remarks
Indicates whether the private key is extractable
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertPublicKeyBytes Property (PDFEncryptor Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetEncryptionCertPublicKeyBytes(int iEncryptionCertIndex);
Remarks
Contains the certificate's public key in DER format.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertQualifiedStatements Property (PDFEncryptor Class)
TBD.
Syntax
int GetEncryptionCertQualifiedStatements(int iEncryptionCertIndex);
int SetEncryptionCertQualifiedStatements(int iEncryptionCertIndex, int iEncryptionCertQualifiedStatements);
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
Default Value
0
Remarks
TBD
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Integer
EncryptionCertSelfSigned Property (PDFEncryptor Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetEncryptionCertSelfSigned(int iEncryptionCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
EncryptionCertSerialNumber Property (PDFEncryptor Class)
Returns the certificate's serial number.
Syntax
QByteArray GetEncryptionCertSerialNumber(int iEncryptionCertIndex);
int SetEncryptionCertSerialNumber(int iEncryptionCertIndex, QByteArray qbaEncryptionCertSerialNumber);
Remarks
Returns the certificate's serial number.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Byte Array
EncryptionCertSigAlgorithm Property (PDFEncryptor Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetEncryptionCertSigAlgorithm(int iEncryptionCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertSubject Property (PDFEncryptor Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetEncryptionCertSubject(int iEncryptionCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptionCertSubjectAlternativeName Property (PDFEncryptor Class)
TBD.
Syntax
QString GetEncryptionCertSubjectAlternativeName(int iEncryptionCertIndex);
int SetEncryptionCertSubjectAlternativeName(int iEncryptionCertIndex, QString qsEncryptionCertSubjectAlternativeName);
Default Value
""
Remarks
TBD.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertSubjectKeyID Property (PDFEncryptor Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetEncryptionCertSubjectKeyID(int iEncryptionCertIndex);
int SetEncryptionCertSubjectKeyID(int iEncryptionCertIndex, QByteArray qbaEncryptionCertSubjectKeyID);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
Byte Array
EncryptionCertSubjectRDN Property (PDFEncryptor Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetEncryptionCertSubjectRDN(int iEncryptionCertIndex);
int SetEncryptionCertSubjectRDN(int iEncryptionCertIndex, QString qsEncryptionCertSubjectRDN);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertValidFrom Property (PDFEncryptor Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetEncryptionCertValidFrom(int iEncryptionCertIndex);
int SetEncryptionCertValidFrom(int iEncryptionCertIndex, QString qsEncryptionCertValidFrom);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionCertValidTo Property (PDFEncryptor Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetEncryptionCertValidTo(int iEncryptionCertIndex);
int SetEncryptionCertValidTo(int iEncryptionCertIndex, QString qsEncryptionCertValidTo);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.
This property is not available at design time.
Data Type
String
EncryptionType Property (PDFEncryptor Class)
The encryption type.
Syntax
int GetEncryptionType();
int SetEncryptionType(int iEncryptionType);
Possible Values
PET_PASSWORD(1),
PET_CERTIFICATE(2)
Default Value
1
Remarks
Use this property to specify the encryption type to use.
Supported values:
| petPassword | 1 | Encrypt the document with passwords. Use OwnerPassword and UserPassword properties to set the passwords. |
| petCertificate | 2 | Encrypt the document with a certificate. Use EncryptionCertificate or EncryptionCertificates to supply the certificate(s). |
Data Type
Integer
EncryptMetadata Property (PDFEncryptor Class)
Specifies whether to encrypt the document metadata.
Syntax
bool GetEncryptMetadata();
int SetEncryptMetadata(bool bEncryptMetadata);
Default Value
true
Remarks
Use this property to enable or disable metadata encryption.
Metadata contains additional information about the document, such as its name and author.
Data Type
Boolean
FIPSMode Property (PDFEncryptor 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 (PDFEncryptor 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 (PDFEncryptor Class)
The PDF file to be encrypted.
Syntax
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
Provide the path to the PDF document to be encrypted.
Data Type
String
OutputBytes Property (PDFEncryptor 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 (PDFEncryptor Class)
The file to save the encrypted document to.
Syntax
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
Specifies the path where the encrypted PDF should be saved.
Data Type
String
OwnerPassword Property (PDFEncryptor Class)
The owner password.
Syntax
QString GetOwnerPassword();
int SetOwnerPassword(QString qsOwnerPassword);
Default Value
""
Remarks
Use this property to provide the document owner password. Though it may be different to UserPassword, most implementations use the same value for the both.
Data Type
String
PermsAnnotations Property (PDFEncryptor Class)
Indicates whether the viewer may add annotations to the document.
Syntax
bool GetPermsAnnotations();
int SetPermsAnnotations(bool bPermsAnnotations);
Default Value
true
Remarks
Indicates whether the viewer may add annotations to the document.
Data Type
Boolean
PermsAssemble Property (PDFEncryptor Class)
Indicates if the viewer may assemble a new document on the basis of the encrypted one.
Syntax
bool GetPermsAssemble();
int SetPermsAssemble(bool bPermsAssemble);
Default Value
true
Remarks
Indicates if the viewer may assemble a new document on the basis of the encrypted one.
Data Type
Boolean
PermsExtract Property (PDFEncryptor Class)
Indicates if the user may extract (copy) pictures and text from the encrypted document.
Syntax
bool GetPermsExtract();
int SetPermsExtract(bool bPermsExtract);
Default Value
true
Remarks
Indicates if the user may extract (copy) pictures and text from the encrypted document.
Data Type
Boolean
PermsExtractAcc Property (PDFEncryptor Class)
Indicates if the user may extract pictures/text from the document for accessibility purposes.
Syntax
bool GetPermsExtractAcc();
int SetPermsExtractAcc(bool bPermsExtractAcc);
Default Value
true
Remarks
Indicates if the user may extract pictures/text from the document for accessibility purposes.
Data Type
Boolean
PermsFillInForms Property (PDFEncryptor Class)
Indicates if the user may fill in forms in the document.
Syntax
bool GetPermsFillInForms();
int SetPermsFillInForms(bool bPermsFillInForms);
Default Value
true
Remarks
Indicates if the user may fill in forms in the document.
Data Type
Boolean
PermsHighQualityPrint Property (PDFEncryptor Class)
Indicates if the document may be printed in high quality.
Syntax
bool GetPermsHighQualityPrint();
int SetPermsHighQualityPrint(bool bPermsHighQualityPrint);
Default Value
true
Remarks
Indicates if the document may be printed in high quality.
Data Type
Boolean
PermsLowQualityPrint Property (PDFEncryptor Class)
Indicates if the document may be printed in low quality.
Syntax
bool GetPermsLowQualityPrint();
int SetPermsLowQualityPrint(bool bPermsLowQualityPrint);
Default Value
true
Remarks
Indicates if the document may be printed in low quality.
Data Type
Boolean
PermsModify Property (PDFEncryptor Class)
Indicates if the document may be modified.
Syntax
bool GetPermsModify();
int SetPermsModify(bool bPermsModify);
Default Value
true
Remarks
Indicates if the document may be modified.
Data Type
Boolean
UserPassword Property (PDFEncryptor Class)
The user password.
Syntax
QString GetUserPassword();
int SetUserPassword(QString qsUserPassword);
Default Value
""
Remarks
Use this property to provide the document user password. Though it may be different to OwnerPassword, most implementations use the same value for the both.
Data Type
String
Config Method (PDFEncryptor 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 (PDFEncryptor 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 (PDFEncryptor Class)
Encrypts the PDF document.
Syntax
int Encrypt();
Remarks
Use this method to encrypt the PDF document as configured in the object's properties.
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 (PDFEncryptor Class)
Information about errors during encryption.
Syntax
class PDFEncryptorErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(PDFEncryptorErrorEventParams *e);
// Or, subclass PDFEncryptor and override this emitter function.
virtual int FireError(PDFEncryptorErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during PDF processing.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (PDFEncryptor Class)
This event notifies the application about an underlying control flow event.
Syntax
class PDFEncryptorNotificationEventParams {
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(PDFEncryptorNotificationEventParams *e);
// Or, subclass PDFEncryptor and override this emitter function.
virtual int FireNotification(PDFEncryptorNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Configuration Settings (PDFEncryptor 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.PDFEncryptor Configuration Settings | ||||||||||||||||||||||||||||||
| EncryptionHandlerName: Specifies the custom security handler PDF-name.Specifies the custom security handler PDF-name for encryption handler. | ||||||||||||||||||||||||||||||
| HardenedKeyGeneration: Specifies if hardened Key generation should be used.Specifies if hardened Key generation should be used when an AES-256 encryption algorithm and password encryption are used. | ||||||||||||||||||||||||||||||
| RC4KeyBits: Specifies the number of key bits used for RC4 algorithm.Specifies the number of key bits used for RC4 encryption algorithm. | ||||||||||||||||||||||||||||||
| TempPath: Location where the temporary files are stored.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (PDFEncryptor Class)
PDFEncryptor 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) | |
| 26214401 Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) | |
| 26214402 Document is encrypted (SB_ERROR_PDF_ENCRYPTED) | |
| 26214403 Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) | |
| 26214404 Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE) | |
| 26214405 Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) | |
| 26214406 Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED) | |
| 26214407 Document is signed (SB_ERROR_PDF_SIGNED) | |
| 26214408 Document is not signed (SB_ERROR_PDF_NOT_SIGNED) | |
| 26214409 Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) | |
| 26214410 Not supported (SB_ERROR_PDF_NOT_SUPPORTED) |