<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Class: SignaturePacket</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">Class: SignaturePacket</h1>
<section>
<header> <h2><span class="attribs"><span class="type-signature"></span></span>SignaturePacket<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description"><p>Implementation of the Signature Packet (Tag 2)</p><p><a href="https://tools.ietf.org/html/rfc4880#section-5.2">RFC4480 5.2</a>:A Signature packet describes a binding between some public key andsome data. The most common signatures are a signature of a file or ablock of text, and a signature that is a certification of a User ID.</p></div> </header>
<article> <div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="SignaturePacket"><span class="type-signature"></span>new SignaturePacket<span class="signature">()</span><span class="type-signature"></span></h4>
<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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L51">line 51</a> </li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="hashAlgorithm"><span class="type-signature"></span>hashAlgorithm<span class="type-signature"> :enums.hash</span></h4>
<h5>Type:</h5> <ul> <li> <span class="param-type">enums.hash</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L56">line 56</a> </li></ul></dd>
</dl>
<h4 class="name" id="publicKeyAlgorithm"><span class="type-signature"></span>publicKeyAlgorithm<span class="type-signature"> :enums.publicKey</span></h4>
<h5>Type:</h5> <ul> <li> <span class="param-type">enums.publicKey</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L58">line 58</a> </li></ul></dd>
</dl>
<h4 class="name" id="signatureType"><span class="type-signature"></span>signatureType<span class="type-signature"> :enums.signature</span></h4>
<h5>Type:</h5> <ul> <li> <span class="param-type">enums.signature</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L54">line 54</a> </li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getExpirationTime"><span class="type-signature"></span>getExpirationTime<span class="signature">()</span><span class="type-signature"> → {Date|Infinity}</span></h4>
<div class="description"> <p>Returns the expiration time of the signature or Infinity if signature does not expire</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L742">line 742</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Expiration time.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Date</span>|
<span class="param-type">Infinity</span>
</dd></dl>
<h4 class="name" id="isExpired"><span class="type-signature"></span>isExpired<span class="signature">(date<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description"> <p>Verifies signature expiration date</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>date</code></td>
<td class="type"> <span class="param-type">Date</span>
</td>
<td class="attributes"> <optional><br>
</td>
<td class="description last"><p>Use the given date for verification instead of the current time</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L730">line 730</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>True if expired.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Boolean</span>
</dd></dl>
<h4 class="name" id="read"><span class="type-signature"></span>read<span class="signature">(bytes)</span><span class="type-signature"> → {<a href="SignaturePacket.html">SignaturePacket</a>}</span></h4>
<div class="description"> <p>parsing function for a signature packet (tag 2).</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>bytes</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"><p>Payload of a tag 2 packet</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L109">line 109</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Object representation.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type"><a href="SignaturePacket.html">SignaturePacket</a></span>
</dd></dl>
<h4 class="name" id="sign"><span class="type-signature">(async) </span>sign<span class="signature">(key, data, date<span class="signature-attributes">opt</span>, detached<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description"> <p>Signs provided data. This needs to be done prior to serialization.</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>key</code></td>
<td class="type"> <span class="param-type"><a href="SecretKeyPacket.html">SecretKeyPacket</a></span>
</td>
<td class="attributes">
</td>
<td class="default"> </td>
<td class="description last"><p>Private key used to sign the message.</p></td> </tr>
<tr> <td class="name"><code>data</code></td>
<td class="type"> <span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="default"> </td>
<td class="description last"><p>Contains packets to be signed.</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 signature creation time.</p></td> </tr>
<tr> <td class="name"><code>detached</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 create a detached 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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L175">line 175</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl> <dt> <div class="param-desc"> <p>if signing failed</p> </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span>
</dd> </dl> </dt> <dd></dd></dl>
<h4 class="name" id="verify"><span class="type-signature">(async) </span>verify<span class="signature">(key, signatureType, data, date<span class="signature-attributes">opt</span>, detached<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description"> <p>verifies the signature packet. Note: not all signature types are implemented</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>key</code></td>
<td class="type"> <span class="param-type"><a href="PublicSubkeyPacket.html">PublicSubkeyPacket</a></span>|
<span class="param-type"><a href="PublicKeyPacket.html">PublicKeyPacket</a></span>|
<span class="param-type"><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></span>|
<span class="param-type"><a href="SecretKeyPacket.html">SecretKeyPacket</a></span>
</td>
<td class="attributes">
</td>
<td class="default"> </td>
<td class="description last"><p>the public key to verify the signature</p></td> </tr>
<tr> <td class="name"><code>signatureType</code></td>
<td class="type"> <span class="param-type"><a href="module-enums.html#.signature">module:enums.signature</a></span>
</td>
<td class="attributes">
</td>
<td class="default"> </td>
<td class="description last"><p>Expected signature type</p></td> </tr>
<tr> <td class="name"><code>data</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>|
<span class="param-type">Object</span>
</td>
<td class="attributes">
</td>
<td class="default"> </td>
<td class="description last"><p>Data which on the signature applies</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>Use the given date instead of the current time to check for signature validity and expiration</p></td> </tr>
<tr> <td class="name"><code>detached</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 verify a detached signature</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L662">line 662</a> </li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl> <dt> <div class="param-desc"> <p>if signature validation failed</p> </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span>
</dd> </dl> </dt> <dd></dd></dl>
<h4 class="name" id="writeHashedSubPackets"><span class="type-signature"></span>writeHashedSubPackets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4>
<div class="description"> <p>Creates Uint8Array of bytes of all subpacket data except Issuer and Embedded Signature subpackets</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L217">line 217</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Subpacket data.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>
</dd></dl>
<h4 class="name" id="writeParams"><span class="type-signature"></span>writeParams<span class="signature">()</span><span class="type-signature"> → {Uint8Array|ReadableStream.<Uint8Array>}</span></h4>
<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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L148">line 148</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.<Uint8Array></span>
</dd></dl>
<h4 class="name" id="writeUnhashedSubPackets"><span class="type-signature"></span>writeUnhashedSubPackets<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4>
<div class="description"> <p>Creates Uint8Array of bytes of Issuer and Embedded Signature subpackets</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.2.1/src/packet/signature.js">packet/signature.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.2.1/src/packet/signature.js#L321">line 321</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Subpacket data.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>
</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>