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

1003 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Keyring</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: Keyring</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Keyring<span class="signature">(storeHandler<span class="signature-attributes">opt</span>, config)</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Keyring"><span class="type-signature"></span>new Keyring<span class="signature">(storeHandler<span class="signature-attributes">opt</span>, config)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialization routine for the keyring.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>storeHandler</code></td>
<td class="type">
<span class="param-type">keyring/localstore</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>class implementing loadPublic(), loadPrivate(), storePublic(), and storePrivate() methods</p></td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
</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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L123">line 123</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear the keyring - erase all the 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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L150">line 150</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getAllKeys"><span class="type-signature"></span>getAllKeys<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Key.html">Key</a>>}</span></h4>
<div class="description">
<p>Get all public and private 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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L186">line 186</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>all keys</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
</dd>
</dl>
<h4 class="name" id="getKeysForId"><span class="type-signature"></span>getKeysForId<span class="signature">(keyId, deep)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Key.html">Key</a>>|null}</span></h4>
<div class="description">
<p>Searches the keyring for keys having the specified key id</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">String</span>
</td>
<td class="description last"><p>provided as string of lowercase hex number
withouth 0x prefix (can be 16-character key ID or fingerprint)</p></td>
</tr>
<tr>
<td class="name"><code>deep</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"><p>if true search also in subkeys</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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L162">line 162</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>keys found or null</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="load"><span class="type-signature">(async) </span>load<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Calls the storeHandler to load the 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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L131">line 131</a>
</li></ul></dd>
</dl>
<h4 class="name" id="removeKeysForId"><span class="type-signature"></span>removeKeysForId<span class="signature">(keyId)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Key.html">Key</a>>|null}</span></h4>
<div class="description">
<p>Removes keys having the specified key id from the keyring</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">String</span>
</td>
<td class="description last"><p>provided as string of lowercase hex number
withouth 0x prefix (can be 16-character key ID or fingerprint)</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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L175">line 175</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>keys found or null</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="Key.html">Key</a>></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="store"><span class="type-signature">(async) </span>store<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Calls the storeHandler to save the 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/keyring/keyring.js">keyring/keyring.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-0/src/keyring/keyring.js#L140">line 140</a>
</li></ul></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