KeyMgr Class

Properties   Methods   Events   Config Settings   Errors  

The KeyMgr class is used to create and manage OpenPGP keys.

Class Name

IPWorksOpenPGP_KeyMgr

Procedural Interface

 ipworksopenpgp_keymgr_open();
 ipworksopenpgp_keymgr_close($res);
 ipworksopenpgp_keymgr_register_callback($res, $id, $function);
 ipworksopenpgp_keymgr_get_last_error($res);
 ipworksopenpgp_keymgr_get_last_error_code($res);
 ipworksopenpgp_keymgr_set($res, $id, $index, $value);
 ipworksopenpgp_keymgr_get($res, $id, $index);
 ipworksopenpgp_keymgr_do_addrevoker($res, $userid);
 ipworksopenpgp_keymgr_do_adduserid($res, $userid);
 ipworksopenpgp_keymgr_do_changeexpirationdate($res, $expirationdate);
 ipworksopenpgp_keymgr_do_changepassphrase($res, $passphrase);
 ipworksopenpgp_keymgr_do_config($res, $configurationstring);
 ipworksopenpgp_keymgr_do_createkey($res, $userid, $passphrase);
 ipworksopenpgp_keymgr_do_createsubkey($res);
 ipworksopenpgp_keymgr_do_deletekey($res, $userid);
 ipworksopenpgp_keymgr_do_exportpublickey($res, $filename, $useasciiarmor);
 ipworksopenpgp_keymgr_do_exportsecretkey($res, $filename, $useasciiarmor);
 ipworksopenpgp_keymgr_do_importkey($res, $filename, $userid);
 ipworksopenpgp_keymgr_do_importkeyb($res, $data, $userid);
 ipworksopenpgp_keymgr_do_listkeys($res);
 ipworksopenpgp_keymgr_do_listsignatures($res);
 ipworksopenpgp_keymgr_do_listsubkeys($res);
 ipworksopenpgp_keymgr_do_loadkeyring($res, $keyringpath);
 ipworksopenpgp_keymgr_do_loadkeyringb($res, $secretkeyringdata, $publickeyringdata);
 ipworksopenpgp_keymgr_do_reset($res);
 ipworksopenpgp_keymgr_do_revokekey($res, $keyid);
 ipworksopenpgp_keymgr_do_savekeyring($res, $keyringpath);
 ipworksopenpgp_keymgr_do_signuserid($res, $userid, $issueruserid);
 ipworksopenpgp_keymgr_do_verifypassphrase($res, $passphrase);

Remarks

The KeyMgr class supports key management according to the specifications outlined in RFC 4880, in addition to draft-ietf-openpgp-crypto-refresh-13, which introduces support for OpenPGP Version 6. You can create, delete, import, export, and manage keys, including both individual keys and keyrings.

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.

KeyCurve Property (IPWorksOpenPGP_KeyMgr Class)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , or Ed448 .

Object Oriented Interface

public function getKeyCurve();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 1 );

Default Value

''

Remarks

This property specifies the elliptic curve if KeyPublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:

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

Data Type

String

KeyEffectiveDate Property (IPWorksOpenPGP_KeyMgr Class)

The date when this key becomes valid.

Object Oriented Interface

public function getKeyEffectiveDate();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 2 );

Default Value

''

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

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

Data Type

String

KeyEncoded Property (IPWorksOpenPGP_KeyMgr Class)

The key.

Object Oriented Interface

public function getKeyEncoded();


public function setKeyEncoded($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 3 );


ipworksopenpgp_keymgr_set($res, 3, $value );

Default Value

''

Remarks

The key. This property can be used to assign a specific key. The KeyFingerprint, KeyId, and KeyUserId properties may also be used to specify a key.

This property is not available at design time.

Data Type

Binary String

KeyExpirationDate Property (IPWorksOpenPGP_KeyMgr Class)

The date the key expires.

Object Oriented Interface

public function getKeyExpirationDate();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 4 );

Default Value

''

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

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

Data Type

String

KeyFingerprint Property (IPWorksOpenPGP_KeyMgr Class)

The hex-encoded, 20-byte fingerprint of the key.

Object Oriented Interface

public function getKeyFingerprint();


public function setKeyFingerprint($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 5 );


ipworksopenpgp_keymgr_set($res, 5, $value );

Default Value

''

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the Keyring. When this property is set the classwill search the Keyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

This property is not available at design time.

Data Type

String

KeyId Property (IPWorksOpenPGP_KeyMgr Class)

The hex-encoded, 4-byte or 8-byte key Id.

Object Oriented Interface

public function getKeyId();


public function setKeyId($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 6 );


ipworksopenpgp_keymgr_set($res, 6, $value );

Default Value

''

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

Note: It is recommended to use the KeyFingerprint property when loading a key from the Keyring, as it is possible for different keys to have the same Id.

This property is not available at design time.

Data Type

String

KeyOtherUserIds Property (IPWorksOpenPGP_KeyMgr Class)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Object Oriented Interface

public function getKeyOtherUserIds();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 8 );

Default Value

''

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

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

Data Type

String

KeyPassphrase Property (IPWorksOpenPGP_KeyMgr Class)

The passphrase for the key's secret key (if any).

Object Oriented Interface

public function getKeyPassphrase();


public function setKeyPassphrase($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 9 );


ipworksopenpgp_keymgr_set($res, 9, $value );

Default Value

''

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

This property is not available at design time.

Data Type

String

KeyPublicKey Property (IPWorksOpenPGP_KeyMgr Class)

The public key of the key.

Object Oriented Interface

public function getKeyPublicKey();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 10 );

Default Value

''

Remarks

The public key of the key. The key is provided as ASCII armored data.

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

Data Type

String

KeyPublicKeyAlgorithm Property (IPWorksOpenPGP_KeyMgr Class)

A text description of the public key algorithm of the key.

Object Oriented Interface

public function getKeyPublicKeyAlgorithm();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 11 );

Default Value

''

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy

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

Data Type

String

KeyPublicKeyLength Property (IPWorksOpenPGP_KeyMgr Class)

The length of the public key in bits.

Object Oriented Interface

public function getKeyPublicKeyLength();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 12 );

Default Value

0

Remarks

The length of the public key in bits. Common values are 512, 1024, and 2048.

If the KeyPublicKeyAlgorithm property is ECDSA, EdDSA, Ed25519, or Ed448, the length of the public key is determined by the KeyCurve. Possible lengths are:

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

Data Type

Integer

KeyRevoked Property (IPWorksOpenPGP_KeyMgr Class)

Whether or not the key is revoked.

Object Oriented Interface

public function getKeyRevoked();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 13 );

Default Value

false

Remarks

Whether or not the key is revoked.

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

Data Type

Boolean

KeySecretKey Property (IPWorksOpenPGP_KeyMgr Class)

The secret key of the key (if available).

Object Oriented Interface

public function getKeySecretKey();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 14 );

Default Value

''

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

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

Data Type

String

KeySecretKeyAvailable Property (IPWorksOpenPGP_KeyMgr Class)

Whether or not a secret key is available for the selected key.

Object Oriented Interface

public function getKeySecretKeyAvailable();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 15 );

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

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

Data Type

Boolean

KeyUsage Property (IPWorksOpenPGP_KeyMgr Class)

A text description of UsageFlags .

Object Oriented Interface

public function getKeyUsage();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 16 );

Default Value

''

Remarks

A text description of KeyUsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

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

Data Type

String

KeyUsageFlags Property (IPWorksOpenPGP_KeyMgr Class)

Flags that show the intended use for the key.

Object Oriented Interface

public function getKeyUsageFlags();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 17 );

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of KeyUsageFlags is a combination of the following flags:

Please refer to the KeyUsage property for a text representation of KeyUsageFlags.

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

Data Type

Integer

KeyUserId Property (IPWorksOpenPGP_KeyMgr Class)

The user Id of the key.

Object Oriented Interface

public function getKeyUserId();


public function setKeyUserId($value);

Procedural Interface

ipworksopenpgp_keymgr_get($res, 18 );


ipworksopenpgp_keymgr_set($res, 18, $value );

Default Value

''

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the Keyring. When this property is set the class will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and KeyOtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The class will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP class's RecipientInfo event.

This property is not available at design time.

Data Type

String

KeyVersion Property (IPWorksOpenPGP_KeyMgr Class)

This property can be used to query the OpenPGP version of the currently selected Key .

Object Oriented Interface

public function getKeyVersion();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 19 );

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected Key. Possible values are:

• 4 - OpenPGP v4 (default)
• 6 - OpenPGP v6

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

Data Type

Integer

Keyring Property (IPWorksOpenPGP_KeyMgr Class)

The location on disk of the keyring.

Object Oriented Interface

public function getKeyring();

Procedural Interface

ipworksopenpgp_keymgr_get($res, 20 );

Default Value

''

Remarks

To load a keyring use the LoadKeyring method.

This property is read-only.

Data Type

String

AddRevoker Method (IPWorksOpenPGP_KeyMgr Class)

Adds a designated revoker to the key.

Object Oriented Interface

public function doAddRevoker($userid);

Procedural Interface

ipworksopenpgp_keymgr_do_addrevoker($res, $userid);

Remarks

This method adds a designated revoker to the selected Key. The UserId parameter specifies the revoker to add. The revoker's key must be present in the current keyring. Use this with caution: once added, a revoker cannot be removed. The key's passphrase is required for this operation and may be specified via KeyPassphrase or through the KeyPassphrase event.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

AddUserId Method (IPWorksOpenPGP_KeyMgr Class)

Adds the specified user Id to the current key.

Object Oriented Interface

public function doAddUserId($userid);

Procedural Interface

ipworksopenpgp_keymgr_do_adduserid($res, $userid);

Remarks

The key's passphrase is required for this operation and may be specified via KeyPassphrase or through the KeyPassphrase event.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

ChangeExpirationDate Method (IPWorksOpenPGP_KeyMgr Class)

Changes the expiration date of the key.

Object Oriented Interface

public function doChangeExpirationDate($expirationdate);

Procedural Interface

ipworksopenpgp_keymgr_do_changeexpirationdate($res, $expirationdate);

Remarks

This method changes the expiration date of the current Key. The ExpirationDate parameter specifies the number of days for which the key is valid starting today. For instance a value of "31" means the key is valid for the next 31 days.

The special value "0" means the key will never expire.

The key's passphrase is required for this operation and may be specified via KeyPassphrase or through the KeyPassphrase event.

Note: See KeyValidityTime for information on specifying the expiration date when creating the key with CreateKey.

ChangePassphrase Method (IPWorksOpenPGP_KeyMgr Class)

Changes the passphrase of the current key.

Object Oriented Interface

public function doChangePassphrase($passphrase);

Procedural Interface

ipworksopenpgp_keymgr_do_changepassphrase($res, $passphrase);

Remarks

The Passphrase parameter specifies the new passphrase.

The key's passphrase is required for this operation and may be specified via KeyPassphrase or through the KeyPassphrase event.

Config Method (IPWorksOpenPGP_KeyMgr Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksopenpgp_keymgr_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 (IPWorksOpenPGP_KeyMgr Class)

Creates an OpenPGP key pair.

Object Oriented Interface

public function doCreateKey($userid, $passphrase);

Procedural Interface

ipworksopenpgp_keymgr_do_createkey($res, $userid, $passphrase);

Remarks

This method creates a new OpenPGP key pair. The UserId parameter specifies the user Id of the key. If KeyVersion is 6, this parameter may be an empty string.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Additional configuration settings may be set to further configure the details of the key (and subkey) being created. Please see the following settings for details:

• KeyEncryptionAlgorithm
• KeyUsage
• KeyValidityTime
• PublicKeyLength
• PublicKeyAlgorithm
• PublicKeySignatureHashAlgorithm
• Curve
• SubKeyAlgorithm
• SubKeyLength
• SubKeyCurve
• SubKeyUsage
• UseArgon2
• Argon2Iterations
• Argon2Parallelism

CreateSubKey Method (IPWorksOpenPGP_KeyMgr Class)

Creates a new subkey.

Object Oriented Interface

public function doCreateSubKey();

Procedural Interface

ipworksopenpgp_keymgr_do_createsubkey($res);

Remarks

This method creates a new subkey. Before calling this method the KeyId property must be set to a valid private key.

The following settings may optionally be set to define specific values for the created subkey:

• KeyValidityTime
• PublicKeyLength
• SubKeyAlgorithm
• SubKeyLength
• SubKeyCurve
• SubKeyUsage

DeleteKey Method (IPWorksOpenPGP_KeyMgr Class)

Deletes the specified key.

Object Oriented Interface

public function doDeleteKey($userid);

Procedural Interface

ipworksopenpgp_keymgr_do_deletekey($res, $userid);

Remarks

This method deletes the key specified by UserId from the current keyring. Below is a table of the type of Ids that may be specified to identify the key:

ExportPublicKey Method (IPWorksOpenPGP_KeyMgr Class)

Exports the public key of the current key.

Object Oriented Interface

public function doExportPublicKey($filename, $useasciiarmor);

Procedural Interface

ipworksopenpgp_keymgr_do_exportpublickey($res, $filename, $useasciiarmor);

Remarks

This method exports the public key of the currently selected Key. The FileName parameter specifies the file on disk to which the public key will be written. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

Note: When UseAsciiArmor is set to True the VersionHeader setting may also be set to specify your own header value.

ExportSecretKey Method (IPWorksOpenPGP_KeyMgr Class)

Exports the private key of the current key.

Object Oriented Interface

public function doExportSecretKey($filename, $useasciiarmor);

Procedural Interface

ipworksopenpgp_keymgr_do_exportsecretkey($res, $filename, $useasciiarmor);

Remarks

This method exports the private key of the currently selected Key. The FileName parameter specifies the file on disk that the private key will be written to. The UseAsciiArmor parameter determines whether or not ASCII armoring is used when writing the key to disk.

ImportKey Method (IPWorksOpenPGP_KeyMgr Class)

Imports the key specified by UserId to the current keyring.

Object Oriented Interface

public function doImportKey($filename, $userid);

Procedural Interface

ipworksopenpgp_keymgr_do_importkey($res, $filename, $userid);

Remarks

This method imports the key specified by UserId from the key file specified by FileName into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the FileName specifies a key file which contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key file will be imported. The ImportAllKeys setting controls the behavior of the class in this case.

Note: If you simply wish to select a key in the current ring set KeyUserId instead.

ImportKeyB Method (IPWorksOpenPGP_KeyMgr Class)

Imports the key specified by UserId to the current keyring.

Object Oriented Interface

public function doImportKeyB($data, $userid);

Procedural Interface

ipworksopenpgp_keymgr_do_importkeyb($res, $data, $userid);

Remarks

This method imports the key specified by UserId from the key data specified by Data into the current Keyring. The imported key will be automatically selected and available in the Key property.

If the Data specifies key data that contains multiple keys only the key belonging to UserId will be imported.

If UserId is set to "*" or "" (empty string) all keys in the key data will be imported. The ImportAllKeys setting controls the behavior of the class in this case.

Note: If you simply wish to select a key in the current ring set KeyUserId instead.

ListKeys Method (IPWorksOpenPGP_KeyMgr Class)

Lists keys in the specified Keyring .

Object Oriented Interface

public function doListKeys();

Procedural Interface

ipworksopenpgp_keymgr_do_listkeys($res);

Remarks

This method lists the keys (public/private key pairs) in the specified keyring. The results are provided through the KeyList event.

KeyList data will also be returned from this method, however it is recommended to use the KeyList event if possible.

ListSignatures Method (IPWorksOpenPGP_KeyMgr Class)

Lists all signatures of the current key.

Object Oriented Interface

public function doListSignatures();

Procedural Interface

ipworksopenpgp_keymgr_do_listsignatures($res);

Remarks

This method lists all the signatures of the currently selected key. The SignatureList event will fire for each signature.

SignatureList data will also be returned from this method. However, it is recommended to use the SignatureList event if possible.

ListSubkeys Method (IPWorksOpenPGP_KeyMgr Class)

Lists the subkeys of the currently selected key.

Object Oriented Interface

public function doListSubkeys();

Procedural Interface

ipworksopenpgp_keymgr_do_listsubkeys($res);

Remarks

This method lists all subkeys of current key. The SubkeyList event will be fired for each subkey.

SubkeyList data will also be returned from this method, however it is recommended to use the SubkeyList event if possible.

LoadKeyring Method (IPWorksOpenPGP_KeyMgr Class)

Loads the keyring from disk.

Object Oriented Interface

public function doLoadKeyring($keyringpath);

Procedural Interface

ipworksopenpgp_keymgr_do_loadkeyring($res, $keyringpath);

Remarks

This method loads the keyring from disk. If the keyring is stored in a directory, set KeyringPath to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file KeyringPath should be set to the path of the file.

When this method is called the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

LoadKeyringB Method (IPWorksOpenPGP_KeyMgr Class)

Loads the keyring from SecretKeyringData and PublicKeyringData .

Object Oriented Interface

public function doLoadKeyringB($secretkeyringdata, $publickeyringdata);

Procedural Interface

ipworksopenpgp_keymgr_do_loadkeyringb($res, $secretkeyringdata, $publickeyringdata);

Remarks

This method loads the keyring from SecretKeyringData and PublicKeyringData.

When this method is called the class will read the keyring and populate the Key property with the first key found in the keyring. Set KeyUserId to select a different key in the current keyring.

Reset Method (IPWorksOpenPGP_KeyMgr Class)

Resets the class properties.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksopenpgp_keymgr_do_reset($res);

Remarks

This method resets all message and key properties to their default values.

RevokeKey Method (IPWorksOpenPGP_KeyMgr Class)

Revokes the specified key.

Object Oriented Interface

public function doRevokeKey($keyid);

Procedural Interface

ipworksopenpgp_keymgr_do_revokekey($res, $keyid);

Remarks

This method revokes the key specified by KeyId and returns the revocation certificate.

When creating a revocation certificate there are two supported formats. The first format includes only the revocation signature. This format is returned by this method. The second format includes both the public key and the revocation signature. This format can be obtained by calling ExportPublicKey after calling this method. Both formats are common, and both formats are acceptable when calling ImportKey.

Before calling this method a key must be selected and available in the Key property.

The KeyId may be the Id of the main key or a subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

SaveKeyring Method (IPWorksOpenPGP_KeyMgr Class)

Saves the current Keyring to disk.

Object Oriented Interface

public function doSaveKeyring($keyringpath);

Procedural Interface

ipworksopenpgp_keymgr_do_savekeyring($res, $keyringpath);

Remarks

This method saves the current keyring to disk. There are two output options. The keyring may either be saved to a single key file or may be saved to a directory.

To save the keyring to a directory set KeyringPath to the path. The directory must already exist. The class will create a "pubring.gpg" and "secring.gpg" file in the specified directory. If the files already exist they will be overwritten.

To save the keyring to a key file set KeyringPath to a path and file name. If the file already exists it will be overwritten.

SignUserId Method (IPWorksOpenPGP_KeyMgr Class)

Signs the specified user Id of the current key.

Object Oriented Interface

public function doSignUserId($userid, $issueruserid);

Procedural Interface

ipworksopenpgp_keymgr_do_signuserid($res, $userid, $issueruserid);

Remarks

This method signs the UserId with the IssuerUserId.

To sign all user Ids in the current key set the UserId parameter to "*".

The key's passphrase is required for this operation and may be specified via KeyPassphrase or through the KeyPassphrase event.

VerifyPassphrase Method (IPWorksOpenPGP_KeyMgr Class)

Verifies the passphrase of specified key.

Object Oriented Interface

public function doVerifyPassphrase($passphrase);

Procedural Interface

ipworksopenpgp_keymgr_do_verifypassphrase($res, $passphrase);

Remarks

This method verifies the passphrase of the key specified by UserId.

If the password is correct, this method returns True; otherwise, this method returns False.

Error Event (IPWorksOpenPGP_KeyMgr Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

KeyList Event (IPWorksOpenPGP_KeyMgr Class)

Fires for each key in the keyring when ListKeys is called.

Object Oriented Interface

public function fireKeyList($param);

Procedural Interface

ipworksopenpgp_keymgr_register_callback($res, 2, array($this, 'fireKeyList'));

Parameter List

 'userid'
 'keyid'
 'fingerprint'
 'hassecretkey'
 'publickeyalgorithm'
 'publickeylength'
 'curve'

Remarks

This event fires once for each key in the Keyring when ListKeys is called.

UserId holds the current user Id of the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

HasSecretKey returns True if the key contains a secret key.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048. If the PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448, the length of the public key is determined by the Curve. Possible lengths are:

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:

KeyPassphrase Event (IPWorksOpenPGP_KeyMgr Class)

Fired if the passphrase of current key is incorrect or empty.

Object Oriented Interface

public function fireKeyPassphrase($param);

Procedural Interface

ipworksopenpgp_keymgr_register_callback($res, 3, array($this, 'fireKeyPassphrase'));

Parameter List

 'userid'
 'keyid'
 'fingerprint'
 'passphrase'

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the KeyPassphrase property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• AddUserId
• SignUserId
• ChangeExpirationDate
• ChangePassphrase

When using the OpenPGP class, or an email-based class, the following methods require a passphrase for the key:

• Decrypt
• Sign
• SignAndEncrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

SignatureList Event (IPWorksOpenPGP_KeyMgr Class)

Fires for each signature of the current key when ListSignatures is called.

Object Oriented Interface

public function fireSignatureList($param);

Procedural Interface

ipworksopenpgp_keymgr_register_callback($res, 4, array($this, 'fireSignatureList'));

Parameter List

 'keyid'
 'fingerprint'
 'userid'
 'issuerfingerprint'
 'issuerkeyid'
 'issueruserid'
 'publickeyalgorithm'
 'curve'
 'hashalgorithm'
 'effectivedate'
 'signatureclass'
 'validitystatus'

Remarks

This event fires once for each signature of the current key when ListSignatures is called.

The KeyId, UserId, and Fingerprint parameters contain relevant information for the current key. Similarly, the IssuerKeyId, IssuerUserId, and IssuerFingerprint parameters contain relevant information for the issuer's key. The format of these parameters are described below.

KeyId and IssuerKeyId hold the hex-encoded, 4- or 8-byte Id of the respective key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

UserId and IssuerUserId hold the user Id of the respective key. The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as it's identifier instead.

Fingerprint and IssuerFingerprint hold the hex-encoded, 20-byte fingerprint of the respective key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Note that if IssuerUserId and IssuerFingerprint are empty, this indicates that the issuer's key could not be found in the current keyring.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, Ed25519, or Ed448. Possible values are:

HashAlgorithm is the hash algorithm used by the signature. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

EffectiveDate is the date when this signature became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00 .

SignatureClass is the type of signature. Possible values are:

ValidityStatus specifies the current validity status of the signature. Possible values are:

Status Event (IPWorksOpenPGP_KeyMgr Class)

Shows the progress of the operation.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworksopenpgp_keymgr_register_callback($res, 5, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

SubkeyList Event (IPWorksOpenPGP_KeyMgr Class)

Fires once for each subkey listed when ListSubkeys is called.

Object Oriented Interface

public function fireSubkeyList($param);

Procedural Interface

ipworksopenpgp_keymgr_register_callback($res, 6, array($this, 'fireSubkeyList'));

Parameter List

 'keyid'
 'fingerprint'
 'publickeyalgorithm'
 'publickeylength'
 'curve'
 'usageflags'
 'usage'
 'effectivedate'
 'expirationdate'
 'revoked'

Remarks

This event fires once for each subkey when ListSubkeys is called.

KeyId is the hex-encoded, 4- or 8-byte Id of the key. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

PublicKeyAlgorithm is the public key algorithm of the subkey. Possible values are:

• RSA
• DSA
• ElGamal
• ECDSA
• EdDSA
• ECDH
• Ed25519
• Ed448
• X25519
• X448

PublicKeyLength is the length of the subkey. Common values are 512, 1024, and 2048. If PublicKeyAlgorithm is ECDSA, EdDSA, ECDH, Ed25519, Ed448, X25519, or X448, the length of the public key is determined by the Curve. Possible lengths are:

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA, EdDSA, ECDH, Ed25519, Ed448, X25519, or X448. Possible values are:

Usage is the textual description of UsageFlags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

UsageFlags is an integer flag that shows the intended use for the key. The value is a combination of the following flags:

EffectiveDate is the date when this key became valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00.

ExpirationDate is the date the key expires. After this date the key will no longer be valid. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. If the ExpirationDate is not populated this indicates that the key never expires.

Revoked Indicates whether the subkey is revoked or not.

Config Settings (KeyMgr Class)

KeyMgr Config Settings

5E70662EA810E768

Base Config Settings

Trappable Errors (KeyMgr Class)

OpenPGP Errors