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);

Remarks

PDFEncryptor encrypts PDF documents with passwords or certificates.

Property List


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

DocumentInfoEncryptionAlgorithmThe symmetric algorithm used to encrypt the document.
DocumentInfoEncryptionTypeThe document encryption type.
DocumentInfoMetadataEncryptedIndicates if the document metadata is encrypted.
DocumentInfoPermissionsContains the document permissions associated with the encryption.
EncryptionAlgorithmThe encryption algorithm to encrypt the document with.
EncryptionCertificateBytesReturns the raw certificate data in DER format.
EncryptionCertificateCAIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
EncryptionCertificateCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
EncryptionCertificateCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
EncryptionCertificateCurveSpecifies the elliptic curve of the EC public key.
EncryptionCertificateFingerprintContains the fingerprint (a hash imprint) of this certificate.
EncryptionCertificateFriendlyNameContains an associated alias (friendly name) of the certificate.
EncryptionCertificateHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
EncryptionCertificateHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
EncryptionCertificateIssuerThe common name of the certificate issuer (CA), typically a company name.
EncryptionCertificateIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
EncryptionCertificateKeyAlgorithmSpecifies the public key algorithm of this certificate.
EncryptionCertificateKeyBitsReturns the length of the public key.
EncryptionCertificateKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
EncryptionCertificateKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
EncryptionCertificateKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
EncryptionCertificateOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
EncryptionCertificateOCSPNoCheckAccessor to the value of the certificate's ocsp-no-check extension.
EncryptionCertificateOriginReturns the origin of this certificate.
EncryptionCertificatePolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
EncryptionCertificatePrivateKeyBytesContains the certificate's private key.
EncryptionCertificatePrivateKeyExistsIndicates whether the certificate has an associated private key.
EncryptionCertificatePrivateKeyExtractableIndicates whether the private key is extractable.
EncryptionCertificatePublicKeyBytesContains the certificate's public key in DER format.
EncryptionCertificateQualifiedStatementsReturns the qualified status of the certificate.
EncryptionCertificateSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
EncryptionCertificateSerialNumberReturns the certificate's serial number.
EncryptionCertificateSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
EncryptionCertificateSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
EncryptionCertificateSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
EncryptionCertificateSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
EncryptionCertificateSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
EncryptionCertificateValidFromThe time point at which the certificate becomes valid, in UTC.
EncryptionCertificateValidToThe time point at which the certificate expires, in UTC.
EncryptMetadataSpecifies whether to encrypt the document metadata.
FIPSModeReserved.
InputBytesUse this property to pass the input to class in byte array form.
InputFileThe PDF file to be encrypted.
OutputBytesUse this property to read the output the class object has produced.
OutputFileThe file to save the encrypted document to.
OwnerPasswordThe owner password.
PermissionsSpecifies the document permissions associated with the encryption.
UserPasswordThe 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.

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
EncryptEncrypts the PDF document.

Event List


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

DocumentLoadedThis event is fired when the document has been loaded into memory.
ErrorInformation about errors during encryption.
NotificationThis 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.

EncryptionHandlerNameSpecifies the custom security handler PDF-name.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
RC4KeyBitsSpecifies the number of key bits used for the RC4 algorithm.
TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

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:

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES256AES256

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:

petPassword1The document is encrypted with a password.
petCertificate2The document is encrypted with a certificate (or many certificates).

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (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:

pepAnnotations0x0001Annotating is allowed

pepAssemble0x0002Assembling a new document on the basis of the processed one is allowed

pepExtract0x0004Extraction/copying of the pictures and text from the document is allowed

pepExtractAcc0x0008Content extraction is allowed for accessibility purposes only

pepFillInForms0x0010Filling forms in is allowed

pepHighQualityPrint0x0020High quality printing is allowed

pepLowQualityPrint0x0040Low quality printing is allowed

pepModify0x0080Modifications are allowed

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:

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES256AES256

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 (a setting in the BasicConstraints extension).

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 (a setting in the BasicConstraints extension).

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 private key.

Object Oriented Interface


public function getEncryptionCertificateCAKeyID();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 8 );


Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

Data Type

Byte Array

EncryptionCertificateCRLDistributionPoints Property (SecureBlackbox_PDFEncryptor Class)

Locations of the CRL (Certificate Revocation List) 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, 9 );


secureblackbox_pdfencryptor_set($res, 9, $value );

Default Value

''

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is not available at design time.

Data Type

String

EncryptionCertificateCurve Property (SecureBlackbox_PDFEncryptor Class)

Specifies the elliptic curve of the EC public key.

Object Oriented Interface


public function getEncryptionCertificateCurve();


public function setEncryptionCertificateCurve($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 10 );


secureblackbox_pdfencryptor_set($res, 10, $value );

Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

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, 11 );


Remarks

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

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

Data Type

Byte Array

EncryptionCertificateFriendlyName Property (SecureBlackbox_PDFEncryptor Class)

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

Object Oriented Interface


public function getEncryptionCertificateFriendlyName();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 12 );


Default Value

''

Remarks

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

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

Data Type

String

EncryptionCertificateHandle Property (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, 13 );


secureblackbox_pdfencryptor_set($res, 13, $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)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Object Oriented Interface


public function getEncryptionCertificateHashAlgorithm();


public function setEncryptionCertificateHashAlgorithm($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 14 );


secureblackbox_pdfencryptor_set($res, 14, $value );

Default Value

''

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

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, 15 );


Default Value

''

Remarks

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

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

Data Type

String

EncryptionCertificateIssuerRDN Property (SecureBlackbox_PDFEncryptor Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Object Oriented Interface


public function getEncryptionCertificateIssuerRDN();


public function setEncryptionCertificateIssuerRDN($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 16 );


secureblackbox_pdfencryptor_set($res, 16, $value );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyAlgorithm Property (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, 17 );


secureblackbox_pdfencryptor_set($res, 17, $value );

Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyBits Property (SecureBlackbox_PDFEncryptor Class)

Returns the length of the public key.

Object Oriented Interface


public function getEncryptionCertificateKeyBits();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 18 );


Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

EncryptionCertificateKeyFingerprint Property (SecureBlackbox_PDFEncryptor Class)

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

Object Oriented Interface


public function getEncryptionCertificateKeyFingerprint();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 19 );


Remarks

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

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

Data Type

Byte Array

EncryptionCertificateKeyUsage Property (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, 20 );


secureblackbox_pdfencryptor_set($res, 20, $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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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, 21 );


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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Object Oriented Interface


public function getEncryptionCertificateOCSPLocations();


public function setEncryptionCertificateOCSPLocations($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 22 );


secureblackbox_pdfencryptor_set($res, 22, $value );

Default Value

''

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is not available at design time.

Data Type

String

EncryptionCertificateOCSPNoCheck Property (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, 23 );


secureblackbox_pdfencryptor_set($res, 23, $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 origin of this certificate.

Object Oriented Interface


public function getEncryptionCertificateOrigin();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 24 );


Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

EncryptionCertificatePolicyIDs Property (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, 25 );


secureblackbox_pdfencryptor_set($res, 25, $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.

This property is not available at design time.

Data Type

String

EncryptionCertificatePrivateKeyBytes Property (SecureBlackbox_PDFEncryptor Class)

Contains the certificate's private key.

Object Oriented Interface


public function getEncryptionCertificatePrivateKeyBytes();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 26 );


Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

EncryptionCertificatePrivateKeyExists Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the certificate has an associated private key.

Object Oriented Interface


public function getEncryptionCertificatePrivateKeyExists();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 27 );


Default Value

false

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

EncryptionCertificatePrivateKeyExtractable Property (SecureBlackbox_PDFEncryptor Class)

Indicates whether the private key is extractable.

Object Oriented Interface


public function getEncryptionCertificatePrivateKeyExtractable();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 28 );


Default Value

false

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

EncryptionCertificatePublicKeyBytes Property (SecureBlackbox_PDFEncryptor Class)

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getEncryptionCertificatePublicKeyBytes();


Procedural Interface


secureblackbox_pdfencryptor_get($res, 29 );


Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

EncryptionCertificateQualifiedStatements Property (SecureBlackbox_PDFEncryptor Class)

Returns the qualified status of the certificate.

Object Oriented Interface


public function getEncryptionCertificateQualifiedStatements();


public function setEncryptionCertificateQualifiedStatements($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 30 );


secureblackbox_pdfencryptor_set($res, 30, $value );

Default Value

0

Remarks

Returns the qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

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, 31 );


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, 32 );


secureblackbox_pdfencryptor_set($res, 32, $value );

Remarks

Returns the certificate's serial number.

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, 33 );


Default Value

''

Remarks

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

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

Data Type

String

EncryptionCertificateSubject Property (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, 34 );


Default Value

''

Remarks

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

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

Data Type

String

EncryptionCertificateSubjectAlternativeName Property (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, 35 );


secureblackbox_pdfencryptor_set($res, 35, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionCertificateSubjectKeyID Property (SecureBlackbox_PDFEncryptor Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Object Oriented Interface


public function getEncryptionCertificateSubjectKeyID();


public function setEncryptionCertificateSubjectKeyID($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 36 );


secureblackbox_pdfencryptor_set($res, 36, $value );

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSubjectRDN Property (SecureBlackbox_PDFEncryptor Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Object Oriented Interface


public function getEncryptionCertificateSubjectRDN();


public function setEncryptionCertificateSubjectRDN($value);

Procedural Interface


secureblackbox_pdfencryptor_get($res, 37 );


secureblackbox_pdfencryptor_set($res, 37, $value );

Default Value

''

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is not available at design time.

Data Type

String

EncryptionCertificateValidFrom Property (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, 38 );


secureblackbox_pdfencryptor_set($res, 38, $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, 39 );


secureblackbox_pdfencryptor_set($res, 39, $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, 40 );


secureblackbox_pdfencryptor_set($res, 40, $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, 41 );


secureblackbox_pdfencryptor_set($res, 41, $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, 42 );


secureblackbox_pdfencryptor_set($res, 42, $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, 43 );


secureblackbox_pdfencryptor_set($res, 43, $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, 44 );


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, 45 );


secureblackbox_pdfencryptor_set($res, 45, $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, 46 );


secureblackbox_pdfencryptor_set($res, 46, $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, 47 );


secureblackbox_pdfencryptor_set($res, 47, $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:

pepAnnotations0x0001Annotating is allowed

pepAssemble0x0002Assembling a new document on the basis of the processed one is allowed

pepExtract0x0004Extraction/copying of the pictures and text from the document is allowed

pepExtractAcc0x0008Content extraction is allowed for accessibility purposes only

pepFillInForms0x0010Filling forms in is allowed

pepHighQualityPrint0x0020High quality printing is allowed

pepLowQualityPrint0x0040Low quality printing is allowed

pepModify0x0080Modifications are allowed

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, 48 );


secureblackbox_pdfencryptor_set($res, 48, $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;....

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.

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.

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

EncryptionHandlerName:   Specifies the custom security handler PDF-name.

Specifies the custom security handler PDF-name for the encryption handler.

HardenedKeyGeneration:   Specifies if hardened Key generation should be used.

Specifies if hardened Key generation should be used when the AES-256 encryption algorithm and password encryption are used.

RC4KeyBits:   Specifies the number of key bits used for the RC4 algorithm.

Specifies the number of key bits used for the RC4 encryption algorithm.

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

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.

StaticIPAddresses:   Gets or sets all the static DNS rules.

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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

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.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

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

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

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

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

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.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (PDFEncryptor Class)

PDFEncryptor Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
26214401   Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS)
26214402   Document is encrypted (SB_ERROR_PDF_ENCRYPTED)
26214403   Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED)
26214404   Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE)
26214405   Invalid password (SB_ERROR_PDF_INVALID_PASSWORD)
26214406   Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED)
26214407   Document is signed (SB_ERROR_PDF_SIGNED)
26214408   Document is not signed (SB_ERROR_PDF_NOT_SIGNED)
26214409   Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE)
26214410   Not supported (SB_ERROR_PDF_NOT_SUPPORTED)