PDFEncryptor Class

Properties   Methods   Events   Config Settings   Errors  

The PDFEncryptor class encrypts PDF documents.

Class Name

SecureBlackbox_PDFEncryptor

Procedural Interface

 secureblackbox_pdfencryptor_open();
 secureblackbox_pdfencryptor_close($res);
 secureblackbox_pdfencryptor_register_callback($res, $id, $function);
 secureblackbox_pdfencryptor_get_last_error($res);
 secureblackbox_pdfencryptor_get_last_error_code($res);
 secureblackbox_pdfencryptor_set($res, $id, $index, $value);
 secureblackbox_pdfencryptor_get($res, $id, $index);
 secureblackbox_pdfencryptor_do_config($res, $configurationstring);
 secureblackbox_pdfencryptor_do_doaction($res, $actionid, $actionparams);
 secureblackbox_pdfencryptor_do_encrypt($res);
 secureblackbox_pdfencryptor_do_reset($res);

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 OwnerPassword and UserPassword 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 EncryptionCertificate 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 EncryptionAlgorithm property to tweak the encryption algorithm. EncryptMetadata 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 InputFile (or InputBytes) and OutputFile properties and call the Encrypt method to complete the operation. If OutputFile is not assigned, the encrypted document will be generated in OutputBytes. 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.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

DocumentInfoEncryptionAlgorithm Property (SecureBlackbox_PDFEncryptor Class)

The symmetric algorithm used to encrypt the document.

Object Oriented Interface

public function getDocumentInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 1 );

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:

This property is read-only and not available at design time.

Data Type

String

DocumentInfoEncryptionType Property (SecureBlackbox_PDFEncryptor Class)

The document encryption type.

Object Oriented Interface

public function getDocumentInfoEncryptionType();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 2 );

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:

This property is read-only and not available at design time.

Data Type

Integer

DocumentInfoMetadataEncrypted Property (SecureBlackbox_PDFEncryptor Class)

Indicates if the document metadata is encrypted.

Object Oriented Interface

public function getDocumentInfoMetadataEncrypted();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 3 );

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 and not available at design time.

Data Type

Boolean

DocumentInfoPermissions Property (SecureBlackbox_PDFEncryptor Class)

Contains the document permissions associated with the encryption.

Object Oriented Interface

public function getDocumentInfoPermissions();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 4 );

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:

This property is read-only and not available at design time.

Data Type

Integer

EncryptionAlgorithm Property (SecureBlackbox_PDFEncryptor Class)

The encryption algorithm to encrypt the document with.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 5 );
secureblackbox_pdfencryptor_set($res, 5, $value );

Default Value

'AES256'

Remarks

Use this property to specify the encryption algorithm to encrypt the PDF document with.

Supported values:

Data Type

String

EncryptionCertificateBytes Property (SecureBlackbox_PDFEncryptor Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertificateBytes();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 6 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertificateCA Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getEncryptionCertificateCA();
public function setEncryptionCertificateCA($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 7 );
secureblackbox_pdfencryptor_set($res, 7, $value );

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.

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateCAKeyID Property (SecureBlackbox_PDFEncryptor Class)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Object Oriented Interface

public function getEncryptionCertificateCAKeyID();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 8 );

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 EncryptionCertificateSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertificateCertType Property (SecureBlackbox_PDFEncryptor Class)

Returns the type of the entity contained in the Certificate object.

Object Oriented Interface

public function getEncryptionCertificateCertType();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 9 );

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 and not available at design time.

Data Type

Integer

EncryptionCertificateCRLDistributionPoints Property (SecureBlackbox_PDFEncryptor Class)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Object Oriented Interface

public function getEncryptionCertificateCRLDistributionPoints();
public function setEncryptionCertificateCRLDistributionPoints($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 10 );
secureblackbox_pdfencryptor_set($res, 10, $value );

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.

This property is not available at design time.

Data Type

String

EncryptionCertificateCurve Property (SecureBlackbox_PDFEncryptor Class)

Specifies the elliptic curve associated with the certificate's public key.

Object Oriented Interface

public function getEncryptionCertificateCurve();
public function setEncryptionCertificateCurve($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 11 );
secureblackbox_pdfencryptor_set($res, 11, $value );

Default Value

''

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

This property is not available at design time.

Data Type

String

EncryptionCertificateFingerprint Property (SecureBlackbox_PDFEncryptor Class)

Contains the fingerprint (a hash imprint) of this certificate.

Object Oriented Interface

public function getEncryptionCertificateFingerprint();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 12 );

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 and not available at design time.

Data Type

String

EncryptionCertificateFriendlyName Property (SecureBlackbox_PDFEncryptor Class)

Contains an associated alias (friendly name) of the certificate.

Object Oriented Interface

public function getEncryptionCertificateFriendlyName();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 13 );

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 and not available at design time.

Data Type

String

EncryptionCertificateHandle Property (SecureBlackbox_PDFEncryptor Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getEncryptionCertificateHandle();
public function setEncryptionCertificateHandle($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 14 );
secureblackbox_pdfencryptor_set($res, 14, $value );

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 (SecureBlackbox_PDFEncryptor Class)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Object Oriented Interface

public function getEncryptionCertificateHashAlgorithm();
public function setEncryptionCertificateHashAlgorithm($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 15 );
secureblackbox_pdfencryptor_set($res, 15, $value );

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 EncryptionCertificateSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

This property is not available at design time.

Data Type

String

EncryptionCertificateIssuer Property (SecureBlackbox_PDFEncryptor Class)

The common name of the certificate issuer (CA), typically a company name.

Object Oriented Interface

public function getEncryptionCertificateIssuer();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 16 );

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 EncryptionCertificateIssuerRDN.

This property is read-only and not available at design time.

Data Type

String

EncryptionCertificateIssuerRDN Property (SecureBlackbox_PDFEncryptor Class)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Object Oriented Interface

public function getEncryptionCertificateIssuerRDN();
public function setEncryptionCertificateIssuerRDN($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 17 );
secureblackbox_pdfencryptor_set($res, 17, $value );

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

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyAlgorithm Property (SecureBlackbox_PDFEncryptor Class)

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getEncryptionCertificateKeyAlgorithm();
public function setEncryptionCertificateKeyAlgorithm($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 18 );
secureblackbox_pdfencryptor_set($res, 18, $value );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

Use the EncryptionCertificateKeyBits, EncryptionCertificateCurve, and EncryptionCertificatePublicKeyBytes properties to get more details about the key the certificate contains.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyBits Property (SecureBlackbox_PDFEncryptor Class)

Returns the length of the public key in bits.

Object Oriented Interface

public function getEncryptionCertificateKeyBits();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 19 );

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 EncryptionCertificatePublicKeyBytes or EncryptionCertificatePrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only and not available at design time.

Data Type

Integer

EncryptionCertificateKeyFingerprint Property (SecureBlackbox_PDFEncryptor Class)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Object Oriented Interface

public function getEncryptionCertificateKeyFingerprint();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 20 );

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 EncryptionCertificateFingerprint 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 and not available at design time.

Data Type

String

EncryptionCertificateKeyUsage Property (SecureBlackbox_PDFEncryptor Class)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Object Oriented Interface

public function getEncryptionCertificateKeyUsage();
public function setEncryptionCertificateKeyUsage($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 21 );
secureblackbox_pdfencryptor_set($res, 21, $value );

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is not available at design time.

Data Type

Integer

EncryptionCertificateKeyValid Property (SecureBlackbox_PDFEncryptor Class)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Object Oriented Interface

public function getEncryptionCertificateKeyValid();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 22 );

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 (SecureBlackbox_PDFEncryptor Class)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Object Oriented Interface

public function getEncryptionCertificateOCSPLocations();
public function setEncryptionCertificateOCSPLocations($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 23 );
secureblackbox_pdfencryptor_set($res, 23, $value );

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.

This property is not available at design time.

Data Type

String

EncryptionCertificateOCSPNoCheck Property (SecureBlackbox_PDFEncryptor Class)

Accessor to the value of the certificate's ocsp-no-check extension.

Object Oriented Interface

public function getEncryptionCertificateOCSPNoCheck();
public function setEncryptionCertificateOCSPNoCheck($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 24 );
secureblackbox_pdfencryptor_set($res, 24, $value );

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateOrigin Property (SecureBlackbox_PDFEncryptor Class)

Returns the location that the certificate was taken or loaded from.

Object Oriented Interface

public function getEncryptionCertificateOrigin();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 25 );

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only and not available at design time.

Data Type

Integer

EncryptionCertificatePolicyIDs Property (SecureBlackbox_PDFEncryptor Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getEncryptionCertificatePolicyIDs();
public function setEncryptionCertificatePolicyIDs($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 26 );
secureblackbox_pdfencryptor_set($res, 26, $value );

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.

This property is not available at design time.

Data Type

String

EncryptionCertificatePrivateKeyBytes Property (SecureBlackbox_PDFEncryptor Class)

Returns the certificate's private key in DER-encoded format.

Object Oriented Interface

public function getEncryptionCertificatePrivateKeyBytes();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 27 );

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 and not available at design time.

Data Type

Byte Array

EncryptionCertificatePrivateKeyExists Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the certificate has a usable private key associated with it.

Object Oriented Interface

public function getEncryptionCertificatePrivateKeyExists();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 28 );

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 EncryptionCertificatePrivateKeyBytes, 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 and not available at design time.

Data Type

Boolean

EncryptionCertificatePrivateKeyExtractable Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getEncryptionCertificatePrivateKeyExtractable();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 29 );

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only and not available at design time.

Data Type

Boolean

EncryptionCertificatePublicKeyBytes Property (SecureBlackbox_PDFEncryptor Class)

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getEncryptionCertificatePublicKeyBytes();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 30 );

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 and not available at design time.

Data Type

Byte Array

EncryptionCertificateQualified Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getEncryptionCertificateQualified();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 31 );

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 and not available at design time.

Data Type

Boolean

EncryptionCertificateQualifiedStatements Property (SecureBlackbox_PDFEncryptor Class)

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getEncryptionCertificateQualifiedStatements();
public function setEncryptionCertificateQualifiedStatements($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 32 );
secureblackbox_pdfencryptor_set($res, 32, $value );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

EncryptionCertificateQualifiers Property (SecureBlackbox_PDFEncryptor Class)

A list of qualifiers.

Object Oriented Interface

public function getEncryptionCertificateQualifiers();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 33 );

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 and not available at design time.

Data Type

String

EncryptionCertificateSelfSigned Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Object Oriented Interface

public function getEncryptionCertificateSelfSigned();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 34 );

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 (SecureBlackbox_PDFEncryptor Class)

Returns the certificate's serial number.

Object Oriented Interface

public function getEncryptionCertificateSerialNumber();
public function setEncryptionCertificateSerialNumber($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 35 );
secureblackbox_pdfencryptor_set($res, 35, $value );

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.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSigAlgorithm Property (SecureBlackbox_PDFEncryptor Class)

Indicates the algorithm that was used by the CA to sign this certificate.

Object Oriented Interface

public function getEncryptionCertificateSigAlgorithm();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 36 );

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 and not available at design time.

Data Type

String

EncryptionCertificateSource Property (SecureBlackbox_PDFEncryptor Class)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Object Oriented Interface

public function getEncryptionCertificateSource();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 37 );

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 and not available at design time.

Data Type

Integer

EncryptionCertificateSubject Property (SecureBlackbox_PDFEncryptor Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Object Oriented Interface

public function getEncryptionCertificateSubject();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 38 );

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 EncryptionCertificateSubjectRDN.

This property is read-only and not available at design time.

Data Type

String

EncryptionCertificateSubjectAlternativeName Property (SecureBlackbox_PDFEncryptor Class)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Object Oriented Interface

public function getEncryptionCertificateSubjectAlternativeName();
public function setEncryptionCertificateSubjectAlternativeName($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 39 );
secureblackbox_pdfencryptor_set($res, 39, $value );

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 EncryptionCertificateSubjectRDN 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.

This property is not available at design time.

Data Type

String

EncryptionCertificateSubjectKeyID Property (SecureBlackbox_PDFEncryptor Class)

Contains a unique identifier of the certificate's cryptographic key.

Object Oriented Interface

public function getEncryptionCertificateSubjectKeyID();
public function setEncryptionCertificateSubjectKeyID($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 40 );
secureblackbox_pdfencryptor_set($res, 40, $value );

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 EncryptionCertificateSubjectKeyID and EncryptionCertificateCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSubjectRDN Property (SecureBlackbox_PDFEncryptor Class)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Object Oriented Interface

public function getEncryptionCertificateSubjectRDN();
public function setEncryptionCertificateSubjectRDN($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 41 );
secureblackbox_pdfencryptor_set($res, 41, $value );

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.

This property is not available at design time.

Data Type

String

EncryptionCertificateValid Property (SecureBlackbox_PDFEncryptor Class)

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.

Object Oriented Interface

public function getEncryptionCertificateValid();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 42 );

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 and not available at design time.

Data Type

Boolean

EncryptionCertificateValidFrom Property (SecureBlackbox_PDFEncryptor Class)

The time point at which the certificate becomes valid, in UTC.

Object Oriented Interface

public function getEncryptionCertificateValidFrom();
public function setEncryptionCertificateValidFrom($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 43 );
secureblackbox_pdfencryptor_set($res, 43, $value );

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 (SecureBlackbox_PDFEncryptor Class)

The time point at which the certificate expires, in UTC.

Object Oriented Interface

public function getEncryptionCertificateValidTo();
public function setEncryptionCertificateValidTo($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 44 );
secureblackbox_pdfencryptor_set($res, 44, $value );

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 (SecureBlackbox_PDFEncryptor Class)

Specifies whether to encrypt the document metadata.

Object Oriented Interface

public function getEncryptMetadata();
public function setEncryptMetadata($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 45 );
secureblackbox_pdfencryptor_set($res, 45, $value );

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 (SecureBlackbox_PDFEncryptor Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 46 );
secureblackbox_pdfencryptor_set($res, 46, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_PDFEncryptor Class)

Use this property to pass the input to class in byte array form.

Object Oriented Interface

public function getInputBytes();
public function setInputBytes($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 47 );
secureblackbox_pdfencryptor_set($res, 47, $value );

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 (SecureBlackbox_PDFEncryptor Class)

The PDF file to be encrypted.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 48 );
secureblackbox_pdfencryptor_set($res, 48, $value );

Default Value

''

Remarks

Provide the path to the PDF document to be encrypted.

Data Type

String

OutputBytes Property (SecureBlackbox_PDFEncryptor Class)

Use this property to read the output the class object has produced.

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_pdfencryptor_get($res, 49 );

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 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 (SecureBlackbox_PDFEncryptor Class)

The file to save the encrypted document to.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 50 );
secureblackbox_pdfencryptor_set($res, 50, $value );

Default Value

''

Remarks

Specifies the path where the encrypted PDF should be saved.

Data Type

String

OwnerPassword Property (SecureBlackbox_PDFEncryptor Class)

The owner password.

Object Oriented Interface

public function getOwnerPassword();
public function setOwnerPassword($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 51 );
secureblackbox_pdfencryptor_set($res, 51, $value );

Default Value

''

Remarks

Use this property to provide the document owner password. Though it may be different from UserPassword, most implementations use the same value for both.

Data Type

String

Permissions Property (SecureBlackbox_PDFEncryptor Class)

Specifies the document permissions associated with the encryption.

Object Oriented Interface

public function getPermissions();
public function setPermissions($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 52 );
secureblackbox_pdfencryptor_set($res, 52, $value );

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:

This property is not available at design time.

Data Type

Integer

UserPassword Property (SecureBlackbox_PDFEncryptor Class)

The user password.

Object Oriented Interface

public function getUserPassword();
public function setUserPassword($value);

Procedural Interface

secureblackbox_pdfencryptor_get($res, 53 );
secureblackbox_pdfencryptor_set($res, 53, $value );

Default Value

''

Remarks

Use this property to provide the document user password. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

Config Method (SecureBlackbox_PDFEncryptor Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_pdfencryptor_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_PDFEncryptor Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_pdfencryptor_do_doaction($res, $actionid, $actionparams);

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 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:

Encrypt Method (SecureBlackbox_PDFEncryptor Class)

Encrypts the PDF document.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

secureblackbox_pdfencryptor_do_encrypt($res);

Remarks

Use this method to encrypt the PDF document as configured in the object's properties.

Reset Method (SecureBlackbox_PDFEncryptor Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_pdfencryptor_do_reset($res);

Remarks

Reset is a generic method available in every class.

DocumentLoaded Event (SecureBlackbox_PDFEncryptor Class)

This event is fired when the document has been loaded into memory.

Object Oriented Interface

public function fireDocumentLoaded($param);

Procedural Interface

secureblackbox_pdfencryptor_register_callback($res, 1, array($this, 'fireDocumentLoaded'));

Parameter List

 'cancel'

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 (SecureBlackbox_PDFEncryptor Class)

Information about errors during encryption.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_pdfencryptor_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (SecureBlackbox_PDFEncryptor Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_pdfencryptor_register_callback($res, 3, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

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:

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

Trappable Errors (PDFEncryptor Class)

PDFEncryptor Errors