keyPassphrase (property)
The passphrase for the key's secret key (if any).
Syntax
- (NSString*)keyPassphrase:(int)keyIndex; - (void)setKeyPassphrase:(int)keyIndex:(NSString*)newKeyPassphrase;
public func keyPassphrase(keyIndex: Int32) throws -> String
public func setKeyPassphrase(keyIndex: Int32, newKeyPassphrase: String) throws -> Void
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
The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.