PDFEncryptor Class
Properties Methods Events Config Settings Errors
The PDFEncryptor class encrypts PDF documents.
Syntax
class secureblackbox.PDFEncryptor
Remarks
PDFEncryptor encrypts PDF documents with passwords or certificates.
Use PDFEncryptor to encrypt unencrypted and unsigned PDF documents. The PDF specification offers two encryption types:
- Password-based encryption: only someone who knows the password can decrypt the document.
- Certificate-based encryption: only the person who has the private key matching the encryption certificate can decrypt the document.
To encrypt a document with a password, simply assign the password to owner_password and user_password properties. While PDF allows you to use different passwords for less-restricted owner and more-restricted user, this is rarely used in practice, with the majority of implementations sticking to the same password for both types of users.
To encrypt a document with a certificate, load the recipient's certificate using CertificateManager or CertificateStorage components and assign it to the encryption_certificate property. The certificate does not need to include the private key.
For both encryption types, use permissions setting to adjust what the viewer can and cannot do. Please note that those are largely declarative, and when a PDF viewing application gets access to the decryption password, it can violate them or simply re-save the document without encryption.
Use encryption_algorithm property to tweak the encryption algorithm. encrypt_metadata specifies whether the document information (author name, producer software etc.) should be encrypted together with the rest of the document or kept in the clear.
Finally, provide the input and output locations using input_file (or input_bytes) and output_file properties and call the encrypt method to complete the operation. If output_file is not assigned, the encrypted document will be generated in output_bytes.
encryptor.InputFile = "plain.pdf";
encryptor.OutputFile = "encrypted.pdf";
encryptor.OwnerPassword = "password";
encryptor.UserPassword = "password";
encryptor.Permissions = pepLowQualityPrint | pepHighQualityPrint;
encryptor.Encrypt();Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| document_info_encryption_algorithm | The symmetric algorithm used to encrypt the document. |
| document_info_encryption_type | The document encryption type. |
| document_info_metadata_encrypted | Indicates if the document metadata is encrypted. |
| document_info_permissions | Contains the document permissions associated with the encryption. |
| encryption_algorithm | The encryption algorithm to encrypt the document with. |
| encryption_certificate_bytes | Returns the raw certificate data in DER format. |
| encryption_certificate_ca | Indicates whether the certificate has a CA capability. |
| encryption_certificate_ca_key_id | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| encryption_certificate_cert_type | Returns the type of the entity contained in the Certificate object. |
| encryption_certificate_crl_distribution_points | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| encryption_certificate_curve | Specifies the elliptic curve associated with the certificate's public key. |
| encryption_certificate_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| encryption_certificate_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| encryption_certificate_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| encryption_certificate_hash_algorithm | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| encryption_certificate_issuer | The common name of the certificate issuer (CA), typically a company name. |
| encryption_certificate_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| encryption_certificate_key_algorithm | Specifies the public key algorithm of this certificate. |
| encryption_certificate_key_bits | Returns the length of the public key in bits. |
| encryption_certificate_key_fingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| encryption_certificate_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| encryption_certificate_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| encryption_certificate_ocsp_locations | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| encryption_certificate_ocsp_no_check | Accessor to the value of the certificate's ocsp-no-check extension. |
| encryption_certificate_origin | Returns the location that the certificate was taken or loaded from. |
| encryption_certificate_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| encryption_certificate_private_key_bytes | Returns the certificate's private key in DER-encoded format. |
| encryption_certificate_private_key_exists | Indicates whether the certificate has a usable private key associated with it. |
| encryption_certificate_private_key_extractable | Indicates whether the private key is extractable (exportable). |
| encryption_certificate_public_key_bytes | Contains the certificate's public key in DER format. |
| encryption_certificate_qualified | Indicates whether the certificate is qualified. |
| encryption_certificate_qualified_statements | Returns a simplified qualified status of the certificate. |
| encryption_certificate_qualifiers | A list of qualifiers. |
| encryption_certificate_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| encryption_certificate_serial_number | Returns the certificate's serial number. |
| encryption_certificate_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| encryption_certificate_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| encryption_certificate_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| encryption_certificate_subject_alternative_name | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| encryption_certificate_subject_key_id | Contains a unique identifier of the certificate's cryptographic key. |
| encryption_certificate_subject_rdn | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| encryption_certificate_valid | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. |
| encryption_certificate_valid_from | The time point at which the certificate becomes valid, in UTC. |
| encryption_certificate_valid_to | The time point at which the certificate expires, in UTC. |
| encrypt_metadata | Specifies whether to encrypt the document metadata. |
| fips_mode | Reserved. |
| input_bytes | Use this property to pass the input to class in byte array form. |
| input_file | The PDF file to be encrypted. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | The file to save the encrypted document to. |
| owner_password | The owner password. |
| permissions | Specifies the document permissions associated with the encryption. |
| user_password | 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. |
| do_action | Performs an additional action. |
| encrypt | Encrypts the PDF document. |
| reset | Resets the class settings. |
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.
| on_document_loaded | This event is fired when the document has been loaded into memory. |
| on_error | Information about errors during encryption. |
| on_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.
| DocumentVersion | The document version from the PDF document header. |
| EmptySignatureFieldAddRevInfo[Index] | Specifies if revocation checking should be performed. |
| EmptySignatureFieldAlternateName[Index] | Contains an alternate field name. |
| EmptySignatureFieldCount | The number of empty signature form fields. |
| EmptySignatureFieldFlags[Index] | The field flags of the signature form field. |
| EmptySignatureFieldHeight[Index] | The Height of the empty signature form field. |
| EmptySignatureFieldInvisible[Index] | The visibility status of the field. |
| EmptySignatureFieldLegalAttestations[Index] | Specifies the legal attestations that are associated with the signature. |
| EmptySignatureFieldMappingName[Index] | The mapping name to be used when exporting form field data from the document. |
| EmptySignatureFieldName[Index] | Textual field name. |
| EmptySignatureFieldOffsetX[Index] | The field's offset from the left page border. |
| EmptySignatureFieldOffsetY[Index] | The field's offset from the bottom page border. |
| EmptySignatureFieldPage[Index] | The index of the form field's page in the document. |
| EmptySignatureFieldRequiredAllowedChanges[Index] | Specifies the changes allowed by the signature. |
| EmptySignatureFieldRequiredConstraints[Index] | Specifies the required Seed Value Dictionary (SVD) constraints. |
| EmptySignatureFieldRequiredDigestAlgorithms[Index] | Specifies the required digest algorithms. |
| EmptySignatureFieldRequiredFilter[Index] | Specifies the required filter. |
| EmptySignatureFieldRequiredLockAction[Index] | Indicates which set of fields shall be locked. |
| EmptySignatureFieldRequiredLockFields[Index] | Indicates the fields that shall be locked on signing. |
| EmptySignatureFieldRequiredReasons[Index] | Specifies the required reasons. |
| EmptySignatureFieldRequiredSubfilters[Index] | Specifies the required subfilters. |
| EmptySignatureFieldTimestampRequired[Index] | Specifies if the signature should be timestamped. |
| EmptySignatureFieldTSPURL[Index] | URL for a TSP server. |
| EmptySignatureFieldWidth[Index] | The Width of the empty signature form field. |
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| PageInfoCount | The number of pages. |
| PageInfoCropBoxEmpty[Index] | Check if the page's crop box is empty or not. |
| PageInfoCropLLX[Index] | Defines the X coordinate of the lower left corner of the crop box. |
| PageInfoCropLLY[Index] | Defines the Y coordinate of the lower left corner of the crop box. |
| PageInfoCropURX[Index] | Defines the X coordinate of the upper right corner of the crop box. |
| PageInfoCropURY[Index] | Defines the Y coordinate of the upper right corner of the crop box. |
| PageInfoHeight[Index] | The Height of the page. |
| PageInfoMediaLLX[Index] | Defines the X coordinate of the lower left corner of the media box. |
| PageInfoMediaLLY[Index] | Defines the Y coordinate of the lower left corner of the media box. |
| PageInfoMediaURX[Index] | Defines the X coordinate of the upper right corner of the media box. |
| PageInfoMediaURY[Index] | Defines the Y coordinate of the upper right corner of the media box. |
| PageInfoRotate[Index] | The Rotate value of the page. |
| PageInfoUserUnit[Index] | Defines the size of default user space units. |
| PageInfoWidth[Index] | The Width of the page. |
| RC4KeyBits | Specifies the number of key bits used for the RC4 algorithm. |
| TempPath | Path for storing temporary files. |
| XMPMetadataContent | The XMP metadata content. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| 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. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| 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. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| 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. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| 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. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
document_info_encryption_algorithm Property
The symmetric algorithm used to encrypt the document.
Syntax
def get_document_info_encryption_algorithm() -> str: ...
document_info_encryption_algorithm = property(get_document_info_encryption_algorithm, None)
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.
document_info_encryption_type Property
The document encryption type.
Syntax
def get_document_info_encryption_type() -> int: ...
document_info_encryption_type = property(get_document_info_encryption_type, None)
Possible Values
0 # None
1 # Password
2 # Certificate
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.
document_info_metadata_encrypted Property
Indicates if the document metadata is encrypted.
Syntax
def get_document_info_metadata_encrypted() -> bool: ...
document_info_metadata_encrypted = property(get_document_info_metadata_encrypted, None)
Default Value
TRUE
Remarks
Indicates if the document metadata is encrypted.
Use this property to check if the document metadata is encrypted.
Metadata contains additional information about the document such as its name and author.
This property is read-only.
document_info_permissions Property
Contains the document permissions associated with the encryption.
Syntax
def get_document_info_permissions() -> int: ...
document_info_permissions = property(get_document_info_permissions, None)
Default Value
0
Remarks
Contains the document permissions associated with the encryption.
Use this property to check the permissions protected by this encryption. The 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.
encryption_algorithm Property
The encryption algorithm to encrypt the document with.
Syntax
def get_encryption_algorithm() -> str: ... def set_encryption_algorithm(value: str) -> None: ...
encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)
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 |
encryption_certificate_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_encryption_certificate_bytes() -> bytes: ...
encryption_certificate_bytes = property(get_encryption_certificate_bytes, None)
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
encryption_certificate_ca Property
Indicates whether the certificate has a CA capability.
Syntax
def get_encryption_certificate_ca() -> bool: ... def set_encryption_certificate_ca(value: bool) -> None: ...
encryption_certificate_ca = property(get_encryption_certificate_ca, set_encryption_certificate_ca)
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
encryption_certificate_ca_key_id Property
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
def get_encryption_certificate_ca_key_id() -> bytes: ...
encryption_certificate_ca_key_id = property(get_encryption_certificate_ca_key_id, None)
Remarks
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the encryption_certificate_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
This property is read-only.
encryption_certificate_cert_type Property
Returns the type of the entity contained in the Certificate object.
Syntax
def get_encryption_certificate_cert_type() -> int: ...
encryption_certificate_cert_type = property(get_encryption_certificate_cert_type, None)
Possible Values
0 # Unknown
1 # X509Certificate
2 # X509CertificateRequest
Default Value
0
Remarks
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
This property is read-only.
encryption_certificate_crl_distribution_points Property
Contains a list of locations of CRL distribution points used to check this certificate's validity.
Syntax
def get_encryption_certificate_crl_distribution_points() -> str: ... def set_encryption_certificate_crl_distribution_points(value: str) -> None: ...
encryption_certificate_crl_distribution_points = property(get_encryption_certificate_crl_distribution_points, set_encryption_certificate_crl_distribution_points)
Default Value
""
Remarks
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
encryption_certificate_curve Property
Specifies the elliptic curve associated with the certificate's public key.
Syntax
def get_encryption_certificate_curve() -> str: ... def set_encryption_certificate_curve(value: str) -> None: ...
encryption_certificate_curve = property(get_encryption_certificate_curve, set_encryption_certificate_curve)
Default Value
""
Remarks
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| 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 |
encryption_certificate_fingerprint Property
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
def get_encryption_certificate_fingerprint() -> str: ...
encryption_certificate_fingerprint = property(get_encryption_certificate_fingerprint, None)
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
This property is read-only.
encryption_certificate_friendly_name Property
Contains an associated alias (friendly name) of the certificate.
Syntax
def get_encryption_certificate_friendly_name() -> str: ...
encryption_certificate_friendly_name = property(get_encryption_certificate_friendly_name, None)
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
This property is read-only.
encryption_certificate_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_encryption_certificate_handle() -> int: ... def set_encryption_certificate_handle(value: int) -> None: ...
encryption_certificate_handle = property(get_encryption_certificate_handle, set_encryption_certificate_handle)
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());encryption_certificate_hash_algorithm Property
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
Syntax
def get_encryption_certificate_hash_algorithm() -> str: ... def set_encryption_certificate_hash_algorithm(value: str) -> None: ...
encryption_certificate_hash_algorithm = property(get_encryption_certificate_hash_algorithm, set_encryption_certificate_hash_algorithm)
Default Value
""
Remarks
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use encryption_certificate_sig_algorithm to find out the hash algorithm that is part of the certificate signature.
| 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 |
encryption_certificate_issuer Property
The common name of the certificate issuer (CA), typically a company name.
Syntax
def get_encryption_certificate_issuer() -> str: ...
encryption_certificate_issuer = property(get_encryption_certificate_issuer, None)
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via encryption_certificate_issuer_rdn.
This property is read-only.
encryption_certificate_issuer_rdn Property
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
def get_encryption_certificate_issuer_rdn() -> str: ... def set_encryption_certificate_issuer_rdn(value: str) -> None: ...
encryption_certificate_issuer_rdn = property(get_encryption_certificate_issuer_rdn, set_encryption_certificate_issuer_rdn)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
encryption_certificate_key_algorithm Property
Specifies the public key algorithm of this certificate.
Syntax
def get_encryption_certificate_key_algorithm() -> str: ... def set_encryption_certificate_key_algorithm(value: str) -> None: ...
encryption_certificate_key_algorithm = property(get_encryption_certificate_key_algorithm, set_encryption_certificate_key_algorithm)
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 |
Use the encryption_certificate_key_bits, encryption_certificate_curve, and encryption_certificate_public_key_bytes properties to get more details about the key the certificate contains.
encryption_certificate_key_bits Property
Returns the length of the public key in bits.
Syntax
def get_encryption_certificate_key_bits() -> int: ...
encryption_certificate_key_bits = property(get_encryption_certificate_key_bits, None)
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the encryption_certificate_public_key_bytes or encryption_certificate_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
This property is read-only.
encryption_certificate_key_fingerprint Property
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
def get_encryption_certificate_key_fingerprint() -> str: ...
encryption_certificate_key_fingerprint = property(get_encryption_certificate_key_fingerprint, None)
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the encryption_certificate_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
This property is read-only.
encryption_certificate_key_usage Property
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
def get_encryption_certificate_key_usage() -> int: ... def set_encryption_certificate_key_usage(value: int) -> None: ...
encryption_certificate_key_usage = property(get_encryption_certificate_key_usage, set_encryption_certificate_key_usage)
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 |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
encryption_certificate_key_valid Property
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
def get_encryption_certificate_key_valid() -> bool: ...
encryption_certificate_key_valid = property(get_encryption_certificate_key_valid, None)
Default Value
FALSE
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only.
encryption_certificate_ocsp_locations Property
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Syntax
def get_encryption_certificate_ocsp_locations() -> str: ... def set_encryption_certificate_ocsp_locations(value: str) -> None: ...
encryption_certificate_ocsp_locations = property(get_encryption_certificate_ocsp_locations, set_encryption_certificate_ocsp_locations)
Default Value
""
Remarks
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
encryption_certificate_ocsp_no_check Property
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
def get_encryption_certificate_ocsp_no_check() -> bool: ... def set_encryption_certificate_ocsp_no_check(value: bool) -> None: ...
encryption_certificate_ocsp_no_check = property(get_encryption_certificate_ocsp_no_check, set_encryption_certificate_ocsp_no_check)
Default Value
FALSE
Remarks
Accessor to the value of the certificate's ocsp-no-check extension.
encryption_certificate_origin Property
Returns the location that the certificate was taken or loaded from.
Syntax
def get_encryption_certificate_origin() -> int: ...
encryption_certificate_origin = property(get_encryption_certificate_origin, None)
Default Value
0
Remarks
Returns the location that the certificate was taken or loaded from.
This property is read-only.
encryption_certificate_policy_i_ds Property
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
def get_encryption_certificate_policy_i_ds() -> str: ... def set_encryption_certificate_policy_i_ds(value: str) -> None: ...
encryption_certificate_policy_i_ds = property(get_encryption_certificate_policy_i_ds, set_encryption_certificate_policy_i_ds)
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.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
encryption_certificate_private_key_bytes Property
Returns the certificate's private key in DER-encoded format.
Syntax
def get_encryption_certificate_private_key_bytes() -> bytes: ...
encryption_certificate_private_key_bytes = property(get_encryption_certificate_private_key_bytes, None)
Remarks
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
This property is read-only.
encryption_certificate_private_key_exists Property
Indicates whether the certificate has a usable private key associated with it.
Syntax
def get_encryption_certificate_private_key_exists() -> bool: ...
encryption_certificate_private_key_exists = property(get_encryption_certificate_private_key_exists, None)
Default Value
FALSE
Remarks
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from encryption_certificate_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
This property is read-only.
encryption_certificate_private_key_extractable Property
Indicates whether the private key is extractable (exportable).
Syntax
def get_encryption_certificate_private_key_extractable() -> bool: ...
encryption_certificate_private_key_extractable = property(get_encryption_certificate_private_key_extractable, None)
Default Value
FALSE
Remarks
Indicates whether the private key is extractable (exportable).
This property is read-only.
encryption_certificate_public_key_bytes Property
Contains the certificate's public key in DER format.
Syntax
def get_encryption_certificate_public_key_bytes() -> bytes: ...
encryption_certificate_public_key_bytes = property(get_encryption_certificate_public_key_bytes, None)
Remarks
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
This property is read-only.
encryption_certificate_qualified Property
Indicates whether the certificate is qualified.
Syntax
def get_encryption_certificate_qualified() -> bool: ...
encryption_certificate_qualified = property(get_encryption_certificate_qualified, None)
Default Value
FALSE
Remarks
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
This property is read-only.
encryption_certificate_qualified_statements Property
Returns a simplified qualified status of the certificate.
Syntax
def get_encryption_certificate_qualified_statements() -> int: ... def set_encryption_certificate_qualified_statements(value: int) -> None: ...
encryption_certificate_qualified_statements = property(get_encryption_certificate_qualified_statements, set_encryption_certificate_qualified_statements)
Possible Values
0 # NonQualified
1 # QualifiedHardware
2 # QualifiedSoftware
Default Value
0
Remarks
Returns a simplified qualified status of the certificate.
encryption_certificate_qualifiers Property
A list of qualifiers.
Syntax
def get_encryption_certificate_qualifiers() -> str: ...
encryption_certificate_qualifiers = property(get_encryption_certificate_qualifiers, None)
Default Value
""
Remarks
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
This property is read-only.
encryption_certificate_self_signed Property
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
def get_encryption_certificate_self_signed() -> bool: ...
encryption_certificate_self_signed = property(get_encryption_certificate_self_signed, None)
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only.
encryption_certificate_serial_number Property
Returns the certificate's serial number.
Syntax
def get_encryption_certificate_serial_number() -> bytes: ... def set_encryption_certificate_serial_number(value: bytes) -> None: ...
encryption_certificate_serial_number = property(get_encryption_certificate_serial_number, set_encryption_certificate_serial_number)
Remarks
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
encryption_certificate_sig_algorithm Property
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
def get_encryption_certificate_sig_algorithm() -> str: ...
encryption_certificate_sig_algorithm = property(get_encryption_certificate_sig_algorithm, None)
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
This property is read-only.
encryption_certificate_source Property
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
def get_encryption_certificate_source() -> int: ...
encryption_certificate_source = property(get_encryption_certificate_source, None)
Possible Values
0 # Unknown
1 # Signature
2 # Document
3 # User
4 # Local
5 # Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
This property is read-only.
encryption_certificate_subject Property
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
def get_encryption_certificate_subject() -> str: ...
encryption_certificate_subject = property(get_encryption_certificate_subject, None)
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 is part of a larger set of credentials available via encryption_certificate_subject_rdn.
This property is read-only.
encryption_certificate_subject_alternative_name Property
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
def get_encryption_certificate_subject_alternative_name() -> str: ... def set_encryption_certificate_subject_alternative_name(value: str) -> None: ...
encryption_certificate_subject_alternative_name = property(get_encryption_certificate_subject_alternative_name, set_encryption_certificate_subject_alternative_name)
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main encryption_certificate_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
encryption_certificate_subject_key_id Property
Contains a unique identifier of the certificate's cryptographic key.
Syntax
def get_encryption_certificate_subject_key_id() -> bytes: ... def set_encryption_certificate_subject_key_id(value: bytes) -> None: ...
encryption_certificate_subject_key_id = property(get_encryption_certificate_subject_key_id, set_encryption_certificate_subject_key_id)
Remarks
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The encryption_certificate_subject_key_id and encryption_certificate_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
encryption_certificate_subject_rdn Property
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
def get_encryption_certificate_subject_rdn() -> str: ... def set_encryption_certificate_subject_rdn(value: str) -> None: ...
encryption_certificate_subject_rdn = property(get_encryption_certificate_subject_rdn, set_encryption_certificate_subject_rdn)
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
encryption_certificate_valid Property
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
Syntax
def get_encryption_certificate_valid() -> bool: ...
encryption_certificate_valid = property(get_encryption_certificate_valid, None)
Default Value
FALSE
Remarks
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
This property is read-only.
encryption_certificate_valid_from Property
The time point at which the certificate becomes valid, in UTC.
Syntax
def get_encryption_certificate_valid_from() -> str: ... def set_encryption_certificate_valid_from(value: str) -> None: ...
encryption_certificate_valid_from = property(get_encryption_certificate_valid_from, set_encryption_certificate_valid_from)
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
encryption_certificate_valid_to Property
The time point at which the certificate expires, in UTC.
Syntax
def get_encryption_certificate_valid_to() -> str: ... def set_encryption_certificate_valid_to(value: str) -> None: ...
encryption_certificate_valid_to = property(get_encryption_certificate_valid_to, set_encryption_certificate_valid_to)
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
encrypt_metadata Property
Specifies whether to encrypt the document metadata.
Syntax
def get_encrypt_metadata() -> bool: ... def set_encrypt_metadata(value: bool) -> None: ...
encrypt_metadata = property(get_encrypt_metadata, set_encrypt_metadata)
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.
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
input_bytes Property
Use this property to pass the input to class in byte array form.
Syntax
def get_input_bytes() -> bytes: ... def set_input_bytes(value: bytes) -> None: ...
input_bytes = property(get_input_bytes, set_input_bytes)
Remarks
Assign a byte array containing the data to be processed to this property.
input_file Property
The PDF file to be encrypted.
Syntax
def get_input_file() -> str: ... def set_input_file(value: str) -> None: ...
input_file = property(get_input_file, set_input_file)
Default Value
""
Remarks
Provide the path to the PDF document to be encrypted.
output_bytes Property
Use this property to read the output the class object has produced.
Syntax
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
Remarks
Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.
This property is read-only.
output_file Property
The file to save the encrypted document to.
Syntax
def get_output_file() -> str: ... def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
Default Value
""
Remarks
Specifies the path where the encrypted PDF should be saved.
owner_password Property
The owner password.
Syntax
def get_owner_password() -> str: ... def set_owner_password(value: str) -> None: ...
owner_password = property(get_owner_password, set_owner_password)
Default Value
""
Remarks
Use this property to provide the document owner password. Though it may be different from user_password, most implementations use the same value for both.
permissions Property
Specifies the document permissions associated with the encryption.
Syntax
def get_permissions() -> int: ... def set_permissions(value: int) -> None: ...
permissions = property(get_permissions, set_permissions)
Default Value
0
Remarks
Use this property to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but keep in mind that 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 |
user_password Property
The user password.
Syntax
def get_user_password() -> str: ... def set_user_password(value: str) -> None: ...
user_password = property(get_user_password, set_user_password)
Default Value
""
Remarks
Use this property to provide the document user password. Though it may be different from owner_password, most implementations use the same value for both.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action 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 insensitive) 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;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
encrypt Method
Encrypts the PDF document.
Syntax
def encrypt() -> None: ...
Remarks
Use this method to encrypt the PDF document as configured in the object's properties.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
on_document_loaded Event
This event is fired when the document has been loaded into memory.
Syntax
class PDFEncryptorDocumentLoadedEventParams(object): @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class PDFEncryptor: @property def on_document_loaded() -> Callable[[PDFEncryptorDocumentLoadedEventParams], None]: ... @on_document_loaded.setter def on_document_loaded(event_hook: Callable[[PDFEncryptorDocumentLoadedEventParams], None]) -> None: ...
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.
on_error Event
Information about errors during encryption.
Syntax
class PDFEncryptorErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class PDFEncryptor: @property def on_error() -> Callable[[PDFEncryptorErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[PDFEncryptorErrorEventParams], None]) -> None: ...
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.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class PDFEncryptorNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class PDFEncryptor: @property def on_notification() -> Callable[[PDFEncryptorNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[PDFEncryptorNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
| DocumentLoaded | Notifies the application that the document has been loaded. This is a backward-compatibility-only notification. Use OnDocumentLoaded event instead. |
PDFEncryptor Config Settings
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
This property contains the PDF document version provided in the document header. The version is returned in the form "Major.Minor": for example, PDF-1.7 will be returned as "1.7", and PDF-2.0 as "2.0".
This property contains True if the viewing application should check the signing certificate revocation info and include the revocation information within the signature value.
This property contains an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface.
Returns the number of empty signature form fields available.
This property contains the empty signature form field flags ("Ff" entry in the signature field dictionary).
This property contains the height of the empty signature form field.
This property contains True if the empty signature form field is visible.
This property contains the legal attestations that are associated with the signature.
This property contains the name to be used when exporting form field data from the document.
This property contains the empty signature field name.
This property contains the horizontal offset of the empty signature form field.
This property contains the vertical offset of the empty signature form field.
This property contains the index of the empty signature form field's page in the document.
This property contains the changes that are allowed to the document when the signature field is signed.
This property contains the required SVD constraints. If a certain bit in RequiredConstraints is switched on, the corresponding data item is constrained.
This property contains the list of the digest algorithms used for signature generation.
This property contains the required filter (name of the preferred signature handler) to use for signature generation.
This property contains a set of form fields that shall be locked when the current signature field is signed.
This property contains the list of form field names that shall be locked when the current signature field is signed. Whether this list shall be included or excluded is defined by the EmptySignatureFieldRequiredLockAction[Index] property.
This property contains the required reasons used for signature generation.
This property contains the list of subfilters required by the signature. A subfilter represents the encoding to use when signing the PDF form.
This property contains True if the signature should be timestamped.
This property contains the TSP server URL.
This property contains the width of the empty signature form field.
Specifies the custom security handler PDF-name for the encryption handler.
Specifies if hardened Key generation should be used when the AES-256 encryption algorithm and password encryption are used.
Returns the number of pages available.
This property contains True if the crop box is empty, and False otherwise. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
This property contains the X coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
This property contains the Y coordinate of the lower left corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
This property contains the X coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
This property contains the Y coordinate of the upper right corner of the crop box of the page. The crop box defines the region to which the contents of the page shall be clipped (cropped) when displayed or printed.
This property contains the page height value.
This property contains the X coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.
This property contains the Y coordinate of the lower left corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.
This property contains the X coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.
This property contains the Y coordinate of the upper right corner of the media box of the page. The media box defines the boundaries of the physical medium on which the page is to be printed.
This property contains the page rotation angle.
This property contains a positive number that shall give the size of default user space units, in multiples of 1/72 inch. The default value is 1.0 (user space unit is 1/72 inch).
This property contains the page width value.
Specifies the number of key bits used for the RC4 encryption algorithm.
This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.
Use this config property to read or set the XMP metadata content.
Base Config Settings
This is a performance setting. It is unlikely that you will ever need to adjust it.
This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.
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.
Set this property to enable or disable cookies caching for the class.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.
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.
Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.
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.
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".
This global setting controls the hardware cryptography usage policy: auto, enable, or disable.
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.
Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.
It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.
Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.
Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Contains a comma-separated list of values that specifies which debug log details to dump.
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 |
Use this property to provide a path to the log file.
Contains a comma-separated list of value pairs ("name:value") that describe filters.
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 |
Use this property to set the log flush mode. The following values are defined:
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Use this property to provide the desired debug log level.
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. |
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.
Use this property to set the log rotation mode. The following values are defined:
| 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) |
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.
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.
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.
Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.
The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocspThe PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cacheThis property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).
Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.
Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.
Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.
Use this config property to store any custom data.
Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.
Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).
Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).
This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.
Allows to switch between internal/native PRNG implementation and the one provided by the platform.
Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).
This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.
Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.
Set this global property to false to make each validation run use its own copy of system certificate stores.
This is an internal setting. Please do not use it unless instructed by the support team.
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.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.
Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).
Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.
PDFEncryptor Errors
PDFEncryptor Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 26214401 | The input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS) |
| 26214402 | Cannot encrypt already encrypted file (SB_ERROR_PDF_ENCRYPTED) |
| 26214403 | The file is not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED) |
| 26214405 | Invalid password (SB_ERROR_PDF_INVALID_PASSWORD) |
| 26214406 | Failed to decrypt the file (SB_ERROR_PDF_DECRYPTION_FAILED) |
| 26214407 | The document is signed (SB_ERROR_PDF_SIGNED) |
| 26214408 | The document is not signed (SB_ERROR_PDF_NOT_SIGNED) |
| 26214409 | Cannot update this type of signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE) |
| 26214410 | Unsupported feature or operation (SB_ERROR_PDF_NOT_SUPPORTED) |
| 26214411 | No timestamp server specified (SB_ERROR_PDF_NO_TIMESTAMP_SERVER) |
| 26214412 | The component is not in edit mode (SB_ERROR_PDF_READONLY) |