Add documentation to pgp module.
This commit is contained in:
Spencer Ofwiti
@@ -68,6 +68,14 @@
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>exports</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
@@ -155,9 +163,14 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#clearkeysinkeyring">clearKeysInKeyring</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:152</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:408</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remove all keys from the keyring.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -173,10 +186,22 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getencryptkeys">getEncryptKeys</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:68</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:250</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all the encryption keys.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>remarks</dt>
|
||||
<dd><p>Current implementation doesn't include encryption keys.
|
||||
This is included to appease the implemented Keystore interface.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of encryption keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -191,10 +216,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getfingerprint">getFingerprint</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:96</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:302</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the first private key's fingerprint.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>The first private key's fingerprint.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -209,16 +240,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getkeyid">getKeyId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:106</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:317</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a key's keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>key: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The key to fetch the keyId from.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>The key's keyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -233,16 +273,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getkeysforid">getKeysForId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:119</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:339</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get keys from the keyring using their keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The keyId of the keys to be fetched from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of the keys with that keyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -257,10 +306,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getprivatekey">getPrivateKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:76</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:266</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the first private key.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The first private key.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -275,16 +330,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getprivatekeyforid">getPrivateKeyForId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:127</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:357</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a private key from the keyring using it's keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyId: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The keyId of the private key to be fetched from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The private key with that keyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -299,10 +363,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getprivatekeyid">getPrivateKeyId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:110</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:325</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the first private key's keyID.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>The first private key's keyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -317,10 +387,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getprivatekeys">getPrivateKeys</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:72</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:258</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all private keys.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of all private keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -335,16 +411,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getpublickeyforid">getPublicKeyForId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:123</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:348</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a public key from the keyring using it's keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyId: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The keyId of the public key to be fetched from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The public key with that keyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -359,16 +444,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getpublickeyforsubkeyid">getPublicKeyForSubkeyId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:131</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:366</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get a public key from the keyring using it's subkeyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>subkeyId: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The subkeyId of the public key to be fetched from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The public key with that subkeyId.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -383,10 +477,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getpublickeys">getPublicKeys</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:56</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:223</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all the public keys.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of public keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -401,16 +501,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#getpublickeysforaddress">getPublicKeysForAddress</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:135</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:375</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get public keys from the keyring using their address.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>address: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The address of the public keys to be fetched from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of the public keys with that address.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -425,10 +534,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#gettrustedactivekeys">getTrustedActiveKeys</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:64</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:239</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all the trusted active keys.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of trusted active keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -443,10 +558,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#gettrustedkeys">getTrustedKeys</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:60</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:231</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all the trusted keys.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of trusted keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -461,16 +582,34 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#importkeypair">importKeyPair</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:43</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:182</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Add a key pair to keyring.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
<dt>throws</dt>
|
||||
<dd><p>Error</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>publicKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The public key to be added to the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>privateKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The private key to be added to the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -488,13 +627,28 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#importprivatekey">importPrivateKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:52</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:211</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Add private key to keyring.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
<dt>throws</dt>
|
||||
<dd><p>Error</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>privateKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The private key to be added to the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -505,23 +659,38 @@
|
||||
<a name="importpublickey" class="tsd-anchor"></a>
|
||||
<h3>import<wbr>Public<wbr>Key</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">import<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">import<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#importpublickey">importPublicKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:48</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:197</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Add public key to keyring.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
<dt>throws</dt>
|
||||
<dd><p>Error</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>publicKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The public key to be added to the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -536,16 +705,29 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#isencryptedprivatekey">isEncryptedPrivateKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:86</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:288</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Verify that a private key is encrypted.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>privateKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The private key to verify.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>true - If private key is encrypted.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -560,16 +742,29 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#isvalidkey">isValidKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:80</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:276</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Test if the input is a valid key.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>key: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The input to be validated.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>true - If the input is a valid key.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -584,9 +779,18 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#loadkeyring">loadKeyring</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:38</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:170</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Instantiate the keyring in the keystore.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -602,16 +806,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#removekeysforid">removeKeysForId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:139</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:384</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remove a public key from the keyring using it's keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyId: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The keyId of the keys to be removed from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
<p>An array of the removed keys.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -626,16 +839,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#removepublickey">removePublicKey</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:147</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:402</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remove a public key from the keyring.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>publicKey: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The public key to be removed from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The removed public key.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -650,16 +872,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#removepublickeyforid">removePublicKeyForId</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:143</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:393</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remove a public key from the keyring using it's keyId.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyId: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The keyId of the public key to be removed from the keyring.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
<p>The removed public key.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -674,16 +905,29 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html">MutableKeyStore</a>.<a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html#sign">sign</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:156</li>
|
||||
<li>Defined in src/app/_pgp/pgp-key-store.ts:418</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Sign message using private key.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>plainText: <span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The message to be signed.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>The generated signature.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
@@ -68,6 +68,14 @@
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>exports</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
@@ -129,13 +137,21 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:34</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:74</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Initializing the Signer.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>keyStore: <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html" class="tsd-signature-type" data-tsd-kind="Interface">MutableKeyStore</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>A keystore holding pgp keys.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="app__pgp_pgp_signer.pgpsigner.html" class="tsd-signature-type" data-tsd-kind="Class">PGPSigner</a></h4>
|
||||
@@ -151,9 +167,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">algo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'sha256'</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:28</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:62</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Encryption algorithm used</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="dgst" class="tsd-anchor"></a>
|
||||
@@ -161,9 +182,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">dgst<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:29</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:64</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Message digest</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="engine" class="tsd-anchor"></a>
|
||||
@@ -171,9 +197,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'pgp'</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:27</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:60</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Encryption engine used.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="keystore" class="tsd-anchor"></a>
|
||||
@@ -181,9 +212,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">key<wbr>Store<span class="tsd-signature-symbol">:</span> <a href="../interfaces/app__pgp_pgp_key_store.mutablekeystore.html" class="tsd-signature-type" data-tsd-kind="Interface">MutableKeyStore</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:31</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:68</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A keystore holding pgp keys.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="loggingservice" class="tsd-anchor"></a>
|
||||
@@ -191,9 +227,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">logging<wbr>Service<span class="tsd-signature-symbol">:</span> <a href="app__services_logging_service.loggingservice.html" class="tsd-signature-type" data-tsd-kind="Class">LoggingService</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:34</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:74</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A service that provides logging capabilities.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="onsign" class="tsd-anchor"></a>
|
||||
@@ -202,9 +243,14 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#onsign">onsign</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:32</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:70</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Event triggered on successful signing of message.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -234,9 +280,14 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#onverify">onverify</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:33</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:72</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Event triggered on successful verification of a signature.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -265,9 +316,14 @@
|
||||
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <a href="../interfaces/app__pgp_pgp_signer.signature.html" class="tsd-signature-type" data-tsd-kind="Interface">Signature</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:30</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:66</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Generated signature</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
@@ -283,10 +339,16 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#fingerprint">fingerprint</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:42</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:90</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get the private key fingerprint.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>A private key fingerprint.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -301,16 +363,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#prepare">prepare</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:46</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:99</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Load the message digest.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>material: <a href="../interfaces/app__pgp_pgp_signer.signable.html" class="tsd-signature-type" data-tsd-kind="Interface">Signable</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>A signable object.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
<p>true - If digest has been loaded successfully.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -325,13 +396,25 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#sign">sign</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:83</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:146</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Signs a message using a private key.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>async</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>digest: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The message to be signed.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -349,16 +432,27 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Implementation of <a href="../interfaces/app__pgp_pgp_signer.signer.html">Signer</a>.<a href="../interfaces/app__pgp_pgp_signer.signer.html#verify">verify</a></p>
|
||||
<ul>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:51</li>
|
||||
<li>Defined in src/app/_pgp/pgp-signer.ts:109</li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Verify that signature is valid.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>digest: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The message that was signed.</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>signature: <a href="../interfaces/app__pgp_pgp_signer.signature.html" class="tsd-signature-type" data-tsd-kind="Interface">Signature</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The generated signature.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
|
||||
Reference in New Issue
Block a user