<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Module: crypto/public_key/dsa</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: crypto/public_key/dsa</h1>
<section>
<header> </header>
<article> <div class="container-overview"> <div class="description"><p>A Digital signature algorithm implementation</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/v6.0.0-beta.0/src/crypto/public_key/dsa.js">crypto/public_key/dsa.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.0/src/crypto/public_key/dsa.js#L18">line 18</a> </li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="~x"><span class="type-signature">(inner) </span>x<span class="type-signature"></span></h4>
<div class="description"> <p>Re-derive public key y' = g ** x mod pExpect y == y'</p><p>Blinded exponentiation computes g**{rq + x} to compare to y</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/v6.0.0-beta.0/src/crypto/public_key/dsa.js">crypto/public_key/dsa.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.0/src/crypto/public_key/dsa.js#L190">line 190</a> </li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".sign"><span class="type-signature">(async, static) </span>sign<span class="signature">(hashAlgo, hashed, g, p, q, x)</span><span class="type-signature"> → {Promise.<{r: Uint8Array, s: Uint8Array}>}</span></h4>
<div class="description"> <p>DSA Sign function</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>hashAlgo</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>hashed</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>g</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>p</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>q</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>x</code></td>
<td class="type"> <span class="param-type">Uint8Array</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/v6.0.0-beta.0/src/crypto/public_key/dsa.js">crypto/public_key/dsa.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.0/src/crypto/public_key/dsa.js#L43">line 43</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<{r: Uint8Array, s: Uint8Array}></span>
</dd></dl>
<h4 class="name" id=".validateParams"><span class="type-signature">(async, static) </span>validateParams<span class="signature">(p, q, g, y, x)</span><span class="type-signature"> → {Promise.<Boolean>}</span></h4>
<div class="description"> <p>Validate DSA parameters</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>p</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"><p>DSA prime</p></td> </tr>
<tr> <td class="name"><code>q</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"><p>DSA group order</p></td> </tr>
<tr> <td class="name"><code>g</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"><p>DSA sub-group generator</p></td> </tr>
<tr> <td class="name"><code>y</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"><p>DSA public key</p></td> </tr>
<tr> <td class="name"><code>x</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"><p>DSA private key</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/v6.0.0-beta.0/src/crypto/public_key/dsa.js">crypto/public_key/dsa.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.0/src/crypto/public_key/dsa.js#L147">line 147</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Whether params are valid.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Boolean></span>
</dd></dl>
<h4 class="name" id=".verify"><span class="type-signature">(async, static) </span>verify<span class="signature">(hashAlgo, r, s, hashed, g, p, q, y)</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description"> <p>DSA Verify function</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>hashAlgo</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>r</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>s</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>hashed</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>g</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>p</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>q</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>
</td>
<td class="description last"></td> </tr>
<tr> <td class="name"><code>y</code></td>
<td class="type"> <span class="param-type">Uint8Array</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/v6.0.0-beta.0/src/crypto/public_key/dsa.js">crypto/public_key/dsa.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.0/src/crypto/public_key/dsa.js#L103">line 103</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span>
</dd></dl>
</article>
</section>
</div>
<nav> <h2><a href="index.html">Home</a></h2><h3>Functions</h3><ul><li><a href="global.html#armor">armor</a></li><li><a href="global.html#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#detectBigInt">detectBigInt</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#getCipherBlockSize">getCipherBlockSize</a></li><li><a href="global.html#getCipherKeySize">getCipherKeySize</a></li><li><a href="global.html#getCipherParams">getCipherParams</a></li><li><a href="global.html#getCompressionStreamInstantiators">getCompressionStreamInstantiators</a></li><li><a href="global.html#newPacketFromTag">newPacketFromTag</a></li><li><a href="global.html#newS2KFromConfig">newS2KFromConfig</a></li><li><a href="global.html#newS2KFromType">newS2KFromType</a></li><li><a href="global.html#produceEncryptionKey">produceEncryptionKey</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#runAEAD">runAEAD</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><li><a href="global.html#zlib">zlib</a></li></ul><h3>Modules</h3><ul><li><a href="module-config.html">config</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="module-crypto_aes_kw.html">crypto/aes_kw</a></li><li><a href="module-crypto_cmac.html">crypto/cmac</a></li><li><a href="module-crypto_crypto.html">crypto/crypto</a></li><li><a href="module-crypto_hash.html">crypto/hash</a></li><li><a href="module-crypto_hkdf.html">crypto/hkdf</a></li><li><a href="module-crypto_mode.html">crypto/mode</a></li><li><a href="module-crypto_mode_cfb.html">crypto/mode/cfb</a></li><li><a href="module-crypto_mode_eax.html">crypto/mode/eax</a></li><li><a href="module-crypto_mode_gcm.html">crypto/mode/gcm</a></li><li><a href="module-crypto_mode_ocb.html">crypto/mode/ocb</a></li><li><a href="module-crypto_pkcs1.html">crypto/pkcs1</a></li><li><a href="module-crypto_public_key.html">crypto/public_key</a></li><li><a href="module-crypto_public_key_dsa.html">crypto/public_key/dsa</a></li><li><a href="module-crypto_public_key_elgamal.html">crypto/public_key/elgamal</a></li><li><a href="module-crypto_public_key_elliptic.html">crypto/public_key/elliptic</a></li><li><a href="module-crypto_public_key_elliptic_curve.html">crypto/public_key/elliptic/curve</a></li><li><a href="module-crypto_public_key_elliptic_ecdh.html">crypto/public_key/elliptic/ecdh</a></li><li><a href="module-crypto_public_key_elliptic_ecdsa.html">crypto/public_key/elliptic/ecdsa</a></li><li><a href="module-crypto_public_key_elliptic_eddsa.html">crypto/public_key/elliptic/eddsa</a></li><li><a href="module-crypto_public_key_elliptic_eddsa_legacy.html">crypto/public_key/elliptic/eddsa_legacy</a></li><li><a href="module-crypto_public_key_prime.html">crypto/public_key/prime</a></li><li><a href="module-crypto_public_key_rsa.html">crypto/public_key/rsa</a></li><li><a href="module-crypto_random.html">crypto/random</a></li><li><a href="module-crypto_signature.html">crypto/signature</a></li><li><a href="module-encoding_base64.html">encoding/base64</a></li><li><a href="module-enums.html">enums</a></li><li><a href="module-key_helper.html">key/helper</a></li><li><a href="module-key_Subkey.html">key/Subkey</a></li><li><a href="module-key_User.html">key/User</a></li><li><a href="module-packet_packet.html">packet/packet</a></li><li><a href="module-type_ecdh_symkey.html">type/ecdh_symkey</a></li><li><a href="module-type_keyid.html">type/keyid</a></li><li><a href="module-type_oid.html">type/oid</a></li><li><a href="module-type_s2k.html">type/s2k</a></li><li><a href="module-type_x25519x448_symkey.html">type/x25519x448_symkey</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="AEADEncryptedDataPacket.html">AEADEncryptedDataPacket</a></li><li><a href="Argon2S2K.html">Argon2S2K</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-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-GenericS2K.html">GenericS2K</a></li><li><a href="OnePassSignaturePacket.html">OnePassSignaturePacket</a></li><li><a href="PacketList.html">PacketList</a></li><li><a href="PaddingPacket.html">PaddingPacket</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.11</a></footer>
<script> prettyPrint(); </script><script src="scripts/linenumber.js"> </script></body></html>