This commit is contained in:
Daniel Huigens
2021-03-03 20:28:16 +01:00
parent b9134ed161
commit 4379d1856e
38 changed files with 5583 additions and 4571 deletions

View File

@@ -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-0/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-0/src/packet/sym_encrypted_integrity_protected_data.js#L43">line 43</a>
<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>
</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-0/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-0/src/packet/sym_encrypted_integrity_protected_data.js#L47">line 47</a>
<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>
</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-0/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-0/src/packet/sym_encrypted_integrity_protected_data.js#L54">line 54</a>
<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>
</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><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h4>
<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"> &rarr; {Boolean}</span></h4>
@@ -333,6 +333,8 @@ should be discarded.</p>
<th>Type</th>
<th>Attributes</th>
@@ -358,6 +360,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -381,6 +391,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -404,6 +422,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -427,10 +453,20 @@ should be discarded.</p>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
<td class="description last"><p>Full configuration, defaults to openpgp.config</p></td>
</tr>
@@ -473,7 +509,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-0/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-0/src/packet/sym_encrypted_integrity_protected_data.js#L109">line 109</a>
<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>
</li></ul></dd>
@@ -509,7 +545,7 @@ should be discarded.</p>
</dt>
<dd>
<span class="param-type">Promise.&lt;Boolean></span>
<span class="param-type">Boolean</span>
</dd>
@@ -527,7 +563,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><span class="type-signature"> &rarr; {Promise.&lt;Boolean>}</span></h4>
<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"> &rarr; {Boolean}</span></h4>
@@ -559,6 +595,8 @@ should be discarded.</p>
<th>Type</th>
<th>Attributes</th>
@@ -584,6 +622,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -607,6 +653,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -630,6 +684,14 @@ should be discarded.</p>
</td>
<td class="attributes">
</td>
@@ -653,10 +715,20 @@ should be discarded.</p>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>(optional) full configuration, defaults to openpgp.config</p></td>
<td class="description last"><p>Full configuration, defaults to openpgp.config</p></td>
</tr>
@@ -699,7 +771,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-0/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-0/src/packet/sym_encrypted_integrity_protected_data.js#L86">line 86</a>
<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>
</li></ul></dd>
@@ -735,7 +807,7 @@ should be discarded.</p>
</dt>
<dd>
<span class="param-type">Promise.&lt;Boolean></span>
<span class="param-type">Boolean</span>
</dd>
@@ -763,13 +835,13 @@ 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="HKP.html">HKP</a></li><li><a href="Key.html">Key</a></li><li><a href="KeyArray.html">KeyArray</a></li><li><a href="Keyring.html">Keyring</a></li><li><a href="LiteralDataPacket.html">LiteralDataPacket</a></li><li><a href="MarkerPacket.html">MarkerPacket</a></li><li><a href="Message.html">Message</a></li><li><a href="module-crypto_random-RandomBuffer.html">RandomBuffer</a></li><li><a href="module-key_SubKey-SubKey.html">SubKey</a></li><li><a href="module-key_User-User.html">User</a></li><li><a href="module-type_kdf_params-KDFParams.html">KDFParams</a></li><li><a href="module-type_keyid-Keyid.html">Keyid</a></li><li><a href="module-type_s2k-S2K.html">S2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PublicKeyEncryptedSessionKeyPacket.html">PublicKeyEncryptedSessionKeyPacket</a></li><li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li><li><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></li><li><a href="SecretKeyPacket.html">SecretKeyPacket</a></li><li><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></li><li><a href="Signature.html">Signature</a></li><li><a href="SignaturePacket.html">SignaturePacket</a></li><li><a href="SymEncryptedIntegrityProtectedDataPacket.html">SymEncryptedIntegrityProtectedDataPacket</a></li><li><a href="SymEncryptedSessionKeyPacket.html">SymEncryptedSessionKeyPacket</a></li><li><a href="SymmetricallyEncryptedDataPacket.html">SymmetricallyEncryptedDataPacket</a></li><li><a href="TrustPacket.html">TrustPacket</a></li><li><a href="UserAttributePacket.html">UserAttributePacket</a></li><li><a href="UserIDPacket.html">UserIDPacket</a></li><li><a href="WKD.html">WKD</a></li></ul>
<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>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Sat Feb 27 2021 01:25:52 GMT+0100 (Midden-Europese standaardtijd)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a>
</footer>
<script> prettyPrint(); </script>