PDFEncryptor Class
Properties Methods Events Config 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.
DocumentInfoEncryptionAlgorithm | The symmetric algorithm used to encrypt the document. |
DocumentInfoEncryptionType | The document encryption type. |
DocumentInfoMetadataEncrypted | Indicates if the document metadata is encrypted. |
DocumentInfoPermissions | Contains the document permissions associated with the encryption. |
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 | Accessor to the value of the certificates ocsp-no-check extension. |
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 | Returns the qualified status of the certificate. |
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 | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
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. |
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. |
Permissions | Specifies the document permissions associated with the encryption. |
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.
DocumentLoaded | This event is fired when the document has been loaded into memory. |
Error | Information about errors during encryption. |
Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config 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. |
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. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
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. |
DocumentInfoEncryptionAlgorithm Property (PDFEncryptor Class)
The symmetric algorithm used to encrypt the document.
Syntax
ANSI (Cross Platform) char* GetDocumentInfoEncryptionAlgorithm(); Unicode (Windows) LPWSTR GetDocumentInfoEncryptionAlgorithm();
char* secureblackbox_pdfencryptor_getdocumentinfoencryptionalgorithm(void* lpObj);
QString GetDocumentInfoEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric algorithm used to encrypt the document.
This property contains the encryption algorithm that was used to encrypt the PDF document.
Supported values:
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
This property is read-only and not available at design time.
Data Type
String
DocumentInfoEncryptionType Property (PDFEncryptor Class)
The document encryption type.
Syntax
ANSI (Cross Platform) int GetDocumentInfoEncryptionType(); Unicode (Windows) INT GetDocumentInfoEncryptionType();
Possible Values
PET_NONE(0),
PET_PASSWORD(1),
PET_CERTIFICATE(2)
int secureblackbox_pdfencryptor_getdocumentinfoencryptiontype(void* lpObj);
int GetDocumentInfoEncryptionType();
Default Value
1
Remarks
The document encryption type.
This property indicates the kind of encryption that was used to encrypt the PDF document.
Supported values:
petPassword | 1 | The document is encrypted with a password. |
petCertificate | 2 | The document is encrypted with a certificate (or many certificates). |
This property is read-only and not available at design time.
Data Type
Integer
DocumentInfoMetadataEncrypted Property (PDFEncryptor Class)
Indicates if the document metadata is encrypted.
Syntax
ANSI (Cross Platform) int GetDocumentInfoMetadataEncrypted(); Unicode (Windows) BOOL GetDocumentInfoMetadataEncrypted();
int secureblackbox_pdfencryptor_getdocumentinfometadataencrypted(void* lpObj);
bool GetDocumentInfoMetadataEncrypted();
Default Value
TRUE
Remarks
Indicates if the document metadata is encrypted.
Use this property to check if document metadata is encrypted.
Metadata contains additional information about document such as its name and author.
This property is read-only and not available at design time.
Data Type
Boolean
DocumentInfoPermissions Property (PDFEncryptor Class)
Contains the document permissions associated with the encryption.
Syntax
ANSI (Cross Platform) int GetDocumentInfoPermissions(); Unicode (Windows) INT GetDocumentInfoPermissions();
int secureblackbox_pdfencryptor_getdocumentinfopermissions(void* lpObj);
int GetDocumentInfoPermissions();
Default Value
0
Remarks
Contains the document permissions associated with the encryption.
Use this property to check permissions protected by this encryption. PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:
pepAnnotations | 0x0001 | Annotating is allowed |
pepAssemble | 0x0002 | Assembling a new document on the basis of the processed one is allowed |
pepExtract | 0x0004 | Extraction/copying of the pictures and text from the document is allowed |
pepExtractAcc | 0x0008 | Content extraction is allowed for accessibility purposes only |
pepFillInForms | 0x0010 | Filling forms in is allowed |
pepHighQualityPrint | 0x0020 | High quality printing is allowed |
pepLowQualityPrint | 0x0040 | Low quality printing is allowed |
pepModify | 0x0080 | Modifications are allowed |
This property is read-only and not available at design time.
Data Type
Integer
EncryptionAlgorithm Property (PDFEncryptor Class)
The encryption algorithm to encrypt the document with.
Syntax
ANSI (Cross Platform) char* GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(const char* lpszEncryptionAlgorithm); Unicode (Windows) LPWSTR GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(LPCWSTR lpszEncryptionAlgorithm);
char* secureblackbox_pdfencryptor_getencryptionalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptionalgorithm(void* lpObj, const char* lpszEncryptionAlgorithm);
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
ANSI (Cross Platform) int GetEncryptionCertificateBytes(char* &lpEncryptionCertificateBytes, int &lenEncryptionCertificateBytes); Unicode (Windows) INT GetEncryptionCertificateBytes(LPSTR &lpEncryptionCertificateBytes, INT &lenEncryptionCertificateBytes);
int secureblackbox_pdfencryptor_getencryptioncertificatebytes(void* lpObj, char** lpEncryptionCertificateBytes, int* lenEncryptionCertificateBytes);
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
ANSI (Cross Platform) int GetEncryptionCertificateCA();
int SetEncryptionCertificateCA(int bEncryptionCertificateCA); Unicode (Windows) BOOL GetEncryptionCertificateCA();
INT SetEncryptionCertificateCA(BOOL bEncryptionCertificateCA);
int secureblackbox_pdfencryptor_getencryptioncertificateca(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateca(void* lpObj, int bEncryptionCertificateCA);
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
ANSI (Cross Platform) int GetEncryptionCertificateCAKeyID(char* &lpEncryptionCertificateCAKeyID, int &lenEncryptionCertificateCAKeyID); Unicode (Windows) INT GetEncryptionCertificateCAKeyID(LPSTR &lpEncryptionCertificateCAKeyID, INT &lenEncryptionCertificateCAKeyID);
int secureblackbox_pdfencryptor_getencryptioncertificatecakeyid(void* lpObj, char** lpEncryptionCertificateCAKeyID, int* lenEncryptionCertificateCAKeyID);
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
ANSI (Cross Platform) char* GetEncryptionCertificateCRLDistributionPoints();
int SetEncryptionCertificateCRLDistributionPoints(const char* lpszEncryptionCertificateCRLDistributionPoints); Unicode (Windows) LPWSTR GetEncryptionCertificateCRLDistributionPoints();
INT SetEncryptionCertificateCRLDistributionPoints(LPCWSTR lpszEncryptionCertificateCRLDistributionPoints);
char* secureblackbox_pdfencryptor_getencryptioncertificatecrldistributionpoints(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatecrldistributionpoints(void* lpObj, const char* lpszEncryptionCertificateCRLDistributionPoints);
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
ANSI (Cross Platform) char* GetEncryptionCertificateCurve();
int SetEncryptionCertificateCurve(const char* lpszEncryptionCertificateCurve); Unicode (Windows) LPWSTR GetEncryptionCertificateCurve();
INT SetEncryptionCertificateCurve(LPCWSTR lpszEncryptionCertificateCurve);
char* secureblackbox_pdfencryptor_getencryptioncertificatecurve(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatecurve(void* lpObj, const char* lpszEncryptionCertificateCurve);
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
ANSI (Cross Platform) int GetEncryptionCertificateFingerprint(char* &lpEncryptionCertificateFingerprint, int &lenEncryptionCertificateFingerprint); Unicode (Windows) INT GetEncryptionCertificateFingerprint(LPSTR &lpEncryptionCertificateFingerprint, INT &lenEncryptionCertificateFingerprint);
int secureblackbox_pdfencryptor_getencryptioncertificatefingerprint(void* lpObj, char** lpEncryptionCertificateFingerprint, int* lenEncryptionCertificateFingerprint);
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
ANSI (Cross Platform) char* GetEncryptionCertificateFriendlyName(); Unicode (Windows) LPWSTR GetEncryptionCertificateFriendlyName();
char* secureblackbox_pdfencryptor_getencryptioncertificatefriendlyname(void* lpObj);
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
ANSI (Cross Platform) int64 GetEncryptionCertificateHandle();
int SetEncryptionCertificateHandle(int64 lEncryptionCertificateHandle); Unicode (Windows) LONG64 GetEncryptionCertificateHandle();
INT SetEncryptionCertificateHandle(LONG64 lEncryptionCertificateHandle);
int64 secureblackbox_pdfencryptor_getencryptioncertificatehandle(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatehandle(void* lpObj, int64 lEncryptionCertificateHandle);
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
ANSI (Cross Platform) char* GetEncryptionCertificateHashAlgorithm();
int SetEncryptionCertificateHashAlgorithm(const char* lpszEncryptionCertificateHashAlgorithm); Unicode (Windows) LPWSTR GetEncryptionCertificateHashAlgorithm();
INT SetEncryptionCertificateHashAlgorithm(LPCWSTR lpszEncryptionCertificateHashAlgorithm);
char* secureblackbox_pdfencryptor_getencryptioncertificatehashalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatehashalgorithm(void* lpObj, const char* lpszEncryptionCertificateHashAlgorithm);
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
ANSI (Cross Platform) char* GetEncryptionCertificateIssuer(); Unicode (Windows) LPWSTR GetEncryptionCertificateIssuer();
char* secureblackbox_pdfencryptor_getencryptioncertificateissuer(void* lpObj);
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
ANSI (Cross Platform) char* GetEncryptionCertificateIssuerRDN();
int SetEncryptionCertificateIssuerRDN(const char* lpszEncryptionCertificateIssuerRDN); Unicode (Windows) LPWSTR GetEncryptionCertificateIssuerRDN();
INT SetEncryptionCertificateIssuerRDN(LPCWSTR lpszEncryptionCertificateIssuerRDN);
char* secureblackbox_pdfencryptor_getencryptioncertificateissuerrdn(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateissuerrdn(void* lpObj, const char* lpszEncryptionCertificateIssuerRDN);
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
ANSI (Cross Platform) char* GetEncryptionCertificateKeyAlgorithm();
int SetEncryptionCertificateKeyAlgorithm(const char* lpszEncryptionCertificateKeyAlgorithm); Unicode (Windows) LPWSTR GetEncryptionCertificateKeyAlgorithm();
INT SetEncryptionCertificateKeyAlgorithm(LPCWSTR lpszEncryptionCertificateKeyAlgorithm);
char* secureblackbox_pdfencryptor_getencryptioncertificatekeyalgorithm(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatekeyalgorithm(void* lpObj, const char* lpszEncryptionCertificateKeyAlgorithm);
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
ANSI (Cross Platform) int GetEncryptionCertificateKeyBits(); Unicode (Windows) INT GetEncryptionCertificateKeyBits();
int secureblackbox_pdfencryptor_getencryptioncertificatekeybits(void* lpObj);
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
ANSI (Cross Platform) int GetEncryptionCertificateKeyFingerprint(char* &lpEncryptionCertificateKeyFingerprint, int &lenEncryptionCertificateKeyFingerprint); Unicode (Windows) INT GetEncryptionCertificateKeyFingerprint(LPSTR &lpEncryptionCertificateKeyFingerprint, INT &lenEncryptionCertificateKeyFingerprint);
int secureblackbox_pdfencryptor_getencryptioncertificatekeyfingerprint(void* lpObj, char** lpEncryptionCertificateKeyFingerprint, int* lenEncryptionCertificateKeyFingerprint);
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
ANSI (Cross Platform) int GetEncryptionCertificateKeyUsage();
int SetEncryptionCertificateKeyUsage(int iEncryptionCertificateKeyUsage); Unicode (Windows) INT GetEncryptionCertificateKeyUsage();
INT SetEncryptionCertificateKeyUsage(INT iEncryptionCertificateKeyUsage);
int secureblackbox_pdfencryptor_getencryptioncertificatekeyusage(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatekeyusage(void* lpObj, int iEncryptionCertificateKeyUsage);
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
ANSI (Cross Platform) int GetEncryptionCertificateKeyValid(); Unicode (Windows) BOOL GetEncryptionCertificateKeyValid();
int secureblackbox_pdfencryptor_getencryptioncertificatekeyvalid(void* lpObj);
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
ANSI (Cross Platform) char* GetEncryptionCertificateOCSPLocations();
int SetEncryptionCertificateOCSPLocations(const char* lpszEncryptionCertificateOCSPLocations); Unicode (Windows) LPWSTR GetEncryptionCertificateOCSPLocations();
INT SetEncryptionCertificateOCSPLocations(LPCWSTR lpszEncryptionCertificateOCSPLocations);
char* secureblackbox_pdfencryptor_getencryptioncertificateocsplocations(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateocsplocations(void* lpObj, const char* lpszEncryptionCertificateOCSPLocations);
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)
Accessor to the value of the certificates ocsp-no-check extension.
Syntax
ANSI (Cross Platform) int GetEncryptionCertificateOCSPNoCheck();
int SetEncryptionCertificateOCSPNoCheck(int bEncryptionCertificateOCSPNoCheck); Unicode (Windows) BOOL GetEncryptionCertificateOCSPNoCheck();
INT SetEncryptionCertificateOCSPNoCheck(BOOL bEncryptionCertificateOCSPNoCheck);
int secureblackbox_pdfencryptor_getencryptioncertificateocspnocheck(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificateocspnocheck(void* lpObj, int bEncryptionCertificateOCSPNoCheck);
bool GetEncryptionCertificateOCSPNoCheck();
int SetEncryptionCertificateOCSPNoCheck(bool bEncryptionCertificateOCSPNoCheck);
Default Value
FALSE
Remarks
Accessor to the value of the certificates ocsp-no-check extension.
This property is not available at design time.
Data Type
Boolean
EncryptionCertificateOrigin Property (PDFEncryptor Class)
Returns the origin of this certificate.
Syntax
ANSI (Cross Platform) int GetEncryptionCertificateOrigin(); Unicode (Windows) INT GetEncryptionCertificateOrigin();
int secureblackbox_pdfencryptor_getencryptioncertificateorigin(void* lpObj);
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
ANSI (Cross Platform) char* GetEncryptionCertificatePolicyIDs();
int SetEncryptionCertificatePolicyIDs(const char* lpszEncryptionCertificatePolicyIDs); Unicode (Windows) LPWSTR GetEncryptionCertificatePolicyIDs();
INT SetEncryptionCertificatePolicyIDs(LPCWSTR lpszEncryptionCertificatePolicyIDs);
char* secureblackbox_pdfencryptor_getencryptioncertificatepolicyids(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatepolicyids(void* lpObj, const char* lpszEncryptionCertificatePolicyIDs);
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
ANSI (Cross Platform) int GetEncryptionCertificatePrivateKeyBytes(char* &lpEncryptionCertificatePrivateKeyBytes, int &lenEncryptionCertificatePrivateKeyBytes); Unicode (Windows) INT GetEncryptionCertificatePrivateKeyBytes(LPSTR &lpEncryptionCertificatePrivateKeyBytes, INT &lenEncryptionCertificatePrivateKeyBytes);
int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeybytes(void* lpObj, char** lpEncryptionCertificatePrivateKeyBytes, int* lenEncryptionCertificatePrivateKeyBytes);
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
ANSI (Cross Platform) int GetEncryptionCertificatePrivateKeyExists(); Unicode (Windows) BOOL GetEncryptionCertificatePrivateKeyExists();
int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeyexists(void* lpObj);
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
ANSI (Cross Platform) int GetEncryptionCertificatePrivateKeyExtractable(); Unicode (Windows) BOOL GetEncryptionCertificatePrivateKeyExtractable();
int secureblackbox_pdfencryptor_getencryptioncertificateprivatekeyextractable(void* lpObj);
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
ANSI (Cross Platform) int GetEncryptionCertificatePublicKeyBytes(char* &lpEncryptionCertificatePublicKeyBytes, int &lenEncryptionCertificatePublicKeyBytes); Unicode (Windows) INT GetEncryptionCertificatePublicKeyBytes(LPSTR &lpEncryptionCertificatePublicKeyBytes, INT &lenEncryptionCertificatePublicKeyBytes);
int secureblackbox_pdfencryptor_getencryptioncertificatepublickeybytes(void* lpObj, char** lpEncryptionCertificatePublicKeyBytes, int* lenEncryptionCertificatePublicKeyBytes);
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)
Returns the qualified status of the certificate.
Syntax
ANSI (Cross Platform) int GetEncryptionCertificateQualifiedStatements();
int SetEncryptionCertificateQualifiedStatements(int iEncryptionCertificateQualifiedStatements); Unicode (Windows) INT GetEncryptionCertificateQualifiedStatements();
INT SetEncryptionCertificateQualifiedStatements(INT iEncryptionCertificateQualifiedStatements);
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
int secureblackbox_pdfencryptor_getencryptioncertificatequalifiedstatements(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatequalifiedstatements(void* lpObj, int iEncryptionCertificateQualifiedStatements);
int GetEncryptionCertificateQualifiedStatements();
int SetEncryptionCertificateQualifiedStatements(int iEncryptionCertificateQualifiedStatements);
Default Value
0
Remarks
Returns the qualified status of the certificate.
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
ANSI (Cross Platform) int GetEncryptionCertificateSelfSigned(); Unicode (Windows) BOOL GetEncryptionCertificateSelfSigned();
int secureblackbox_pdfencryptor_getencryptioncertificateselfsigned(void* lpObj);
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
ANSI (Cross Platform) int GetEncryptionCertificateSerialNumber(char* &lpEncryptionCertificateSerialNumber, int &lenEncryptionCertificateSerialNumber);
int SetEncryptionCertificateSerialNumber(const char* lpEncryptionCertificateSerialNumber, int lenEncryptionCertificateSerialNumber); Unicode (Windows) INT GetEncryptionCertificateSerialNumber(LPSTR &lpEncryptionCertificateSerialNumber, INT &lenEncryptionCertificateSerialNumber);
INT SetEncryptionCertificateSerialNumber(LPCSTR lpEncryptionCertificateSerialNumber, INT lenEncryptionCertificateSerialNumber);
int secureblackbox_pdfencryptor_getencryptioncertificateserialnumber(void* lpObj, char** lpEncryptionCertificateSerialNumber, int* lenEncryptionCertificateSerialNumber);
int secureblackbox_pdfencryptor_setencryptioncertificateserialnumber(void* lpObj, const char* lpEncryptionCertificateSerialNumber, int lenEncryptionCertificateSerialNumber);
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
ANSI (Cross Platform) char* GetEncryptionCertificateSigAlgorithm(); Unicode (Windows) LPWSTR GetEncryptionCertificateSigAlgorithm();
char* secureblackbox_pdfencryptor_getencryptioncertificatesigalgorithm(void* lpObj);
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
ANSI (Cross Platform) char* GetEncryptionCertificateSubject(); Unicode (Windows) LPWSTR GetEncryptionCertificateSubject();
char* secureblackbox_pdfencryptor_getencryptioncertificatesubject(void* lpObj);
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)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
ANSI (Cross Platform) char* GetEncryptionCertificateSubjectAlternativeName();
int SetEncryptionCertificateSubjectAlternativeName(const char* lpszEncryptionCertificateSubjectAlternativeName); Unicode (Windows) LPWSTR GetEncryptionCertificateSubjectAlternativeName();
INT SetEncryptionCertificateSubjectAlternativeName(LPCWSTR lpszEncryptionCertificateSubjectAlternativeName);
char* secureblackbox_pdfencryptor_getencryptioncertificatesubjectalternativename(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectalternativename(void* lpObj, const char* lpszEncryptionCertificateSubjectAlternativeName);
QString GetEncryptionCertificateSubjectAlternativeName();
int SetEncryptionCertificateSubjectAlternativeName(QString qsEncryptionCertificateSubjectAlternativeName);
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
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
ANSI (Cross Platform) int GetEncryptionCertificateSubjectKeyID(char* &lpEncryptionCertificateSubjectKeyID, int &lenEncryptionCertificateSubjectKeyID);
int SetEncryptionCertificateSubjectKeyID(const char* lpEncryptionCertificateSubjectKeyID, int lenEncryptionCertificateSubjectKeyID); Unicode (Windows) INT GetEncryptionCertificateSubjectKeyID(LPSTR &lpEncryptionCertificateSubjectKeyID, INT &lenEncryptionCertificateSubjectKeyID);
INT SetEncryptionCertificateSubjectKeyID(LPCSTR lpEncryptionCertificateSubjectKeyID, INT lenEncryptionCertificateSubjectKeyID);
int secureblackbox_pdfencryptor_getencryptioncertificatesubjectkeyid(void* lpObj, char** lpEncryptionCertificateSubjectKeyID, int* lenEncryptionCertificateSubjectKeyID);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectkeyid(void* lpObj, const char* lpEncryptionCertificateSubjectKeyID, int lenEncryptionCertificateSubjectKeyID);
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
ANSI (Cross Platform) char* GetEncryptionCertificateSubjectRDN();
int SetEncryptionCertificateSubjectRDN(const char* lpszEncryptionCertificateSubjectRDN); Unicode (Windows) LPWSTR GetEncryptionCertificateSubjectRDN();
INT SetEncryptionCertificateSubjectRDN(LPCWSTR lpszEncryptionCertificateSubjectRDN);
char* secureblackbox_pdfencryptor_getencryptioncertificatesubjectrdn(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatesubjectrdn(void* lpObj, const char* lpszEncryptionCertificateSubjectRDN);
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
ANSI (Cross Platform) char* GetEncryptionCertificateValidFrom();
int SetEncryptionCertificateValidFrom(const char* lpszEncryptionCertificateValidFrom); Unicode (Windows) LPWSTR GetEncryptionCertificateValidFrom();
INT SetEncryptionCertificateValidFrom(LPCWSTR lpszEncryptionCertificateValidFrom);
char* secureblackbox_pdfencryptor_getencryptioncertificatevalidfrom(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatevalidfrom(void* lpObj, const char* lpszEncryptionCertificateValidFrom);
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
ANSI (Cross Platform) char* GetEncryptionCertificateValidTo();
int SetEncryptionCertificateValidTo(const char* lpszEncryptionCertificateValidTo); Unicode (Windows) LPWSTR GetEncryptionCertificateValidTo();
INT SetEncryptionCertificateValidTo(LPCWSTR lpszEncryptionCertificateValidTo);
char* secureblackbox_pdfencryptor_getencryptioncertificatevalidto(void* lpObj);
int secureblackbox_pdfencryptor_setencryptioncertificatevalidto(void* lpObj, const char* lpszEncryptionCertificateValidTo);
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
EncryptMetadata Property (PDFEncryptor Class)
Specifies whether to encrypt the document metadata.
Syntax
ANSI (Cross Platform) int GetEncryptMetadata();
int SetEncryptMetadata(int bEncryptMetadata); Unicode (Windows) BOOL GetEncryptMetadata();
INT SetEncryptMetadata(BOOL bEncryptMetadata);
int secureblackbox_pdfencryptor_getencryptmetadata(void* lpObj);
int secureblackbox_pdfencryptor_setencryptmetadata(void* lpObj, int bEncryptMetadata);
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
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_pdfencryptor_getfipsmode(void* lpObj);
int secureblackbox_pdfencryptor_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
InputBytes Property (PDFEncryptor Class)
Use this property to pass the input to class in the byte array form.
Syntax
ANSI (Cross Platform) int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes); Unicode (Windows) INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);
int secureblackbox_pdfencryptor_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_pdfencryptor_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);
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
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_pdfencryptor_getinputfile(void* lpObj);
int secureblackbox_pdfencryptor_setinputfile(void* lpObj, const char* lpszInputFile);
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
ANSI (Cross Platform) int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes); Unicode (Windows) INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_pdfencryptor_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);
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
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_pdfencryptor_getoutputfile(void* lpObj);
int secureblackbox_pdfencryptor_setoutputfile(void* lpObj, const char* lpszOutputFile);
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
ANSI (Cross Platform) char* GetOwnerPassword();
int SetOwnerPassword(const char* lpszOwnerPassword); Unicode (Windows) LPWSTR GetOwnerPassword();
INT SetOwnerPassword(LPCWSTR lpszOwnerPassword);
char* secureblackbox_pdfencryptor_getownerpassword(void* lpObj);
int secureblackbox_pdfencryptor_setownerpassword(void* lpObj, const char* lpszOwnerPassword);
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
Permissions Property (PDFEncryptor Class)
Specifies the document permissions associated with the encryption.
Syntax
ANSI (Cross Platform) int GetPermissions();
int SetPermissions(int iPermissions); Unicode (Windows) INT GetPermissions();
INT SetPermissions(INT iPermissions);
int secureblackbox_pdfencryptor_getpermissions(void* lpObj);
int secureblackbox_pdfencryptor_setpermissions(void* lpObj, int iPermissions);
int GetPermissions();
int SetPermissions(int iPermissions);
Default Value
0
Remarks
Use this property to specify permissions protected by this encryption. PDF specification expects applications to comply with these permissions when handling encrypted documents, but keep in mind it is a policy-like requirement rather than an enforcement. Provide the permissions as a bit mask of the following flags:
pepAnnotations | 0x0001 | Annotating is allowed |
pepAssemble | 0x0002 | Assembling a new document on the basis of the processed one is allowed |
pepExtract | 0x0004 | Extraction/copying of the pictures and text from the document is allowed |
pepExtractAcc | 0x0008 | Content extraction is allowed for accessibility purposes only |
pepFillInForms | 0x0010 | Filling forms in is allowed |
pepHighQualityPrint | 0x0020 | High quality printing is allowed |
pepLowQualityPrint | 0x0040 | Low quality printing is allowed |
pepModify | 0x0080 | Modifications are allowed |
This property is not available at design time.
Data Type
Integer
UserPassword Property (PDFEncryptor Class)
The user password.
Syntax
ANSI (Cross Platform) char* GetUserPassword();
int SetUserPassword(const char* lpszUserPassword); Unicode (Windows) LPWSTR GetUserPassword();
INT SetUserPassword(LPCWSTR lpszUserPassword);
char* secureblackbox_pdfencryptor_getuserpassword(void* lpObj);
int secureblackbox_pdfencryptor_setuserpassword(void* lpObj, const char* lpszUserPassword);
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
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_pdfencryptor_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (PDFEncryptor Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_pdfencryptor_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insencitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Encrypt Method (PDFEncryptor Class)
Encrypts the PDF document.
Syntax
ANSI (Cross Platform) int Encrypt(); Unicode (Windows) INT Encrypt();
int secureblackbox_pdfencryptor_encrypt(void* lpObj);
int Encrypt();
Remarks
Use this method to encrypt the PDF document as configured in the object's properties.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DocumentLoaded Event (PDFEncryptor Class)
This event is fired when the document has been loaded into memory.
Syntax
ANSI (Cross Platform) virtual int FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e);
typedef struct {
int Cancel; int reserved; } PDFEncryptorDocumentLoadedEventParams;
Unicode (Windows) virtual INT FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e);
typedef struct {
BOOL Cancel; INT reserved; } PDFEncryptorDocumentLoadedEventParams;
#define EID_PDFENCRYPTOR_DOCUMENTLOADED 1 virtual INT SECUREBLACKBOX_CALL FireDocumentLoaded(BOOL &bCancel);
class PDFEncryptorDocumentLoadedEventParams { public: bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e);
// Or, subclass PDFEncryptor and override this emitter function. virtual int FireDocumentLoaded(PDFEncryptorDocumentLoadedEventParams *e) {...}
Remarks
The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the Pages information to find the optimal position for the signature widget.
Set Cancel to true to terminate document processing on this stage.
Error Event (PDFEncryptor Class)
Information about errors during encryption.
Syntax
ANSI (Cross Platform) virtual int FireError(PDFEncryptorErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } PDFEncryptorErrorEventParams;
Unicode (Windows) virtual INT FireError(PDFEncryptorErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } PDFEncryptorErrorEventParams;
#define EID_PDFENCRYPTOR_ERROR 2 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
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
ANSI (Cross Platform) virtual int FireNotification(PDFEncryptorNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } PDFEncryptorNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(PDFEncryptorNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } PDFEncryptorNotificationEventParams;
#define EID_PDFENCRYPTOR_NOTIFICATION 3 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
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.
Config 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 Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (PDFEncryptor Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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) |