PGPReader Class

Properties   Methods   Events   Config Settings   Errors  

The PGPReader class reads and unprotects protected PGP files.

Class Name

SecureBlackbox_PGPReader

Procedural Interface

 secureblackbox_pgpreader_open();
 secureblackbox_pgpreader_close($res);
 secureblackbox_pgpreader_register_callback($res, $id, $function);
 secureblackbox_pgpreader_get_last_error($res);
 secureblackbox_pgpreader_get_last_error_code($res);
 secureblackbox_pgpreader_set($res, $id, $index, $value);
 secureblackbox_pgpreader_get($res, $id, $index);
 secureblackbox_pgpreader_do_config($res, $configurationstring);
 secureblackbox_pgpreader_do_decryptandverify($res);
 secureblackbox_pgpreader_do_doaction($res, $actionid, $actionparams);
 secureblackbox_pgpreader_do_verifydetached($res);

Remarks

PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" data.

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.

Armored Property (SecureBlackbox_PGPReader Class)

Indicates if the processed message had been base64-armored.

Object Oriented Interface

public function getArmored();

Procedural Interface

secureblackbox_pgpreader_get($res, 1 );

Default Value

false

Remarks

This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.

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

Data Type

Boolean

Compressed Property (SecureBlackbox_PGPReader Class)

Indicates if the processed message had been compressed.

Object Oriented Interface

public function getCompressed();

Procedural Interface

secureblackbox_pgpreader_get($res, 2 );

Default Value

false

Remarks

This property is set to true if the supplied message was compressed by its creator.

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

Data Type

Boolean

DataBytes Property (SecureBlackbox_PGPReader Class)

Use this property to pass the original signed data to class in the byte array form.

Object Oriented Interface

public function getDataBytes();


public function setDataBytes($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 3 );


secureblackbox_pgpreader_set($res, 3, $value );

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

This property is not available at design time.

Data Type

Byte Array

DataFile Property (SecureBlackbox_PGPReader Class)

The name of the file containing the original signed data.

Object Oriented Interface

public function getDataFile();


public function setDataFile($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 4 );


secureblackbox_pgpreader_set($res, 4, $value );

Default Value

''

Remarks

Use this property to provide the original data when validating detached signatures with VerifyDetached.

Data Type

String

DecryptingKeyCount Property (SecureBlackbox_PGPReader Class)

The number of records in the DecryptingKey arrays.

Object Oriented Interface

public function getDecryptingKeyCount();


public function setDecryptingKeyCount($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 5 );


secureblackbox_pgpreader_set($res, 5, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DecryptingKeyHandle
• DecryptingKeyKeyFP
• DecryptingKeyKeyID
• DecryptingKeyPassphrase
• DecryptingKeyPassphraseValid
• DecryptingKeyUsername

The array indices start at 0 and end at DecryptingKeyCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptingKeyHandle Property (SecureBlackbox_PGPReader Class)

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

Object Oriented Interface

public function getDecryptingKeyHandle($decryptingkeyindex);


public function setDecryptingKeyHandle($decryptingkeyindex, $value);

Procedural Interface

secureblackbox_pgpreader_get($res, 13 , $decryptingkeyindex);


secureblackbox_pgpreader_set($res, 13, $value , $decryptingkeyindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

This property is not available at design time.

Data Type

Long64

DecryptingKeyKeyFP Property (SecureBlackbox_PGPReader Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface

public function getDecryptingKeyKeyFP($decryptingkeyindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 18 , $decryptingkeyindex);

Default Value

''

Remarks

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

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

Data Type

String

DecryptingKeyKeyID Property (SecureBlackbox_PGPReader Class)

Contains a 8-byte key identifier.

Object Oriented Interface

public function getDecryptingKeyKeyID($decryptingkeyindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 20 , $decryptingkeyindex);

Default Value

''

Remarks

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

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

Data Type

String

DecryptingKeyPassphrase Property (SecureBlackbox_PGPReader Class)

The key protection password.

Object Oriented Interface

public function getDecryptingKeyPassphrase($decryptingkeyindex);


public function setDecryptingKeyPassphrase($decryptingkeyindex, $value);

Procedural Interface

secureblackbox_pgpreader_get($res, 22 , $decryptingkeyindex);


secureblackbox_pgpreader_set($res, 22, $value , $decryptingkeyindex);

Default Value

''

Remarks

The key protection password.

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

This property is not available at design time.

Data Type

String

DecryptingKeyPassphraseValid Property (SecureBlackbox_PGPReader Class)

Use this property to check whether the specified Passphrase is valid and can be used to unlock the secret key.

Object Oriented Interface

public function getDecryptingKeyPassphraseValid($decryptingkeyindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 23 , $decryptingkeyindex);

Default Value

false

Remarks

Use this property to check whether the specified DecryptingKeyPassphrase is valid and can be used to unlock the secret key.

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

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

Data Type

Boolean

DecryptingKeyUsername Property (SecureBlackbox_PGPReader Class)

Specifies the name of the user bound to this key.

Object Oriented Interface

public function getDecryptingKeyUsername($decryptingkeyindex);


public function setDecryptingKeyUsername($decryptingkeyindex, $value);

Procedural Interface

secureblackbox_pgpreader_get($res, 32 , $decryptingkeyindex);


secureblackbox_pgpreader_set($res, 32, $value , $decryptingkeyindex);

Default Value

''

Remarks

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

The $decryptingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptingKeyCount property.

This property is not available at design time.

Data Type

String

ExternalCryptoAsyncDocumentID Property (SecureBlackbox_PGPReader Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 36 );


secureblackbox_pgpreader_set($res, 36, $value );

Default Value

''

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SecureBlackbox_PGPReader Class)

Custom parameters to be passed to the signing service (uninterpreted).

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 37 );


secureblackbox_pgpreader_set($res, 37, $value );

Default Value

''

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SecureBlackbox_PGPReader Class)

Additional data to be included in the async state and mirrored back by the requestor.

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 38 );


secureblackbox_pgpreader_set($res, 38, $value );

Default Value

''

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SecureBlackbox_PGPReader Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 39 );


secureblackbox_pgpreader_set($res, 39, $value );

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_PGPReader Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 40 );


secureblackbox_pgpreader_set($res, 40, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_PGPReader Class)

The ID of the pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 41 );


secureblackbox_pgpreader_set($res, 41, $value );

Default Value

''

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SecureBlackbox_PGPReader Class)

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 42 );


secureblackbox_pgpreader_set($res, 42, $value );

Default Value

''

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SecureBlackbox_PGPReader Class)

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 43 );


secureblackbox_pgpreader_set($res, 43, $value );

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_PGPReader Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 44 );


secureblackbox_pgpreader_set($res, 44, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_PGPReader Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 45 );


secureblackbox_pgpreader_set($res, 45, $value );

Default Value

''

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SecureBlackbox_PGPReader Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 46 );


secureblackbox_pgpreader_set($res, 46, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (SecureBlackbox_PGPReader 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_pgpreader_get($res, 47 );


secureblackbox_pgpreader_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_PGPReader Class)

Provides a filename of a file to process.

Object Oriented Interface

public function getInputFile();


public function setInputFile($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 48 );


secureblackbox_pgpreader_set($res, 48, $value );

Default Value

''

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

Data Type

String

KeyPassphrase Property (SecureBlackbox_PGPReader Class)

Specifies a passphrase for the decryption key.

Object Oriented Interface

public function getKeyPassphrase();


public function setKeyPassphrase($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 49 );


secureblackbox_pgpreader_set($res, 49, $value );

Default Value

''

Remarks

Use this property to provide a passphrase for the decryption secret key.

If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.

Data Type

String

OutputBytes Property (SecureBlackbox_PGPReader Class)

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

Object Oriented Interface

public function getOutputBytes();

Procedural Interface

secureblackbox_pgpreader_get($res, 50 );

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_PGPReader Class)

The file where the encrypted and/or signed data will be saved.

Object Oriented Interface

public function getOutputFile();


public function setOutputFile($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 51 );


secureblackbox_pgpreader_set($res, 51, $value );

Default Value

''

Remarks

Use this property to provide a path to the file where the class should store the encrypted and/or signed data.

Data Type

String

Passphrase Property (SecureBlackbox_PGPReader Class)

Specifies a message decryption password.

Object Oriented Interface

public function getPassphrase();


public function setPassphrase($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 52 );


secureblackbox_pgpreader_set($res, 52, $value );

Default Value

''

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.

Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.

If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.

Data Type

String

ProcessedLength Property (SecureBlackbox_PGPReader Class)

Reports the number of bytes processed.

Object Oriented Interface

public function getProcessedLength();

Procedural Interface

secureblackbox_pgpreader_get($res, 53 );

Default Value

0

Remarks

Use this property to check the number of bytes that the component has read when processing the protected message.

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

Data Type

Long64

Profile Property (SecureBlackbox_PGPReader Class)

Specifies a pre-defined profile to apply when creating the signature.

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 54 );


secureblackbox_pgpreader_set($res, 54, $value );

Default Value

''

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

SignatureCount Property (SecureBlackbox_PGPReader Class)

The number of records in the Signature arrays.

Object Oriented Interface

public function getSignatureCount();

Procedural Interface

secureblackbox_pgpreader_get($res, 55 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCertificationType
• SignatureCreationTime
• SignatureExpirationTime
• SignatureExportable
• SignatureHandle
• SignatureHashAlgorithm
• SignatureKeyExpirationTime
• SignatureLegacyFormat
• SignaturePolicyURL
• SignaturePrimaryUserID
• SignatureReasonForRevocation
• SignatureRevocable
• SignatureRevocation
• SignatureSignatureClass
• SignatureSignerKeyID
• SignatureSignerUserID
• SignatureStrictlyValid
• SignatureTextSignature
• SignatureTrustAmount
• SignatureTrustLevel
• SignatureValidated
• SignatureValidity
• SignatureVersion

The array indices start at 0 and end at SignatureCount - 1.

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

Data Type

Integer

SignatureCertificationType Property (SecureBlackbox_PGPReader Class)

Specifies the type of a UserID signature.

Object Oriented Interface

public function getSignatureCertificationType($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 56 , $signatureindex);

Default Value

0

Remarks

Specifies the type of a UserID signature.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureCreationTime Property (SecureBlackbox_PGPReader Class)

The time when the signature was created, in Universal Coordinated Time (UTC).

Object Oriented Interface

public function getSignatureCreationTime($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 57 , $signatureindex);

Default Value

''

Remarks

The time when the signature was created, in Universal Coordinated Time (UTC).

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureExpirationTime Property (SecureBlackbox_PGPReader Class)

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Object Oriented Interface

public function getSignatureExpirationTime($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 58 , $signatureindex);

Default Value

0

Remarks

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Ths property set to 0 indicates that the signature never expires.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureExportable Property (SecureBlackbox_PGPReader Class)

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

Object Oriented Interface

public function getSignatureExportable($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 59 , $signatureindex);

Default Value

false

Remarks

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureHandle Property (SecureBlackbox_PGPReader Class)

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

Object Oriented Interface

public function getSignatureHandle($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 60 , $signatureindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Long64

SignatureHashAlgorithm Property (SecureBlackbox_PGPReader Class)

Specifies the hash algorithm used in the signature.

Object Oriented Interface

public function getSignatureHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 61 , $signatureindex);

Default Value

''

Remarks

Specifies the hash algorithm used in the signature.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureKeyExpirationTime Property (SecureBlackbox_PGPReader Class)

The number of seconds after which the signed key will expire.

Object Oriented Interface

public function getSignatureKeyExpirationTime($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 62 , $signatureindex);

Default Value

0

Remarks

The number of seconds after which the signed key will expire.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureLegacyFormat Property (SecureBlackbox_PGPReader Class)

Indicates whether signature uses PGP 2.

Object Oriented Interface

public function getSignatureLegacyFormat($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 63 , $signatureindex);

Default Value

false

Remarks

Indicates whether signature uses PGP 2.6.x-compatible packet format.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignaturePolicyURL Property (SecureBlackbox_PGPReader Class)

Contains the URL of the signature policy.

Object Oriented Interface

public function getSignaturePolicyURL($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 64 , $signatureindex);

Default Value

''

Remarks

Contains the URL of the signature policy.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignaturePrimaryUserID Property (SecureBlackbox_PGPReader Class)

Indicates whether the UserID covered by the signature is the main user id for this key.

Object Oriented Interface

public function getSignaturePrimaryUserID($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 65 , $signatureindex);

Default Value

false

Remarks

Indicates whether the UserID covered by the signature is the main user id for this key.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureReasonForRevocation Property (SecureBlackbox_PGPReader Class)

Describes the reason why the key or the certificate was revoked.

Object Oriented Interface

public function getSignatureReasonForRevocation($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 66 , $signatureindex);

Default Value

''

Remarks

Describes the reason why the key or the certificate was revoked.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureRevocable Property (SecureBlackbox_PGPReader Class)

Specifies whether the signature can be revoked.

Object Oriented Interface

public function getSignatureRevocable($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 67 , $signatureindex);

Default Value

false

Remarks

Specifies whether the signature can be revoked.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureRevocation Property (SecureBlackbox_PGPReader Class)

Indicates whether or not the signature is a revocation signature.

Object Oriented Interface

public function getSignatureRevocation($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 68 , $signatureindex);

Default Value

false

Remarks

Indicates whether or not the signature is a revocation signature.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureSignatureClass Property (SecureBlackbox_PGPReader Class)

Indicates the signature class.

Object Oriented Interface

public function getSignatureSignatureClass($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 69 , $signatureindex);

Default Value

0

Remarks

Indicates the signature class.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureSignerKeyID Property (SecureBlackbox_PGPReader Class)

Indicates the KeyID of the signing key.

Object Oriented Interface

public function getSignatureSignerKeyID($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 70 , $signatureindex);

Default Value

''

Remarks

Indicates the KeyID of the signing key.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureSignerUserID Property (SecureBlackbox_PGPReader Class)

Indicates the UserID associated with the signing key.

Object Oriented Interface

public function getSignatureSignerUserID($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 71 , $signatureindex);

Default Value

''

Remarks

Indicates the UserID associated with the signing key.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

String

SignatureStrictlyValid Property (SecureBlackbox_PGPReader Class)

Returns True if this signature is valid in a strict way (no compatibility relaxations).

Object Oriented Interface

public function getSignatureStrictlyValid($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 72 , $signatureindex);

Default Value

false

Remarks

Returns True if this signature is valid in a strict way (no compatibility relaxations).

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureTextSignature Property (SecureBlackbox_PGPReader Class)

Indicates whether or not the signature is made over a text document.

Object Oriented Interface

public function getSignatureTextSignature($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 73 , $signatureindex);

Default Value

false

Remarks

Indicates whether or not the signature is made over a text document.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureTrustAmount Property (SecureBlackbox_PGPReader Class)

Specifies the amount of trust assigned by this signature.

Object Oriented Interface

public function getSignatureTrustAmount($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 74 , $signatureindex);

Default Value

0

Remarks

Specifies the amount of trust assigned by this signature.

Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureTrustLevel Property (SecureBlackbox_PGPReader Class)

The trust level assigned by this signature.

Object Oriented Interface

public function getSignatureTrustLevel($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 75 , $signatureindex);

Default Value

0

Remarks

The trust level assigned by this signature.

Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureValidated Property (SecureBlackbox_PGPReader Class)

Whether the signature has been validated.

Object Oriented Interface

public function getSignatureValidated($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 76 , $signatureindex);

Default Value

false

Remarks

Whether the signature has been validated.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Boolean

SignatureValidity Property (SecureBlackbox_PGPReader Class)

Provides the validity status of the signature if the signature has been validated.

Object Oriented Interface

public function getSignatureValidity($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 77 , $signatureindex);

Default Value

0

Remarks

Provides the validity status of the signature if the signature has been validated.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

SignatureVersion Property (SecureBlackbox_PGPReader Class)

Indicates the signature version.

Object Oriented Interface

public function getSignatureVersion($signatureindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 78 , $signatureindex);

Default Value

0

Remarks

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

The $signatureindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

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

Data Type

Integer

VerifyingKeyCount Property (SecureBlackbox_PGPReader Class)

The number of records in the VerifyingKey arrays.

Object Oriented Interface

public function getVerifyingKeyCount();


public function setVerifyingKeyCount($value);

Procedural Interface

secureblackbox_pgpreader_get($res, 79 );


secureblackbox_pgpreader_set($res, 79, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• VerifyingKeyHandle
• VerifyingKeyKeyFP
• VerifyingKeyKeyID
• VerifyingKeyUsername

The array indices start at 0 and end at VerifyingKeyCount - 1.

This property is not available at design time.

Data Type

Integer

VerifyingKeyHandle Property (SecureBlackbox_PGPReader Class)

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

Object Oriented Interface

public function getVerifyingKeyHandle($verifyingkeyindex);


public function setVerifyingKeyHandle($verifyingkeyindex, $value);

Procedural Interface

secureblackbox_pgpreader_get($res, 87 , $verifyingkeyindex);


secureblackbox_pgpreader_set($res, 87, $value , $verifyingkeyindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $verifyingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.

This property is not available at design time.

Data Type

Long64

VerifyingKeyKeyFP Property (SecureBlackbox_PGPReader Class)

The 20-byte fingerprint (hash value) of this key.

Object Oriented Interface

public function getVerifyingKeyKeyFP($verifyingkeyindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 92 , $verifyingkeyindex);

Default Value

''

Remarks

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

The $verifyingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.

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

Data Type

String

VerifyingKeyKeyID Property (SecureBlackbox_PGPReader Class)

Contains a 8-byte key identifier.

Object Oriented Interface

public function getVerifyingKeyKeyID($verifyingkeyindex);

Procedural Interface

secureblackbox_pgpreader_get($res, 94 , $verifyingkeyindex);

Default Value

''

Remarks

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

The $verifyingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.

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

Data Type

String

VerifyingKeyUsername Property (SecureBlackbox_PGPReader Class)

Specifies the name of the user bound to this key.

Object Oriented Interface

public function getVerifyingKeyUsername($verifyingkeyindex);


public function setVerifyingKeyUsername($verifyingkeyindex, $value);

Procedural Interface

secureblackbox_pgpreader_get($res, 106 , $verifyingkeyindex);


secureblackbox_pgpreader_set($res, 106, $value , $verifyingkeyindex);

Default Value

''

Remarks

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

The $verifyingkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the VerifyingKeyCount property.

This property is not available at design time.

Data Type

String

Config Method (SecureBlackbox_PGPReader Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DecryptAndVerify Method (SecureBlackbox_PGPReader Class)

Decrypts and verifies a protected message.

Object Oriented Interface

public function doDecryptAndVerify();

Procedural Interface

secureblackbox_pgpreader_do_decryptandverify($res);

Remarks

Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).

DoAction Method (SecureBlackbox_PGPReader Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_pgpreader_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;....

VerifyDetached Method (SecureBlackbox_PGPReader Class)

Verifies a detached signature.

Object Oriented Interface

public function doVerifyDetached();

Procedural Interface

secureblackbox_pgpreader_do_verifydetached($res);

Remarks

Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).

EncryptionInfo Event (SecureBlackbox_PGPReader Class)

Reports early information on encryption parameters.

Object Oriented Interface

public function fireEncryptionInfo($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 1, array($this, 'fireEncryptionInfo'));

Parameter List

 'keyids'
 'integrityprotected'
 'passphraseused'

Remarks

The class fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.

KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.

IntegrityProtected parameter specifies whether the message includes a modification detection record.

Error Event (SecureBlackbox_PGPReader Class)

Information about errors during PGP decryption/verification.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during decryption/verification of protected data.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalDecrypt Event (SecureBlackbox_PGPReader Class)

Handles remote or external decryption.

Object Oriented Interface

public function fireExternalDecrypt($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 3, array($this, 'fireExternalDecrypt'));

Parameter List

 'operationid'
 'algorithm'
 'pars'
 'encrypteddata'
 'data'

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

FileExtractionFinish Event (SecureBlackbox_PGPReader Class)

Reports the ending of file extraction process.

Object Oriented Interface

public function fireFileExtractionFinish($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 4, array($this, 'fireFileExtractionFinish'));

Parameter List

 'filename'
 'timestamp'

Remarks

This event informs about the ending of extraction of the next available file. Filename parameter indicates the original file name, and the Timestamp its last modification time.

In the handler, the user can take away the output stream or store the file data from OutputBytes.

FileExtractionStart Event (SecureBlackbox_PGPReader Class)

Reports the beginning of file extraction process.

Object Oriented Interface

public function fireFileExtractionStart($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 5, array($this, 'fireFileExtractionStart'));

Parameter List

 'filename'
 'timestamp'
 'skip'

Remarks

This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. Filename parameter indicates the original file name, and the Timestamp its last modification time.

The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.

KeyPassphraseNeeded Event (SecureBlackbox_PGPReader Class)

Requests a key protection password from the application.

Object Oriented Interface

public function fireKeyPassphraseNeeded($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 6, array($this, 'fireKeyPassphraseNeeded'));

Parameter List

 'keyid'
 'userid'
 'mainkey'
 'passphrase'
 'skip'

Remarks

The class fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase (which is requested via PassphraseNeeded). The class fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.

If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

MultipleFilesFound Event (SecureBlackbox_PGPReader Class)

Fires if the PGP message is recognized to contain multiple files.

Object Oriented Interface

public function fireMultipleFilesFound($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 7, array($this, 'fireMultipleFilesFound'));

Parameter List

 'tarfilename'
 'proceed'

Remarks

The class fires this event to report that there is more than one file in the PGP message.

The TarFilename specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.

Notification Event (SecureBlackbox_PGPReader Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 8, 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.

PassphraseNeeded Event (SecureBlackbox_PGPReader Class)

Requests a data protection password from the application.

Object Oriented Interface

public function firePassphraseNeeded($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 9, array($this, 'firePassphraseNeeded'));

Parameter List

 'passphrase'
 'skip'

Remarks

The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.

Progress Event (SecureBlackbox_PGPReader Class)

Reports the progress of the decryption operation.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 10, array($this, 'fireProgress'));

Parameter List

 'current'
 'total'
 'cancel'

Remarks

The class fires this event repeatedly to report the progress of the file extraction operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.

Signed Event (SecureBlackbox_PGPReader Class)

Notifies the application about a signed message.

Object Oriented Interface

public function fireSigned($param);

Procedural Interface

secureblackbox_pgpreader_register_callback($res, 11, array($this, 'fireSigned'));

Parameter List

 'keyids'
 'signaturetype'

Remarks

The class fires this event when it identifies a signed message to allow the application to prepare the component for verification.

Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.

SignatureType indicates the signature type:

Config Settings (PGPReader 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.

PGPReader Config Settings

Base Config Settings

Trappable Errors (PGPReader Class)

PGPReader 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) 
	27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
	27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
	27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
	27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
	27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
	27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)