KeyPassphrase Property
Specifies a passphrase for the decryption key.
Syntax
pgpreader.getKeyPassphrase([callback]) pgpreader.setKeyPassphrase( keyPassphrase, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getKeyPassphrase([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setKeyPassphrase([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Use this property to provide a passphrase for the decryption secret key.
If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.
Data Type
String