PublicKeyProtection Property
Specifies the level of protection applied to the secret key.
Syntax
pgpkeyring.getPublicKeyProtection(index, [callback])
Possible Values
0 (pptNone), 1 (pptLow), 2 (pptNormal), 3 (pptHigh)
Default Value
0
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 getPublicKeyProtection([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 setPublicKeyProtection([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
Specifies the level of protection applied to the secret key.
Allowed values:
pptNone | 0 | Key is not encrypted |
pptLow | 1 | Only the password hash is used to derive the secret key |
pptNormal | 2 | Password hash with salt is used to derive the secret key |
pptHigh | 3 | Hash from multiple passwords and salt are used for key derivation |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the PublicKeyCount property.
This property is read-only and not available at design time.
Data Type
Integer