KeyPassphrase Event

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