suzanne.soy/fork-openpgpjs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
365a5efb63
fork-openpgpjs/docs/Key.html
Daniel Huigens 365a5efb63 5.0.0-0
2021-02-27 01:25:52 +01:00

7170 lines
86 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Key</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Key</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Key<span class="signature">(packetlist)</span><span class="type-signature"></span></h2>
<div class="class-description"><p>Class that represents an OpenPGP key. Must contain a primary key.
Can contain additional subkeys, signatures, user ids, user attributes.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Key"><span class="type-signature"></span>new Key<span class="signature">(packetlist)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>packetlist</code></td>
<td class="type">
<span class="param-type"><a href="PacketList.html">PacketList</a></span>
</td>
<td class="description last"><p>The packets that form this key</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L45">line 45</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addSubkey"><span class="type-signature">(async) </span>addSubkey<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Generates a new OpenPGP subkey, and returns a clone of the Key object with the new subkey added.
Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the primary key. DSA primary keys default to RSA subkeys.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options.type</code></td>
<td class="type">
<span class="param-type">ecc</span>
|
<span class="param-type">rsa</span>
</td>
<td class="description last"><p>The subkey algorithm: ECC or RSA</p></td>
</tr>
<tr>
<td class="name"><code>options.curve</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>(optional) Elliptic curve for ECC keys</p></td>
</tr>
<tr>
<td class="name"><code>options.rsaBits</code></td>
<td class="type">
<span class="param-type">Integer</span>
</td>
<td class="description last"><p>(optional) Number of bits for RSA subkeys</p></td>
</tr>
<tr>
<td class="name"><code>options.keyExpirationTime</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>(optional) Number of seconds from the key creation time after which the key expires</p></td>
</tr>
<tr>
<td class="name"><code>options.date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) Override the creation date of the key and the key signatures</p></td>
</tr>
<tr>
<td class="name"><code>options.sign</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>(optional) Indicates whether the subkey should sign rather than encrypt. Defaults to false</p></td>
</tr>
<tr>
<td class="name"><code>options.config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) custom configuration settings to overwrite those in openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L888">line 888</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="applyRevocationCertificate"><span class="type-signature">(async) </span>applyRevocationCertificate<span class="signature">(revocationCertificate, config)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Applies a revocation certificate to a key
This adds the first signature packet in the armored text to the key,
if it is a valid revocation signature.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>revocationCertificate</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>armored revocation certificate</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L770">line 770</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new revoked key</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="armor"><span class="type-signature"></span>armor<span class="signature">(config)</span><span class="type-signature"> &rarr; {ReadableStream.&lt;String>}</span></h4>
<div class="description">
<p>Returns ASCII armored text of key</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L267">line 267</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>ASCII armor</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ReadableStream.&lt;String></span>
</dd>
</dl>
<h4 class="name" id="clearPrivateParams"><span class="type-signature"></span>clearPrivateParams<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear private key parameters</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L504">line 504</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clone"><span class="type-signature">(async) </span>clone<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Clones the key object</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L162">line 162</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>shallow clone of the key</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(passphrases, keyId, config)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Decrypts all secret key and subkey packets matching keyId</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>passphrases</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array.&lt;String></span>
</td>
<td class="default">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>keyId</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L420">line 420</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if any matching key or subkey packets did not decrypt successfully</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(passphrases, keyId, config)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Encrypts all secret key and subkey packets matching keyId</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>passphrases</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array.&lt;String></span>
</td>
<td class="default">
</td>
<td class="description last"><p>if multiple passphrases, then should be in same order as packets each should encrypt</p></td>
</tr>
<tr>
<td class="name"><code>keyId</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L394">line 394</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if encryption failed for any key or subkey</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="getAlgorithmInfo"><span class="type-signature"></span>getAlgorithmInfo<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
<div class="description">
<p>Returns algorithm information</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L231">line 231</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object of the form {algorithm: String, bits:int, curve:String}</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getAlgorithmInfo"><span class="type-signature"></span>getAlgorithmInfo<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
<div class="description">
<p>Returns algorithm information</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L231">line 231</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>An object of the form {algorithm: String, bits:int, curve:String}</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getCreationTime"><span class="type-signature"></span>getCreationTime<span class="signature">()</span><span class="type-signature"> &rarr; {Date}</span></h4>
<div class="description">
<p>Returns the creation time of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L173">line 173</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Date</span>
</dd>
</dl>
<h4 class="name" id="getCreationTime"><span class="type-signature"></span>getCreationTime<span class="signature">()</span><span class="type-signature"> &rarr; {Date}</span></h4>
<div class="description">
<p>Returns the creation time of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L173">line 173</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Date</span>
</dd>
</dl>
<h4 class="name" id="getDecryptionKeys"><span class="type-signature">(async) </span>getDecryptionKeys<span class="signature">(keyId,, date,, userId,, config)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;(<a href="Key.html">Key</a>|SubKey)>>}</span></h4>
<div class="description">
<p>Returns all keys that are available for decryption, matching the keyId when given
This is useful to retrieve keys for session key decryption</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyId,</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>date,</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>userId,</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L361">line 361</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>array of decryption keys</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Array.&lt;(<a href="Key.html">Key</a>|SubKey)>></span>
</dd>
</dl>
<h4 class="name" id="getEncryptionKey"><span class="type-signature">(async) </span>getEncryptionKey<span class="signature">(keyId,, date,, userId,, config)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="Key.html">Key</a>|SubKey|null)>}</span></h4>
<div class="description">
<p>Returns last created key or key by given keyId that is available for encryption or decryption</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyId,</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>date,</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>userId,</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L322">line 322</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>key or null if no encryption key has been found</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;(<a href="Key.html">Key</a>|SubKey|null)></span>
</dd>
</dl>
<h4 class="name" id="getExpirationTime"><span class="type-signature">(async) </span>getExpirationTime<span class="signature">(capabilities,, keyId,, userId,, config)</span><span class="type-signature"> &rarr; {Promise.&lt;(Date|Infinity|null)>}</span></h4>
<div class="description">
<p>Returns the latest date when the key can be used for encrypting, signing, or both, depending on the <code>capabilities</code> paramater.
When <code>capabilities</code> is null, defaults to returning the expiry date of the primary key.
Returns null if <code>capabilities</code> is passed and the key does not have the specified capabilities or is revoked or invalid.
Returns Infinity if the key doesn't expire.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>capabilities,</code></td>
<td class="type">
<span class="param-type"><a href="global.html#encrypt">encrypt</a></span>
|
<span class="param-type"><a href="global.html#sign">sign</a></span>
|
<span class="param-type">encrypt_sign</span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>keyId,</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>userId,</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>optional user ID</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L568">line 568</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;(Date|Infinity|null)></span>
</dd>
</dl>
<h4 class="name" id="getFingerprint"><span class="type-signature"></span>getFingerprint<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
<div class="description">
<p>Calculates the fingerprint of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L215">line 215</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A string containing the fingerprint in lowercase hex</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="getFingerprint"><span class="type-signature"></span>getFingerprint<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
<div class="description">
<p>Calculates the fingerprint of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L215">line 215</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A string containing the fingerprint in lowercase hex</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4>
<div class="description">
<p>Calculates the key id of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L181">line 181</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A 8 byte key id</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</dd>
</dl>
<h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4>
<div class="description">
<p>Calculates the key id of the key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L181">line 181</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A 8 byte key id</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</dd>
</dl>
<h4 class="name" id="getKeyIds"><span class="type-signature"></span>getKeyIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>>}</span></h4>
<div class="description">
<p>Returns key IDs of all keys</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L200">line 200</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span>
</dd>
</dl>
<h4 class="name" id="getKeys"><span class="type-signature"></span>getKeys<span class="signature">(keyId)</span><span class="type-signature"> &rarr; {Array.&lt;(<a href="Key.html">Key</a>|SubKey)>}</span></h4>
<div class="description">
<p>Returns an array containing all public or private keys matching keyId.
If keyId is not present, returns all keys starting with the primary key.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyId</code></td>
<td class="type">
<span class="param-type">type/keyid</span>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L188">line 188</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;(<a href="Key.html">Key</a>|SubKey)></span>
</dd>
</dl>
<h4 class="name" id="getPrimaryUser"><span class="type-signature">(async) </span>getPrimaryUser<span class="signature">(date, userId, config)</span><span class="type-signature"> &rarr; {Promise.&lt;{user: User, selfCertification: <a href="SignaturePacket.html">SignaturePacket</a>}>}</span></h4>
<div class="description">
<p>Returns primary user and most significant (latest valid) self signature</p>
<ul>
<li>if multiple primary users exist, returns the one with the latest self signature</li>
<li>otherwise, returns the user with the latest self signature</li>
</ul>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) use the given date for verification instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) user ID to get instead of the primary user, if it exists</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L604">line 604</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The primary user and the self signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;{user: User, selfCertification: <a href="SignaturePacket.html">SignaturePacket</a>}></span>
</dd>
</dl>
<h4 class="name" id="getRevocationCertificate"><span class="type-signature">(async) </span>getRevocationCertificate<span class="signature">(date, config)</span><span class="type-signature"> &rarr; {Promise.&lt;String>}</span></h4>
<div class="description">
<p>Get revocation certificate from a revoked key.
(To get a revocation certificate for an unrevoked key, call revoke() first.)</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Use the given date instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L753">line 753</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>armored revocation certificate</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;String></span>
</dd>
</dl>
<h4 class="name" id="getSigningKey"><span class="type-signature">(async) </span>getSigningKey<span class="signature">(keyId,, date, userId,, config)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="Key.html">Key</a>|SubKey|null)>}</span></h4>
<div class="description">
<p>Returns last created key or key by given keyId that is available for signing and verification</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyId,</code></td>
<td class="type">
<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span>
</td>
<td class="description last"><p>optional</p></td>
</tr>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) use the given date for verification instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>userId,</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>optional user ID</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L281">line 281</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>key or null if no signing key has been found</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;(<a href="Key.html">Key</a>|SubKey|null)></span>
</dd>
</dl>
<h4 class="name" id="getSubkeys"><span class="type-signature"></span>getSubkeys<span class="signature">(keyId)</span><span class="type-signature"> &rarr; {Array.&lt;SubKey>}</span></h4>
<div class="description">
<p>Returns an array containing all public or private subkeys matching keyId;
If keyId is not present, returns all subkeys.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyId</code></td>
<td class="type">
<span class="param-type">type/keyid</span>
</td>
<td class="default">
null
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L172">line 172</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;SubKey></span>
</dd>
</dl>
<h4 class="name" id="getUserIds"><span class="type-signature"></span>getUserIds<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
<div class="description">
<p>Returns userids</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L208">line 208</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>array of userids</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
<h4 class="name" id="hasSameFingerprintAs"><span class="type-signature"></span>hasSameFingerprintAs<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Calculates whether two keys have the same fingerprint without actually calculating the fingerprint</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L223">line 223</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Whether the two keys have the same version and public key data</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="hasSameFingerprintAs"><span class="type-signature"></span>hasSameFingerprintAs<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Calculates whether two keys have the same fingerprint without actually calculating the fingerprint</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/packet/public_key.js#L223">line 223</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Whether the two keys have the same version and public key data</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="isDecrypted"><span class="type-signature"></span>isDecrypted<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Returns true if the primary key or any subkey is decrypted.
A dummy key is considered encrypted.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L454">line 454</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isPrivate"><span class="type-signature"></span>isPrivate<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Returns true if this is a private key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L226">line 226</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="isPublic"><span class="type-signature"></span>isPublic<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
<div class="description">
<p>Returns true if this is a public key</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L218">line 218</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(signature, key,, date, config)</span><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h4>
<div class="description">
<p>Checks if a signature on a key is revoked</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>signature</code></td>
<td class="type">
<span class="param-type"><a href="SignaturePacket.html">SignaturePacket</a></span>
</td>
<td class="description last"><p>The signature to verify</p></td>
</tr>
<tr>
<td class="name"><code>key,</code></td>
<td class="type">
<span class="param-type"><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></span>
|
<span class="param-type"><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></span>
|
<span class="param-type"><a href="PublicKeyPacket.html">PublicKeyPacket</a></span>
|
<span class="param-type"><a href="SecretKeyPacket.html">SecretKeyPacket</a></span>
</td>
<td class="description last"><p>optional The key to verify the signature</p></td>
</tr>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>Use the given date instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L527">line 527</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the certificate is revoked</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Boolean></span>
</dd>
</dl>
<h4 class="name" id="packetlist2structure"><span class="type-signature"></span>packetlist2structure<span class="signature">(packetlist)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Transforms packetlist to structured key data</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>packetlist</code></td>
<td class="type">
<span class="param-type"><a href="PacketList.html">PacketList</a></span>
</td>
<td class="description last"><p>The packets that form a key</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L69">line 69</a>
</li></ul></dd>
</dl>
<h4 class="name" id="revoke"><span class="type-signature">(async) </span>revoke<span class="signature">(reasonForRevocation, date, config)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Revokes the key</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>reasonForRevocation</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>optional, object indicating the reason for revocation</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>flag</code></td>
<td class="type">
<span class="param-type"><a href="module-enums.html#.reasonForRevocation">module:enums.reasonForRevocation</a></span>
</td>
<td class="description last"><p>optional, flag indicating the reason for revocation</p></td>
</tr>
<tr>
<td class="name"><code>string</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>optional, string explaining the reason for revocation</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>optional, override the creationtime of the revocation signature</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L724">line 724</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new key with revocation signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="signAllUsers"><span class="type-signature">(async) </span>signAllUsers<span class="signature">(privateKeys, config)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Signs all users of key</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>privateKeys</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
</td>
<td class="description last"><p>decrypted private keys for signing</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L818">line 818</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new public key with new certificate signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="signPrimaryUser"><span class="type-signature">(async) </span>signPrimaryUser<span class="signature">(privateKeys, date, userId, config)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Signs primary user of key</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>privateKeys</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
</td>
<td class="description last"><p>decrypted private keys for signing</p></td>
</tr>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) use the given date for verification instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) user ID to get instead of the primary user, if it exists</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L803">line 803</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new public key with new certificate signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="toPacketlist"><span class="type-signature"></span>toPacketlist<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PacketList.html">PacketList</a>}</span></h4>
<div class="description">
<p>Transforms structured key data to packetlist</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L147">line 147</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The packets that form a key</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="PacketList.html">PacketList</a></span>
</dd>
</dl>
<h4 class="name" id="toPublic"><span class="type-signature"></span>toPublic<span class="signature">(config)</span><span class="type-signature"> &rarr; {<a href="Key.html">Key</a>}</span></h4>
<div class="description">
<p>Returns key as public key (shallow copy)</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L235">line 235</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>new public Key</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Key.html">Key</a></span>
</dd>
</dl>
<h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(key, config)</span><span class="type-signature"> &rarr; {Promise.&lt;undefined>}</span></h4>
<div class="description">
<p>Update key with new components from specified key with same key ID:
users, subkeys, certificates are merged into the destination key,
duplicates and expired signatures are ignored.</p>
<p>If the specified key is a private key and the destination key is public,
the destination key is transformed to a private key.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type"><a href="Key.html">Key</a></span>
</td>
<td class="description last"><p>Source key to merge</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L659">line 659</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;undefined></span>
</dd>
</dl>
<h4 class="name" id="validate"><span class="type-signature">(async) </span>validate<span class="signature">(config)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Check whether the private and public primary key parameters correspond
Together with verification of binding signatures, this guarantees key integrity
In case of gnu-dummy primary key, it is enough to validate any signing subkeys
otherwise all encryption subkeys are validated
If only gnu-dummy keys are found, we cannot properly validate so we throw an error</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L468">line 468</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if validation was not successful and the key cannot be trusted</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="verifyAllUsers"><span class="type-signature">(async) </span>verifyAllUsers<span class="signature">(keys, config)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;{userid: String, keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>>}</span></h4>
<div class="description">
<p>Verifies all users of key</p>
<ul>
<li>if no arguments are given, verifies the self certificates;</li>
<li>otherwise, verifies all certificates signed with given keys.</li>
</ul>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keys</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
</td>
<td class="description last"><p>array of keys to verify certificate signatures</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L858">line 858</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>list of userid, signer's keyid and validity of signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Array.&lt;{userid: String, keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>></span>
</dd>
</dl>
<h4 class="name" id="verifyPrimaryKey"><span class="type-signature">(async) </span>verifyPrimaryKey<span class="signature">(date, userId, config)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Verify primary key. Checks for revocation signatures, expiration time
and valid self signature. Throws if the primary key is invalid.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) use the given date for verification instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) user ID</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L542">line 542</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>If key verification failed</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="verifyPrimaryUser"><span class="type-signature">(async) </span>verifyPrimaryUser<span class="signature">(keys, date, userId, config)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>>}</span></h4>
<div class="description">
<p>Verifies primary user of key</p>
<ul>
<li>if no arguments are given, verifies the self certificates;</li>
<li>otherwise, verifies all certificates signed with given keys.</li>
</ul>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keys</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
</td>
<td class="description last"><p>array of keys to verify certificate signatures</p></td>
</tr>
<tr>
<td class="name"><code>date</code></td>
<td class="type">
<span class="param-type">Date</span>
</td>
<td class="description last"><p>(optional) use the given date for verification instead of the current time</p></td>
</tr>
<tr>
<td class="name"><code>userId</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) user ID to get instead of the primary user, if it exists</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/key/key.js#L839">line 839</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>List of signer's keyid and validity of signature</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;Array.&lt;{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#armor">armor</a></li><li><a href="global.html#decrypt">decrypt</a></li><li><a href="global.html#decryptKey">decryptKey</a></li><li><a href="global.html#decryptSessionKeys">decryptSessionKeys</a></li><li><a href="global.html#encrypt">encrypt</a></li><li><a href="global.html#encryptKey">encryptKey</a></li><li><a href="global.html#encryptSessionKey">encryptSessionKey</a></li><li><a href="global.html#generateKey">generateKey</a></li><li><a href="global.html#generateSessionKey">generateSessionKey</a></li><li><a href="global.html#readCleartextMessage">readCleartextMessage</a></li><li><a href="global.html#readKey">readKey</a></li><li><a href="global.html#readKeys">readKeys</a></li><li><a href="global.html#readMessage">readMessage</a></li><li><a href="global.html#readSignature">readSignature</a></li><li><a href="global.html#reformatKey">reformatKey</a></li><li><a href="global.html#revokeKey">revokeKey</a></li><li><a href="global.html#sign">sign</a></li><li><a href="global.html#unarmor">unarmor</a></li><li><a href="global.html#verify">verify</a></li></ul><h3>Modules</h3><ul><li><a href="module-config.html">config</a></li><li><a href="module-enums.html">enums</a></li></ul><h3>Classes</h3><ul><li><a href="AEADEncryptedDataPacket.html">AEADEncryptedDataPacket</a></li><li><a href="CleartextMessage.html">CleartextMessage</a></li><li><a href="CompressedDataPacket.html">CompressedDataPacket</a></li><li><a href="HKP.html">HKP</a></li><li><a href="Key.html">Key</a></li><li><a href="KeyArray.html">KeyArray</a></li><li><a href="Keyring.html">Keyring</a></li><li><a href="LiteralDataPacket.html">LiteralDataPacket</a></li><li><a href="MarkerPacket.html">MarkerPacket</a></li><li><a href="Message.html">Message</a></li><li><a href="module-crypto_random-RandomBuffer.html">RandomBuffer</a></li><li><a href="module-key_SubKey-SubKey.html">SubKey</a></li><li><a href="module-key_User-User.html">User</a></li><li><a href="module-type_kdf_params-KDFParams.html">KDFParams</a></li><li><a href="module-type_keyid-Keyid.html">Keyid</a></li><li><a href="module-type_s2k-S2K.html">S2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PublicKeyEncryptedSessionKeyPacket.html">PublicKeyEncryptedSessionKeyPacket</a></li><li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li><li><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></li><li><a href="SecretKeyPacket.html">SecretKeyPacket</a></li><li><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></li><li><a href="Signature.html">Signature</a></li><li><a href="SignaturePacket.html">SignaturePacket</a></li><li><a href="SymEncryptedIntegrityProtectedDataPacket.html">SymEncryptedIntegrityProtectedDataPacket</a></li><li><a href="SymEncryptedSessionKeyPacket.html">SymEncryptedSessionKeyPacket</a></li><li><a href="SymmetricallyEncryptedDataPacket.html">SymmetricallyEncryptedDataPacket</a></li><li><a href="TrustPacket.html">TrustPacket</a></li><li><a href="UserAttributePacket.html">UserAttributePacket</a></li><li><a href="UserIDPacket.html">UserIDPacket</a></li><li><a href="WKD.html">WKD</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sat Feb 27 2021 01:25:52 GMT+0100 (Midden-Europese standaardtijd)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink