<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Module: config</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"></head>
<body>
<div id="main">
<h1 class="page-title">Module: config</h1>
<section>
<header> </header>
<article> <div class="container-overview"> <div class="description"><p>This object contains global configuration values.</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.4.0/src/config/index.js">config/index.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/index.js#L1">line 1</a> </li></ul></dd>
<dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li>module:config/config</li> </ul> </dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".aeadChunkSizeByte"><span class="type-signature">(static) </span>aeadChunkSizeByte<span class="type-signature"></span></h4>
<div class="description"> <p>Chunk Size Byte for Authenticated Encryption with Additional Data (AEAD) modeOnly has an effect when aeadProtect is set to true.Must be an integer value from 0 to 56.</p></div>
<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>aeadChunkSizeByte</code></td>
<td class="type"> <span class="param-type">Integer</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L69">line 69</a> </li></ul></dd>
</dl>
<h4 class="name" id=".aeadProtect"><span class="type-signature">(static) </span>aeadProtect<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></div>
<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>aeadProtect</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/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>
<h4 class="name" id=".allowInsecureDecryptionWithSigningKeys"><span class="type-signature">(static) </span>allowInsecureDecryptionWithSigningKeys<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 bugwhere key flags were ignored when selecting a key for encryption.</p></div>
<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>allowInsecureDecryptionWithSigningKeys</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L135">line 135</a> </li></ul></dd>
</dl>
<h4 class="name" id=".allowInsecureVerificationWithReformattedKeys"><span class="type-signature">(static) </span>allowInsecureVerificationWithReformattedKeys<span class="type-signature"></span></h4>
<div class="description"> <p>Allow verification of message signatures with keys whose validity at the time of signing cannot be determined.Instead, a verification key will also be consider valid as long as it is valid at the current time.This setting is potentially insecure, but it is needed to verify messages signed with keys that were later reformatted,and have self-signature's creation date that does not match the primary key creation date.</p></div>
<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>allowInsecureDecryptionWithSigningKeys</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L144">line 144</a> </li></ul></dd>
</dl>
<h4 class="name" id=".allowUnauthenticatedMessages"><span class="type-signature">(static) </span>allowUnauthenticatedMessages<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></div>
<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>allowUnauthenticatedMessages</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L93">line 93</a> </li></ul></dd>
</dl>
<h4 class="name" id=".allowUnauthenticatedStream"><span class="type-signature">(static) </span>allowUnauthenticatedStream<span class="type-signature"></span></h4>
<div class="description"> <p>Allow streaming unauthenticated data before its integrity has been checked. This would allow the application toprocess large streams while limiting memory usage by releasing the decrypted chunks as soon as possibleand deferring checking their integrity until the decrypted stream has been read in full.</p><p>This setting is <strong>insecure</strong> if the partially decrypted message is processed further or displayed to the user.</p></div>
<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>allowUnauthenticatedStream</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L103">line 103</a> </li></ul></dd>
</dl>
<h4 class="name" id=".checksumRequired"><span class="type-signature">(static) </span>checksumRequired<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>checksumRequired</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Do not throw error when armor is missing a checksum</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L108">line 108</a> </li></ul></dd>
</dl>
<h4 class="name" id=".commentString"><span class="type-signature">(static) </span>commentString<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>commentString</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>A comment string to be included in armored messages</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L199">line 199</a> </li></ul></dd>
</dl>
<h4 class="name" id=".constantTimePKCS1Decryption"><span class="type-signature">(static) </span>constantTimePKCS1Decryption<span class="type-signature"></span></h4>
<div class="description"> <p>Enable constant-time decryption of RSA- and ElGamal-encrypted session keys, to hinder Bleichenbacher-like attacks (https://link.springer.com/chapter/10.1007/BFb0055716).This setting has measurable performance impact and it is only helpful in application scenarios where both of the following conditions apply:</p><ul><li>new/incoming messages are automatically decrypted (without user interaction);</li><li>an attacker can determine how long it takes to decrypt each message (e.g. due to decryption errors being logged remotely).See also <code>constantTimePKCS1DecryptionSupportedSymmetricAlgorithms</code>.</li></ul></div>
<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>constantTimePKCS1Decryption</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L155">line 155</a> </li></ul></dd>
</dl>
<h4 class="name" id=".constantTimePKCS1DecryptionSupportedSymmetricAlgorithms"><span class="type-signature">(static) </span>constantTimePKCS1DecryptionSupportedSymmetricAlgorithms<span class="type-signature"></span></h4>
<div class="description"> <p>This setting is only meaningful if <code>constantTimePKCS1Decryption</code> is enabled.Decryption of RSA- and ElGamal-encrypted session keys of symmetric algorithms different from the ones specified here will fail.However, the more algorithms are added, the slower the decryption procedure becomes.</p></div>
<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>constantTimePKCS1DecryptionSupportedSymmetricAlgorithms</code></td>
<td class="type"> <span class="param-type">Set.<Integer></span>
</td>
<td class="description last"><p><a href="module-enums.html#.symmetric">module:enums.symmetric</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L163">line 163</a> </li></ul></dd>
</dl>
<h4 class="name" id=".deflateLevel"><span class="type-signature">(static) </span>deflateLevel<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>deflateLevel</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Default zip/zlib compression level, between 1 and 9</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L44">line 44</a> </li></ul></dd>
</dl>
<h4 class="name" id=".ignoreMalformedPackets"><span class="type-signature">(static) </span>ignoreMalformedPackets<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>ignoreMalformedPackets</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Ignore malformed packets on parsing instead of throwing an error</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L179">line 179</a> </li></ul></dd>
</dl>
<h4 class="name" id=".ignoreUnsupportedPackets"><span class="type-signature">(static) </span>ignoreUnsupportedPackets<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>ignoreUnsupportedPackets</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Ignore unsupported/unrecognizable packets on parsing instead of throwing an error</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L174">line 174</a> </li></ul></dd>
</dl>
<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 triggervalidation error when the notation is marked as critical.</p></div>
<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>knownNotations</code></td>
<td class="type"> <span class="param-type">Array</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L213">line 213</a> </li></ul></dd>
</dl>
<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>
<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>maxUserIDLength</code></td>
<td class="type"> <span class="param-type">Integer</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L206">line 206</a> </li></ul></dd>
</dl>
<h4 class="name" id=".minBytesForWebCrypto"><span class="type-signature">(static) </span>minBytesForWebCrypto<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>minBytesForWebCrypto</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>The minimum amount of bytes for which to use native WebCrypto APIs when available</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L169">line 169</a> </li></ul></dd>
</dl>
<h4 class="name" id=".minRSABits"><span class="type-signature">(static) </span>minRSABits<span class="type-signature"></span></h4>
<div class="description"> <p>Minimum RSA key size allowed for key generation and message signing, verification and encryption.The default is 2047 since due to a bug, previous versions of OpenPGP.js could generate 2047-bit keys instead of 2048-bit ones.</p></div>
<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"></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L115">line 115</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>Work-around for rare GPG decryption bug when encrypting with multiple passwords.<strong>Slower and slightly less secure</strong></p></div>
<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>passwordCollisionCheck</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L122">line 122</a> </li></ul></dd>
</dl>
<h4 class="name" id=".preferredAEADAlgorithm"><span class="type-signature">(static) </span>preferredAEADAlgorithm<span class="type-signature"></span></h4>
<div class="description"> <p>Default Authenticated Encryption with Additional Data (AEAD) encryption modeOnly has an effect when aeadProtect is set to true.</p></div>
<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>preferredAEADAlgorithm</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Default AEAD mode <a href="module-enums.html#.aead">module:enums.aead</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L61">line 61</a> </li></ul></dd>
</dl>
<h4 class="name" id=".preferredCompressionAlgorithm"><span class="type-signature">(static) </span>preferredCompressionAlgorithm<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>compression</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Default compression algorithm <a href="module-enums.html#.compression">module:enums.compression</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L39">line 39</a> </li></ul></dd>
</dl>
<h4 class="name" id=".preferredHashAlgorithm"><span class="type-signature">(static) </span>preferredHashAlgorithm<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>preferredHashAlgorithm</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Default hash algorithm <a href="module-enums.html#.hash">module:enums.hash</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L29">line 29</a> </li></ul></dd>
</dl>
<h4 class="name" id=".preferredSymmetricAlgorithm"><span class="type-signature">(static) </span>preferredSymmetricAlgorithm<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>preferredSymmetricAlgorithm</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>Default encryption cipher <a href="module-enums.html#.symmetric">module:enums.symmetric</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L34">line 34</a> </li></ul></dd>
</dl>
<h4 class="name" id=".rejectCurves"><span class="type-signature">(static) </span>rejectCurves<span class="type-signature"></span></h4>
<div class="description"> <p>Reject non-standard curves for key generation, message encryption, signing or verification</p></div>
<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>rejectCurves</code></td>
<td class="type"> <span class="param-type">Set.<String></span>
</td>
<td class="description last"><p><a href="module-enums.html#.curve">module:enums.curve</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L245">line 245</a> </li></ul></dd>
</dl>
<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>
<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>rejectHashAlgorithms</code></td>
<td class="type"> <span class="param-type">Set.<Integer></span>
</td>
<td class="description last"><p><a href="module-enums.html#.hash">module:enums.hash</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L227">line 227</a> </li></ul></dd>
</dl>
<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>
<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>rejectMessageHashAlgorithms</code></td>
<td class="type"> <span class="param-type">Set.<Integer></span>
</td>
<td class="description last"><p><a href="module-enums.html#.hash">module:enums.hash</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L233">line 233</a> </li></ul></dd>
</dl>
<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 key generation and message encryption, signing or verification</p></div>
<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>rejectPublicKeyAlgorithms</code></td>
<td class="type"> <span class="param-type">Set.<Integer></span>
</td>
<td class="description last"><p><a href="module-enums.html#.publicKey">module:enums.publicKey</a></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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L239">line 239</a> </li></ul></dd>
</dl>
<h4 class="name" id=".revocationsExpire"><span class="type-signature">(static) </span>revocationsExpire<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>revocationsExpire</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>If true, expired revocation signatures are ignored</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L127">line 127</a> </li></ul></dd>
</dl>
<h4 class="name" id=".s2kIterationCountByte"><span class="type-signature">(static) </span>s2kIterationCountByte<span class="type-signature"></span></h4>
<div class="description"> <p><a href="https://tools.ietf.org/html/rfc4880#section-3.7.1.3">RFC4880 3.7.1.3</a>:Iteration Count Byte for S2K (String to Key)</p></div>
<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>s2kIterationCountByte</code></td>
<td class="type"> <span class="param-type">Integer</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L84">line 84</a> </li></ul></dd>
</dl>
<h4 class="name" id=".showComment"><span class="type-signature">(static) </span>showComment<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>showComment</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Whether to include module:config/config.commentString in armored messages</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L189">line 189</a> </li></ul></dd>
</dl>
<h4 class="name" id=".showVersion"><span class="type-signature">(static) </span>showVersion<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>showVersion</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"><p>Whether to include module:config/config.versionString in armored messages</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L184">line 184</a> </li></ul></dd>
</dl>
<h4 class="name" id=".useIndutnyElliptic"><span class="type-signature">(static) </span>useIndutnyElliptic<span class="type-signature"></span></h4>
<div class="description"> <p>Whether to use the indutny/elliptic library for curves (other than Curve25519) that are not supported by the available native crypto API.When false, certain standard curves will not be supported (depending on the platform).Note: the indutny/elliptic curve library is not designed to be constant time.</p></div>
<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>useIndutnyElliptic</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L221">line 221</a> </li></ul></dd>
</dl>
<h4 class="name" id=".v5Keys"><span class="type-signature">(static) </span>v5Keys<span class="type-signature"></span></h4>
<div class="description"> <p>Use V5 keys.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>
<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>v5Keys</code></td>
<td class="type"> <span class="param-type">Boolean</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L77">line 77</a> </li></ul></dd>
</dl>
<h4 class="name" id=".versionString"><span class="type-signature">(static) </span>versionString<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>versionString</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>A version string to be included in armored messages</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.4.0/src/config/config.js">config/config.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.4.0/src/config/config.js#L194">line 194</a> </li></ul></dd>
</dl>
</article>
</section>
</div>
<nav> <h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#aes">aes</a></li><li><a href="global.html#armor">armor</a></li><li><a href="global.html#createCleartextMessage">createCleartextMessage</a></li><li><a href="global.html#createKey">createKey</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#formatObject">formatObject</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#readPrivateKey">readPrivateKey</a></li><li><a href="global.html#readPrivateKeys">readPrivateKeys</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><li><a href="global.html#wrapKeyObject">wrapKeyObject</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="PrivateKey.html">PrivateKey</a></li><li><a href="PublicKey.html">PublicKey</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></footer>
<script> prettyPrint(); </script><script src="scripts/linenumber.js"> </script></body></html>