diff options
| author | Daniel Huigens <d.huigens@protonmail.com> | 2021-04-27 15:00:54 +0300 |
|---|---|---|
| committer | Daniel Huigens <d.huigens@protonmail.com> | 2021-04-27 15:00:54 +0300 |
| commit | 2d07c43030ad01e065a36c961912a881a123250c (patch) | |
| tree | 0612eced5ab17ea89d22d7954a1d9e8d0ce540d3 /docs | |
| parent | 28c590241913bcf4987641e691fcd3a3184a218b (diff) | |
5.0.0-2v5.0.0-2
Diffstat (limited to 'docs')
32 files changed, 1956 insertions, 3806 deletions
diff --git a/docs/AEADEncryptedDataPacket.html b/docs/AEADEncryptedDataPacket.html index c6fa9645..b77e9cc0 100644 --- a/docs/AEADEncryptedDataPacket.html +++ b/docs/AEADEncryptedDataPacket.html @@ -98,7 +98,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L51">line 51</a> </li></ul></dd> @@ -154,7 +154,7 @@ AEAD Protected Data Packet</p></div> - <h4 class="name" id="crypt"><span class="type-signature">(async) </span>crypt<span class="signature">(fn, key, data, streaming)</span><span class="type-signature"> → {Uint8Array|ReadableStream.<Uint8Array>}</span></h4> + <h4 class="name" id="crypt"><span class="type-signature">(async) </span>crypt<span class="signature">(fn, key, data)</span><span class="type-signature"> → {Promise.<(Uint8Array|ReadableStream.<Uint8Array>)>}</span></h4> @@ -270,29 +270,6 @@ AEAD Protected Data Packet</p></div> </tr> - - <tr> - - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - - - - <td class="description last"><p>Whether the top-level function will return a stream</p></td> - </tr> - - </tbody> </table> @@ -332,7 +309,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L123">line 123</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L125">line 125</a> </li></ul></dd> @@ -368,10 +345,7 @@ AEAD Protected Data Packet</p></div> </dt> <dd> -<span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> +<span class="param-type">Promise.<(Uint8Array|ReadableStream.<Uint8Array>)></span> </dd> @@ -389,7 +363,7 @@ AEAD Protected Data Packet</p></div> - <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key, streaming)</span><span class="type-signature"></span></h4> + <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key)</span><span class="type-signature"></span></h4> @@ -476,29 +450,6 @@ AEAD Protected Data Packet</p></div> </tr> - - <tr> - - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - - - - <td class="description last"><p>Whether the top-level function will return a stream</p></td> - </tr> - - </tbody> </table> @@ -538,7 +489,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L86">line 86</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L95">line 95</a> </li></ul></dd> @@ -603,7 +554,7 @@ AEAD Protected Data Packet</p></div> - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, streaming, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> @@ -711,37 +662,6 @@ AEAD Protected Data Packet</p></div> <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last"><p>Whether the top-level function will return a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -811,7 +731,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L104">line 104</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L107">line 107</a> </li></ul></dd> @@ -982,7 +902,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L56">line 56</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L66">line 66</a> </li></ul></dd> @@ -1072,7 +992,7 @@ AEAD Protected Data Packet</p></div> <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-1/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/aead_encrypted_data.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js">packet/aead_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/aead_encrypted_data.js#L84">line 84</a> </li></ul></dd> @@ -1143,7 +1063,7 @@ AEAD Protected Data Packet</p></div> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/CleartextMessage.html b/docs/CleartextMessage.html index c940e543..7918d80d 100644 --- a/docs/CleartextMessage.html +++ b/docs/CleartextMessage.html @@ -168,7 +168,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L35">line 35</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L38">line 38</a> </li></ul></dd> @@ -231,145 +231,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o - <h4 class="name" id=".fromText"><span class="type-signature">(static) </span>fromText<span class="signature">(text)</span><span class="type-signature"></span></h4> - - - - - - -<div class="description"> - <p>Creates a new CleartextMessage object from text</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>text</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> - - - - </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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L150">line 150</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - - - - - - - - - - - - - - - <h4 class="name" id="armor"><span class="type-signature"></span>armor<span class="signature">(config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {String|ReadableStream.<String>}</span></h4> @@ -485,7 +346,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L132">line 132</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L112">line 112</a> </li></ul></dd> @@ -546,7 +407,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o - <h4 class="name" id="getSigningKeyIds"><span class="type-signature"></span>getSigningKeyIds<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>>}</span></h4> + <h4 class="name" id="getSigningKeyIDs"><span class="type-signature"></span>getSigningKeyIDs<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>>}</span></h4> @@ -600,7 +461,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L48">line 48</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L51">line 51</a> </li></ul></dd> @@ -629,7 +490,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <div class="param-desc"> - <p>Array of keyid objects.</p> + <p>Array of keyID objects.</p> </div> @@ -640,7 +501,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o </dt> <dd> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> </dd> @@ -712,7 +573,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L122">line 122</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L102">line 102</a> </li></ul></dd> @@ -770,7 +631,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o - <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="CleartextMessage.html">CleartextMessage</a>}</span></h4> + <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIDs<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="CleartextMessage.html">CleartextMessage</a>>}</span></h4> @@ -892,13 +753,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <tr> - <td class="name"><code>signingKeyIds</code></td> + <td class="name"><code>signingKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -922,7 +783,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o </td> - <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIds[i] corresponds to privateKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]</p></td> </tr> @@ -966,7 +827,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -1076,7 +937,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L68">line 68</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L71">line 71</a> </li></ul></dd> @@ -1116,608 +977,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o </dt> <dd> -<span class="param-type"><a href="CleartextMessage.html">CleartextMessage</a></span> - - - </dd> -</dl> - - - - - - - - - - - - - - <h4 class="name" id="signDetached"><span class="type-signature">(async) </span>signDetached<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Signature.html">Signature</a>}</span></h4> - - - - - - -<div class="description"> - <p>Sign the cleartext message</p> -</div> - - - - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</th> - - - - <th>Default</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.<<a href="Key.html">Key</a>></span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>private keys with decrypted secret key data for signing</p></td> - </tr> - - - - <tr> - - <td class="name"><code>signature</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="Signature.html">Signature</a></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - null - - </td> - - - <td class="description last"><p>Any existing detached signature</p></td> - </tr> - - - - <tr> - - <td class="name"><code>signingKeyIds</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIds[i] corresponds to privateKeys[i]</p></td> - </tr> - - - - <tr> - - <td class="name"><code>date</code></td> - - - <td class="type"> - - -<span class="param-type">Date</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>The creation time of the signature that should be created</p></td> - </tr> - - - - <tr> - - <td class="name"><code>userIds</code></td> - - - <td class="type"> - - -<span class="param-type">Array</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>User IDs to sign with, e.g. [{ name:'Steve Sender', email:'steve@openpgp.org' }]</p></td> - </tr> - - - - <tr> - - <td class="name"><code>config</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L83">line 83</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - - - - -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>New detached signature of message content.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="Signature.html">Signature</a></span> - - - </dd> -</dl> - - - - - - - - - - - - - - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(keys, date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>}</span></h4> - - - - - - -<div class="description"> - <p>Verify signatures of cleartext signed message</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>keys</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<<a href="Key.html">Key</a>></span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last"><p>Array of keys to verify signatures</p></td> - </tr> - - - - <tr> - - <td class="name"><code>date</code></td> - - - <td class="type"> - - -<span class="param-type">Date</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>Verify the signature against the given date, i.e. check signature creation time < date < expiration time</p></td> - </tr> - - - - <tr> - - <td class="name"><code>config</code></td> - - - <td class="type"> - - -<span class="param-type">Object</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L98">line 98</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">Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}></span> +<span class="param-type">Promise.<<a href="CleartextMessage.html">CleartextMessage</a>></span> </dd> @@ -1735,7 +995,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o - <h4 class="name" id="verifyDetached"><span class="type-signature">(async) </span>verifyDetached<span class="signature">(keys, date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>}</span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(keys, date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>>}</span></h4> @@ -1914,7 +1174,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L110">line 110</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L90">line 90</a> </li></ul></dd> @@ -1943,7 +1203,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o <div class="param-desc"> - <p>List of signer's keyid and validity of signature.</p> + <p>List of signer's keyID and validity of signature.</p> </div> @@ -1954,7 +1214,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o </dt> <dd> -<span class="param-type">Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}></span> +<span class="param-type">Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>></span> </dd> @@ -1982,7 +1242,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-7">https://tools.ietf.o </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/CompressedDataPacket.html b/docs/CompressedDataPacket.html index 9eef81fa..10f34045 100644 --- a/docs/CompressedDataPacket.html +++ b/docs/CompressedDataPacket.html @@ -160,7 +160,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L44">line 44</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L54">line 54</a> </li></ul></dd> @@ -266,7 +266,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L64">line 64</a> </li></ul></dd> @@ -343,7 +343,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L65">line 65</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L70">line 70</a> </li></ul></dd> @@ -407,7 +407,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L70">line 70</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L75">line 75</a> </li></ul></dd> @@ -481,81 +481,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L54">line 54</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L49">line 49</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L59">line 59</a> </li></ul></dd> @@ -637,7 +563,7 @@ a Signature or One-Pass Signature packet, and contains a literal data packet.</p <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L124">line 124</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L125">line 125</a> </li></ul></dd> @@ -728,7 +654,7 @@ read by read_packet</p> <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L108">line 108</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L113">line 113</a> </li></ul></dd> @@ -870,7 +796,7 @@ read by read_packet</p> <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L77">line 77</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L82">line 82</a> </li></ul></dd> @@ -960,7 +886,7 @@ read by read_packet</p> <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-1/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/compressed_data.js#L95">line 95</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js">packet/compressed_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/compressed_data.js#L100">line 100</a> </li></ul></dd> @@ -1031,7 +957,7 @@ read by read_packet</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/Key.html b/docs/Key.html index bbbbde65..b3c93523 100644 --- a/docs/Key.html +++ b/docs/Key.html @@ -145,7 +145,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.</p></div> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L45">line 45</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L48">line 48</a> </li></ul></dd> @@ -201,7 +201,7 @@ Can contain additional subkeys, signatures, user ids, user attributes.</p></div> - <h4 class="name" id="addSubkey"><span class="type-signature">(async) </span>addSubkey<span class="signature">()</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="addSubkey"><span class="type-signature">(async) </span>addSubkey<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -446,7 +446,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L888">line 888</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L878">line 878</a> </li></ul></dd> @@ -482,7 +482,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -500,7 +500,7 @@ Supports RSA and ECC keys. Defaults to the algorithm and bit size/curve of the p - <h4 class="name" id="applyRevocationCertificate"><span class="type-signature">(async) </span>applyRevocationCertificate<span class="signature">(revocationCertificate, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="applyRevocationCertificate"><span class="type-signature">(async) </span>applyRevocationCertificate<span class="signature">(revocationCertificate, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -648,7 +648,7 @@ if it is a valid revocation signature.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L770">line 770</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L756">line 756</a> </li></ul></dd> @@ -688,7 +688,7 @@ if it is a valid revocation signature.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -821,7 +821,7 @@ if it is a valid revocation signature.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L267">line 267</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L296">line 296</a> </li></ul></dd> @@ -933,7 +933,7 @@ if it is a valid revocation signature.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L504">line 504</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L488">line 488</a> </li></ul></dd> @@ -969,7 +969,7 @@ if it is a valid revocation signature.</p> - <h4 class="name" id="clone"><span class="type-signature">(async) </span>clone<span class="signature">()</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="clone"><span class="type-signature">(async) </span>clone<span class="signature">(deep<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -988,118 +988,6 @@ if it is a valid revocation signature.</p> - - - - -<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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/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"><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 class="signature-attributes">opt</span>)</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> @@ -1129,88 +1017,13 @@ if it is a valid revocation signature.</p> <tr> - <td class="name"><code>passphrases</code></td> + <td class="name"><code>deep</code></td> <td class="type"> -<span class="param-type">String</span> -| - -<span class="param-type">Array.<String></span> - - - - </td> - - - <td class="attributes"> - - - - - - </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="attributes"> - - - - - - </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> +<span class="param-type">Boolean</span> @@ -1231,10 +1044,12 @@ if it is a valid revocation signature.</p> <td class="default"> + false + </td> - <td class="description last"><p>Full configuration, defaults to openpgp.config</p></td> + <td class="description last"><p>Whether to return a deep clone</p></td> </tr> @@ -1277,7 +1092,7 @@ if it is a valid revocation signature.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L420">line 420</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L166">line 166</a> </li></ul></dd> @@ -1300,303 +1115,35 @@ if it is a valid revocation signature.</p> -<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> - - - - - - - +<h5>Returns:</h5> - - - - - - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(passphrases, keyId, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> - - - - - - -<div class="description"> - <p>Encrypts all secret key and subkey packets matching keyId</p> +<div class="param-desc"> + <p>Clone of the key.</p> </div> - - - - - - - <h5>Parameters:</h5> - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Attributes</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.<String></span> - - - - </td> - - - <td class="attributes"> - - - - - - </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="attributes"> - - - - - - </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="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/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> + Type </dt> - <dd></dd> - <dt> - <dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type">Error</span> + <dd> + +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> - </dd> - </dl> - </dt> - <dd></dd> + </dd> </dl> - - - @@ -1657,7 +1204,7 @@ if it is a valid revocation signature.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -1769,7 +1316,7 @@ if it is a valid revocation signature.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -1881,7 +1428,7 @@ if it is a valid revocation signature.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -1989,7 +1536,7 @@ if it is a valid revocation signature.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -2043,7 +1590,7 @@ if it is a valid revocation signature.</p> - <h4 class="name" id="getDecryptionKeys"><span class="type-signature">(async) </span>getDecryptionKeys<span class="signature">(keyId,, date,, userId,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<(<a href="Key.html">Key</a>|SubKey)>}</span></h4> + <h4 class="name" id="getDecryptionKeys"><span class="type-signature">(async) </span>getDecryptionKeys<span class="signature">(keyID,, date,, userID,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<(<a href="Key.html">Key</a>|SubKey)>>}</span></h4> @@ -2051,7 +1598,7 @@ if it is a valid revocation signature.</p> <div class="description"> - <p>Returns all keys that are available for decryption, matching the keyId when given + <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> @@ -2090,13 +1637,13 @@ This is useful to retrieve keys for session key decryption</p> <tr> - <td class="name"><code>keyId,</code></td> + <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> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> @@ -2152,7 +1699,7 @@ This is useful to retrieve keys for session key decryption</p> <tr> - <td class="name"><code>userId,</code></td> + <td class="name"><code>userID,</code></td> <td class="type"> @@ -2252,7 +1799,7 @@ This is useful to retrieve keys for session key decryption</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L361">line 361</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L409">line 409</a> </li></ul></dd> @@ -2292,7 +1839,7 @@ This is useful to retrieve keys for session key decryption</p> </dt> <dd> -<span class="param-type">Array.<(<a href="Key.html">Key</a>|SubKey)></span> +<span class="param-type">Promise.<Array.<(<a href="Key.html">Key</a>|SubKey)>></span> </dd> @@ -2310,7 +1857,7 @@ This is useful to retrieve keys for session key decryption</p> - <h4 class="name" id="getEncryptionKey"><span class="type-signature">(async) </span>getEncryptionKey<span class="signature">(keyId,, date,, userId,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>|SubKey|null}</span></h4> + <h4 class="name" id="getEncryptionKey"><span class="type-signature">(async) </span>getEncryptionKey<span class="signature">(keyID,, date,, userID,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(<a href="Key.html">Key</a>|SubKey|null)>}</span></h4> @@ -2318,7 +1865,7 @@ This is useful to retrieve keys for session key decryption</p> <div class="description"> - <p>Returns last created key or key by given keyId that is available for encryption or decryption</p> + <p>Returns last created key or key by given keyID that is available for encryption or decryption</p> </div> @@ -2356,13 +1903,13 @@ This is useful to retrieve keys for session key decryption</p> <tr> - <td class="name"><code>keyId,</code></td> + <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> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> @@ -2418,7 +1965,7 @@ This is useful to retrieve keys for session key decryption</p> <tr> - <td class="name"><code>userId,</code></td> + <td class="name"><code>userID,</code></td> <td class="type"> @@ -2518,7 +2065,7 @@ This is useful to retrieve keys for session key decryption</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L322">line 322</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L363">line 363</a> </li></ul></dd> @@ -2558,13 +2105,7 @@ This is useful to retrieve keys for session key decryption</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> -| - -<span class="param-type">SubKey</span> -| - -<span class="param-type">null</span> +<span class="param-type">Promise.<(<a href="Key.html">Key</a>|SubKey|null)></span> </dd> @@ -2582,7 +2123,7 @@ This is useful to retrieve keys for session key decryption</p> - <h4 class="name" id="getExpirationTime"><span class="type-signature">(async) </span>getExpirationTime<span class="signature">(capabilities,, keyId,, userId,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Date|Infinity|null}</span></h4> + <h4 class="name" id="getExpirationTime"><span class="type-signature">(async) </span>getExpirationTime<span class="signature">(capabilities,, keyID,, userID,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(Date|Infinity|null)>}</span></h4> @@ -2668,13 +2209,13 @@ Returns Infinity if the key doesn't expire.</p> <tr> - <td class="name"><code>keyId,</code></td> + <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> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> @@ -2699,7 +2240,7 @@ Returns Infinity if the key doesn't expire.</p> <tr> - <td class="name"><code>userId,</code></td> + <td class="name"><code>userID,</code></td> <td class="type"> @@ -2799,7 +2340,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L568">line 568</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L552">line 552</a> </li></ul></dd> @@ -2835,13 +2376,7 @@ Returns Infinity if the key doesn't expire.</p> </dt> <dd> -<span class="param-type">Date</span> -| - -<span class="param-type">Infinity</span> -| - -<span class="param-type">null</span> +<span class="param-type">Promise.<(Date|Infinity|null)></span> </dd> @@ -2913,7 +2448,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -3025,7 +2560,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -3083,7 +2618,7 @@ Returns Infinity if the key doesn't expire.</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -3137,7 +2672,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -3177,7 +2712,7 @@ Returns Infinity if the key doesn't expire.</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -3195,7 +2730,7 @@ Returns Infinity if the key doesn't expire.</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -3249,7 +2784,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -3289,7 +2824,7 @@ Returns Infinity if the key doesn't expire.</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -3307,7 +2842,7 @@ Returns Infinity if the key doesn't expire.</p> - <h4 class="name" id="getKeyIds"><span class="type-signature"></span>getKeyIds<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>>}</span></h4> + <h4 class="name" id="getKeyIDs"><span class="type-signature"></span>getKeyIDs<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>>}</span></h4> @@ -3361,7 +2896,7 @@ Returns Infinity if the key doesn't expire.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L200">line 200</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L221">line 221</a> </li></ul></dd> @@ -3397,7 +2932,7 @@ Returns Infinity if the key doesn't expire.</p> </dt> <dd> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> </dd> @@ -3415,7 +2950,7 @@ Returns Infinity if the key doesn't expire.</p> - <h4 class="name" id="getKeys"><span class="type-signature"></span>getKeys<span class="signature">(keyId)</span><span class="type-signature"> → {Array.<(<a href="Key.html">Key</a>|SubKey)>}</span></h4> + <h4 class="name" id="getKeys"><span class="type-signature"></span>getKeys<span class="signature">(keyID)</span><span class="type-signature"> → {Array.<(<a href="Key.html">Key</a>|SubKey)>}</span></h4> @@ -3423,8 +2958,8 @@ Returns Infinity if the key doesn't expire.</p> <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> + <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> @@ -3462,7 +2997,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <tr> - <td class="name"><code>keyId</code></td> + <td class="name"><code>keyID</code></td> <td class="type"> @@ -3527,7 +3062,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L188">line 188</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L209">line 209</a> </li></ul></dd> @@ -3581,7 +3116,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> - <h4 class="name" id="getPrimaryUser"><span class="type-signature">(async) </span>getPrimaryUser<span class="signature">(date<span class="signature-attributes">opt</span>, userId<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{user: User, selfCertification: <a href="SignaturePacket.html">SignaturePacket</a>}>}</span></h4> + <h4 class="name" id="getPrimaryUser"><span class="type-signature">(async) </span>getPrimaryUser<span class="signature">(date<span class="signature-attributes">opt</span>, userID<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{user: User, selfCertification: <a href="SignaturePacket.html">SignaturePacket</a>}>}</span></h4> @@ -3664,7 +3199,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <tr> - <td class="name"><code>userId</code></td> + <td class="name"><code>userID</code></td> <td class="type"> @@ -3766,7 +3301,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L604">line 604</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L590">line 590</a> </li></ul></dd> @@ -3824,7 +3359,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> - <h4 class="name" id="getRevocationCertificate"><span class="type-signature">(async) </span>getRevocationCertificate<span class="signature">(date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {String}</span></h4> + <h4 class="name" id="getRevocationCertificate"><span class="type-signature">(async) </span>getRevocationCertificate<span class="signature">(date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<String>}</span></h4> @@ -3971,7 +3506,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L753">line 753</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L739">line 739</a> </li></ul></dd> @@ -4011,7 +3546,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> </dt> <dd> -<span class="param-type">String</span> +<span class="param-type">Promise.<String></span> </dd> @@ -4029,7 +3564,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> - <h4 class="name" id="getSigningKey"><span class="type-signature">(async) </span>getSigningKey<span class="signature">(keyId,, date<span class="signature-attributes">opt</span>, userId,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>|SubKey|null}</span></h4> + <h4 class="name" id="getSigningKey"><span class="type-signature">(async) </span>getSigningKey<span class="signature">(keyID,, date<span class="signature-attributes">opt</span>, userID,, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(<a href="Key.html">Key</a>|SubKey|null)>}</span></h4> @@ -4037,7 +3572,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <div class="description"> - <p>Returns last created key or key by given keyId that is available for signing and verification</p> + <p>Returns last created key or key by given keyID that is available for signing and verification</p> </div> @@ -4075,13 +3610,13 @@ If keyId is not present, returns all keys starting with the primary key.</p> <tr> - <td class="name"><code>keyId,</code></td> + <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> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> @@ -4139,7 +3674,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <tr> - <td class="name"><code>userId,</code></td> + <td class="name"><code>userID,</code></td> <td class="type"> @@ -4239,7 +3774,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L281">line 281</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L310">line 310</a> </li></ul></dd> @@ -4279,13 +3814,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> -| - -<span class="param-type">SubKey</span> -| - -<span class="param-type">null</span> +<span class="param-type">Promise.<(<a href="Key.html">Key</a>|SubKey|null)></span> </dd> @@ -4303,7 +3832,7 @@ If keyId is not present, returns all keys starting with the primary key.</p> - <h4 class="name" id="getSubkeys"><span class="type-signature"></span>getSubkeys<span class="signature">(keyId)</span><span class="type-signature"> → {Array.<SubKey>}</span></h4> + <h4 class="name" id="getSubkeys"><span class="type-signature"></span>getSubkeys<span class="signature">(keyID)</span><span class="type-signature"> → {Array.<SubKey>}</span></h4> @@ -4311,8 +3840,8 @@ If keyId is not present, returns all keys starting with the primary key.</p> <div class="description"> - <p>Returns an array containing all public or private subkeys matching keyId; -If keyId is not present, returns all subkeys.</p> + <p>Returns an array containing all public or private subkeys matching keyID; +If keyID is not present, returns all subkeys.</p> </div> @@ -4350,7 +3879,7 @@ If keyId is not present, returns all subkeys.</p> <tr> - <td class="name"><code>keyId</code></td> + <td class="name"><code>keyID</code></td> <td class="type"> @@ -4415,7 +3944,7 @@ If keyId is not present, returns all subkeys.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L172">line 172</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L193">line 193</a> </li></ul></dd> @@ -4469,7 +3998,7 @@ If keyId is not present, returns all subkeys.</p> - <h4 class="name" id="getUserIds"><span class="type-signature"></span>getUserIds<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> + <h4 class="name" id="getUserIDs"><span class="type-signature"></span>getUserIDs<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4> @@ -4477,7 +4006,7 @@ If keyId is not present, returns all subkeys.</p> <div class="description"> - <p>Returns userids</p> + <p>Returns userIDs</p> </div> @@ -4523,7 +4052,7 @@ If keyId is not present, returns all subkeys.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L208">line 208</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L229">line 229</a> </li></ul></dd> @@ -4552,7 +4081,7 @@ If keyId is not present, returns all subkeys.</p> <div class="param-desc"> - <p>Array of userids.</p> + <p>Array of userIDs.</p> </div> @@ -4635,7 +4164,7 @@ If keyId is not present, returns all subkeys.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -4747,7 +4276,7 @@ If keyId is not present, returns all subkeys.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -4860,7 +4389,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L454">line 454</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L438">line 438</a> </li></ul></dd> @@ -4950,7 +4479,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L226">line 226</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L247">line 247</a> </li></ul></dd> @@ -5058,7 +4587,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L218">line 218</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L239">line 239</a> </li></ul></dd> @@ -5112,7 +4641,7 @@ A dummy key is considered encrypted.</p> - <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(signature, key,, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(signature, key,, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -5329,7 +4858,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L527">line 527</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L511">line 511</a> </li></ul></dd> @@ -5369,7 +4898,7 @@ A dummy key is considered encrypted.</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -5490,7 +5019,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L72">line 72</a> </li></ul></dd> @@ -5526,7 +5055,7 @@ A dummy key is considered encrypted.</p> - <h4 class="name" id="revoke"><span class="type-signature">(async) </span>revoke<span class="signature">(reasonForRevocation, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="revoke"><span class="type-signature">(async) </span>revoke<span class="signature">(reasonForRevocation, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -5775,7 +5304,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L724">line 724</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L710">line 710</a> </li></ul></dd> @@ -5815,7 +5344,7 @@ A dummy key is considered encrypted.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -5833,7 +5362,7 @@ A dummy key is considered encrypted.</p> - <h4 class="name" id="signAllUsers"><span class="type-signature">(async) </span>signAllUsers<span class="signature">(privateKeys, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="signAllUsers"><span class="type-signature">(async) </span>signAllUsers<span class="signature">(privateKeys, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -5979,7 +5508,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L818">line 818</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L804">line 804</a> </li></ul></dd> @@ -6019,7 +5548,7 @@ A dummy key is considered encrypted.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -6037,7 +5566,7 @@ A dummy key is considered encrypted.</p> - <h4 class="name" id="signPrimaryUser"><span class="type-signature">(async) </span>signPrimaryUser<span class="signature">(privateKeys, date<span class="signature-attributes">opt</span>, userId<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="signPrimaryUser"><span class="type-signature">(async) </span>signPrimaryUser<span class="signature">(privateKeys, date<span class="signature-attributes">opt</span>, userID<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -6147,7 +5676,7 @@ A dummy key is considered encrypted.</p> <tr> - <td class="name"><code>userId</code></td> + <td class="name"><code>userID</code></td> <td class="type"> @@ -6249,7 +5778,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L803">line 803</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L789">line 789</a> </li></ul></dd> @@ -6289,7 +5818,7 @@ A dummy key is considered encrypted.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -6361,7 +5890,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L147">line 147</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L150">line 150</a> </li></ul></dd> @@ -6534,7 +6063,7 @@ A dummy key is considered encrypted.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L235">line 235</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L256">line 256</a> </li></ul></dd> @@ -6592,7 +6121,7 @@ A dummy key is considered encrypted.</p> - <h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {undefined}</span></h4> + <h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<undefined>}</span></h4> @@ -6742,7 +6271,7 @@ the destination key is transformed to a private key.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L659">line 659</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L645">line 645</a> </li></ul></dd> @@ -6778,7 +6307,7 @@ the destination key is transformed to a private key.</p> </dt> <dd> -<span class="param-type">undefined</span> +<span class="param-type">Promise.<undefined></span> </dd> @@ -6915,7 +6444,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L468">line 468</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L452">line 452</a> </li></ul></dd> @@ -6980,7 +6509,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err - <h4 class="name" id="verifyAllUsers"><span class="type-signature">(async) </span>verifyAllUsers<span class="signature">(keys, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{userid: String, keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>>}</span></h4> + <h4 class="name" id="verifyAllUsers"><span class="type-signature">(async) </span>verifyAllUsers<span class="signature">(keys, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{userID: String, keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>>}</span></h4> @@ -7130,7 +6659,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L858">line 858</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L848">line 848</a> </li></ul></dd> @@ -7159,7 +6688,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err <div class="param-desc"> - <p>list of userid, signer's keyid and validity of signature</p> + <p>List of userID, signer's keyID and validity of signature</p> </div> @@ -7170,7 +6699,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err </dt> <dd> -<span class="param-type">Promise.<Array.<{userid: String, keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>></span> +<span class="param-type">Promise.<Array.<{userID: String, keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>></span> </dd> @@ -7188,7 +6717,7 @@ If only gnu-dummy keys are found, we cannot properly validate so we throw an err - <h4 class="name" id="verifyPrimaryKey"><span class="type-signature">(async) </span>verifyPrimaryKey<span class="signature">(date<span class="signature-attributes">opt</span>, userId<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="verifyPrimaryKey"><span class="type-signature">(async) </span>verifyPrimaryKey<span class="signature">(date<span class="signature-attributes">opt</span>, userID<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> @@ -7268,7 +6797,7 @@ and valid self signature. Throws if the primary key is invalid.</p> <tr> - <td class="name"><code>userId</code></td> + <td class="name"><code>userID</code></td> <td class="type"> @@ -7370,7 +6899,7 @@ and valid self signature. Throws if the primary key is invalid.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L542">line 542</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L526">line 526</a> </li></ul></dd> @@ -7435,7 +6964,7 @@ and valid self signature. Throws if the primary key is invalid.</p> - <h4 class="name" id="verifyPrimaryUser"><span class="type-signature">(async) </span>verifyPrimaryUser<span class="signature">(keys, date<span class="signature-attributes">opt</span>, userId<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>>}</span></h4> + <h4 class="name" id="verifyPrimaryUser"><span class="type-signature">(async) </span>verifyPrimaryUser<span class="signature">(keys, date<span class="signature-attributes">opt</span>, userID<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>>}</span></h4> @@ -7549,7 +7078,7 @@ and valid self signature. Throws if the primary key is invalid.</p> <tr> - <td class="name"><code>userId</code></td> + <td class="name"><code>userID</code></td> <td class="type"> @@ -7651,7 +7180,119 @@ and valid self signature. Throws if the primary key is invalid.</p> <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-1/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/key.js#L839">line 839</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L827">line 827</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.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4> + + + + + + +<div class="description"> + <p>Returns binary encoded 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-2/src/key/key.js">key/key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/key.js#L287">line 287</a> </li></ul></dd> @@ -7680,7 +7321,7 @@ and valid self signature. Throws if the primary key is invalid.</p> <div class="param-desc"> - <p>List of signer's keyid and validity of signature</p> + <p>Binary key.</p> </div> @@ -7691,7 +7332,7 @@ and valid self signature. Throws if the primary key is invalid.</p> </dt> <dd> -<span class="param-type">Promise.<Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>></span> +<span class="param-type">Uint8Array</span> </dd> @@ -7719,7 +7360,7 @@ and valid self signature. Throws if the primary key is invalid.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/LiteralDataPacket.html b/docs/LiteralDataPacket.html index a7a06837..91c7e7a2 100644 --- a/docs/LiteralDataPacket.html +++ b/docs/LiteralDataPacket.html @@ -147,7 +147,7 @@ further interpreted.</p></div> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L33">line 33</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L37">line 37</a> </li></ul></dd> @@ -326,7 +326,7 @@ further interpreted.</p></div> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L87">line 87</a> </li></ul></dd> @@ -441,7 +441,7 @@ further interpreted.</p></div> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L109">line 109</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L112">line 112</a> </li></ul></dd> @@ -623,7 +623,7 @@ with normalized end of line to \n</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L60">line 60</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L63">line 63</a> </li></ul></dd> @@ -684,7 +684,7 @@ with normalized end of line to \n</p> - <h4 class="name" id="read"><span class="type-signature">(async) </span>read<span class="signature">(input)</span><span class="type-signature"> → {<a href="LiteralDataPacket.html">LiteralDataPacket</a>}</span></h4> + <h4 class="name" id="read"><span class="type-signature">(async) </span>read<span class="signature">(input)</span><span class="type-signature"> → {Promise.<<a href="LiteralDataPacket.html">LiteralDataPacket</a>>}</span></h4> @@ -790,7 +790,7 @@ with normalized end of line to \n</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L120">line 120</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L123">line 123</a> </li></ul></dd> @@ -830,7 +830,7 @@ with normalized end of line to \n</p> </dt> <dd> -<span class="param-type"><a href="LiteralDataPacket.html">LiteralDataPacket</a></span> +<span class="param-type">Promise.<<a href="LiteralDataPacket.html">LiteralDataPacket</a>></span> </dd> @@ -986,7 +986,7 @@ with normalized end of line to \n</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L72">line 72</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L75">line 75</a> </li></ul></dd> @@ -1125,7 +1125,7 @@ with normalized end of line to \n</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L100">line 100</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L103">line 103</a> </li></ul></dd> @@ -1332,7 +1332,7 @@ will be normalized to \r\n and by default text is converted to UTF8</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L48">line 48</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L51">line 51</a> </li></ul></dd> @@ -1422,7 +1422,7 @@ will be normalized to \r\n and by default text is converted to UTF8</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L156">line 156</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L159">line 159</a> </li></ul></dd> @@ -1537,7 +1537,7 @@ will be normalized to \r\n and by default text is converted to UTF8</p> <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-1/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/literal_data.js#L141">line 141</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/literal_data.js#L144">line 144</a> </li></ul></dd> @@ -1605,7 +1605,7 @@ will be normalized to \r\n and by default text is converted to UTF8</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/MarkerPacket.html b/docs/MarkerPacket.html index 96e4b316..a6173698 100644 --- a/docs/MarkerPacket.html +++ b/docs/MarkerPacket.html @@ -101,7 +101,7 @@ the Marker packet.</p> <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-1/src/packet/marker.js">packet/marker.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/marker.js#L34">line 34</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/marker.js">packet/marker.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/marker.js#L33">line 33</a> </li></ul></dd> @@ -307,7 +307,7 @@ input at position</p></td> <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-1/src/packet/marker.js">packet/marker.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/marker.js#L49">line 49</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/marker.js">packet/marker.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/marker.js#L49">line 49</a> </li></ul></dd> @@ -375,7 +375,7 @@ input at position</p></td> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/Message.html b/docs/Message.html index e7b8ec32..4490019a 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -146,7 +146,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L50">line 50</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L66">line 66</a> </li></ul></dd> @@ -209,7 +209,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id=".encryptSessionKey"><span class="type-signature">(async, static) </span>encryptSessionKey<span class="signature">(sessionKey, algorithm, aeadAlgorithm<span class="signature-attributes">opt</span>, publicKeys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, wildcard<span class="signature-attributes">opt</span>, encryptionKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id=".encryptSessionKey"><span class="type-signature">(async, static) </span>encryptSessionKey<span class="signature">(sessionKey, algorithm, aeadAlgorithm<span class="signature-attributes">opt</span>, publicKeys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, wildcard<span class="signature-attributes">opt</span>, encryptionKeyIDs<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> @@ -357,7 +357,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </td> - <td class="description last"><p>Aead algorithm, e.g. 'eax' or 'ocb'</p></td> + <td class="description last"><p>AEAD algorithm, e.g. 'eax' or 'ocb'</p></td> </tr> @@ -477,13 +477,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>encryptionKeyIds</code></td> + <td class="name"><code>encryptionKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -507,7 +507,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </td> - <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIds[i] corresponds to publicKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]</p></td> </tr> @@ -551,7 +551,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -661,7 +661,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L356">line 356</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L373">line 373</a> </li></ul></dd> @@ -701,7 +701,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> </dd> @@ -719,7 +719,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id=".fromBinary"><span class="type-signature">(static) </span>fromBinary<span class="signature">(bytes, filename<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id=".generateSessionKey"><span class="type-signature">(async, static) </span>generateSessionKey<span class="signature">(keys<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<{data: Uint8Array, algorithm: String}>}</span></h4> @@ -727,7 +727,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="description"> - <p>Creates new message object from binary data.</p> + <p>Generate a new session key object, taking the algorithm preferences of the passed public keys into account, if any.</p> </div> @@ -755,8 +755,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <th>Default</th> - <th class="last">Description</th> </tr> @@ -767,16 +765,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>bytes</code></td> + <td class="name"><code>keys</code></td> <td class="type"> -<span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> +<span class="param-type">Array.<<a href="Key.html">Key</a>></span> @@ -785,6 +780,8 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <td class="attributes"> + <optional><br> + @@ -793,25 +790,21 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <td class="default"> - - </td> - - <td class="description last"><p>The message contents</p></td> + <td class="description last"><p>Public key(s) to select algorithm preferences for</p></td> </tr> <tr> - <td class="name"><code>filename</code></td> + <td class="name"><code>date</code></td> <td class="type"> -<span class="param-type">String</span> +<span class="param-type">Date</span> @@ -830,27 +823,21 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <td class="default"> - - "" - - </td> - - <td class="description last"><p>Name of the file (if any)</p></td> + <td class="description last"><p>Date to select algorithm preferences at</p></td> </tr> <tr> - <td class="name"><code>date</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> -<span class="param-type">Date</span> +<span class="param-type">Array.<Object></span> @@ -869,36 +856,21 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <td class="default"> - - current date - - </td> - - <td class="description last"><p>Date of the message, or modification date of the file</p></td> + <td class="description last"><p>User IDs to select algorithm preferences for</p></td> </tr> <tr> - <td class="name"><code>type</code></td> + <td class="name"><code>config</code></td> <td class="type"> -<span class="param-type">'utf8'</span> -| - -<span class="param-type">'binary'</span> -| - -<span class="param-type">'text'</span> -| - -<span class="param-type">'mime'</span> +<span class="param-type">Object</span> @@ -917,14 +889,8 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <td class="default"> - - 'binary' - - </td> - - <td class="description last"><p>Data packet type</p></td> + <td class="description last"><p>Full configuration, defaults to openpgp.config</p></td> </tr> @@ -967,7 +933,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L663">line 663</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L302">line 302</a> </li></ul></dd> @@ -996,7 +962,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>New message object.</p> + <p>Object with session key data and algorithm.</p> </div> @@ -1007,7 +973,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<{data: Uint8Array, algorithm: String}></span> </dd> @@ -1025,7 +991,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id=".fromText"><span class="type-signature">(static) </span>fromText<span class="signature">(text, filename<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id="appendSignature"><span class="type-signature">(async) </span>appendSignature<span class="signature">(detachedSignature)</span><span class="type-signature"></span></h4> @@ -1033,7 +999,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="description"> - <p>Creates new message object from text.</p> + <p>Append signature to unencrypted message object</p> </div> @@ -1057,12 +1023,8 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <th>Type</th> - <th>Attributes</th> - - <th>Default</th> - <th class="last">Description</th> </tr> @@ -1073,164 +1035,26 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>text</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>The message contents</p></td> - </tr> - - - - <tr> - - <td class="name"><code>filename</code></td> + <td class="name"><code>detachedSignature</code></td> <td class="type"> <span class="param-type">String</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - "" - - </td> - - - <td class="description last"><p>Name of the file (if any)</p></td> - </tr> - - - - <tr> - - <td class="name"><code>date</code></td> - - - <td class="type"> - - -<span class="param-type">Date</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - current date - - </td> - - - <td class="description last"><p>Date of the message, or modification date of the file</p></td> - </tr> - - - - <tr> - - <td class="name"><code>type</code></td> - - - <td class="type"> - - -<span class="param-type">'utf8'</span> -| - -<span class="param-type">'binary'</span> -| - -<span class="param-type">'text'</span> | -<span class="param-type">'mime'</span> +<span class="param-type">Uint8Array</span> </td> - <td class="attributes"> - - <optional><br> - - - - - - </td> - - <td class="default"> - - 'utf8' - - </td> - - <td class="description last"><p>Data packet type</p></td> + <td class="description last"><p>The detached ASCII-armored or Uint8Array PGP signature</p></td> </tr> @@ -1273,7 +1097,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L636">line 636</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L630">line 630</a> </li></ul></dd> @@ -1298,28 +1122,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet -<h5>Returns:</h5> - - -<div class="param-desc"> - <p>New message object.</p> -</div> - - - -<dl> - <dt> - Type - </dt> - <dd> - -<span class="param-type"><a href="Message.html">Message</a></span> - - - </dd> -</dl> - - @@ -1331,7 +1133,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id=".generateSessionKey"><span class="type-signature">(async, static) </span>generateSessionKey<span class="signature">(keys<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="armor"><span class="type-signature"></span>armor<span class="signature">(config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ReadableStream.<String>}</span></h4> @@ -1339,7 +1141,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="description"> - <p>Generate a new session key object, taking the algorithm preferences of the passed public keys into account, if any.</p> + <p>Returns ASCII armored text of message</p> </div> @@ -1377,105 +1179,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>keys</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<<a href="Key.html">Key</a>></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>Public key(s) to select algorithm preferences for</p></td> - </tr> - - - - <tr> - - <td class="name"><code>date</code></td> - - - <td class="type"> - - -<span class="param-type">Date</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>Date to select algorithm preferences at</p></td> - </tr> - - - - <tr> - - <td class="name"><code>userIds</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<Object></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>User IDs to select algorithm preferences for</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -1545,7 +1248,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L285">line 285</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L650">line 650</a> </li></ul></dd> @@ -1574,7 +1277,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>Object with session key data and algorithm.</p> + <p>ASCII armor.</p> </div> @@ -1585,7 +1288,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">ReadableStream.<String></span> </dd> @@ -1603,7 +1306,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="appendSignature"><span class="type-signature">(async) </span>appendSignature<span class="signature">(detachedSignature)</span><span class="type-signature"></span></h4> + <h4 class="name" id="compress"><span class="type-signature"></span>compress<span class="signature">(algo, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> @@ -1611,149 +1314,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="description"> - <p>Append signature to unencrypted message object</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>detachedSignature</code></td> - - - <td class="type"> - - -<span class="param-type">String</span> -| - -<span class="param-type">Uint8Array</span> - - - - </td> - - - - - - <td class="description last"><p>The detached ASCII-armored or Uint8Array PGP signature</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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L606">line 606</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - - - - - - - - - - - - - - - - - - - - <h4 class="name" id="armor"><span class="type-signature"></span>armor<span class="signature">(config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {ReadableStream.<String>}</span></h4> - - - - - - -<div class="description"> - <p>Returns ASCII armored text of message</p> + <p>Compresses the message (the literal and -if signed- signature data packets of the message)</p> </div> @@ -1791,13 +1352,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>config</code></td> + <td class="name"><code>algo</code></td> <td class="type"> -<span class="param-type">Object</span> +<span class="param-type"><a href="module-enums.html#.compression">module:enums.compression</a></span> @@ -1806,8 +1367,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <td class="attributes"> - <optional><br> - @@ -1817,150 +1376,10 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <td class="description last"><p>Full configuration, defaults to openpgp.config</p></td> + <td class="description last"><p>compression algorithm</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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L623">line 623</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.<String></span> - - - </dd> -</dl> - - - - - - - - - - - - - - <h4 class="name" id="compress"><span class="type-signature"></span>compress<span class="signature">(config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> - - - - - - -<div class="description"> - <p>Compresses the message (the literal and -if signed- signature data packets of the message)</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> @@ -2033,7 +1452,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L484">line 484</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L501">line 501</a> </li></ul></dd> @@ -2091,7 +1510,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(privateKeys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, sessionKeys<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(privateKeys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, sessionKeys<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> @@ -2236,39 +1655,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -2338,7 +1724,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L99">line 99</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L114">line 114</a> </li></ul></dd> @@ -2378,7 +1764,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> </dd> @@ -2577,7 +1963,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L150">line 150</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L167">line 167</a> </li></ul></dd> @@ -2635,7 +2021,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(keys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, sessionKey<span class="signature-attributes">opt</span>, wildcard<span class="signature-attributes">opt</span>, encryptionKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(keys<span class="signature-attributes">opt</span>, passwords<span class="signature-attributes">opt</span>, sessionKey<span class="signature-attributes">opt</span>, wildcard<span class="signature-attributes">opt</span>, encryptionKeyIDs<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> @@ -2833,13 +2219,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>encryptionKeyIds</code></td> + <td class="name"><code>encryptionKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -2863,7 +2249,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </td> - <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIds[i] corresponds to publicKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]</p></td> </tr> @@ -2907,7 +2293,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -2944,43 +2330,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - </td> - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -3054,7 +2403,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L308">line 308</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L325">line 325</a> </li></ul></dd> @@ -3094,7 +2443,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> </dd> @@ -3112,7 +2461,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="getEncryptionKeyIds"><span class="type-signature"></span>getEncryptionKeyIds<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>>}</span></h4> + <h4 class="name" id="getEncryptionKeyIDs"><span class="type-signature"></span>getEncryptionKeyIDs<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>>}</span></h4> @@ -3166,7 +2515,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L58">line 58</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L74">line 74</a> </li></ul></dd> @@ -3195,7 +2544,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>Array of keyid objects.</p> + <p>Array of keyID objects.</p> </div> @@ -3206,7 +2555,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> </dd> @@ -3278,7 +2627,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L257">line 257</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L274">line 274</a> </li></ul></dd> @@ -3393,7 +2742,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L247">line 247</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L264">line 264</a> </li></ul></dd> @@ -3454,7 +2803,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="getSigningKeyIds"><span class="type-signature"></span>getSigningKeyIds<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>>}</span></h4> + <h4 class="name" id="getSigningKeyIDs"><span class="type-signature"></span>getSigningKeyIDs<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>>}</span></h4> @@ -3508,7 +2857,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L71">line 71</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L87">line 87</a> </li></ul></dd> @@ -3537,7 +2886,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>Array of keyid objects.</p> + <p>Array of keyID objects.</p> </div> @@ -3548,7 +2897,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> </dd> @@ -3620,7 +2969,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L267">line 267</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L284">line 284</a> </li></ul></dd> @@ -3681,7 +3030,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIDs<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> @@ -3803,13 +3152,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>signingKeyIds</code></td> + <td class="name"><code>signingKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -3833,7 +3182,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </td> - <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIds[i] corresponds to privateKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]</p></td> </tr> @@ -3877,7 +3226,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -3914,45 +3263,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - false - - </td> - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -4026,7 +3336,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L424">line 424</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L440">line 440</a> </li></ul></dd> @@ -4066,7 +3376,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> </dd> @@ -4084,7 +3394,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="signDetached"><span class="type-signature">(async) </span>signDetached<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIds<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIds<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="Signature.html">Signature</a>}</span></h4> + <h4 class="name" id="signDetached"><span class="type-signature">(async) </span>signDetached<span class="signature">(privateKeys, signature<span class="signature-attributes">opt</span>, signingKeyIDs<span class="signature-attributes">opt</span>, date<span class="signature-attributes">opt</span>, userIDs<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="Signature.html">Signature</a>>}</span></h4> @@ -4206,13 +3516,13 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>signingKeyIds</code></td> + <td class="name"><code>signingKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -4236,7 +3546,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </td> - <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIds[i] corresponds to privateKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]</p></td> </tr> @@ -4280,7 +3590,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -4317,45 +3627,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - false - - </td> - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -4429,7 +3700,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L510">line 510</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L527">line 527</a> </li></ul></dd> @@ -4469,7 +3740,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type"><a href="Signature.html">Signature</a></span> +<span class="param-type">Promise.<<a href="Signature.html">Signature</a>></span> </dd> @@ -4541,7 +3812,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L594">line 594</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L618">line 618</a> </li></ul></dd> @@ -4599,7 +3870,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(keys, date<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<({keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean})>}</span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(keys, date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>>}</span></h4> @@ -4709,39 +3980,6 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -4811,7 +4049,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L527">line 527</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L547">line 547</a> </li></ul></dd> @@ -4840,7 +4078,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>List of signer's keyid and validity of signature.</p> + <p>List of signer's keyID and validity of signatures.</p> </div> @@ -4851,7 +4089,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type">Array.<({keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean})></span> +<span class="param-type">Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>></span> </dd> @@ -4869,7 +4107,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet - <h4 class="name" id="verifyDetached"><span class="type-signature">(async) </span>verifyDetached<span class="signature">(keys, signature, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Array.<({keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean})>}</span></h4> + <h4 class="name" id="verifyDetached"><span class="type-signature">(async) </span>verifyDetached<span class="signature">(keys, signature, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>>}</span></h4> @@ -5077,7 +4315,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L580">line 580</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L604">line 604</a> </li></ul></dd> @@ -5106,7 +4344,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <div class="param-desc"> - <p>List of signer's keyid and validity of signature.</p> + <p>List of signer's keyID and validity of signature.</p> </div> @@ -5117,7 +4355,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </dt> <dd> -<span class="param-type">Array.<({keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean})></span> +<span class="param-type">Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, signature: Promise.<<a href="Signature.html">Signature</a>>, verified: Promise.<Boolean>}>></span> </dd> @@ -5189,7 +4427,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L614">line 614</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L641">line 641</a> </li></ul></dd> @@ -5257,7 +4495,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-11.3">https://tools.iet </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/OnePassSignaturePacket.html b/docs/OnePassSignaturePacket.html index e3eaf759..f33797b0 100644 --- a/docs/OnePassSignaturePacket.html +++ b/docs/OnePassSignaturePacket.html @@ -101,7 +101,7 @@ can compute the entire signed message in one pass.</p></div> <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L35">line 35</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L39">line 39</a> </li></ul></dd> @@ -199,7 +199,7 @@ that describes another signature to be applied to the same message data.</p> <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L66">line 66</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L65">line 65</a> </li></ul></dd> @@ -263,7 +263,7 @@ that describes another signature to be applied to the same message data.</p> <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L53">line 53</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L52">line 52</a> </li></ul></dd> @@ -288,7 +288,7 @@ that describes another signature to be applied to the same message data.</p> -<h4 class="name" id="issuerKeyId"><span class="type-signature"></span>issuerKeyId<span class="type-signature"></span></h4> +<h4 class="name" id="issuerKeyID"><span class="type-signature"></span>issuerKeyID<span class="type-signature"></span></h4> @@ -334,7 +334,7 @@ that describes another signature to be applied to the same message data.</p> <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L60">line 60</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L59">line 59</a> </li></ul></dd> @@ -398,7 +398,7 @@ that describes another signature to be applied to the same message data.</p> <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L58">line 58</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L57">line 57</a> </li></ul></dd> @@ -471,81 +471,7 @@ Signature types are described in <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L48">line 48</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L47">line 47</a> </li></ul></dd> @@ -609,7 +535,7 @@ Signature types are described in <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L42">line 42</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L41">line 41</a> </li></ul></dd> @@ -740,7 +666,7 @@ Signature types are described in <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L73">line 73</a> </li></ul></dd> @@ -852,7 +778,7 @@ Signature types are described in <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-1/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/one_pass_signature.js#L106">line 106</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js">packet/one_pass_signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/one_pass_signature.js#L105">line 105</a> </li></ul></dd> @@ -920,7 +846,7 @@ Signature types are described in </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/PacketList.html b/docs/PacketList.html index cf0b2f3a..ce15ca72 100644 --- a/docs/PacketList.html +++ b/docs/PacketList.html @@ -97,7 +97,7 @@ are stored as numerical indices.</p></div> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L18">line 18</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L31">line 31</a> </li></ul></dd> @@ -218,7 +218,7 @@ are stored as numerical indices.</p></div> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L178">line 178</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L190">line 190</a> </li></ul></dd> @@ -308,7 +308,7 @@ are stored as numerical indices.</p></div> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L135">line 135</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L147">line 147</a> </li></ul></dd> @@ -447,7 +447,7 @@ are stored as numerical indices.</p></div> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L154">line 154</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L166">line 166</a> </li></ul></dd> @@ -558,7 +558,7 @@ are stored as numerical indices.</p></div> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L161">line 161</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L173">line 173</a> </li></ul></dd> @@ -698,7 +698,7 @@ writing to packetlist[i] directly will result in an error.</p> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L122">line 122</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L134">line 134</a> </li></ul></dd> @@ -840,7 +840,7 @@ writing to packetlist[i] directly will result in an error.</p> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L23">line 23</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L36">line 36</a> </li></ul></dd> @@ -931,7 +931,7 @@ class instance.</p> <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-1/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/packetlist.js#L79">line 79</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L91">line 91</a> </li></ul></dd> @@ -999,7 +999,7 @@ class instance.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/PublicKeyEncryptedSessionKeyPacket.html b/docs/PublicKeyEncryptedSessionKeyPacket.html index df3875ef..0d71b39d 100644 --- a/docs/PublicKeyEncryptedSessionKeyPacket.html +++ b/docs/PublicKeyEncryptedSessionKeyPacket.html @@ -107,7 +107,7 @@ decrypt the message.</p></div> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L44">line 44</a> </li></ul></dd> @@ -209,7 +209,7 @@ decrypt the message.</p></div> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L51">line 51</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L54">line 54</a> </li></ul></dd> @@ -237,7 +237,7 @@ decrypt the message.</p></div> - <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(key)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(key)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -341,7 +341,7 @@ packets (tag 1)</p> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L113">line 113</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L116">line 116</a> </li></ul></dd> @@ -377,7 +377,7 @@ packets (tag 1)</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -395,7 +395,7 @@ packets (tag 1)</p> - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(key)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(key)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -498,7 +498,7 @@ packets (tag 1)</p> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L92">line 92</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L95">line 95</a> </li></ul></dd> @@ -534,7 +534,7 @@ packets (tag 1)</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -655,7 +655,7 @@ packets (tag 1)</p> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L62">line 62</a> </li></ul></dd> @@ -745,7 +745,7 @@ packets (tag 1)</p> <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-1/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key_encrypted_session_key.js#L73">line 73</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js">packet/public_key_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key_encrypted_session_key.js#L76">line 76</a> </li></ul></dd> @@ -813,7 +813,7 @@ packets (tag 1)</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/PublicKeyPacket.html b/docs/PublicKeyPacket.html index ca2fb3e6..8e2c76f6 100644 --- a/docs/PublicKeyPacket.html +++ b/docs/PublicKeyPacket.html @@ -195,7 +195,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L44">line 44</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L48">line 48</a> </li></ul></dd> @@ -301,7 +301,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L63">line 63</a> </li></ul></dd> @@ -375,7 +375,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L58">line 58</a> </li></ul></dd> @@ -449,7 +449,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L73">line 73</a> </li></ul></dd> @@ -523,7 +523,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L79">line 79</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L78">line 78</a> </li></ul></dd> @@ -541,13 +541,13 @@ key (sometimes called an OpenPGP certificate).</p></div> -<h4 class="name" id="keyid"><span class="type-signature"></span>keyid<span class="type-signature"> :<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span></h4> +<h4 class="name" id="keyID"><span class="type-signature"></span>keyID<span class="type-signature"> :<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span></h4> <div class="description"> - <p>Keyid</p> + <p>KeyID</p> </div> @@ -556,7 +556,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <ul> <li> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </li> @@ -597,7 +597,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L83">line 83</a> </li></ul></dd> @@ -671,7 +671,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L68">line 68</a> </li></ul></dd> @@ -735,7 +735,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L249">line 249</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L248">line 248</a> </li></ul></dd> @@ -760,80 +760,6 @@ key (sometimes called an OpenPGP certificate).</p></div> -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L49">line 49</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - <h4 class="name" id="version"><span class="type-signature"></span>version<span class="type-signature"> :Integer</span></h4> @@ -890,7 +816,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L53">line 53</a> </li></ul></dd> @@ -954,7 +880,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L255">line 255</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L254">line 254</a> </li></ul></dd> @@ -1043,7 +969,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -1155,7 +1081,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -1263,7 +1189,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -1375,7 +1301,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L198">line 198</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L197">line 197</a> </li></ul></dd> @@ -1433,7 +1359,7 @@ key (sometimes called an OpenPGP certificate).</p></div> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -1487,7 +1413,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -1527,7 +1453,7 @@ key (sometimes called an OpenPGP certificate).</p></div> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -1599,7 +1525,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -1711,7 +1637,7 @@ key (sometimes called an OpenPGP certificate).</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L165">line 165</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L164">line 164</a> </li></ul></dd> @@ -1872,7 +1798,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L93">line 93</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L92">line 92</a> </li></ul></dd> @@ -1984,7 +1910,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L130">line 130</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L129">line 129</a> </li></ul></dd> @@ -2096,7 +2022,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L152">line 152</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L151">line 151</a> </li></ul></dd> @@ -2142,7 +2068,7 @@ called by read_tag<num></p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/PublicSubkeyPacket.html b/docs/PublicSubkeyPacket.html index 1cc129b0..59e06c91 100644 --- a/docs/PublicSubkeyPacket.html +++ b/docs/PublicSubkeyPacket.html @@ -193,7 +193,7 @@ services.</p></div> <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-1/src/packet/public_subkey.js">packet/public_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_subkey.js#L34">line 34</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_subkey.js">packet/public_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_subkey.js#L39">line 39</a> </li></ul></dd> @@ -315,7 +315,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L63">line 63</a> </li></ul></dd> @@ -394,7 +394,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L58">line 58</a> </li></ul></dd> @@ -473,7 +473,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L73">line 73</a> </li></ul></dd> @@ -552,7 +552,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L79">line 79</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L78">line 78</a> </li></ul></dd> @@ -570,13 +570,13 @@ services.</p></div> -<h4 class="name" id="keyid"><span class="type-signature"></span>keyid<span class="type-signature"> :<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span></h4> +<h4 class="name" id="keyID"><span class="type-signature"></span>keyID<span class="type-signature"> :<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span></h4> <div class="description"> - <p>Keyid</p> + <p>KeyID</p> </div> @@ -585,7 +585,7 @@ services.</p></div> <ul> <li> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </li> @@ -606,7 +606,7 @@ services.</p></div> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#keyid">PublicKeyPacket#keyid</a> + <a href="PublicKeyPacket.html#keyID">PublicKeyPacket#keyID</a> </li></ul></dd> @@ -631,7 +631,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L83">line 83</a> </li></ul></dd> @@ -710,7 +710,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L68">line 68</a> </li></ul></dd> @@ -779,7 +779,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L249">line 249</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L248">line 248</a> </li></ul></dd> @@ -804,85 +804,6 @@ services.</p></div> -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<dl class="details"> - - - - - - - - - <dt class="tag-overrides">Overrides:</dt> - <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#tag">PublicKeyPacket#tag</a> - </li></ul></dd> - - - - - - - - - - - - - - - - - - - - - - <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L49">line 49</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - <h4 class="name" id="version"><span class="type-signature"></span>version<span class="type-signature"> :Integer</span></h4> @@ -944,7 +865,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L53">line 53</a> </li></ul></dd> @@ -1013,7 +934,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L255">line 255</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L254">line 254</a> </li></ul></dd> @@ -1107,7 +1028,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -1224,7 +1145,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -1337,7 +1258,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -1454,7 +1375,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L198">line 198</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L197">line 197</a> </li></ul></dd> @@ -1512,7 +1433,7 @@ services.</p></div> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -1546,7 +1467,7 @@ services.</p></div> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#getKeyId">PublicKeyPacket#getKeyId</a> + <a href="PublicKeyPacket.html#getKeyID">PublicKeyPacket#getKeyID</a> </li></ul></dd> @@ -1571,7 +1492,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -1611,7 +1532,7 @@ services.</p></div> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -1688,7 +1609,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -1805,7 +1726,7 @@ services.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L165">line 165</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L164">line 164</a> </li></ul></dd> @@ -1971,7 +1892,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L93">line 93</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L92">line 92</a> </li></ul></dd> @@ -2088,7 +2009,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L130">line 130</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L129">line 129</a> </li></ul></dd> @@ -2205,7 +2126,7 @@ called by read_tag<num></p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L152">line 152</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L151">line 151</a> </li></ul></dd> @@ -2251,7 +2172,7 @@ called by read_tag<num></p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SecretKeyPacket.html b/docs/SecretKeyPacket.html index d32f44d1..0fb8dee8 100644 --- a/docs/SecretKeyPacket.html +++ b/docs/SecretKeyPacket.html @@ -191,7 +191,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L36">line 36</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L40">line 40</a> </li></ul></dd> @@ -308,7 +308,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L70">line 70</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L69">line 69</a> </li></ul></dd> @@ -387,7 +387,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L63">line 63</a> </li></ul></dd> @@ -466,7 +466,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L58">line 58</a> </li></ul></dd> @@ -545,7 +545,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L73">line 73</a> </li></ul></dd> @@ -624,7 +624,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L79">line 79</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L78">line 78</a> </li></ul></dd> @@ -688,7 +688,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L50">line 50</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L49">line 49</a> </li></ul></dd> @@ -706,13 +706,13 @@ includes the secret-key material after all the public-key fields.</p></div> -<h4 class="name" id="keyid"><span class="type-signature"></span>keyid<span class="type-signature"> :<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span></h4> +<h4 class="name" id="keyID"><span class="type-signature"></span>keyID<span class="type-signature"> :<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span></h4> <div class="description"> - <p>Keyid</p> + <p>KeyID</p> </div> @@ -721,7 +721,7 @@ includes the secret-key material after all the public-key fields.</p></div> <ul> <li> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </li> @@ -742,7 +742,7 @@ includes the secret-key material after all the public-key fields.</p></div> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#keyid">PublicKeyPacket#keyid</a> + <a href="PublicKeyPacket.html#keyID">PublicKeyPacket#keyID</a> </li></ul></dd> @@ -767,7 +767,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L83">line 83</a> </li></ul></dd> @@ -831,7 +831,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L46">line 46</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L45">line 45</a> </li></ul></dd> @@ -905,7 +905,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L75">line 75</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L74">line 74</a> </li></ul></dd> @@ -984,7 +984,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L68">line 68</a> </li></ul></dd> @@ -1053,7 +1053,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L249">line 249</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L248">line 248</a> </li></ul></dd> @@ -1134,7 +1134,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L60">line 60</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L59">line 59</a> </li></ul></dd> @@ -1152,7 +1152,7 @@ includes the secret-key material after all the public-key fields.</p></div> -<h4 class="name" id="s2k_usage"><span class="type-signature"></span>s2k_usage<span class="type-signature"> :Integer</span></h4> +<h4 class="name" id="s2kUsage"><span class="type-signature"></span>s2kUsage<span class="type-signature"> :Integer</span></h4> @@ -1208,7 +1208,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L55">line 55</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L54">line 54</a> </li></ul></dd> @@ -1282,86 +1282,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L65">line 65</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<dl class="details"> - - - - - - - - - <dt class="tag-overrides">Overrides:</dt> - <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#tag">PublicKeyPacket#tag</a> - </li></ul></dd> - - - - - - - - - - - - - - - - - - - - - - <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L42">line 42</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L64">line 64</a> </li></ul></dd> @@ -1440,7 +1361,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L53">line 53</a> </li></ul></dd> @@ -1509,7 +1430,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L255">line 255</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L254">line 254</a> </li></ul></dd> @@ -1598,7 +1519,7 @@ includes the secret-key material after all the public-key fields.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L414">line 414</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L414">line 414</a> </li></ul></dd> @@ -1643,6 +1564,7 @@ includes the secret-key material after all the public-key fields.</p></div> <div class="description"> <p>Decrypts the private key params which are needed to use the key. +Successful decryption does not imply key integrity, call validate() to confirm that. SecretKeyPacket.isDecrypted should be false, as otherwise calls to this function will throw an error.</p> </div> @@ -1739,7 +1661,7 @@ otherwise calls to this function will throw an error.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L322">line 322</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L322">line 322</a> </li></ul></dd> @@ -1769,7 +1691,7 @@ otherwise calls to this function will throw an error.</p> <dl> <dt> <div class="param-desc"> - <p>if decryption was not successful</p> + <p>if the key is already decrypted, or if decryption was not successful</p> </div> </dt> <dd></dd> @@ -1953,7 +1875,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L274">line 274</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L273">line 273</a> </li></ul></dd> @@ -2077,7 +1999,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -2194,7 +2116,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -2307,7 +2229,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -2424,7 +2346,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L198">line 198</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L197">line 197</a> </li></ul></dd> @@ -2482,7 +2404,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -2516,7 +2438,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#getKeyId">PublicKeyPacket#getKeyId</a> + <a href="PublicKeyPacket.html#getKeyID">PublicKeyPacket#getKeyID</a> </li></ul></dd> @@ -2541,7 +2463,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -2581,7 +2503,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -2658,7 +2580,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -2776,7 +2698,7 @@ Returns false for gnu-dummy keys and null for public keys.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L230">line 230</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L229">line 229</a> </li></ul></dd> @@ -2887,7 +2809,7 @@ Returns false for gnu-dummy keys and null for public keys.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L238">line 238</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L237">line 237</a> </li></ul></dd> @@ -3057,7 +2979,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L247">line 247</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L246">line 246</a> </li></ul></dd> @@ -3202,7 +3124,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L85">line 85</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L84">line 84</a> </li></ul></dd> @@ -3292,7 +3214,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L380">line 380</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L380">line 380</a> </li></ul></dd> @@ -3416,7 +3338,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L171">line 171</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L170">line 170</a> </li></ul></dd> @@ -3533,7 +3455,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L152">line 152</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L151">line 151</a> </li></ul></dd> @@ -3579,7 +3501,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SecretSubkeyPacket.html b/docs/SecretSubkeyPacket.html index 2a19961a..2f67e505 100644 --- a/docs/SecretSubkeyPacket.html +++ b/docs/SecretSubkeyPacket.html @@ -190,7 +190,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_subkey.js">packet/secret_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_subkey.js#L32">line 32</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_subkey.js">packet/secret_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_subkey.js#L36">line 36</a> </li></ul></dd> @@ -312,7 +312,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L70">line 70</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L69">line 69</a> </li></ul></dd> @@ -391,7 +391,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L63">line 63</a> </li></ul></dd> @@ -470,7 +470,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L58">line 58</a> </li></ul></dd> @@ -549,7 +549,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L73">line 73</a> </li></ul></dd> @@ -628,7 +628,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L79">line 79</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L78">line 78</a> </li></ul></dd> @@ -697,7 +697,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L50">line 50</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L49">line 49</a> </li></ul></dd> @@ -715,13 +715,13 @@ Key packet and has exactly the same format.</p></div> -<h4 class="name" id="keyid"><span class="type-signature"></span>keyid<span class="type-signature"> :<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span></h4> +<h4 class="name" id="keyID"><span class="type-signature"></span>keyID<span class="type-signature"> :<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span></h4> <div class="description"> - <p>Keyid</p> + <p>KeyID</p> </div> @@ -730,7 +730,7 @@ Key packet and has exactly the same format.</p></div> <ul> <li> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </li> @@ -751,7 +751,7 @@ Key packet and has exactly the same format.</p></div> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="SecretKeyPacket.html#keyid">SecretKeyPacket#keyid</a> + <a href="SecretKeyPacket.html#keyID">SecretKeyPacket#keyID</a> </li></ul></dd> @@ -776,7 +776,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L83">line 83</a> </li></ul></dd> @@ -845,7 +845,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L46">line 46</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L45">line 45</a> </li></ul></dd> @@ -924,7 +924,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L75">line 75</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L74">line 74</a> </li></ul></dd> @@ -1003,7 +1003,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L68">line 68</a> </li></ul></dd> @@ -1072,7 +1072,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L249">line 249</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L248">line 248</a> </li></ul></dd> @@ -1158,7 +1158,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L60">line 60</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L59">line 59</a> </li></ul></dd> @@ -1176,7 +1176,7 @@ Key packet and has exactly the same format.</p></div> -<h4 class="name" id="s2k_usage"><span class="type-signature"></span>s2k_usage<span class="type-signature"> :Integer</span></h4> +<h4 class="name" id="s2kUsage"><span class="type-signature"></span>s2kUsage<span class="type-signature"> :Integer</span></h4> @@ -1212,7 +1212,7 @@ Key packet and has exactly the same format.</p></div> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="SecretKeyPacket.html#s2k_usage">SecretKeyPacket#s2k_usage</a> + <a href="SecretKeyPacket.html#s2kUsage">SecretKeyPacket#s2kUsage</a> </li></ul></dd> @@ -1237,7 +1237,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L55">line 55</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L54">line 54</a> </li></ul></dd> @@ -1316,86 +1316,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L65">line 65</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<dl class="details"> - - - - - - - - - <dt class="tag-overrides">Overrides:</dt> - <dd class="tag-overrides"><ul class="dummy"><li> - <a href="SecretKeyPacket.html#tag">SecretKeyPacket#tag</a> - </li></ul></dd> - - - - - - - - - - - - - - - - - - - - - - <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L42">line 42</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L64">line 64</a> </li></ul></dd> @@ -1474,7 +1395,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L53">line 53</a> </li></ul></dd> @@ -1543,7 +1464,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L255">line 255</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L254">line 254</a> </li></ul></dd> @@ -1637,7 +1558,7 @@ Key packet and has exactly the same format.</p></div> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L414">line 414</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L414">line 414</a> </li></ul></dd> @@ -1682,6 +1603,7 @@ Key packet and has exactly the same format.</p></div> <div class="description"> <p>Decrypts the private key params which are needed to use the key. +Successful decryption does not imply key integrity, call validate() to confirm that. SecretKeyPacket.isDecrypted should be false, as otherwise calls to this function will throw an error.</p> </div> @@ -1783,7 +1705,7 @@ otherwise calls to this function will throw an error.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L322">line 322</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L322">line 322</a> </li></ul></dd> @@ -1813,7 +1735,7 @@ otherwise calls to this function will throw an error.</p> <dl> <dt> <div class="param-desc"> - <p>if decryption was not successful</p> + <p>if the key is already decrypted, or if decryption was not successful</p> </div> </dt> <dd></dd> @@ -2002,7 +1924,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L274">line 274</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L273">line 273</a> </li></ul></dd> @@ -2126,7 +2048,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -2243,7 +2165,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -2356,7 +2278,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -2473,7 +2395,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L198">line 198</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L197">line 197</a> </li></ul></dd> @@ -2531,7 +2453,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -2565,7 +2487,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="SecretKeyPacket.html#getKeyId">SecretKeyPacket#getKeyId</a> + <a href="SecretKeyPacket.html#getKeyID">SecretKeyPacket#getKeyID</a> </li></ul></dd> @@ -2590,7 +2512,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -2630,7 +2552,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -2707,7 +2629,7 @@ This can be used to remove passphrase protection after calling decrypt().</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -2825,7 +2747,7 @@ Returns false for gnu-dummy keys and null for public keys.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L230">line 230</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L229">line 229</a> </li></ul></dd> @@ -2941,7 +2863,7 @@ Returns false for gnu-dummy keys and null for public keys.</p> <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L238">line 238</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L237">line 237</a> </li></ul></dd> @@ -3116,7 +3038,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L247">line 247</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L246">line 246</a> </li></ul></dd> @@ -3261,7 +3183,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L85">line 85</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L84">line 84</a> </li></ul></dd> @@ -3356,7 +3278,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L380">line 380</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L380">line 380</a> </li></ul></dd> @@ -3480,7 +3402,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/secret_key.js#L171">line 171</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js">packet/secret_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/secret_key.js#L170">line 170</a> </li></ul></dd> @@ -3597,7 +3519,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L152">line 152</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L151">line 151</a> </li></ul></dd> @@ -3643,7 +3565,7 @@ The resulting key cannot be used for signing/decrypting but can still verify sig </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/Signature.html b/docs/Signature.html index 82d0b4fb..da3b3abd 100644 --- a/docs/Signature.html +++ b/docs/Signature.html @@ -144,7 +144,7 @@ <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-1/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/signature.js#L30">line 30</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js#L34">line 34</a> </li></ul></dd> @@ -322,7 +322,7 @@ <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-1/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/signature.js#L47">line 47</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js#L51">line 51</a> </li></ul></dd> @@ -434,7 +434,7 @@ <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-1/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/signature.js#L38">line 38</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js#L42">line 42</a> </li></ul></dd> @@ -502,7 +502,7 @@ </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SignaturePacket.html b/docs/SignaturePacket.html index b0576890..3a0a6cae 100644 --- a/docs/SignaturePacket.html +++ b/docs/SignaturePacket.html @@ -148,7 +148,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L38">line 38</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L42">line 42</a> </li></ul></dd> @@ -258,7 +258,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L732">line 732</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L729">line 729</a> </li></ul></dd> @@ -431,7 +431,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L719">line 719</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L716">line 716</a> </li></ul></dd> @@ -592,7 +592,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L94">line 94</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L97">line 97</a> </li></ul></dd> @@ -650,7 +650,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> - <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(key, data, detached<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(key, data, detached<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> @@ -804,45 +804,6 @@ block of text, and a signature that is a certification of a User ID.</p></div> </tr> - - <tr> - - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - false - - </td> - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - </tbody> </table> @@ -882,7 +843,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L157">line 157</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L159">line 159</a> </li></ul></dd> @@ -947,7 +908,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(key, signatureType, data, detached<span class="signature-attributes">opt</span>, streaming<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(key, signatureType, data, detached<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> @@ -1151,45 +1112,6 @@ block of text, and a signature that is a certification of a User ID.</p></div> <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - false - - </td> - - - <td class="description last"><p>Whether to process data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -1263,7 +1185,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L664">line 664</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L662">line 662</a> </li></ul></dd> @@ -1328,7 +1250,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> - <h4 class="name" id="write_hashed_sub_packets"><span class="type-signature"></span>write_hashed_sub_packets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4> + <h4 class="name" id="writeHashedSubPackets"><span class="type-signature"></span>writeHashedSubPackets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4> @@ -1382,7 +1304,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L200">line 200</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L202">line 202</a> </li></ul></dd> @@ -1440,7 +1362,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> - <h4 class="name" id="write_params"><span class="type-signature"></span>write_params<span class="signature">()</span><span class="type-signature"> → {Uint8Array|ReadableStream.<Uint8Array>}</span></h4> + <h4 class="name" id="writeParams"><span class="type-signature"></span>writeParams<span class="signature">()</span><span class="type-signature"> → {Uint8Array|ReadableStream.<Uint8Array>}</span></h4> @@ -1490,7 +1412,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L130">line 130</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L133">line 133</a> </li></ul></dd> @@ -1547,7 +1469,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> - <h4 class="name" id="write_unhashed_sub_packets"><span class="type-signature"></span>write_unhashed_sub_packets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4> + <h4 class="name" id="writeUnhashedSubPackets"><span class="type-signature"></span>writeUnhashedSubPackets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4> @@ -1601,7 +1523,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> <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-1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/signature.js#L303">line 303</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/signature.js#L305">line 305</a> </li></ul></dd> @@ -1669,7 +1591,7 @@ block of text, and a signature that is a certification of a User ID.</p></div> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SymEncryptedIntegrityProtectedDataPacket.html b/docs/SymEncryptedIntegrityProtectedDataPacket.html index 261eb36c..a5ea6f5c 100644 --- a/docs/SymEncryptedIntegrityProtectedDataPacket.html +++ b/docs/SymEncryptedIntegrityProtectedDataPacket.html @@ -101,7 +101,7 @@ packet.</p></div> <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-1/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_integrity_protected_data.js#L43">line 43</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js#L54">line 54</a> </li></ul></dd> @@ -197,7 +197,7 @@ packet.</p></div> <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-1/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_integrity_protected_data.js#L47">line 47</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js#L57">line 57</a> </li></ul></dd> @@ -273,7 +273,7 @@ should be discarded.</p> <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-1/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_integrity_protected_data.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js#L64">line 64</a> </li></ul></dd> @@ -301,7 +301,7 @@ should be discarded.</p> - <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key, streaming, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(sessionKeyAlgorithm, key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -409,37 +409,6 @@ should be discarded.</p> <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last"><p>Whether to read this.encrypted as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -509,7 +478,7 @@ should be discarded.</p> <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-1/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_integrity_protected_data.js#L109">line 109</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js#L117">line 117</a> </li></ul></dd> @@ -545,7 +514,7 @@ should be discarded.</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -563,7 +532,7 @@ should be discarded.</p> - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, streaming, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(sessionKeyAlgorithm, key, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -671,37 +640,6 @@ should be discarded.</p> <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">Boolean</span> - - - - </td> - - - <td class="attributes"> - - - - - - </td> - - - - - <td class="description last"><p>Whether to set this.encrypted to a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>config</code></td> @@ -771,7 +709,7 @@ should be discarded.</p> <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-1/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_integrity_protected_data.js#L86">line 86</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js">packet/sym_encrypted_integrity_protected_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_integrity_protected_data.js#L95">line 95</a> </li></ul></dd> @@ -807,7 +745,7 @@ should be discarded.</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -835,7 +773,7 @@ should be discarded.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SymEncryptedSessionKeyPacket.html b/docs/SymEncryptedSessionKeyPacket.html index 7bd44abb..d2b4fb83 100644 --- a/docs/SymEncryptedSessionKeyPacket.html +++ b/docs/SymEncryptedSessionKeyPacket.html @@ -165,7 +165,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> <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-1/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_session_key.js#L41">line 41</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js#L45">line 45</a> </li></ul></dd> @@ -324,7 +324,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> <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-1/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_session_key.js#L125">line 125</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js#L128">line 128</a> </li></ul></dd> @@ -535,7 +535,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> <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-1/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_session_key.js#L155">line 155</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js#L158">line 158</a> </li></ul></dd> @@ -703,7 +703,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> <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-1/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_session_key.js#L58">line 58</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js#L61">line 61</a> </li></ul></dd> @@ -793,7 +793,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> <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-1/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/sym_encrypted_session_key.js#L99">line 99</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js">packet/sym_encrypted_session_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/sym_encrypted_session_key.js#L102">line 102</a> </li></ul></dd> @@ -861,7 +861,7 @@ the Symmetric-Key Encrypted Session Key packet.</p></div> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/SymmetricallyEncryptedDataPacket.html b/docs/SymmetricallyEncryptedDataPacket.html index 38748242..81c63777 100644 --- a/docs/SymmetricallyEncryptedDataPacket.html +++ b/docs/SymmetricallyEncryptedDataPacket.html @@ -101,7 +101,7 @@ that form whole OpenPGP messages).</p></div> <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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L41">line 41</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js#L52">line 52</a> </li></ul></dd> @@ -197,7 +197,7 @@ that form whole OpenPGP messages).</p></div> <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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L50">line 50</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js#L56">line 56</a> </li></ul></dd> @@ -271,81 +271,7 @@ that form whole OpenPGP messages).</p></div> <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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L55">line 55</a> - </li></ul></dd> - - - - - - - -</dl> - - - - - - - - -<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="type-signature"> :<a href="module-enums.html#.packet">module:enums.packet</a></span></h4> - - - - -<div class="description"> - <p>Packet type</p> -</div> - - - - <h5>Type:</h5> - <ul> - <li> - -<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> - - - </li> - </ul> - - - - - -<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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L46">line 46</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js#L61">line 61</a> </li></ul></dd> @@ -551,7 +477,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-9.2">RFC 4880 9.2</a> f <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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L76">line 76</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js#L82">line 82</a> </li></ul></dd> @@ -794,7 +720,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-9.2">RFC 4880 9.2</a> f <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-1/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/symmetrically_encrypted_data.js#L105">line 105</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js">packet/symmetrically_encrypted_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/symmetrically_encrypted_data.js#L106">line 106</a> </li></ul></dd> @@ -869,7 +795,7 @@ See <a href="https://tools.ietf.org/html/rfc4880#section-9.2">RFC 4880 9.2</a> f </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/TrustPacket.html b/docs/TrustPacket.html index be92ce46..cd54e56f 100644 --- a/docs/TrustPacket.html +++ b/docs/TrustPacket.html @@ -105,7 +105,7 @@ other than local keyring files.</p></div> <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-1/src/packet/trust.js">packet/trust.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/trust.js#L21">line 21</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/trust.js">packet/trust.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/trust.js#L20">line 20</a> </li></ul></dd> @@ -265,7 +265,7 @@ Currently not implemented as we ignore trust packets</p> <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-1/src/packet/trust.js">packet/trust.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/trust.js#L30">line 30</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/trust.js">packet/trust.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/trust.js#L30">line 30</a> </li></ul></dd> @@ -311,7 +311,7 @@ Currently not implemented as we ignore trust packets</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/UserAttributePacket.html b/docs/UserAttributePacket.html index 1e9c168d..3984d09e 100644 --- a/docs/UserAttributePacket.html +++ b/docs/UserAttributePacket.html @@ -107,7 +107,7 @@ an implementation may use any method desired.</p></div> <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-1/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/user_attribute.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js#L44">line 44</a> </li></ul></dd> @@ -266,7 +266,7 @@ an implementation may use any method desired.</p></div> <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-1/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/user_attribute.js#L78">line 78</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js#L81">line 81</a> </li></ul></dd> @@ -427,7 +427,7 @@ an implementation may use any method desired.</p></div> <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-1/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/user_attribute.js#L49">line 49</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js#L52">line 52</a> </li></ul></dd> @@ -517,7 +517,7 @@ an implementation may use any method desired.</p></div> <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-1/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/user_attribute.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js">packet/user_attribute.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/user_attribute.js#L67">line 67</a> </li></ul></dd> @@ -585,7 +585,7 @@ an implementation may use any method desired.</p></div> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/UserIDPacket.html b/docs/UserIDPacket.html index 05d4dd07..06b7bbaa 100644 --- a/docs/UserIDPacket.html +++ b/docs/UserIDPacket.html @@ -100,7 +100,7 @@ specifies the length of the User ID.</p></div> <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-1/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/userid.js#L34">line 34</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js#L38">line 38</a> </li></ul></dd> @@ -150,7 +150,7 @@ specifies the length of the User ID.</p></div> -<h4 class="name" id="userid"><span class="type-signature"></span>userid<span class="type-signature"> :String</span></h4> +<h4 class="name" id="userID"><span class="type-signature"></span>userID<span class="type-signature"> :String</span></h4> @@ -207,7 +207,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> <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-1/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/userid.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js#L43">line 43</a> </li></ul></dd> @@ -235,7 +235,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> - <h4 class="name" id=".fromObject"><span class="type-signature">(static) </span>fromObject<span class="signature">(userId)</span><span class="type-signature"> → {<a href="UserIDPacket.html">UserIDPacket</a>}</span></h4> + <h4 class="name" id=".fromObject"><span class="type-signature">(static) </span>fromObject<span class="signature">(userID)</span><span class="type-signature"> → {<a href="UserIDPacket.html">UserIDPacket</a>}</span></h4> @@ -279,7 +279,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> <tr> - <td class="name"><code>userId</code></td> + <td class="name"><code>userID</code></td> <td class="type"> @@ -295,7 +295,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> - <td class="description last"><p>Object specifying userId name, email and comment</p></td> + <td class="description last"><p>Object specifying userID name, email and comment</p></td> </tr> @@ -338,7 +338,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> <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-1/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/userid.js#L53">line 53</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js#L56">line 56</a> </li></ul></dd> @@ -495,7 +495,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> <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-1/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/userid.js#L74">line 74</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js#L77">line 77</a> </li></ul></dd> @@ -585,7 +585,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> <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-1/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/userid.js#L92">line 92</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js">packet/userid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/userid.js#L95">line 95</a> </li></ul></dd> @@ -653,7 +653,7 @@ John Doe <a href="mailto:john@example.com">john@example.com</a></p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/global.html b/docs/global.html index c96248e5..5c01c7c8 100644 --- a/docs/global.html +++ b/docs/global.html @@ -352,7 +352,7 @@ <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-1/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/encoding/armor.js#L357">line 357</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/encoding/armor.js#L357">line 357</a> </li></ul></dd> @@ -413,7 +413,592 @@ - <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="createCleartextMessage"><span class="type-signature">(async) </span>createCleartextMessage<span class="signature">(options)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Creates a new CleartextMessage object from text</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</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + + + + <td class="description last"> + <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>text</code></td> + + + <td class="type"> + + +<span class="param-type">String</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + </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-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L207">line 207</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + + + + <h4 class="name" id="createMessage"><span class="type-signature">(async) </span>createMessage<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> + + + + + + +<div class="description"> + <p>Creates new message object from text or binary 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>options</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + + + + <td class="description last"> + <h6>Properties</h6> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>text</code></td> + + + <td class="type"> + + +<span class="param-type">String</span> +| + +<span class="param-type">ReadableStream.<String></span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"><p>The text message contents</p></td> + </tr> + + + + <tr> + + <td class="name"><code>binary</code></td> + + + <td class="type"> + + +<span class="param-type">Uint8Array</span> +| + +<span class="param-type">ReadableStream.<Uint8Array></span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"><p>The binary message contents</p></td> + </tr> + + + + <tr> + + <td class="name"><code>filename</code></td> + + + <td class="type"> + + +<span class="param-type">String</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + "" + + </td> + + + <td class="description last"><p>Name of the file (if any)</p></td> + </tr> + + + + <tr> + + <td class="name"><code>date</code></td> + + + <td class="type"> + + +<span class="param-type">Date</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + current date + + </td> + + + <td class="description last"><p>Date of the message, or modification date of the file</p></td> + </tr> + + + + <tr> + + <td class="name"><code>format</code></td> + + + <td class="type"> + + +<span class="param-type">'utf8'</span> +| + +<span class="param-type">'binary'</span> +| + +<span class="param-type">'text'</span> +| + +<span class="param-type">'mime'</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + 'utf8' if text is passed, 'binary' otherwise + + </td> + + + <td class="description last"><p>Data packet type</p></td> + </tr> + + + </tbody> +</table> + + </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-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L848">line 848</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <p>New message object.</p> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="decrypt"><span class="type-signature">(async) </span>decrypt<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -699,16 +1284,13 @@ a session key or a password must be specified.</p> <tr> - <td class="name"><code>format</code></td> + <td class="name"><code>expectSigned</code></td> <td class="type"> -<span class="param-type">'utf8'</span> -| - -<span class="param-type">'binary'</span> +<span class="param-type">Boolean</span> @@ -729,34 +1311,28 @@ a session key or a password must be specified.</p> <td class="default"> - 'utf8' + false </td> - <td class="description last"><p>Whether to return data as a string(Stream) or Uint8Array(Stream). If 'utf8' (the default), also normalize newlines.</p></td> + <td class="description last"><p>If true, data decryption fails if the message is not signed with the provided publicKeys</p></td> </tr> <tr> - <td class="name"><code>streaming</code></td> + <td class="name"><code>format</code></td> <td class="type"> -<span class="param-type">'web'</span> -| - -<span class="param-type">'ponyfill'</span> -| - -<span class="param-type">'node'</span> +<span class="param-type">'utf8'</span> | -<span class="param-type">false</span> +<span class="param-type">'binary'</span> @@ -777,12 +1353,12 @@ a session key or a password must be specified.</p> <td class="default"> - type of stream `message` was created from, if any + 'utf8' </td> - <td class="description last"><p>Whether to return data as a stream. Defaults to the type of stream <code>message</code> was created from, if any.</p></td> + <td class="description last"><p>Whether to return data as a string(Stream) or Uint8Array(Stream). If 'utf8' (the default), also normalize newlines.</p></td> </tr> @@ -945,7 +1521,7 @@ a session key or a password must be specified.</p> <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L305">line 305</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L307">line 307</a> </li></ul></dd> @@ -981,9 +1557,9 @@ a session key or a password must be specified.</p> filename: String, signatures: [ { - keyid: module:type/keyid~Keyid, + keyID: module:type/keyid~KeyID, verified: Promise<Boolean>, - valid: Boolean (if streaming was false) + valid: Boolean (if `message` was not created from a stream) }, ... ] }</code></pre> @@ -997,7 +1573,7 @@ a session key or a password must be specified.</p> </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -1015,7 +1591,7 @@ a session key or a password must be specified.</p> - <h4 class="name" id="decryptKey"><span class="type-signature">(async) </span>decryptKey<span class="signature">(options)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="decryptKey"><span class="type-signature">(async) </span>decryptKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -1245,7 +1821,7 @@ This method does not change the original key.</p> <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L167">line 167</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L163">line 163</a> </li></ul></dd> @@ -1285,7 +1861,7 @@ This method does not change the original key.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -1303,7 +1879,7 @@ This method does not change the original key.</p> - <h4 class="name" id="decryptSessionKeys"><span class="type-signature">(async) </span>decryptSessionKeys<span class="signature">(options)</span><span class="type-signature"> → {Object|undefined}</span></h4> + <h4 class="name" id="decryptSessionKeys"><span class="type-signature">(async) </span>decryptSessionKeys<span class="signature">(options)</span><span class="type-signature"> → {Promise.<(Object|undefined)>}</span></h4> @@ -1571,7 +2147,7 @@ a password must be specified.</p> <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L499">line 499</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L524">line 524</a> </li></ul></dd> @@ -1613,10 +2189,7 @@ or 'undefined' if no key packets found</p> </dt> <dd> -<span class="param-type">Object</span> -| - -<span class="param-type">undefined</span> +<span class="param-type">Promise.<(Object|undefined)></span> </dd> @@ -1634,7 +2207,7 @@ or 'undefined' if no key packets found</p> - <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(options)</span><span class="type-signature"> → {String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>}</span></h4> + <h4 class="name" id="encrypt"><span class="type-signature">(async) </span>encrypt<span class="signature">(options)</span><span class="type-signature"> → {Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>}</span></h4> @@ -1753,7 +2326,7 @@ must be specified. If private keys are specified, those will be used to sign the </td> - <td class="description last"><p>Message to be encrypted as created by <a href="Message.html#.fromText">Message.fromText</a> or <a href="Message.html#.fromBinary">Message.fromBinary</a></p></td> + <td class="description last"><p>Message to be encrypted as created by <a href="global.html#createMessage">createMessage</a></p></td> </tr> @@ -1956,54 +2529,6 @@ must be specified. If private keys are specified, those will be used to sign the <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">'web'</span> -| - -<span class="param-type">'ponyfill'</span> -| - -<span class="param-type">'node'</span> -| - -<span class="param-type">false</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - type of stream `message` was created from, if any - - </td> - - - <td class="description last"><p>Whether to return data as a stream</p></td> - </tr> - - - - <tr> - <td class="name"><code>signature</code></td> @@ -2080,13 +2605,13 @@ must be specified. If private keys are specified, those will be used to sign the <tr> - <td class="name"><code>signingKeyIds</code></td> + <td class="name"><code>signingKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -2112,20 +2637,20 @@ must be specified. If private keys are specified, those will be used to sign the </td> - <td class="description last"><p>Array of key IDs to use for signing. Each <code>signingKeyIds[i]</code> corresponds to <code>privateKeys[i]</code></p></td> + <td class="description last"><p>Array of key IDs to use for signing. Each <code>signingKeyIDs[i]</code> corresponds to <code>privateKeys[i]</code></p></td> </tr> <tr> - <td class="name"><code>encryptionKeyIds</code></td> + <td class="name"><code>encryptionKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -2151,7 +2676,7 @@ must be specified. If private keys are specified, those will be used to sign the </td> - <td class="description last"><p>Array of key IDs to use for encryption. Each <code>encryptionKeyIds[i]</code> corresponds to <code>publicKeys[i]</code></p></td> + <td class="description last"><p>Array of key IDs to use for encryption. Each <code>encryptionKeyIDs[i]</code> corresponds to <code>publicKeys[i]</code></p></td> </tr> @@ -2197,7 +2722,7 @@ must be specified. If private keys are specified, those will be used to sign the <tr> - <td class="name"><code>fromUserIds</code></td> + <td class="name"><code>fromUserIDs</code></td> <td class="type"> @@ -2236,7 +2761,7 @@ must be specified. If private keys are specified, those will be used to sign the <tr> - <td class="name"><code>toUserIds</code></td> + <td class="name"><code>toUserIDs</code></td> <td class="type"> @@ -2355,7 +2880,7 @@ must be specified. If private keys are specified, those will be used to sign the <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L253">line 253</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L251">line 251</a> </li></ul></dd> @@ -2395,22 +2920,7 @@ must be specified. If private keys are specified, those will be used to sign the </dt> <dd> -<span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> -| - -<span class="param-type">NodeStream.<String></span> -| - -<span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> -| - -<span class="param-type">NodeStream.<Uint8Array></span> +<span class="param-type">Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)></span> </dd> @@ -2428,7 +2938,7 @@ must be specified. If private keys are specified, those will be used to sign the - <h4 class="name" id="encryptKey"><span class="type-signature">(async) </span>encryptKey<span class="signature">(options)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="encryptKey"><span class="type-signature">(async) </span>encryptKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -2658,7 +3168,7 @@ This method does not change the original key.</p> <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L196">line 196</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L195">line 195</a> </li></ul></dd> @@ -2698,7 +3208,7 @@ This method does not change the original key.</p> </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -2716,7 +3226,7 @@ This method does not change the original key.</p> - <h4 class="name" id="encryptSessionKey"><span class="type-signature">(async) </span>encryptSessionKey<span class="signature">(options)</span><span class="type-signature"> → {String|Uint8Array}</span></h4> + <h4 class="name" id="encryptSessionKey"><span class="type-signature">(async) </span>encryptSessionKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<(String|Uint8Array)>}</span></h4> @@ -2907,7 +3417,7 @@ or passwords must be specified.</p> </td> - <td class="description last"><p>Aead algorithm, e.g. 'eax' or 'ocb'</p></td> + <td class="description last"><p>AEAD algorithm, e.g. 'eax' or 'ocb'</p></td> </tr> @@ -3072,13 +3582,13 @@ or passwords must be specified.</p> <tr> - <td class="name"><code>encryptionKeyIds</code></td> + <td class="name"><code>encryptionKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -3104,7 +3614,7 @@ or passwords must be specified.</p> </td> - <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIds[i] corresponds to publicKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for encryption. Each encryptionKeyIDs[i] corresponds to publicKeys[i]</p></td> </tr> @@ -3150,7 +3660,7 @@ or passwords must be specified.</p> <tr> - <td class="name"><code>toUserIds</code></td> + <td class="name"><code>toUserIDs</code></td> <td class="type"> @@ -3269,7 +3779,7 @@ or passwords must be specified.</p> <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L473">line 473</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L498">line 498</a> </li></ul></dd> @@ -3309,10 +3819,7 @@ or passwords must be specified.</p> </dt> <dd> -<span class="param-type">String</span> -| - -<span class="param-type">Uint8Array</span> +<span class="param-type">Promise.<(String|Uint8Array)></span> </dd> @@ -3330,7 +3837,7 @@ or passwords must be specified.</p> - <h4 class="name" id="generateKey"><span class="type-signature">(async) </span>generateKey<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="generateKey"><span class="type-signature">(async) </span>generateKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -3420,16 +3927,16 @@ or passwords must be specified.</p> <tr> - <td class="name"><code>type</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> -<span class="param-type">'ecc'</span> +<span class="param-type">Object</span> | -<span class="param-type">'rsa'</span> +<span class="param-type">Array.<Object></span> @@ -3438,8 +3945,6 @@ or passwords must be specified.</p> <td class="attributes"> - <optional><br> - @@ -3450,28 +3955,26 @@ or passwords must be specified.</p> <td class="default"> - 'ecc' - </td> - <td class="description last"><p>The primary key algorithm type: ECC (default) or RSA</p></td> + <td class="description last"><p>User IDs as objects: <code>{ name: 'Jo Doe', email: 'info@jo.com' }</code></p></td> </tr> <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>type</code></td> <td class="type"> -<span class="param-type">Object</span> +<span class="param-type">'ecc'</span> | -<span class="param-type">Array.<Object></span> +<span class="param-type">'rsa'</span> @@ -3480,6 +3983,8 @@ or passwords must be specified.</p> <td class="attributes"> + <optional><br> + @@ -3490,10 +3995,12 @@ or passwords must be specified.</p> <td class="default"> + 'ecc' + </td> - <td class="description last"><p>User IDs as objects: <code>{ name: 'Jo Doe', email: 'info@jo.com' }</code></p></td> + <td class="description last"><p>The primary key algorithm type: ECC (default) or RSA</p></td> </tr> @@ -3817,7 +4324,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L60">line 60</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L53">line 53</a> </li></ul></dd> @@ -3858,7 +4365,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -3876,7 +4383,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="generateSessionKey"><span class="type-signature">(async) </span>generateSessionKey<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="generateSessionKey"><span class="type-signature">(async) </span>generateSessionKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<{data: Uint8Array, algorithm: String}>}</span></h4> @@ -4043,7 +4550,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <tr> - <td class="name"><code>toUserIds</code></td> + <td class="name"><code>toUserIDs</code></td> <td class="type"> @@ -4162,7 +4669,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L443">line 443</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L468">line 468</a> </li></ul></dd> @@ -4202,6 +4709,190 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> +<span class="param-type">Promise.<{data: Uint8Array, algorithm: String}></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="newPacketFromTag"><span class="type-signature"></span>newPacketFromTag<span class="signature">(tag, allowedPackets)</span><span class="type-signature"> → {Object}</span></h4> + + + + + + +<div class="description"> + <p>Instantiate a new packet given its tag</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>tag</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="module-enums.html#.packet">module:enums.packet</a></span> + + + + </td> + + + + + + <td class="description last"><p>Property value from <a href="module-enums.html#.packet">module:enums.packet</a></p></td> + </tr> + + + + <tr> + + <td class="name"><code>allowedPackets</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + + + + <td class="description last"><p>mapping where keys are allowed packet tags, pointing to their Packet class</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-2/src/packet/packetlist.js">packet/packetlist.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/packetlist.js#L11">line 11</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <p>New packet object with type based on tag</p> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + <span class="param-type">Object</span> @@ -4220,7 +4911,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="readCleartextMessage"><span class="type-signature">(async) </span>readCleartextMessage<span class="signature">(options)</span><span class="type-signature"> → {<a href="CleartextMessage.html">CleartextMessage</a>}</span></h4> + <h4 class="name" id="readCleartextMessage"><span class="type-signature">(async) </span>readCleartextMessage<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="CleartextMessage.html">CleartextMessage</a>>}</span></h4> @@ -4315,9 +5006,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> @@ -4418,7 +5106,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/cleartext.js#L165">line 165</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js">cleartext.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/cleartext.js#L135">line 135</a> </li></ul></dd> @@ -4458,7 +5146,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type"><a href="CleartextMessage.html">CleartextMessage</a></span> +<span class="param-type">Promise.<<a href="CleartextMessage.html">CleartextMessage</a>></span> </dd> @@ -4476,7 +5164,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="readKey"><span class="type-signature">(async) </span>readKey<span class="signature">(options)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="readKey"><span class="type-signature">(async) </span>readKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -4571,9 +5259,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> @@ -4607,9 +5292,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> @@ -4712,7 +5394,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/factory.js#L252">line 252</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/factory.js#L263">line 263</a> </li></ul></dd> @@ -4752,7 +5434,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -4770,7 +5452,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="readKeys"><span class="type-signature">(async) </span>readKeys<span class="signature">(options)</span><span class="type-signature"> → {Array.<<a href="Key.html">Key</a>>}</span></h4> + <h4 class="name" id="readKeys"><span class="type-signature">(async) </span>readKeys<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Array.<<a href="Key.html">Key</a>>>}</span></h4> @@ -4865,9 +5547,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> @@ -4901,9 +5580,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> @@ -5006,7 +5682,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/factory.js#L282">line 282</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/factory.js">key/factory.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/factory.js#L299">line 299</a> </li></ul></dd> @@ -5046,7 +5722,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type">Array.<<a href="Key.html">Key</a>></span> +<span class="param-type">Promise.<Array.<<a href="Key.html">Key</a>>></span> </dd> @@ -5064,7 +5740,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="readMessage"><span class="type-signature">(async) </span>readMessage<span class="signature">(options)</span><span class="type-signature"> → {<a href="Message.html">Message</a>}</span></h4> + <h4 class="name" id="readMessage"><span class="type-signature">(async) </span>readMessage<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Message.html">Message</a>>}</span></h4> @@ -5300,7 +5976,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/message.js#L820">line 820</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js">message.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/message.js#L805">line 805</a> </li></ul></dd> @@ -5340,7 +6016,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Promise.<<a href="Message.html">Message</a>></span> </dd> @@ -5358,7 +6034,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="readSignature"><span class="type-signature">(async) </span>readSignature<span class="signature">(options)</span><span class="type-signature"> → {<a href="Signature.html">Signature</a>}</span></h4> + <h4 class="name" id="readSignature"><span class="type-signature">(async) </span>readSignature<span class="signature">(options)</span><span class="type-signature"> → {Promise.<<a href="Signature.html">Signature</a>>}</span></h4> @@ -5453,9 +6129,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> @@ -5489,9 +6162,6 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> @@ -5594,7 +6264,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/signature.js#L62">line 62</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js">signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/signature.js#L66">line 66</a> </li></ul></dd> @@ -5634,7 +6304,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type"><a href="Signature.html">Signature</a></span> +<span class="param-type">Promise.<<a href="Signature.html">Signature</a>></span> </dd> @@ -5652,7 +6322,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="reformatKey"><span class="type-signature">(async) </span>reformatKey<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="reformatKey"><span class="type-signature">(async) </span>reformatKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -5777,7 +6447,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <tr> - <td class="name"><code>userIds</code></td> + <td class="name"><code>userIDs</code></td> <td class="type"> @@ -5973,7 +6643,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L96">line 96</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L92">line 92</a> </li></ul></dd> @@ -6014,7 +6684,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -6032,7 +6702,7 @@ sign parameter defaults to false, and indicates whether the subkey should sign r - <h4 class="name" id="revokeKey"><span class="type-signature">(async) </span>revokeKey<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="revokeKey"><span class="type-signature">(async) </span>revokeKey<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -6402,7 +7072,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L132">line 132</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L128">line 128</a> </li></ul></dd> @@ -6444,7 +7114,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -6462,7 +7132,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(options)</span><span class="type-signature"> → {String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>}</span></h4> + <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(options)</span><span class="type-signature"> → {Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)>}</span></h4> @@ -6667,54 +7337,6 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <tr> - <td class="name"><code>streaming</code></td> - - - <td class="type"> - - -<span class="param-type">'web'</span> -| - -<span class="param-type">'ponyfill'</span> -| - -<span class="param-type">'node'</span> -| - -<span class="param-type">false</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - - - </td> - - - - <td class="default"> - - type of stream `message` was created from, if any - - </td> - - - <td class="description last"><p>Whether to return data as a stream. Defaults to the type of stream <code>message</code> was created from, if any.</p></td> - </tr> - - - - <tr> - <td class="name"><code>detached</code></td> @@ -6754,13 +7376,13 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <tr> - <td class="name"><code>signingKeyIds</code></td> + <td class="name"><code>signingKeyIDs</code></td> <td class="type"> -<span class="param-type">Array.<<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>></span> +<span class="param-type">Array.<<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>></span> @@ -6786,7 +7408,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be </td> - <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIds[i] corresponds to privateKeys[i]</p></td> + <td class="description last"><p>Array of key IDs to use for signing. Each signingKeyIDs[i] corresponds to privateKeys[i]</p></td> </tr> @@ -6832,7 +7454,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <tr> - <td class="name"><code>fromUserIds</code></td> + <td class="name"><code>fromUserIDs</code></td> <td class="type"> @@ -6951,7 +7573,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L349">line 349</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L364">line 364</a> </li></ul></dd> @@ -6991,22 +7613,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be </dt> <dd> -<span class="param-type">String</span> -| - -<span class="param-type">ReadableStream.<String></span> -| - -<span class="param-type">NodeStream.<String></span> -| - -<span class="param-type">Uint8Array</span> -| - -<span class="param-type">ReadableStream.<Uint8Array></span> -| - -<span class="param-type">NodeStream.<Uint8Array></span> +<span class="param-type">Promise.<(String|ReadableStream.<String>|NodeStream.<String>|Uint8Array|ReadableStream.<Uint8Array>|NodeStream.<Uint8Array>)></span> </dd> @@ -7024,7 +7631,7 @@ If a revocation certificate is passed, the reasonForRevocation parameter will be - <h4 class="name" id="unarmor"><span class="type-signature">(async) </span>unarmor<span class="signature">(input)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="unarmor"><span class="type-signature">(async) </span>unarmor<span class="signature">(input)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -7128,7 +7735,7 @@ the encoded bytes</p> <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-1/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/encoding/armor.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/encoding/armor.js">encoding/armor.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/encoding/armor.js#L231">line 231</a> </li></ul></dd> @@ -7169,7 +7776,7 @@ an attribute "data" containing a stream of bytes and "type" </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -7187,7 +7794,7 @@ an attribute "data" containing a stream of bytes and "type" - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(options)</span><span class="type-signature"> → {Object}</span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4> @@ -7277,16 +7884,16 @@ an attribute "data" containing a stream of bytes and "type" <tr> - <td class="name"><code>publicKeys</code></td> + <td class="name"><code>message</code></td> <td class="type"> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type"><a href="CleartextMessage.html">CleartextMessage</a></span> | -<span class="param-type">Array.<<a href="Key.html">Key</a>></span> +<span class="param-type"><a href="Message.html">Message</a></span> @@ -7308,23 +7915,23 @@ an attribute "data" containing a stream of bytes and "type" </td> - <td class="description last"><p>Array of publicKeys or single key, to verify signatures</p></td> + <td class="description last"><p>(cleartext) message object with signatures</p></td> </tr> <tr> - <td class="name"><code>message</code></td> + <td class="name"><code>publicKeys</code></td> <td class="type"> -<span class="param-type"><a href="CleartextMessage.html">CleartextMessage</a></span> +<span class="param-type"><a href="Key.html">Key</a></span> | -<span class="param-type"><a href="Message.html">Message</a></span> +<span class="param-type">Array.<<a href="Key.html">Key</a>></span> @@ -7346,23 +7953,20 @@ an attribute "data" containing a stream of bytes and "type" </td> - <td class="description last"><p>(cleartext) message object with signatures</p></td> + <td class="description last"><p>Array of publicKeys or single key, to verify signatures</p></td> </tr> <tr> - <td class="name"><code>format</code></td> + <td class="name"><code>expectSigned</code></td> <td class="type"> -<span class="param-type">'utf8'</span> -| - -<span class="param-type">'binary'</span> +<span class="param-type">Boolean</span> @@ -7383,34 +7987,28 @@ an attribute "data" containing a stream of bytes and "type" <td class="default"> - 'utf8' + false </td> - <td class="description last"><p>Whether to return data as a string(Stream) or Uint8Array(Stream). If 'utf8' (the default), also normalize newlines.</p></td> + <td class="description last"><p>If true, verification throws if the message is not signed with the provided publicKeys</p></td> </tr> <tr> - <td class="name"><code>streaming</code></td> + <td class="name"><code>format</code></td> <td class="type"> -<span class="param-type">'web'</span> -| - -<span class="param-type">'ponyfill'</span> -| - -<span class="param-type">'node'</span> +<span class="param-type">'utf8'</span> | -<span class="param-type">false</span> +<span class="param-type">'binary'</span> @@ -7431,12 +8029,12 @@ an attribute "data" containing a stream of bytes and "type" <td class="default"> - type of stream `message` was created from, if any + 'utf8' </td> - <td class="description last"><p>Whether to return data as a stream. Defaults to the type of stream <code>message</code> was created from, if any.</p></td> + <td class="description last"><p>Whether to return data as a string(Stream) or Uint8Array(Stream). If 'utf8' (the default), also normalize newlines.</p></td> </tr> @@ -7599,7 +8197,7 @@ an attribute "data" containing a stream of bytes and "type" <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-1/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/openpgp.js#L404">line 404</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js">openpgp.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/openpgp.js#L417">line 417</a> </li></ul></dd> @@ -7634,9 +8232,9 @@ an attribute "data" containing a stream of bytes and "type" data: Uint8Array|ReadableStream<Uint8Array>|NodeStream, (if `message` was a Message) signatures: [ { - keyid: module:type/keyid~Keyid, + keyID: module:type/keyid~KeyID, verified: Promise<Boolean>, - valid: Boolean (if `streaming` was false) + valid: Boolean (if `message` was not created from a stream) }, ... ] }</code></pre> @@ -7650,7 +8248,7 @@ an attribute "data" containing a stream of bytes and "type" </dt> <dd> -<span class="param-type">Object</span> +<span class="param-type">Promise.<Object></span> </dd> @@ -7678,7 +8276,7 @@ an attribute "data" containing a stream of bytes and "type" </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/index.html b/docs/index.html index 7aeeb83a..f475e984 100644 --- a/docs/index.html +++ b/docs/index.html @@ -208,9 +208,9 @@ library to convert back and forth between them.</p> <li> <p>The library implements the <a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-10">IETF proposal</a> for authenticated encryption using native AES-EAX, OCB, or GCM. This makes symmetric encryption up to 30x faster on supported platforms. Since the specification has not been finalized and other OpenPGP implementations haven't adopted it yet, the feature is currently behind a flag. <strong>Note: activating this setting can break compatibility with other OpenPGP implementations, and also with future versions of OpenPGP.js. Don't use it with messages you want to store on disk or in a database.</strong> You can enable it by setting <code>openpgp.config.aeadProtect = true</code>.</p> <p>You can change the AEAD mode by setting one of the following options:</p> -<pre class="prettyprint source"><code>openpgp.config.aeadMode = openpgp.enums.aead.eax // Default, native -openpgp.config.aeadMode = openpgp.enums.aead.ocb // Non-native -openpgp.config.aeadMode = openpgp.enums.aead.experimentalGcm // **Non-standard**, fastest +<pre class="prettyprint source"><code>openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.eax // Default, native +openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.ocb // Non-native +openpgp.config.preferredAEADAlgorithm = openpgp.enums.aead.experimentalGCM // **Non-standard**, fastest </code></pre> </li> <li> @@ -243,7 +243,7 @@ openpgp.config.aeadMode = openpgp.enums.aead.experimentalGcm // **Non-standard** </code></pre> <p>To test whether the lazy loading works, try to generate a key with a non-standard curve:</p> <pre class="prettyprint source lang-js"><code>import { generateKey } from 'openpgp/lightweight'; -await generateKey({ curve: 'brainpoolP512r1', userIds: [{ name: 'Test', email: 'test@test.com' }] }); +await generateKey({ curve: 'brainpoolP512r1', userIDs: [{ name: 'Test', email: 'test@test.com' }] }); </code></pre> <p>For more examples of how to generate a key, see <a href="#generate-new-key-pair">Generate new key pair</a>. It is recommended to use <code>curve25519</code> instead of <code>brainpoolP512r1</code> by default.</p> <h4 id="browser-(plain-files)">Browser (plain files)</h4> @@ -259,9 +259,9 @@ import * as openpgp from './openpgp.min.mjs'; <h3 id="examples">Examples</h3> <p>Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the <a href="https://github.com/openpgpjs/openpgpjs/blob/master/test/general/openpgp.js">public API unit tests</a>. If you're upgrading from v4 it might help to check out the <a href="https://github.com/openpgpjs/openpgpjs/wiki/V5-Changelog">changelog</a> and <a href="https://github.com/openpgpjs/openpgpjs#documentation">documentation</a>.</p> <h4 id="encrypt-and-decrypt-uint8array-data-with-a-password">Encrypt and decrypt <em>Uint8Array</em> data with a password</h4> -<p>Encryption will use the algorithm specified in config.encryptionCipher (defaults to aes256), and decryption will use the algorithm used for encryption.</p> +<p>Encryption will use the algorithm specified in config.preferredSymmetricAlgorithm (defaults to aes256), and decryption will use the algorithm used for encryption.</p> <pre class="prettyprint source lang-js"><code>(async () => { - const message = openpgp.Message.fromBinary(new Uint8Array([0x01, 0x01, 0x01])); + const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x01, 0x01]) }); const encrypted = await openpgp.encrypt({ message, // input as Message object passwords: ['secret stuff'], // multiple passwords possible @@ -296,11 +296,13 @@ import * as openpgp from './openpgp.min.mjs'; const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored }); - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase); + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); const encrypted = await openpgp.encrypt({ - message: openpgp.Message.fromText('Hello, World!'), // input as Message object + message: await openpgp.createMessage({ text: 'Hello, World!' }), // input as Message object publicKeys: publicKey, // for encryption privateKeys: privateKey // for signing (optional) }); @@ -309,15 +311,16 @@ import * as openpgp from './openpgp.min.mjs'; const message = await openpgp.readMessage({ armoredMessage: encrypted // parse armored message }); - const { data: decrypted } = await openpgp.decrypt({ + const { data: decrypted, signatures } = await openpgp.decrypt({ message, publicKeys: publicKey, // for verification (optional) privateKeys: privateKey // for decryption }); console.log(decrypted); // 'Hello, World!' + console.log(signatures[0].valid) // signature validity (signed messages only) })(); </code></pre> -<p>Encrypt with multiple public keys:</p> +<p>Encrypt to multiple public keys:</p> <pre class="prettyprint source lang-js"><code>(async () => { const publicKeysArmored = [ `-----BEGIN PGP PUBLIC KEY BLOCK----- @@ -335,10 +338,12 @@ import * as openpgp from './openpgp.min.mjs'; const publicKeys = await Promise.all(publicKeysArmored.map(armoredKey => openpgp.readKey({ armoredKey }))); - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase) + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); - const message = openpgp.Message.fromText(message); + const message = await openpgp.createMessage({ text: message }); const encrypted = await openpgp.encrypt({ message:, // input as Message object publicKeys, // for encryption @@ -347,25 +352,61 @@ import * as openpgp from './openpgp.min.mjs'; console.log(encrypted); // '-----BEGIN PGP MESSAGE ... END PGP MESSAGE-----' })(); </code></pre> -<h4 id="encrypt-with-compression">Encrypt with compression</h4> -<p>By default, <code>encrypt</code> will not use any compression. It's possible to override that behavior in two ways:</p> -<p>Either set the <code>compression</code> parameter in the options object when calling <code>encrypt</code>.</p> +<p>If you expect an encrypted message to be signed with one of the public keys you have, and do not want to trust the decrypted data otherwise, you can pass the decryption option <code>expectSigned = true</code>, so that the decryption operation will fail if no valid signature is found:</p> +<pre class="prettyprint source lang-js"><code>(async () => { + // put keys in backtick (``) to avoid errors caused by spaces or tabs + const publicKeyArmored = `-----BEGIN PGP PUBLIC KEY BLOCK----- +... +-----END PGP PUBLIC KEY BLOCK-----`; + const privateKeyArmored = `-----BEGIN PGP PRIVATE KEY BLOCK----- +... +-----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key + const passphrase = `yourPassphrase`; // what the private key is encrypted with + + const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored }); + + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); + + const encryptedAndSignedMessage = `-----BEGIN PGP MESSAGE----- +... +-----END PGP MESSAGE-----`; + + const message = await openpgp.readMessage({ + armoredMessage: encryptedAndSignedMessage // parse armored message + }); + // decryption will fail if all signatures are invalid or missing + const { data: decrypted, signatures } = await openpgp.decrypt({ + message, + privateKeys: privateKey // for decryption + expectSigned: true, + publicKeys: publicKey, // for verification (mandatory with expectSigned=true) + }); + console.log(decrypted); // 'Hello, World!' +})(); +</code></pre> +<h4 id="encrypt-symmetrically-with-compression">Encrypt symmetrically with compression</h4> +<p>By default, <code>encrypt</code> will not use any compression when encrypting symmetrically only (i.e. when no <code>publicKeys</code> are given). +It's possible to change that behaviour by enabling compression through the config, either for the single encryption:</p> <pre class="prettyprint source lang-js"><code>(async () => { - const message = openpgp.Message.fromBinary(new Uint8Array([0x01, 0x02, 0x03])); // or .fromText('string') + const message = await openpgp.createMessage({ binary: new Uint8Array([0x01, 0x02, 0x03]) }); // or createMessage({ text: 'string' }) const encrypted = await openpgp.encrypt({ message, passwords: ['secret stuff'], // multiple passwords possible - compression: openpgp.enums.compression.zip // compress the data with zip + config: { preferredCompressionAlgorithm: openpgp.enums.compression.zlib } // compress the data with zlib }); })(); </code></pre> -<p>Or, override the config to enable compression:</p> -<pre class="prettyprint source lang-js"><code>openpgp.config.compression = openpgp.enums.compression.zlib; +<p>or by changing the default global configuration:</p> +<pre class="prettyprint source lang-js"><code>openpgp.config.preferredCompressionAlgorithm = openpgp.enums.compression.zlib </code></pre> <p>Where the value can be any of:</p> <ul> <li><code>openpgp.enums.compression.zip</code></li> <li><code>openpgp.enums.compression.zlib</code></li> +<li><code>openpgp.enums.compression.uncompressed</code> (default)</li> </ul> <h4 id="streaming-encrypt-uint8array-data-with-a-password">Streaming encrypt <em>Uint8Array</em> data with a password</h4> <pre class="prettyprint source lang-js"><code>(async () => { @@ -376,7 +417,7 @@ import * as openpgp from './openpgp.min.mjs'; } }); - const message = openpgp.Message.fromBinary(readableStream); + const message = await openpgp.createMessage({ binary: readableStream }); const encrypted = await openpgp.encrypt({ message, // input as Message object passwords: ['secret stuff'], // multiple passwords possible @@ -414,8 +455,10 @@ its <a href="https://openpgpjs.org/web-stream-tools/Reader.html">Reader class</a const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored }); - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase); + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); const readableStream = new openpgp.stream.ReadableStream({ start(controller) { @@ -425,7 +468,7 @@ its <a href="https://openpgpjs.org/web-stream-tools/Reader.html">Reader class</a }); const encrypted = await openpgp.encrypt({ - message: openpgp.Message.fromText(readableStream), // input as Message object + message: await openpgp.createMessage({ text: readableStream }), // input as Message object publicKeys: publicKey, // for encryption privateKeys: privateKey // for signing (optional) }); @@ -453,7 +496,7 @@ and a subkey for encryption using Curve25519.</p> const { privateKeyArmored, publicKeyArmored, revocationCertificate } = await openpgp.generateKey({ type: 'ecc', // Type of the key, defaults to ECC curve: 'curve25519', // ECC curve name, defaults to curve25519 - userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs + userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs passphrase: 'super long and hard to guess secret' // protects the private key }); @@ -467,7 +510,7 @@ and a subkey for encryption using Curve25519.</p> const key = await openpgp.generateKey({ type: 'rsa', // Type of the key rsaBits: 4096, // RSA key size (defaults to 4096 bits) - userIds: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs + userIDs: [{ name: 'Jon Smith', email: 'jon@example.com' }], // you can pass multiple user IDs passphrase: 'super long and hard to guess secret' // protects the private key }); })(); @@ -501,10 +544,12 @@ and a subkey for encryption using Curve25519.</p> const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored }); - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase); + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); - const unsignedMessage = openpgp.CleartextMessage.fromText('Hello, World!'); + const unsignedMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' }); const cleartextMessage = await openpgp.sign({ message: unsignedMessage, // CleartextMessage or Message object privateKeys: privateKey // for signing @@ -520,7 +565,7 @@ and a subkey for encryption using Curve25519.</p> }); const { valid } = verified.signatures[0]; if (valid) { - console.log('signed by key id ' + verified.signatures[0].keyid.toHex()); + console.log('signed by key id ' + verified.signatures[0].keyID.toHex()); } else { throw new Error('signature could not be verified'); } @@ -538,10 +583,12 @@ and a subkey for encryption using Curve25519.</p> const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmored }); - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase); + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); - const cleartextMessage = openpgp.CleartextMessage.fromText('Hello, World!'); + const cleartextMessage = await openpgp.createCleartextMessage({ text: 'Hello, World!' }); const detachedSignature = await openpgp.sign({ message: cleartextMessage, // CleartextMessage or Message object privateKeys: privateKey, // for signing @@ -559,7 +606,7 @@ and a subkey for encryption using Curve25519.</p> }); const { valid } = verified.signatures[0]; if (valid) { - console.log('signed by key id ' + verified.signatures[0].keyid.toHex()); + console.log('signed by key id ' + verified.signatures[0].keyID.toHex()); } else { throw new Error('signature could not be verified'); } @@ -582,10 +629,12 @@ and a subkey for encryption using Curve25519.</p> -----END PGP PRIVATE KEY BLOCK-----`; // encrypted private key const passphrase = `yourPassphrase`; // what the private key is encrypted with - const privateKey = await openpgp.readKey({ armoredKey: privateKeyArmored }); - await privateKey.decrypt(passphrase); + const privateKey = await openpgp.decryptKey({ + privateKey: await openpgp.readKey({ armoredKey: privateKeyArmored }), + passphrase + }); - const message = openpgp.Message.fromBinary(readableStream); // or .fromText(readableStream: ReadableStream<String>) + const message = await openpgp.createMessage({ binary: readableStream }); // or createMessage({ text: ReadableStream<String> }) const signatureArmored = await openpgp.sign({ message, privateKeys: privateKey // for signing @@ -602,9 +651,9 @@ and a subkey for encryption using Curve25519.</p> // even if you don't need it, as that is what triggers the // verification of the data. - const { valid } = verified.signatures[0]; + const valid = await verified.signatures[0].verified; if (valid) { - console.log('signed by key id ' + verified.signatures[0].keyid.toHex()); + console.log('signed by key id ' + verified.signatures[0].keyID.toHex()); } else { throw new Error('signature could not be verified'); } @@ -638,7 +687,7 @@ and a subkey for encryption using Curve25519.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-config.html b/docs/module-config.html index a11d39a7..8853f602 100644 --- a/docs/module-config.html +++ b/docs/module-config.html @@ -89,7 +89,7 @@ <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-1/src/config/index.js">config/index.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/index.js#L1">line 1</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/index.js">config/index.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/index.js#L1">line 1</a> </li></ul></dd> @@ -247,7 +247,7 @@ Must be an integer value from 0 to 56.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L69">line 69</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L69">line 69</a> </li></ul></dd> @@ -265,14 +265,15 @@ Must be an integer value from 0 to 56.</p> -<h4 class="name" id=".aeadMode"><span class="type-signature">(static) </span>aeadMode<span class="type-signature"></span></h4> +<h4 class="name" id=".aeadProtect"><span class="type-signature">(static) </span>aeadProtect<span class="type-signature"></span></h4> <div class="description"> - <p>Default Authenticated Encryption with Additional Data (AEAD) encryption mode -Only has an effect when aeadProtect is set to true.</p> + <p>Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. +Note: not all OpenPGP implementations are compatible with this option. +<strong>FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION</strong></p> </div> @@ -307,13 +308,13 @@ Only has an effect when aeadProtect is set to true.</p> <tr> - <td class="name"><code>aeadMode</code></td> + <td class="name"><code>aeadProtect</code></td> <td class="type"> -<span class="param-type">Integer</span> +<span class="param-type">Boolean</span> @@ -323,7 +324,7 @@ Only has an effect when aeadProtect is set to true.</p> - <td class="description last"><p>Default AEAD mode <a href="module-enums.html#.aead">module:enums.aead</a></p></td> + <td class="description last"></td> </tr> @@ -364,13 +365,20 @@ Only has an effect when aeadProtect is set to true.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L61">line 61</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L54">line 54</a> </li></ul></dd> + <dt class="tag-see">See:</dt> + <dd class="tag-see"> + <ul> + <li><a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-07">RFC4880bis-07</a></li> + </ul> + </dd> + </dl> @@ -382,15 +390,15 @@ Only has an effect when aeadProtect is set to true.</p> -<h4 class="name" id=".aeadProtect"><span class="type-signature">(static) </span>aeadProtect<span class="type-signature"></span></h4> +<h4 class="name" id=".allowInsecureDecryptionWithSigningKeys"><span class="type-signature">(static) </span>allowInsecureDecryptionWithSigningKeys<span class="type-signature"></span></h4> <div class="description"> - <p>Use Authenticated Encryption with Additional Data (AEAD) protection for symmetric encryption. -Note: not all OpenPGP implementations are compatible with this option. -<strong>FUTURE OPENPGP.JS VERSIONS MAY BREAK COMPATIBILITY WHEN USING THIS OPTION</strong></p> + <p>Allow decryption using RSA keys without <code>encrypt</code> flag. +This setting is potentially insecure, but it is needed to get around an old openpgpjs bug +where key flags were ignored when selecting a key for encryption.</p> </div> @@ -425,7 +433,7 @@ Note: not all OpenPGP implementations are compatible with this option. <tr> - <td class="name"><code>aeadProtect</code></td> + <td class="name"><code>allowInsecureDecryptionWithSigningKeys</code></td> <td class="type"> @@ -482,20 +490,13 @@ Note: not all OpenPGP implementations are compatible with this option. <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L54">line 54</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L130">line 130</a> </li></ul></dd> - <dt class="tag-see">See:</dt> - <dd class="tag-see"> - <ul> - <li><a href="https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-07">RFC4880bis-07</a></li> - </ul> - </dd> - </dl> @@ -507,15 +508,18 @@ Note: not all OpenPGP implementations are compatible with this option. -<h4 class="name" id=".allowInsecureDecryptionWithSigningKeys"><span class="type-signature">(static) </span>allowInsecureDecryptionWithSigningKeys<span class="type-signature"></span></h4> +<h4 class="name" id=".allowUnauthenticatedMessages"><span class="type-signature">(static) </span>allowUnauthenticatedMessages<span class="type-signature"></span></h4> <div class="description"> - <p>Allow decryption using RSA keys without <code>encrypt</code> flag. -This setting is potentially insecure, but it is needed to get around an old openpgpjs bug -where key flags were ignored when selecting a key for encryption.</p> + <p>Allow decryption of messages without integrity protection. +This is an <strong>insecure</strong> setting:</p> +<ul> +<li>message modifications cannot be detected, thus processing the decrypted data is potentially unsafe.</li> +<li>it enables downgrade attacks against integrity-protected messages.</li> +</ul> </div> @@ -550,7 +554,7 @@ where key flags were ignored when selecting a key for encryption.</p> <tr> - <td class="name"><code>allowInsecureDecryptionWithSigningKeys</code></td> + <td class="name"><code>allowUnauthenticatedMessages</code></td> <td class="type"> @@ -607,7 +611,7 @@ where key flags were ignored when selecting a key for encryption.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L130">line 130</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L93">line 93</a> </li></ul></dd> @@ -625,18 +629,14 @@ where key flags were ignored when selecting a key for encryption.</p> -<h4 class="name" id=".allowUnauthenticatedMessages"><span class="type-signature">(static) </span>allowUnauthenticatedMessages<span class="type-signature"></span></h4> +<h4 class="name" id=".allowUnauthenticatedStream"><span class="type-signature">(static) </span>allowUnauthenticatedStream<span class="type-signature"></span></h4> <div class="description"> - <p>Allow decryption of messages without integrity protection. -This is an <strong>insecure</strong> setting:</p> -<ul> -<li>message modifications cannot be detected, thus processing the decrypted data is potentially unsafe.</li> -<li>it enables downgrade attacks against integrity-protected messages.</li> -</ul> + <p>Allow streaming unauthenticated data before its integrity has been checked. +This setting is <strong>insecure</strong> if the partially decrypted message is processed further or displayed to the user.</p> </div> @@ -671,7 +671,7 @@ This is an <strong>insecure</strong> setting:</p> <tr> - <td class="name"><code>allowUnauthenticatedMessages</code></td> + <td class="name"><code>allowUnauthenticatedStream</code></td> <td class="type"> @@ -728,7 +728,7 @@ This is an <strong>insecure</strong> setting:</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L93">line 93</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L100">line 100</a> </li></ul></dd> @@ -746,15 +746,10 @@ This is an <strong>insecure</strong> setting:</p> -<h4 class="name" id=".allowUnauthenticatedStream"><span class="type-signature">(static) </span>allowUnauthenticatedStream<span class="type-signature"></span></h4> - +<h4 class="name" id=".checksumRequired"><span class="type-signature">(static) </span>checksumRequired<span class="type-signature"></span></h4> -<div class="description"> - <p>Allow streaming unauthenticated data before its integrity has been checked. -This setting is <strong>insecure</strong> if the partially decrypted message is processed further or displayed to the user.</p> -</div> @@ -788,7 +783,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>allowUnauthenticatedStream</code></td> + <td class="name"><code>checksumRequired</code></td> <td class="type"> @@ -804,7 +799,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"></td> + <td class="description last"><p>Do not throw error when armor is missing a checksum</p></td> </tr> @@ -845,7 +840,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L100">line 100</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L105">line 105</a> </li></ul></dd> @@ -863,7 +858,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".checksumRequired"><span class="type-signature">(static) </span>checksumRequired<span class="type-signature"></span></h4> +<h4 class="name" id=".commentString"><span class="type-signature">(static) </span>commentString<span class="type-signature"></span></h4> @@ -900,13 +895,13 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>checksumRequired</code></td> + <td class="name"><code>commentString</code></td> <td class="type"> -<span class="param-type">Boolean</span> +<span class="param-type">String</span> @@ -916,7 +911,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"><p>Do not throw error when armor is missing a checksum</p></td> + <td class="description last"><p>A comment string to be included in armored messages</p></td> </tr> @@ -957,7 +952,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L105">line 105</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L162">line 162</a> </li></ul></dd> @@ -975,7 +970,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".commentString"><span class="type-signature">(static) </span>commentString<span class="type-signature"></span></h4> +<h4 class="name" id=".deflateLevel"><span class="type-signature">(static) </span>deflateLevel<span class="type-signature"></span></h4> @@ -1012,13 +1007,13 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>commentString</code></td> + <td class="name"><code>deflateLevel</code></td> <td class="type"> -<span class="param-type">String</span> +<span class="param-type">Integer</span> @@ -1028,7 +1023,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"><p>A comment string to be included in armored messages</p></td> + <td class="description last"><p>Default zip/zlib compression level, between 1 and 9</p></td> </tr> @@ -1069,7 +1064,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L162">line 162</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L44">line 44</a> </li></ul></dd> @@ -1087,10 +1082,15 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".compression"><span class="type-signature">(static) </span>compression<span class="type-signature"></span></h4> +<h4 class="name" id=".knownNotations"><span class="type-signature">(static) </span>knownNotations<span class="type-signature"></span></h4> + +<div class="description"> + <p>Contains notatations that are considered "known". Known notations do not trigger +validation error when the notation is marked as critical.</p> +</div> @@ -1124,13 +1124,13 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>compression</code></td> + <td class="name"><code>knownNotations</code></td> <td class="type"> -<span class="param-type">Integer</span> +<span class="param-type">Array</span> @@ -1140,7 +1140,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"><p>Default compression algorithm <a href="module-enums.html#.compression">module:enums.compression</a></p></td> + <td class="description last"></td> </tr> @@ -1181,7 +1181,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L39">line 39</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L176">line 176</a> </li></ul></dd> @@ -1199,11 +1199,15 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".deflateLevel"><span class="type-signature">(static) </span>deflateLevel<span class="type-signature"></span></h4> +<h4 class="name" id=".maxUserIDLength"><span class="type-signature">(static) </span>maxUserIDLength<span class="type-signature"></span></h4> +<div class="description"> + <p>Max userID string length (used for parsing)</p> +</div> + @@ -1236,7 +1240,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>deflateLevel</code></td> + <td class="name"><code>maxUserIDLength</code></td> <td class="type"> @@ -1252,7 +1256,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"><p>Default zip/zlib compression level, between 1 and 9</p></td> + <td class="description last"></td> </tr> @@ -1293,7 +1297,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L44">line 44</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L169">line 169</a> </li></ul></dd> @@ -1311,7 +1315,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".encryptionCipher"><span class="type-signature">(static) </span>encryptionCipher<span class="type-signature"></span></h4> +<h4 class="name" id=".minBytesForWebCrypto"><span class="type-signature">(static) </span>minBytesForWebCrypto<span class="type-signature"></span></h4> @@ -1348,7 +1352,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <tr> - <td class="name"><code>encryptionCipher</code></td> + <td class="name"><code>minBytesForWebCrypto</code></td> <td class="type"> @@ -1364,7 +1368,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is - <td class="description last"><p>Default encryption cipher <a href="module-enums.html#.symmetric">module:enums.symmetric</a></p></td> + <td class="description last"><p>The minimum amount of bytes for which to use native WebCrypto APIs when available</p></td> </tr> @@ -1405,7 +1409,7 @@ This setting is <strong>insecure</strong> if the partially decrypted message is <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L34">line 34</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L136">line 136</a> </li></ul></dd> @@ -1423,14 +1427,126 @@ This setting is <strong>insecure</strong> if the partially decrypted message is -<h4 class="name" id=".knownNotations"><span class="type-signature">(static) </span>knownNotations<span class="type-signature"></span></h4> +<h4 class="name" id=".minRSABits"><span class="type-signature">(static) </span>minRSABits<span class="type-signature"></span></h4> + + + + + + + + + + + <h5 class="subsection-title">Properties:</h5> + + + +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>minRSABits</code></td> + + + <td class="type"> + + +<span class="param-type">Number</span> + + + + </td> + + + + + + <td class="description last"><p>Minimum RSA key size allowed for key generation and message signing, verification and encryption</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-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L110">line 110</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + +<h4 class="name" id=".passwordCollisionCheck"><span class="type-signature">(static) </span>passwordCollisionCheck<span class="type-signature"></span></h4> <div class="description"> - <p>Contains notatations that are considered "known". Known notations do not trigger -validation error when the notation is marked as critical.</p> + <p>Work-around for rare GPG decryption bug when encrypting with multiple passwords. +<strong>Slower and slightly less secure</strong></p> </div> @@ -1465,13 +1581,13 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>knownNotations</code></td> + <td class="name"><code>passwordCollisionCheck</code></td> <td class="type"> -<span class="param-type">Array</span> +<span class="param-type">Boolean</span> @@ -1522,7 +1638,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L176">line 176</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L117">line 117</a> </li></ul></dd> @@ -1540,13 +1656,14 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".maxUseridLength"><span class="type-signature">(static) </span>maxUseridLength<span class="type-signature"></span></h4> +<h4 class="name" id=".preferredAEADAlgorithm"><span class="type-signature">(static) </span>preferredAEADAlgorithm<span class="type-signature"></span></h4> <div class="description"> - <p>Max userid string length (used for parsing)</p> + <p>Default Authenticated Encryption with Additional Data (AEAD) encryption mode +Only has an effect when aeadProtect is set to true.</p> </div> @@ -1581,7 +1698,7 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>maxUseridLength</code></td> + <td class="name"><code>preferredAEADAlgorithm</code></td> <td class="type"> @@ -1597,7 +1714,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"></td> + <td class="description last"><p>Default AEAD mode <a href="module-enums.html#.aead">module:enums.aead</a></p></td> </tr> @@ -1638,7 +1755,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L169">line 169</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L61">line 61</a> </li></ul></dd> @@ -1656,7 +1773,7 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".minBytesForWebCrypto"><span class="type-signature">(static) </span>minBytesForWebCrypto<span class="type-signature"></span></h4> +<h4 class="name" id=".preferredCompressionAlgorithm"><span class="type-signature">(static) </span>preferredCompressionAlgorithm<span class="type-signature"></span></h4> @@ -1693,7 +1810,7 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>minBytesForWebCrypto</code></td> + <td class="name"><code>compression</code></td> <td class="type"> @@ -1709,7 +1826,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"><p>The minimum amount of bytes for which to use native WebCrypto APIs when available</p></td> + <td class="description last"><p>Default compression algorithm <a href="module-enums.html#.compression">module:enums.compression</a></p></td> </tr> @@ -1750,7 +1867,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L136">line 136</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L39">line 39</a> </li></ul></dd> @@ -1768,7 +1885,7 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".minRsaBits"><span class="type-signature">(static) </span>minRsaBits<span class="type-signature"></span></h4> +<h4 class="name" id=".preferredHashAlgorithm"><span class="type-signature">(static) </span>preferredHashAlgorithm<span class="type-signature"></span></h4> @@ -1805,13 +1922,13 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>minRsaBits</code></td> + <td class="name"><code>preferredHashAlgorithm</code></td> <td class="type"> -<span class="param-type">Number</span> +<span class="param-type">Integer</span> @@ -1821,7 +1938,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"><p>Minimum RSA key size allowed for key generation</p></td> + <td class="description last"><p>Default hash algorithm <a href="module-enums.html#.hash">module:enums.hash</a></p></td> </tr> @@ -1862,7 +1979,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L110">line 110</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L29">line 29</a> </li></ul></dd> @@ -1880,16 +1997,11 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".passwordCollisionCheck"><span class="type-signature">(static) </span>passwordCollisionCheck<span class="type-signature"></span></h4> +<h4 class="name" id=".preferredSymmetricAlgorithm"><span class="type-signature">(static) </span>preferredSymmetricAlgorithm<span class="type-signature"></span></h4> -<div class="description"> - <p>Work-around for rare GPG decryption bug when encrypting with multiple passwords. -<strong>Slower and slightly less secure</strong></p> -</div> - @@ -1922,13 +2034,13 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>passwordCollisionCheck</code></td> + <td class="name"><code>preferredSymmetricAlgorithm</code></td> <td class="type"> -<span class="param-type">Boolean</span> +<span class="param-type">Integer</span> @@ -1938,7 +2050,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"></td> + <td class="description last"><p>Default encryption cipher <a href="module-enums.html#.symmetric">module:enums.symmetric</a></p></td> </tr> @@ -1979,7 +2091,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L117">line 117</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L34">line 34</a> </li></ul></dd> @@ -1997,10 +2109,14 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".preferHashAlgorithm"><span class="type-signature">(static) </span>preferHashAlgorithm<span class="type-signature"></span></h4> +<h4 class="name" id=".rejectHashAlgorithms"><span class="type-signature">(static) </span>rejectHashAlgorithms<span class="type-signature"></span></h4> + +<div class="description"> + <p>Reject insecure hash algorithms</p> +</div> @@ -2034,13 +2150,13 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>preferHashAlgorithm</code></td> + <td class="name"><code>rejectHashAlgorithms</code></td> <td class="type"> -<span class="param-type">Integer</span> +<span class="param-type">Set.<Integer></span> @@ -2050,7 +2166,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"><p>Default hash algorithm <a href="module-enums.html#.hash">module:enums.hash</a></p></td> + <td class="description last"><p><a href="module-enums.html#.hash">module:enums.hash</a></p></td> </tr> @@ -2091,7 +2207,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L29">line 29</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L187">line 187</a> </li></ul></dd> @@ -2109,10 +2225,14 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".rejectHashAlgorithms"><span class="type-signature">(static) </span>rejectHashAlgorithms<span class="type-signature"></span></h4> +<h4 class="name" id=".rejectMessageHashAlgorithms"><span class="type-signature">(static) </span>rejectMessageHashAlgorithms<span class="type-signature"></span></h4> + +<div class="description"> + <p>Reject insecure message hash algorithms</p> +</div> @@ -2146,7 +2266,7 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>reject_hash_algorithms</code></td> + <td class="name"><code>rejectMessageHashAlgorithms</code></td> <td class="type"> @@ -2162,7 +2282,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"><p>Reject insecure hash algorithms <a href="module-enums.html#.hash">module:enums.hash</a></p></td> + <td class="description last"><p><a href="module-enums.html#.hash">module:enums.hash</a></p></td> </tr> @@ -2203,7 +2323,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L186">line 186</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L193">line 193</a> </li></ul></dd> @@ -2221,10 +2341,14 @@ validation error when the notation is marked as critical.</p> -<h4 class="name" id=".rejectMessageHashAlgorithms"><span class="type-signature">(static) </span>rejectMessageHashAlgorithms<span class="type-signature"></span></h4> +<h4 class="name" id=".rejectPublicKeyAlgorithms"><span class="type-signature">(static) </span>rejectPublicKeyAlgorithms<span class="type-signature"></span></h4> + +<div class="description"> + <p>Reject insecure public key algorithms for message encryption, signing or verification</p> +</div> @@ -2258,7 +2382,7 @@ validation error when the notation is marked as critical.</p> <tr> - <td class="name"><code>reject_message_hash_algorithms</code></td> + <td class="name"><code>rejectPublicKeyAlgorithms</code></td> <td class="type"> @@ -2274,7 +2398,7 @@ validation error when the notation is marked as critical.</p> - <td class="description last"><p>Reject insecure message hash algorithms <a href="module-enums.html#.hash">module:enums.hash</a></p></td> + <td class="description last"><p><a href="module-enums.html#.publicKey">module:enums.publicKey</a></p></td> </tr> @@ -2315,7 +2439,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L191">line 191</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L199">line 199</a> </li></ul></dd> @@ -2427,7 +2551,7 @@ validation error when the notation is marked as critical.</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L122">line 122</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L122">line 122</a> </li></ul></dd> @@ -2544,7 +2668,7 @@ Iteration Count Byte for S2K (String to Key)</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L84">line 84</a> </li></ul></dd> @@ -2656,7 +2780,7 @@ Iteration Count Byte for S2K (String to Key)</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L152">line 152</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L152">line 152</a> </li></ul></dd> @@ -2768,7 +2892,7 @@ Iteration Count Byte for S2K (String to Key)</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L147">line 147</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L147">line 147</a> </li></ul></dd> @@ -2880,7 +3004,7 @@ Iteration Count Byte for S2K (String to Key)</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L141">line 141</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L141">line 141</a> </li></ul></dd> @@ -2992,7 +3116,7 @@ Iteration Count Byte for S2K (String to Key)</p> <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L181">line 181</a> </li></ul></dd> @@ -3110,7 +3234,7 @@ Note: not all OpenPGP implementations are compatible with this option. <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L77">line 77</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L77">line 77</a> </li></ul></dd> @@ -3222,7 +3346,7 @@ Note: not all OpenPGP implementations are compatible with this option. <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-1/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/config/config.js#L157">line 157</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/config/config.js#L157">line 157</a> </li></ul></dd> @@ -3256,7 +3380,7 @@ Note: not all OpenPGP implementations are compatible with this option. </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-crypto_random-RandomBuffer.html b/docs/module-crypto_random-RandomBuffer.html index 4eb93e4c..685f8e8f 100644 --- a/docs/module-crypto_random-RandomBuffer.html +++ b/docs/module-crypto_random-RandomBuffer.html @@ -95,7 +95,7 @@ <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-1/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/crypto/random.js#L33">line 33</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js#L33">line 33</a> </li></ul></dd> @@ -254,7 +254,7 @@ <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-1/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/crypto/random.js#L73">line 73</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js#L73">line 73</a> </li></ul></dd> @@ -393,7 +393,7 @@ <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-1/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/crypto/random.js#L43">line 43</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js#L43">line 43</a> </li></ul></dd> @@ -532,7 +532,7 @@ <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-1/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/crypto/random.js#L53">line 53</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js">crypto/random.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/crypto/random.js#L53">line 53</a> </li></ul></dd> @@ -578,7 +578,7 @@ </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-enums.html b/docs/module-enums.html index 2ea46ca7..6994587d 100644 --- a/docs/module-enums.html +++ b/docs/module-enums.html @@ -155,7 +155,7 @@ <tr> - <td class="name"><code>experimentalGcm</code></td> + <td class="name"><code>experimentalGCM</code></td> <td class="type"> @@ -212,7 +212,7 @@ <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L180">line 180</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L180">line 180</a> </li></ul></dd> @@ -476,7 +476,7 @@ <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L409">line 409</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L409">line 409</a> </li></ul></dd> @@ -671,7 +671,7 @@ <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L142">line 142</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L142">line 142</a> </li></ul></dd> @@ -1878,7 +1878,7 @@ <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L14">line 14</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L14">line 14</a> </li></ul></dd> @@ -2059,7 +2059,7 @@ fingerprint format</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L440">line 440</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L440">line 440</a> </li></ul></dd> @@ -2323,7 +2323,7 @@ fingerprint format</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L155">line 155</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L155">line 155</a> </li></ul></dd> @@ -2589,7 +2589,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L386">line 386</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L386">line 386</a> </li></ul></dd> @@ -2784,7 +2784,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L215">line 215</a> </li></ul></dd> @@ -3244,7 +3244,7 @@ possession of more than one person.</p></td> <tr> - <td class="name"><code>AEADEncryptedData</code></td> + <td class="name"><code>aeadEncryptedData</code></td> <td class="type"> @@ -3301,7 +3301,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L190">line 190</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L190">line 190</a> </li></ul></dd> @@ -3635,7 +3635,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L97">line 97</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L97">line 97</a> </li></ul></dd> @@ -3796,7 +3796,7 @@ possession of more than one person.</p></td> <tr> - <td class="name"><code>userIdInvalid</code></td> + <td class="name"><code>userIDInvalid</code></td> <td class="type"> @@ -3853,7 +3853,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L423">line 423</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L423">line 423</a> </li></ul></dd> @@ -4048,7 +4048,7 @@ possession of more than one person.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L86">line 86</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L86">line 86</a> </li></ul></dd> @@ -4565,7 +4565,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L231">line 231</a> </li></ul></dd> @@ -5002,7 +5002,7 @@ document) that cannot include a target subpacket.</p></td> <tr> - <td class="name"><code>primaryUserId</code></td> + <td class="name"><code>primaryUserID</code></td> <td class="type"> @@ -5025,7 +5025,7 @@ document) that cannot include a target subpacket.</p></td> <tr> - <td class="name"><code>policyUri</code></td> + <td class="name"><code>policyURI</code></td> <td class="type"> @@ -5071,7 +5071,7 @@ document) that cannot include a target subpacket.</p></td> <tr> - <td class="name"><code>signersUserId</code></td> + <td class="name"><code>signersUserID</code></td> <td class="type"> @@ -5209,7 +5209,7 @@ document) that cannot include a target subpacket.</p></td> <tr> - <td class="name"><code>preferredAeadAlgorithms</code></td> + <td class="name"><code>preferredAEADAlgorithms</code></td> <td class="type"> @@ -5266,7 +5266,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L353">line 353</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L353">line 353</a> </li></ul></dd> @@ -5576,7 +5576,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L125">line 125</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L125">line 125</a> </li></ul></dd> @@ -5772,7 +5772,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L169">line 169</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L169">line 169</a> </li></ul></dd> @@ -5854,7 +5854,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L465">line 465</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L465">line 465</a> </li></ul></dd> @@ -5944,7 +5944,7 @@ document) that cannot include a target subpacket.</p></td> <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-1/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/enums.js#L452">line 452</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js">enums.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/enums.js#L452">line 452</a> </li></ul></dd> @@ -5990,7 +5990,7 @@ document) that cannot include a target subpacket.</p></td> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-key_SubKey-SubKey.html b/docs/module-key_SubKey-SubKey.html index c93c3df2..9281f167 100644 --- a/docs/module-key_SubKey-SubKey.html +++ b/docs/module-key_SubKey-SubKey.html @@ -95,7 +95,7 @@ <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L21">line 21</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L21">line 21</a> </li></ul></dd> @@ -210,7 +210,7 @@ <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -327,7 +327,7 @@ <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L231">line 231</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L230">line 230</a> </li></ul></dd> @@ -444,7 +444,7 @@ <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -557,7 +557,7 @@ <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L173">line 173</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L172">line 172</a> </li></ul></dd> @@ -611,7 +611,7 @@ - <h4 class="name" id="getExpirationTime"><span class="type-signature">(async) </span>getExpirationTime<span class="signature">(primaryKey, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Date|Infinity|null}</span></h4> + <h4 class="name" id="getExpirationTime"><span class="type-signature">(async) </span>getExpirationTime<span class="signature">(primaryKey, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(Date|Infinity|null)>}</span></h4> @@ -792,7 +792,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L101">line 101</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L101">line 101</a> </li></ul></dd> @@ -828,13 +828,7 @@ Returns null if the subkey is invalid.</p> </dt> <dd> -<span class="param-type">Date</span> -| - -<span class="param-type">Infinity</span> -| - -<span class="param-type">null</span> +<span class="param-type">Promise.<(Date|Infinity|null)></span> </dd> @@ -911,7 +905,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -1028,7 +1022,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L215">line 215</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L214">line 214</a> </li></ul></dd> @@ -1086,7 +1080,7 @@ Returns null if the subkey is invalid.</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -1120,7 +1114,7 @@ Returns null if the subkey is invalid.</p> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#getKeyId">PublicKeyPacket#getKeyId</a> + <a href="PublicKeyPacket.html#getKeyID">PublicKeyPacket#getKeyID</a> </li></ul></dd> @@ -1145,7 +1139,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -1185,7 +1179,7 @@ Returns null if the subkey is invalid.</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -1203,7 +1197,7 @@ Returns null if the subkey is invalid.</p> - <h4 class="name" id="getKeyId"><span class="type-signature"></span>getKeyId<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>}</span></h4> + <h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4> @@ -1237,7 +1231,7 @@ Returns null if the subkey is invalid.</p> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> - <a href="PublicKeyPacket.html#getKeyId">PublicKeyPacket#getKeyId</a> + <a href="PublicKeyPacket.html#getKeyID">PublicKeyPacket#getKeyID</a> </li></ul></dd> @@ -1262,7 +1256,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L181">line 181</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L180">line 180</a> </li></ul></dd> @@ -1302,7 +1296,7 @@ Returns null if the subkey is invalid.</p> </dt> <dd> -<span class="param-type"><a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a></span> +<span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span> </dd> @@ -1379,7 +1373,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -1496,7 +1490,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L223">line 223</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L222">line 222</a> </li></ul></dd> @@ -1613,7 +1607,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L165">line 165</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L164">line 164</a> </li></ul></dd> @@ -1729,7 +1723,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/packet/public_key.js#L165">line 165</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/packet/public_key.js#L164">line 164</a> </li></ul></dd> @@ -1786,7 +1780,7 @@ Returns null if the subkey is invalid.</p> - <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(primaryKey, signature, key,, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(primaryKey, signature, key,, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -2037,7 +2031,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L56">line 56</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L56">line 56</a> </li></ul></dd> @@ -2077,7 +2071,7 @@ Returns null if the subkey is invalid.</p> </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -2095,7 +2089,7 @@ Returns null if the subkey is invalid.</p> - <h4 class="name" id="revoke"><span class="type-signature">(async) </span>revoke<span class="signature">(primaryKey, reasonForRevocation, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {SubKey}</span></h4> + <h4 class="name" id="revoke"><span class="type-signature">(async) </span>revoke<span class="signature">(primaryKey, reasonForRevocation, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<SubKey>}</span></h4> @@ -2375,7 +2369,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L168">line 168</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L168">line 168</a> </li></ul></dd> @@ -2415,7 +2409,7 @@ Returns null if the subkey is invalid.</p> </dt> <dd> -<span class="param-type">SubKey</span> +<span class="param-type">Promise.<SubKey></span> </dd> @@ -2487,7 +2481,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L34">line 34</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L34">line 34</a> </li></ul></dd> @@ -2721,7 +2715,7 @@ Returns null if the subkey is invalid.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L123">line 123</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L123">line 123</a> </li></ul></dd> @@ -2786,7 +2780,7 @@ Returns null if the subkey is invalid.</p> - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(primaryKey, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="SignaturePacket.html">SignaturePacket</a>}</span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(primaryKey, date, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="SignaturePacket.html">SignaturePacket</a>>}</span></h4> @@ -2967,7 +2961,7 @@ and valid binding signature.</p> <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-1/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/subkey.js#L76">line 76</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js">key/subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/subkey.js#L76">line 76</a> </li></ul></dd> @@ -3032,7 +3026,7 @@ and valid binding signature.</p> </dt> <dd> -<span class="param-type"><a href="SignaturePacket.html">SignaturePacket</a></span> +<span class="param-type">Promise.<<a href="SignaturePacket.html">SignaturePacket</a>></span> </dd> @@ -3060,7 +3054,7 @@ and valid binding signature.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-key_User-User.html b/docs/module-key_User-User.html index b5a809c3..c1c237b9 100644 --- a/docs/module-key_User-User.html +++ b/docs/module-key_User-User.html @@ -95,7 +95,7 @@ <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L15">line 15</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L15">line 15</a> </li></ul></dd> @@ -151,7 +151,7 @@ - <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(primaryKey, certificate, key,, date, config)</span><span class="type-signature"> → {Boolean}</span></h4> + <h4 class="name" id="isRevoked"><span class="type-signature">(async) </span>isRevoked<span class="signature">(primaryKey, certificate, key,, date, config)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4> @@ -358,7 +358,7 @@ <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L87">line 87</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L87">line 87</a> </li></ul></dd> @@ -398,7 +398,7 @@ </dt> <dd> -<span class="param-type">Boolean</span> +<span class="param-type">Promise.<Boolean></span> </dd> @@ -416,7 +416,7 @@ - <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(primaryKey, privateKeys, config)</span><span class="type-signature"> → {<a href="Key.html">Key</a>}</span></h4> + <h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(primaryKey, privateKeys, config)</span><span class="type-signature"> → {Promise.<<a href="Key.html">Key</a>>}</span></h4> @@ -568,7 +568,7 @@ <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L48">line 48</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L48">line 48</a> </li></ul></dd> @@ -608,7 +608,7 @@ </dt> <dd> -<span class="param-type"><a href="Key.html">Key</a></span> +<span class="param-type">Promise.<<a href="Key.html">Key</a>></span> </dd> @@ -680,7 +680,7 @@ <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L30">line 30</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L30">line 30</a> </li></ul></dd> @@ -734,7 +734,7 @@ - <h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(user, primaryKey, config)</span><span class="type-signature"> → {undefined}</span></h4> + <h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(user, primaryKey, config)</span><span class="type-signature"> → {Promise.<undefined>}</span></h4> @@ -886,7 +886,7 @@ <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L213">line 213</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L215">line 215</a> </li></ul></dd> @@ -922,7 +922,7 @@ </dt> <dd> -<span class="param-type">undefined</span> +<span class="param-type">Promise.<undefined></span> </dd> @@ -940,7 +940,7 @@ - <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(primaryKey, date, config)</span><span class="type-signature"> → {true}</span></h4> + <h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(primaryKey, date, config)</span><span class="type-signature"> → {Promise.<true>}</span></h4> @@ -1093,7 +1093,7 @@ and validity of self signature.</p> <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L170">line 170</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L172">line 172</a> </li></ul></dd> @@ -1162,7 +1162,7 @@ and validity of self signature.</p> </dt> <dd> -<span class="param-type">true</span> +<span class="param-type">Promise.<true></span> </dd> @@ -1180,7 +1180,7 @@ and validity of self signature.</p> - <h4 class="name" id="verifyAllCertifications"><span class="type-signature">(async) </span>verifyAllCertifications<span class="signature">(primaryKey, keys, date, config)</span><span class="type-signature"> → {Promise.<Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>>}</span></h4> + <h4 class="name" id="verifyAllCertifications"><span class="type-signature">(async) </span>verifyAllCertifications<span class="signature">(primaryKey, keys, date, config)</span><span class="type-signature"> → {Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>>}</span></h4> @@ -1355,7 +1355,7 @@ and validity of self signature.</p> <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L148">line 148</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L150">line 150</a> </li></ul></dd> @@ -1384,7 +1384,7 @@ and validity of self signature.</p> <div class="param-desc"> - <p>List of signer's keyid and validity of signature</p> + <p>List of signer's keyID and validity of signature</p> </div> @@ -1395,7 +1395,7 @@ and validity of self signature.</p> </dt> <dd> -<span class="param-type">Promise.<Array.<{keyid: <a href="module-type_keyid-Keyid.html">module:type/keyid~Keyid</a>, valid: Boolean}>></span> +<span class="param-type">Promise.<Array.<{keyID: <a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>, valid: Boolean}>></span> </dd> @@ -1413,7 +1413,7 @@ and validity of self signature.</p> - <h4 class="name" id="verifyCertificate"><span class="type-signature">(async) </span>verifyCertificate<span class="signature">(primaryKey, certificate, keys, date, config)</span><span class="type-signature"> → {true|null}</span></h4> + <h4 class="name" id="verifyCertificate"><span class="type-signature">(async) </span>verifyCertificate<span class="signature">(primaryKey, certificate, keys, date, config)</span><span class="type-signature"> → {Promise.<(true|null)>}</span></h4> @@ -1611,7 +1611,7 @@ and validity of self signature.</p> <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-1/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/key/user.js#L108">line 108</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js">key/user.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/key/user.js#L108">line 108</a> </li></ul></dd> @@ -1651,10 +1651,7 @@ and validity of self signature.</p> </dt> <dd> -<span class="param-type">true</span> -| - -<span class="param-type">null</span> +<span class="param-type">Promise.<(true|null)></span> </dd> @@ -1682,7 +1679,7 @@ and validity of self signature.</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-type_kdf_params-KDFParams.html b/docs/module-type_kdf_params-KDFParams.html index fde87145..776a22fc 100644 --- a/docs/module-type_kdf_params-KDFParams.html +++ b/docs/module-type_kdf_params-KDFParams.html @@ -163,7 +163,7 @@ <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-1/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/kdf_params.js#L35">line 35</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js#L35">line 35</a> </li></ul></dd> @@ -322,7 +322,7 @@ <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-1/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/kdf_params.js#L51">line 51</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js#L51">line 51</a> </li></ul></dd> @@ -434,7 +434,7 @@ <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-1/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/kdf_params.js#L64">line 64</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js">type/kdf_params.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/kdf_params.js#L64">line 64</a> </li></ul></dd> @@ -502,7 +502,7 @@ </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-type_keyid-Keyid.html b/docs/module-type_keyid-KeyID.html index 84d082ba..c3f8882a 100644 --- a/docs/module-type_keyid-Keyid.html +++ b/docs/module-type_keyid-KeyID.html @@ -2,7 +2,7 @@ <html lang="en"> <head> <meta charset="utf-8"> - <title>JSDoc: Class: Keyid</title> + <title>JSDoc: Class: KeyID</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> @@ -17,7 +17,7 @@ <div id="main"> - <h1 class="page-title">Class: Keyid</h1> + <h1 class="page-title">Class: KeyID</h1> @@ -28,7 +28,7 @@ <header> - <h2><span class="attribs"><span class="type-signature"></span></span>Keyid<span class="signature">()</span><span class="type-signature"></span></h2> + <h2><span class="attribs"><span class="type-signature"></span></span>KeyID<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description"><p>Implementation of type key id</p> <p><a href="https://tools.ietf.org/html/rfc4880#section-3.3">RFC4880 3.3</a>: @@ -50,7 +50,7 @@ formed.</p></div> - <h4 class="name" id="Keyid"><span class="type-signature"></span>new Keyid<span class="signature">()</span><span class="type-signature"></span></h4> + <h4 class="name" id="KeyID"><span class="type-signature"></span>new KeyID<span class="signature">()</span><span class="type-signature"></span></h4> @@ -100,7 +100,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L35">line 35</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L35">line 35</a> </li></ul></dd> @@ -156,7 +156,7 @@ formed.</p></div> - <h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(keyid, matchWildcard)</span><span class="type-signature"></span></h4> + <h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(keyID, matchWildcard)</span><span class="type-signature"></span></h4> @@ -202,13 +202,13 @@ formed.</p></div> <tr> - <td class="name"><code>keyid</code></td> + <td class="name"><code>keyID</code></td> <td class="type"> -<span class="param-type">Keyid</span> +<span class="param-type">KeyID</span> @@ -251,7 +251,7 @@ formed.</p></div> </td> - <td class="description last"><p>Indicates whether to check if either keyid is a wildcard</p></td> + <td class="description last"><p>Indicates whether to check if either keyID is a wildcard</p></td> </tr> @@ -294,7 +294,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L68">line 68</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L68">line 68</a> </li></ul></dd> @@ -384,7 +384,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L76">line 76</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L76">line 76</a> </li></ul></dd> @@ -496,7 +496,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L84">line 84</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L84">line 84</a> </li></ul></dd> @@ -657,7 +657,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L43">line 43</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L43">line 43</a> </li></ul></dd> @@ -747,7 +747,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L59">line 59</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L59">line 59</a> </li></ul></dd> @@ -859,7 +859,7 @@ formed.</p></div> <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-1/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/keyid.js#L51">line 51</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js">type/keyid.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/keyid.js#L51">line 51</a> </li></ul></dd> @@ -927,7 +927,7 @@ formed.</p></div> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> diff --git a/docs/module-type_s2k-S2K.html b/docs/module-type_s2k-S2K.html index 5c004e97..686f612e 100644 --- a/docs/module-type_s2k-S2K.html +++ b/docs/module-type_s2k-S2K.html @@ -152,7 +152,7 @@ <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L40">line 40</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L40">line 40</a> </li></ul></dd> @@ -254,7 +254,7 @@ <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L42">line 42</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L42">line 42</a> </li></ul></dd> @@ -324,7 +324,7 @@ <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L46">line 46</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L46">line 46</a> </li></ul></dd> @@ -398,7 +398,7 @@ <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L50">line 50</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L50">line 50</a> </li></ul></dd> @@ -468,7 +468,7 @@ <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L44">line 44</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L44">line 44</a> </li></ul></dd> @@ -496,7 +496,7 @@ - <h4 class="name" id="produce_key"><span class="type-signature">(async) </span>produce_key<span class="signature">(passphrase)</span><span class="type-signature"> → {Uint8Array}</span></h4> + <h4 class="name" id="produceKey"><span class="type-signature">(async) </span>produceKey<span class="signature">(passphrase)</span><span class="type-signature"> → {Promise.<Uint8Array>}</span></h4> @@ -600,7 +600,7 @@ hashAlgorithm</p> <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L149">line 149</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L150">line 150</a> </li></ul></dd> @@ -641,7 +641,7 @@ hashAlgorithm hash length</p> </dt> <dd> -<span class="param-type">Uint8Array</span> +<span class="param-type">Promise.<Uint8Array></span> </dd> @@ -762,7 +762,7 @@ hashAlgorithm hash length</p> <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L65">line 65</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L65">line 65</a> </li></ul></dd> @@ -874,7 +874,7 @@ hashAlgorithm hash length</p> <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-1/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-1/src/type/s2k.js#L116">line 116</a> + <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js">type/s2k.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.0.0-2/src/type/s2k.js#L116">line 116</a> </li></ul></dd> @@ -942,7 +942,7 @@ hashAlgorithm hash length</p> </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="Key.html">Key</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></ul> + <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#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createMessage">createMessage</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#newPacketFromTag">newPacketFromTag</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="Key.html">Key</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></ul> </nav> <br class="clear"> |