PGPKeyManager Class

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager class manages individual PGP keys.

Class Name

SecureBlackbox_PGPKeyManager

Procedural Interface

 secureblackbox_pgpkeymanager_open();
 secureblackbox_pgpkeymanager_close($res);
 secureblackbox_pgpkeymanager_register_callback($res, $id, $function);
 secureblackbox_pgpkeymanager_get_last_error($res);
 secureblackbox_pgpkeymanager_get_last_error_code($res);
 secureblackbox_pgpkeymanager_set($res, $id, $index, $value);
 secureblackbox_pgpkeymanager_get($res, $id, $index);
 secureblackbox_pgpkeymanager_do_changepassphrase($res, $oldpassphrase, $newpassphrase);
 secureblackbox_pgpkeymanager_do_changeprotection($res, $oldpassphrase, $newpassphrase, $prottype, $encalgorithm, $hashalgorithm);
 secureblackbox_pgpkeymanager_do_checkpassphrase($res, $passphrase);
 secureblackbox_pgpkeymanager_do_config($res, $configurationstring);
 secureblackbox_pgpkeymanager_do_createkey($res, $version, $algorithm, $bits, $validto, $password);
 secureblackbox_pgpkeymanager_do_createsubkey($res, $algorithm, $bits, $validto, $password);
 secureblackbox_pgpkeymanager_do_createuser($res, $username);
 secureblackbox_pgpkeymanager_do_doaction($res, $actionid, $actionparams);
 secureblackbox_pgpkeymanager_do_exportbytes($res, $secret);
 secureblackbox_pgpkeymanager_do_exporttofile($res, $filename, $secret);
 secureblackbox_pgpkeymanager_do_generatepair($res, $version, $username, $strength, $validto, $password);
 secureblackbox_pgpkeymanager_do_importbytes($res, $key);
 secureblackbox_pgpkeymanager_do_importfromfile($res, $filename);
 secureblackbox_pgpkeymanager_do_importpinned($res);
 secureblackbox_pgpkeymanager_do_removesignature($res, $index);
 secureblackbox_pgpkeymanager_do_removesubkey($res, $index);
 secureblackbox_pgpkeymanager_do_removeuser($res, $index);
 secureblackbox_pgpkeymanager_do_reset($res);
 secureblackbox_pgpkeymanager_do_revokekey($res, $reason, $comment);
 secureblackbox_pgpkeymanager_do_revokesubkey($res, $index, $reason, $comment);
 secureblackbox_pgpkeymanager_do_revokeuser($res, $index, $reason, $comment);
 secureblackbox_pgpkeymanager_do_signkey($res, $keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);
 secureblackbox_pgpkeymanager_do_signsubkey($res, $index, $keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);
 secureblackbox_pgpkeymanager_do_signuser($res, $index, $keyvalidto, $hashalgorithm, $primary, $certtype);
 secureblackbox_pgpkeymanager_do_verify($res, $index);

Remarks

PGPKeyManager provides means for generating, checking, and editing individual PGP keys.

PGPKeyManager can work with RSA, Elgamal (DH), ECDSA, DSS, and EdDSA keypairs with or without subkeys. Public and private PGP keys of versions 2, 3, 4, 5, and 6 are supported.

Note: if you are looking to work with multi-key files ('keyrings'), please see the PGPKeyring component instead. PGPKeyManager works with individual PGP key structures ('key trees' - one primary key with subkeys). For that same reason, consider using PGPKeyring for loading keys that are to be used with PGPWriter and PGPReader for signing or encryption. It is often the case that even allegedly single-key files actually contain more than one key tree, which may lead to key material loss if they are loaded into PGPKeyManager.

Or, putting it in a simple way:

• Use PGPKeyManager if you need to alter a key (e.g. generate, add or remove subkeys, revoke, re-sign, change password).
• Where you need to use an existing key (e.g. for signing), use PGPKeyring, even if it is a standalone key.
• To alter a key residing in a keyring, load the keyring files into PGPKeyring first. The assign the key in question to PGPKeyManager, make the necessary changes, return it back to the keyring, and re-save the keyring.

You can load keys into a PGPKeyManager object in one of the following ways:

• By loading it from a file or memory using ImportFromFile or ImportBytes methods.
• By importing it from a PGPKeyring object using ImportPinned method.
• By generating it using GeneratePair or CreateKey methods.

Mgr.ImportFromFile("key.pub"); Once you have the key loaded in your PGPKeyManager object, you can perform a variety of operations on it:

• Iterate over elements of the key tree using Subkeys, Signatures, and Users collections.
• Add new subkeys to it using CreateSubkey method. Note that your new subkey is unlikely to be accepted elsewhere unless you sign it.
• Add new user records to the key with CreateUser method.
• Signing keys, subkeys, and user records (existing or new) with this or another private key using SignKey, SignSubkey, and SignUser methods. The new signatures are added to the key tree.
• Remove or revoke existing subkeys, user records, and signatures.
• Change the key protection level or password.

Note: Use pinning to copy keys between PGPKeyring and PGPKeyManager: Keyring.PinnedKey = Mgr.Key; Keyring.ImportPinned(); Mgr.PinnedKey = Keyring.SelectedKeys[i]; Mgr.ImportPinned(); Once your work with the key tree has completed, save it to a buffer or file using ExportBytes and ExportToFile methods.

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.

KeyBitsInKey Property (SecureBlackbox_PGPKeyManager Class)

Indicates the key length in bits.

Object Oriented Interface

public function getKeyBitsInKey();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 1 );

Default Value

2048

Remarks

Indicates the key length in bits.

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

Data Type

Integer

KeyCanEncrypt Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key can be used for encryption.

Object Oriented Interface

public function getKeyCanEncrypt();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 2 );

Default Value

false

Remarks

Returns True if this key can be used for encryption.

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

Data Type

Boolean

KeyCanSign Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key can be used for signing.

Object Oriented Interface

public function getKeyCanSign();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 3 );

Default Value

false

Remarks

Returns True if this key can be used for signing.

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

Data Type

Boolean

KeyCurve Property (SecureBlackbox_PGPKeyManager Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface

public function getKeyCurve();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 4 );

Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

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

Data Type

String

KeyEnabled Property (SecureBlackbox_PGPKeyManager Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface

public function getKeyEnabled();
public function setKeyEnabled($value);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 5 );
secureblackbox_pgpkeymanager_set($res, 5, $value );

Default Value

false

Remarks

Enables or disables this key for use in encryption or signing operation.

This property is not available at design time.

Data Type

Boolean

KeyEncryptionAlgorithm Property (SecureBlackbox_PGPKeyManager Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface

public function getKeyEncryptionAlgorithm();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 6 );

Default Value

'AES128'

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

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

Data Type

String

KeyIsPublic Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface

public function getKeyIsPublic();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 8 );

Default Value

false

Remarks

Returns True if this key is a public key, and False otherwise.

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

Data Type

Boolean

KeyIsSecret Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface

public function getKeyIsSecret();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 9 );

Default Value

false

Remarks

Returns True if this key is a secret key, and False otherwise.

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

Data Type

Boolean

KeyIsSubkey Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface

public function getKeyIsSubkey();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 10 );

Default Value

false

Remarks

Returns True if this key is a subkey of another key, and False otherwise.

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

Data Type

Boolean

KeyKeyFP Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getKeyKeyFP();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 11 );

Default Value

''

Remarks

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

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

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

Data Type

String

KeyKeyID Property (SecureBlackbox_PGPKeyManager Class)

Contains a 8-byte key identifier.

Object Oriented Interface

public function getKeyKeyID();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 12 );

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.

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

Data Type

String

KeyPassphrase Property (SecureBlackbox_PGPKeyManager Class)

The key protection password.

Object Oriented Interface

public function getKeyPassphrase();
public function setKeyPassphrase($value);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 13 );
secureblackbox_pgpkeymanager_set($res, 13, $value );

Default Value

''

Remarks

The key protection password.

This property is not available at design time.

Data Type

String

KeyPassphraseValid Property (SecureBlackbox_PGPKeyManager 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 getKeyPassphraseValid();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 14 );

Default Value

false

Remarks

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

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

Data Type

Boolean

KeyPrimaryKeyID Property (SecureBlackbox_PGPKeyManager Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface

public function getKeyPrimaryKeyID();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 15 );

Default Value

''

Remarks

If this key is a subkey (KeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.

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

Data Type

String

KeyProtection Property (SecureBlackbox_PGPKeyManager Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface

public function getKeyProtection();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 16 );

Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

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

Data Type

Integer

KeyPublicKeyAlgorithm Property (SecureBlackbox_PGPKeyManager Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface

public function getKeyPublicKeyAlgorithm();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 17 );

Default Value

''

Remarks

Specifies the asymmetric algorithm of the key.

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

Data Type

String

KeyQBits Property (SecureBlackbox_PGPKeyManager Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface

public function getKeyQBits();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 18 );

Default Value

0

Remarks

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

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

Data Type

Integer

KeyTimestamp Property (SecureBlackbox_PGPKeyManager Class)

Use this property to check the time the key was generated.

Object Oriented Interface

public function getKeyTimestamp();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 19 );

Default Value

''

Remarks

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

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

Data Type

String

KeyUsername Property (SecureBlackbox_PGPKeyManager Class)

Specifies the name of the user bound to this key.

Object Oriented Interface

public function getKeyUsername();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 20 );

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.

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

Data Type

String

KeyValidTo Property (SecureBlackbox_PGPKeyManager Class)

Provide accurate expiration moment indication.

Object Oriented Interface

public function getKeyValidTo();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 21 );

Default Value

'0'

Remarks

Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.

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

Data Type

String

KeyVersion Property (SecureBlackbox_PGPKeyManager Class)

Indicates the key version.

Object Oriented Interface

public function getKeyVersion();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 22 );

Default Value

0

Remarks

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.

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

Data Type

Integer

PinnedKeyHandle Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getPinnedKeyHandle();
public function setPinnedKeyHandle($value);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 29 );
secureblackbox_pgpkeymanager_set($res, 29, $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

SignatureCount Property (SecureBlackbox_PGPKeyManager Class)

The number of records in the Signature arrays.

Object Oriented Interface

public function getSignatureCount();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 45 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignatureCertificationType
• SignatureCreationTime
• SignatureExpirationTime
• SignatureExportable
• SignatureHandle
• SignatureHashAlgorithm
• SignatureHashMark
• SignatureKeyExpirationTime
• SignatureKeyFlags
• SignatureLegacyFormat
• SignaturePolicyURL
• SignaturePreferredAlgorithms
• SignaturePrimaryUserID
• SignatureReasonForRevocation
• SignatureRevocable
• SignatureRevocation
• SignatureSignatureClass
• SignatureSignerKeyID
• SignatureSignerUserID
• SignatureStrictlyValid
• SignatureTarget
• 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_PGPKeyManager Class)

Specifies the type of a UserID signature.

Object Oriented Interface

public function getSignatureCertificationType($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 46 , $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_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureCreationTime($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 47 , $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_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureExpirationTime($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 48 , $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_PGPKeyManager 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_pgpkeymanager_get($res, 49 , $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_PGPKeyManager 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_pgpkeymanager_get($res, 50 , $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_PGPKeyManager Class)

Specifies the hash algorithm used in the signature.

Object Oriented Interface

public function getSignatureHashAlgorithm($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 51 , $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

SignatureHashMark Property (SecureBlackbox_PGPKeyManager Class)

Returns the hash mark attribute of a signature.

Object Oriented Interface

public function getSignatureHashMark($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 52 , $signatureindex);

Default Value

0

Remarks

Returns the hash mark attribute of a signature.

Check this property to get a hash mark of a 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

SignatureKeyExpirationTime Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureKeyExpirationTime($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 53 , $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

SignatureKeyFlags Property (SecureBlackbox_PGPKeyManager Class)

Returns the key flags included in the signature.

Object Oriented Interface

public function getSignatureKeyFlags($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 54 , $signatureindex);

Default Value

0

Remarks

Returns the key flags included in the signature.

Use this property to retrieve the key flags stored in the key 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

SignatureLegacyFormat Property (SecureBlackbox_PGPKeyManager Class)

Indicates whether signature uses PGP 2.

Object Oriented Interface

public function getSignatureLegacyFormat($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 55 , $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_PGPKeyManager Class)

Contains the URL of the signature policy.

Object Oriented Interface

public function getSignaturePolicyURL($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 56 , $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

SignaturePreferredAlgorithms Property (SecureBlackbox_PGPKeyManager Class)

Contains a list of algorithms preferred by the signed key holder.

Object Oriented Interface

public function getSignaturePreferredAlgorithms($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 57 , $signatureindex);

Default Value

''

Remarks

Contains a list of algorithms preferred by the signed key holder.

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_PGPKeyManager 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_pgpkeymanager_get($res, 58 , $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_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureReasonForRevocation($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 59 , $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_PGPKeyManager Class)

Specifies whether the signature can be revoked.

Object Oriented Interface

public function getSignatureRevocable($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 60 , $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_PGPKeyManager Class)

Indicates whether or not the signature is a revocation signature.

Object Oriented Interface

public function getSignatureRevocation($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 61 , $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_PGPKeyManager Class)

Indicates the signature class.

Object Oriented Interface

public function getSignatureSignatureClass($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 62 , $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_PGPKeyManager Class)

Indicates the KeyID of the signing key.

Object Oriented Interface

public function getSignatureSignerKeyID($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 63 , $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_PGPKeyManager Class)

Indicates the UserID associated with the signing key.

Object Oriented Interface

public function getSignatureSignerUserID($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 64 , $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_PGPKeyManager 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_pgpkeymanager_get($res, 65 , $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

SignatureTarget Property (SecureBlackbox_PGPKeyManager Class)

Indicates the KeyID or Username of the target key or user.

Object Oriented Interface

public function getSignatureTarget($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 66 , $signatureindex);

Default Value

''

Remarks

Indicates the KeyID or Username of the target key or user.

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

SignatureTextSignature Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureTextSignature($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 67 , $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_PGPKeyManager Class)

Specifies the amount of trust assigned by this signature.

Object Oriented Interface

public function getSignatureTrustAmount($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 68 , $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_PGPKeyManager Class)

The trust level assigned by this signature.

Object Oriented Interface

public function getSignatureTrustLevel($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 69 , $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_PGPKeyManager Class)

Whether the signature has been validated.

Object Oriented Interface

public function getSignatureValidated($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 70 , $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_PGPKeyManager Class)

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

Object Oriented Interface

public function getSignatureValidity($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 71 , $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_PGPKeyManager Class)

Indicates the signature version.

Object Oriented Interface

public function getSignatureVersion($signatureindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 72 , $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

SigningKeyHandle Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getSigningKeyHandle();
public function setSigningKeyHandle($value);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 79 );
secureblackbox_pgpkeymanager_set($res, 79, $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

SubkeyCount Property (SecureBlackbox_PGPKeyManager Class)

The number of records in the Subkey arrays.

Object Oriented Interface

public function getSubkeyCount();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 95 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubkeyBitsInKey
• SubkeyCanEncrypt
• SubkeyCanSign
• SubkeyCurve
• SubkeyEnabled
• SubkeyEncryptionAlgorithm
• SubkeyHandle
• SubkeyIsPublic
• SubkeyIsSecret
• SubkeyIsSubkey
• SubkeyKeyFP
• SubkeyKeyID
• SubkeyPassphrase
• SubkeyPassphraseValid
• SubkeyPrimaryKeyID
• SubkeyProtection
• SubkeyPublicKeyAlgorithm
• SubkeyQBits
• SubkeyTimestamp
• SubkeyUsername
• SubkeyValidTo
• SubkeyVersion

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

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

Data Type

Integer

SubkeyBitsInKey Property (SecureBlackbox_PGPKeyManager Class)

Indicates the key length in bits.

Object Oriented Interface

public function getSubkeyBitsInKey($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 96 , $subkeyindex);

Default Value

2048

Remarks

Indicates the key length in bits.

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

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

Data Type

Integer

SubkeyCanEncrypt Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key can be used for encryption.

Object Oriented Interface

public function getSubkeyCanEncrypt($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 97 , $subkeyindex);

Default Value

false

Remarks

Returns True if this key can be used for encryption.

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

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

Data Type

Boolean

SubkeyCanSign Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key can be used for signing.

Object Oriented Interface

public function getSubkeyCanSign($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 98 , $subkeyindex);

Default Value

false

Remarks

Returns True if this key can be used for signing.

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

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

Data Type

Boolean

SubkeyCurve Property (SecureBlackbox_PGPKeyManager Class)

Indicates the elliptic curve associated with a EC key.

Object Oriented Interface

public function getSubkeyCurve($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 99 , $subkeyindex);

Default Value

''

Remarks

Indicates the elliptic curve associated with a EC key.

Supported values:

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

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

Data Type

String

SubkeyEnabled Property (SecureBlackbox_PGPKeyManager Class)

Enables or disables this key for use in encryption or signing operation.

Object Oriented Interface

public function getSubkeyEnabled($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 100 , $subkeyindex);

Default Value

false

Remarks

Enables or disables this key for use in encryption or signing operation.

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

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

Data Type

Boolean

SubkeyEncryptionAlgorithm Property (SecureBlackbox_PGPKeyManager Class)

Indicates the symmetric algorithm used to encrypt the secret key.

Object Oriented Interface

public function getSubkeyEncryptionAlgorithm($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 101 , $subkeyindex);

Default Value

'AES128'

Remarks

Indicates the symmetric algorithm used to encrypt the secret key.

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

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

Data Type

String

SubkeyHandle Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getSubkeyHandle($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 102 , $subkeyindex);

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 $subkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

Long64

SubkeyIsPublic Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a public key, and False otherwise.

Object Oriented Interface

public function getSubkeyIsPublic($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 103 , $subkeyindex);

Default Value

false

Remarks

Returns True if this key is a public key, and False otherwise.

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

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

Data Type

Boolean

SubkeyIsSecret Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a secret key, and False otherwise.

Object Oriented Interface

public function getSubkeyIsSecret($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 104 , $subkeyindex);

Default Value

false

Remarks

Returns True if this key is a secret key, and False otherwise.

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

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

Data Type

Boolean

SubkeyIsSubkey Property (SecureBlackbox_PGPKeyManager Class)

Returns True if this key is a subkey of another key, and False otherwise.

Object Oriented Interface

public function getSubkeyIsSubkey($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 105 , $subkeyindex);

Default Value

false

Remarks

Returns True if this key is a subkey of another key, and False otherwise.

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

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

Data Type

Boolean

SubkeyKeyFP Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getSubkeyKeyFP($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 106 , $subkeyindex);

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 $subkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyKeyID Property (SecureBlackbox_PGPKeyManager Class)

Contains a 8-byte key identifier.

Object Oriented Interface

public function getSubkeyKeyID($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 107 , $subkeyindex);

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 $subkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyPassphrase Property (SecureBlackbox_PGPKeyManager Class)

The key protection password.

Object Oriented Interface

public function getSubkeyPassphrase($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 108 , $subkeyindex);

Default Value

''

Remarks

The key protection password.

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

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

Data Type

String

SubkeyPassphraseValid Property (SecureBlackbox_PGPKeyManager 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 getSubkeyPassphraseValid($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 109 , $subkeyindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

SubkeyPrimaryKeyID Property (SecureBlackbox_PGPKeyManager Class)

If this key is a subkey ( IsSubkey returns True), this property contains the identifier of the subkey's primary key.

Object Oriented Interface

public function getSubkeyPrimaryKeyID($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 110 , $subkeyindex);

Default Value

''

Remarks

If this key is a subkey (SubkeyIsSubkey returns True), this property contains the identifier of the subkey's primary key.

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

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

Data Type

String

SubkeyProtection Property (SecureBlackbox_PGPKeyManager Class)

Specifies the level of protection applied to the secret key.

Object Oriented Interface

public function getSubkeyProtection($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 111 , $subkeyindex);

Default Value

0

Remarks

Specifies the level of protection applied to the secret key.

Allowed values:

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

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

Data Type

Integer

SubkeyPublicKeyAlgorithm Property (SecureBlackbox_PGPKeyManager Class)

Specifies the asymmetric algorithm of the key.

Object Oriented Interface

public function getSubkeyPublicKeyAlgorithm($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 112 , $subkeyindex);

Default Value

''

Remarks

Specifies the asymmetric algorithm of the key.

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

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

Data Type

String

SubkeyQBits Property (SecureBlackbox_PGPKeyManager Class)

The length of the DSA Q (legitimate range: 160-512).

Object Oriented Interface

public function getSubkeyQBits($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 113 , $subkeyindex);

Default Value

0

Remarks

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

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

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

Data Type

Integer

SubkeyTimestamp Property (SecureBlackbox_PGPKeyManager Class)

Use this property to check the time the key was generated.

Object Oriented Interface

public function getSubkeyTimestamp($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 114 , $subkeyindex);

Default Value

''

Remarks

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

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

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

Data Type

String

SubkeyUsername Property (SecureBlackbox_PGPKeyManager Class)

Specifies the name of the user bound to this key.

Object Oriented Interface

public function getSubkeyUsername($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 115 , $subkeyindex);

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 $subkeyindex parameter specifies the index of the item in the array. The size of the array is controlled by the SubkeyCount property.

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

Data Type

String

SubkeyValidTo Property (SecureBlackbox_PGPKeyManager Class)

Provide accurate expiration moment indication.

Object Oriented Interface

public function getSubkeyValidTo($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 116 , $subkeyindex);

Default Value

'0'

Remarks

Provide accurate expiration moment indication. This is different to expires property which only contains expiration time in days in old keys.

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

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

Data Type

String

SubkeyVersion Property (SecureBlackbox_PGPKeyManager Class)

Indicates the key version.

Object Oriented Interface

public function getSubkeyVersion($subkeyindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 117 , $subkeyindex);

Default Value

0

Remarks

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only four versions are currently allowed here: 3, 4, 5 and 6. It is recommended that all new keys are created with version of 6.

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

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

Data Type

Integer

UserCount Property (SecureBlackbox_PGPKeyManager Class)

The number of records in the User arrays.

Object Oriented Interface

public function getUserCount();

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 118 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserHandle
• UserUsername

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

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

Data Type

Integer

UserHandle Property (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function getUserHandle($userindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 119 , $userindex);

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 $userindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

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

Data Type

Long64

UserUsername Property (SecureBlackbox_PGPKeyManager Class)

Specifies the user name of user.

Object Oriented Interface

public function getUserUsername($userindex);

Procedural Interface

secureblackbox_pgpkeymanager_get($res, 120 , $userindex);

Default Value

''

Remarks

Specifies the user name of user.

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

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

Data Type

String

ChangePassphrase Method (SecureBlackbox_PGPKeyManager Class)

Changes the password of the secret key.

Object Oriented Interface

public function doChangePassphrase($oldpassphrase, $newpassphrase);

Procedural Interface

secureblackbox_pgpkeymanager_do_changepassphrase($res, $oldpassphrase, $newpassphrase);

Remarks

Call this method to change the password that protects the secret key and all its subkeys.

Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).

ChangeProtection Method (SecureBlackbox_PGPKeyManager Class)

Changes the protection level of the secret key.

Object Oriented Interface

public function doChangeProtection($oldpassphrase, $newpassphrase, $prottype, $encalgorithm, $hashalgorithm);

Procedural Interface

secureblackbox_pgpkeymanager_do_changeprotection($res, $oldpassphrase, $newpassphrase, $prottype, $encalgorithm, $hashalgorithm);

Remarks

Use this method to change the protection level of the Key.

OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see for more details), EncAlgorithm is the key encryption algorithm, and

and HashAlgorithm specify the algorithms to be used for key derivation.

Note: use SubkeyIndex configuration setting to change the passphrase on a specific key or subkey only (without touching other subkeys).

CheckPassphrase Method (SecureBlackbox_PGPKeyManager Class)

Checks if the password matches the secret key.

Object Oriented Interface

public function doCheckPassphrase($passphrase);

Procedural Interface

secureblackbox_pgpkeymanager_do_checkpassphrase($res, $passphrase);

Remarks

Use this method to check if a password can decrypt the Key.

Config Method (SecureBlackbox_PGPKeyManager Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

CreateKey Method (SecureBlackbox_PGPKeyManager Class)

Generates a new key.

Object Oriented Interface

public function doCreateKey($version, $algorithm, $bits, $validto, $password);

Procedural Interface

secureblackbox_pgpkeymanager_do_createkey($res, $version, $algorithm, $bits, $validto, $password);

Remarks

Use this method to generate a new key with the provided parameters.

CreateSubkey Method (SecureBlackbox_PGPKeyManager Class)

Generates a new subkey.

Object Oriented Interface

public function doCreateSubkey($algorithm, $bits, $validto, $password);

Procedural Interface

secureblackbox_pgpkeymanager_do_createsubkey($res, $algorithm, $bits, $validto, $password);

Remarks

Use this method to generate a new subkey with the provided parameters.

CreateUser Method (SecureBlackbox_PGPKeyManager Class)

Adds a user to an existing key.

Object Oriented Interface

public function doCreateUser($username);

Procedural Interface

secureblackbox_pgpkeymanager_do_createuser($res, $username);

Remarks

Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".

DoAction Method (SecureBlackbox_PGPKeyManager Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

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

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

ExportBytes Method (SecureBlackbox_PGPKeyManager Class)

Serializes the key to a byte array.

Object Oriented Interface

public function doExportBytes($secret);

Procedural Interface

secureblackbox_pgpkeymanager_do_exportbytes($res, $secret);

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

ExportToFile Method (SecureBlackbox_PGPKeyManager Class)

Exports the key to a file.

Object Oriented Interface

public function doExportToFile($filename, $secret);

Procedural Interface

secureblackbox_pgpkeymanager_do_exporttofile($res, $filename, $secret);

Remarks

Use this method to save the Key (both the public and secret parts) to the file specified in Filename.

GeneratePair Method (SecureBlackbox_PGPKeyManager Class)

Generates a new pair of PGP keys.

Object Oriented Interface

public function doGeneratePair($version, $username, $strength, $validto, $password);

Procedural Interface

secureblackbox_pgpkeymanager_do_generatepair($res, $version, $username, $strength, $validto, $password);

Remarks

Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys.

Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.

This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.

The following PGP key versions and strengths are supported:

Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.

ImportBytes Method (SecureBlackbox_PGPKeyManager Class)

Loads a key from a byte array.

Object Oriented Interface

public function doImportBytes($key);

Procedural Interface

secureblackbox_pgpkeymanager_do_importbytes($res, $key);

Remarks

Use this method to load a key, either public or secret, from a byte array.

ImportFromFile Method (SecureBlackbox_PGPKeyManager Class)

Loads a key from a file.

Object Oriented Interface

public function doImportFromFile($filename);

Procedural Interface

secureblackbox_pgpkeymanager_do_importfromfile($res, $filename);

Remarks

Use this method to load a key, either public or secret, from a file.

ImportPinned Method (SecureBlackbox_PGPKeyManager Class)

Loads a key from a pinned key object.

Object Oriented Interface

public function doImportPinned();

Procedural Interface

secureblackbox_pgpkeymanager_do_importpinned($res);

Remarks

Use this method to load a PGP key from a PinnedKey object. This is an easy way to import a key object from a keyring.

RemoveSignature Method (SecureBlackbox_PGPKeyManager Class)

Unbinds the specified signature from the key, subkey or user.

Object Oriented Interface

public function doRemoveSignature($index);

Procedural Interface

secureblackbox_pgpkeymanager_do_removesignature($res, $index);

Remarks

Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.

RemoveSubkey Method (SecureBlackbox_PGPKeyManager Class)

Removes the specified subkey from the key.

Object Oriented Interface

public function doRemoveSubkey($index);

Procedural Interface

secureblackbox_pgpkeymanager_do_removesubkey($res, $index);

Remarks

Use this method to remove the subkey referred by its Index from the key.

RemoveUser Method (SecureBlackbox_PGPKeyManager Class)

Unbinds the specified user from the key.

Object Oriented Interface

public function doRemoveUser($index);

Procedural Interface

secureblackbox_pgpkeymanager_do_removeuser($res, $index);

Remarks

Use this method to remove the specified user from the list of UserIDs bound to the key.

Reset Method (SecureBlackbox_PGPKeyManager Class)

Creates a new empty keyring.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_pgpkeymanager_do_reset($res);

Remarks

Use this method to initialize a new empty keyring.

RevokeKey Method (SecureBlackbox_PGPKeyManager Class)

Revokes the key.

Object Oriented Interface

public function doRevokeKey($reason, $comment);

Procedural Interface

secureblackbox_pgpkeymanager_do_revokekey($res, $reason, $comment);

Remarks

Use this method to revoke the key by adding a revocation signature.

RevokeSubkey Method (SecureBlackbox_PGPKeyManager Class)

Revokes the key's subkey.

Object Oriented Interface

public function doRevokeSubkey($index, $reason, $comment);

Procedural Interface

secureblackbox_pgpkeymanager_do_revokesubkey($res, $index, $reason, $comment);

Remarks

Use this method to revoke the subkey with a given Index by adding a revocation signature.

RevokeUser Method (SecureBlackbox_PGPKeyManager Class)

Revokes a user certification.

Object Oriented Interface

public function doRevokeUser($index, $reason, $comment);

Procedural Interface

secureblackbox_pgpkeymanager_do_revokeuser($res, $index, $reason, $comment);

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the key.

SignKey Method (SecureBlackbox_PGPKeyManager Class)

Sign the key.

Object Oriented Interface

public function doSignKey($keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);

Procedural Interface

secureblackbox_pgpkeymanager_do_signkey($res, $keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);

Remarks

Use this method to sign the main key, or 'create a key binding signature', in terms of the PGP specification. Provide the signing key in SigningKey.

Use the KeyValidTo parameter to specify the key validity period and HashAlgorithm to provide the signature hash algorithm.

The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:

Encryption algorithms:

• Plaintext
• IDEA
• 3DES
• Blowfish
• AES128
• AES192
• AES256
• Twofish256
• CAST5
• Camellia128
• Camellia192
• Camellia256

Compression algorithms:

• ZIP
• ZLIB
• BZIP2

Hash algorithms:

• MD5
• SHA
• RIPEMD160
• SHA224
• SHA256
• SHA384
• SHA512
• SHA3-256
• SHA3-384
• SHA3-512

Example: Camellia192,AES192,SHA256,ZIP

If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.

The KeyFlags parameter is a bitmask that can contain the following bit flags:

SignSubkey Method (SecureBlackbox_PGPKeyManager Class)

Sign the key's subkey.

Object Oriented Interface

public function doSignSubkey($index, $keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);

Procedural Interface

secureblackbox_pgpkeymanager_do_signsubkey($res, $index, $keyvalidto, $hashalgorithm, $preferredalgs, $keyflags);

Remarks

Use this method to sign the subkey with a given Index (create a 'subkey binding signature'). Provide the signing key in SigningKey.

Use the KeyValidTo parameter to specify the subkey validity period and HashAlgorithm to provide the signature hash algorithm.

The PreferredAlgs parameter is expected to contain a list of algorithms that the signer of the key prefers the senders to use when using the subkey that is being signed. This value can contain a comma-separated mix of symmetric, hash, and compression algorithms from the following lists:

Encryption algorithms:

• Plaintext
• IDEA
• 3DES
• Blowfish
• AES128
• AES192
• AES256
• Twofish256
• CAST5
• Camellia128
• Camellia192
• Camellia256

Compression algorithms:

• ZIP
• ZLIB
• BZIP2

Hash algorithms:

• MD5
• SHA
• RIPEMD160
• SHA224
• SHA256
• SHA384
• SHA512
• SHA3-256
• SHA3-384
• SHA3-512

Example: Camellia256,Twofish256,AES256,ZLIB,SHA512

If you leave PreferredAlgs, no algorithm preferences information will be saved with the key.

The KeyFlags parameter is a bitmask that can contain the following bit flags:

SignUser Method (SecureBlackbox_PGPKeyManager Class)

Creates a user certification.

Object Oriented Interface

public function doSignUser($index, $keyvalidto, $hashalgorithm, $primary, $certtype);

Procedural Interface

secureblackbox_pgpkeymanager_do_signuser($res, $index, $keyvalidto, $hashalgorithm, $primary, $certtype);

Remarks

Use this method to sign the user ID with the specified Index using the SigningKey. This signature creates a binding between the user ID and their main key.

While it is typical to sign user IDs with their own secret keys, occasionally third-party authentication is used where the binding is signed with a third-party key.

The KeyValidTo parameter indicates the expiration date of the binding. It can be different to that of the signing and/or the main key. The Primary parameter indicates whether this should be considered the primary user ID for this key (for example, if the user has more than one email). The CertType parameters indicates the type of binding, and should be set to one of the following values (if unsure, use pctGeneric):

Verify Method (SecureBlackbox_PGPKeyManager Class)

Verifies the integrity of a key signature.

Object Oriented Interface

public function doVerify($index);

Procedural Interface

secureblackbox_pgpkeymanager_do_verify($res, $index);

Remarks

Use this method to validate a key signature. Provide the index of the signature as a parameter.

Error Event (SecureBlackbox_PGPKeyManager Class)

Information about errors during PGP key management.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_pgpkeymanager_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during key management.

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

KeyPassphraseNeeded Event (SecureBlackbox_PGPKeyManager Class)

Requests a key protection password from the application.

Object Oriented Interface

public function fireKeyPassphraseNeeded($param);

Procedural Interface

secureblackbox_pgpkeymanager_register_callback($res, 2, 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. The class fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in SigningKeys. 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.

Notification Event (SecureBlackbox_PGPKeyManager Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_pgpkeymanager_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 (PGPKeyManager 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.

PGPKeyManager Config Settings

Base Config Settings

Trappable Errors (PGPKeyManager Class)

PGPKeyManager Errors