JSDoc: Module: key

Module: key

key

Source:

<static> generate(keyType, numBits, userId, passphrase) → {module:key~Key}

Generates a new OpenPGP key. Currently only supports RSA keys. Primary and subkey will be of same type.

Name	Type	Description
`keyType`	module:enums.publicKey	to indicate what type of key to make. RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1
`numBits`	Integer	number of bits for the key creation.
`userId`	String	assumes already in form of "User Name "
`passphrase`	String	The passphrase used to encrypt the resulting private key

Source:

<static> readArmored(armoredText) → {Object}

Reads an OpenPGP armored text and returns one or multiple key objects

Name	Type	Description
`armoredText`	String	text to be parsed

Source:

result object with key and error arrays