-
armor() → {String}
-
Returns ASCII armored text of key
- Source:
Returns:
ASCII armor
-
Type
-
String
-
decrypt(passphrase) → {Boolean}
-
Decrypts all secret key and subkey packets
Parameters:
| Name |
Type |
Description |
passphrase |
String
|
|
- Source:
Returns:
true if all key and subkey packets decrypted successfully
-
Type
-
Boolean
-
decryptKeyPacket(keyIds, passphrase) → {Boolean}
-
Decrypts specific key packets by key ID
Parameters:
| Name |
Type |
Description |
keyIds |
Array.<keyid>
|
|
passphrase |
String
|
|
- Source:
Returns:
true if all key packets decrypted successfully
-
Type
-
Boolean
-
getAllKeyPackets() → {Array.<(public_subkey|secret_subkey|packet_secret_key|packet_public_key)>}
-
Returns all the private and public key and subkey packets
- Source:
Returns:
-
Type
-
Array.<(public_subkey|secret_subkey|packet_secret_key|packet_public_key)>
-
getEncryptionKeyPacket() → {public_subkey|secret_subkey|packet_secret_key|packet_public_key|null}
-
Returns the first valid encryption key packet for this key
- Source:
Returns:
key packet or null if no encryption key has been found
-
Type
-
public_subkey
|
secret_subkey
|
packet_secret_key
|
packet_public_key
|
null
-
getKeyIds() → {Array.<keyid>}
-
Returns key IDs of all key packets
- Source:
Returns:
-
Type
-
Array.<keyid>
-
getKeyPacket() → {packet_secret_key|packet_public_key|null}
-
Returns the primary key packet (secret or public)
- Source:
Returns:
-
Type
-
packet_secret_key
|
packet_public_key
|
null
-
getPreferredHashAlgorithm() → {String}
-
Returns preferred signature hash algorithm of this key
- Source:
Returns:
-
Type
-
String
-
getPrimaryUser() → {Object}
-
Returns primary user and most significant (latest valid) self signature
- if multiple users are marked as primary users returns the one with the latest self signature
- if no primary user is found returns the user with the latest self signature
- Source:
Returns:
The primary user and the self signature
-
Type
-
Object
-
getPrivateKeyPacket(keyIds) → {secret_subkey|packet_secret_key|null}
-
Returns first private key packet for given array of key IDs
Parameters:
| Name |
Type |
Description |
keyIds |
Array.<keyid>
|
|
- Source:
Returns:
-
Type
-
secret_subkey
|
packet_secret_key
|
null
-
getPublicKeyPacket(keyIds) → {public_subkey|packet_public_key|null}
-
Returns first public key packet for given array of key IDs
Parameters:
| Name |
Type |
Description |
keyIds |
Array.<keyid>
|
|
- Source:
Returns:
-
Type
-
public_subkey
|
packet_public_key
|
null
-
getSigningKeyPacket() → {secret_subkey|packet_secret_key|null}
-
Returns first key packet that is available for signing
- Source:
Returns:
key packet or null if no signing key has been found
-
Type
-
secret_subkey
|
packet_secret_key
|
null
-
getSubkeyPackets() → {Array.<(public_subkey|secret_subkey)>}
-
Returns all the private and public subkey packets
- Source:
Returns:
-
Type
-
Array.<(public_subkey|secret_subkey)>
-
getUserIds() → {Array.<string>}
-
Returns userids
- Source:
Returns:
array of userids
-
Type
-
Array.<string>
-
isPrivate() → {Boolean}
-
Returns true if this is a private key
- Source:
Returns:
-
Type
-
Boolean
-
isPublic() → {Boolean}
-
Returns true if this is a public key
- Source:
Returns:
-
Type
-
Boolean
-
packetlist2structure(packetlist)
-
Transforms packetlist to structured key data
Parameters:
| Name |
Type |
Description |
packetlist |
packetlist
|
The packets that form a key |
- Source:
-
toPacketlist() → {packetlist}
-
Transforms structured key data to packetlist
- Source:
Returns:
The packets that form a key
-
Type
-
packetlist
-
toPublic() → {Key}
-
Returns key as public key (shallow copy)
- Source:
Returns:
new public Key
-
Type
-
Key
-
verifyPrimaryKey() → {enums.keyStatus}
-
Verify primary key. Checks for revocation signatures, expiration time
and valid self signature
- Source:
Returns:
The status of the primary key
-
Type
-
enums.keyStatus