Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openpgp/docs/LiteralDataPacket.html

OpenPGP implementation for JavaScript
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590
<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Class: LiteralDataPacket</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <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: LiteralDataPacket</h1>




<section>
<header> <h2><span class="attribs"><span class="type-signature"></span></span>LiteralDataPacket<span class="signature">(date)</span><span class="type-signature"></span></h2> <div class="class-description"><p>Implementation of the Literal Data Packet (Tag 11)</p><p><a href="https://tools.ietf.org/html/rfc4880#section-5.9">RFC4880 5.9</a>:A Literal Data packet contains the body of a message; data that is not to befurther interpreted.</p></div> </header>
<article> <div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="LiteralDataPacket"><span class="type-signature"></span>new LiteralDataPacket<span class="signature">(date)</span><span class="type-signature"></span></h4>











<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>date</code></td>
<td class="type"> <span class="param-type">Date</span>

</td>


<td class="description last"><p>The creation date of the literal package</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L37">line 37</a> </li></ul></dd>


</dl>



















</div>







<h3 class="subsection-title">Methods</h3>


<h4 class="name" id="getBytes"><span class="type-signature"></span>getBytes<span class="signature">(clone<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Uint8Array|ReadableStream.&lt;Uint8Array>}</span></h4>



<div class="description"> <p>Get the byte sequence representing the literal packet data</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>clone</code></td>
<td class="type"> <span class="param-type">Boolean</span>

</td>
<td class="attributes"> &lt;optional><br>

</td>
<td class="default"> false </td>
<td class="description last"><p>Whether to return a clone so that getBytes/getText can be called again</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L87">line 87</a> </li></ul></dd>


</dl>














<h5>Returns:</h5>
<div class="param-desc"> <p>A sequence of bytes.</p></div>


<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.&lt;Uint8Array></span>

</dd></dl>







<h4 class="name" id="getFilename"><span class="type-signature"></span>getFilename<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>



<div class="description"> <p>Get the filename of the literal packet data</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L112">line 112</a> </li></ul></dd>


</dl>














<h5>Returns:</h5>
<div class="param-desc"> <p>Filename.</p></div>


<dl> <dt> Type </dt> <dd> <span class="param-type">String</span>

</dd></dl>







<h4 class="name" id="getText"><span class="type-signature"></span>getText<span class="signature">(clone<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String|ReadableStream.&lt;String>}</span></h4>



<div class="description"> <p>Returns literal data packets as native JavaScript stringwith normalized end of line to \n</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>clone</code></td>
<td class="type"> <span class="param-type">Boolean</span>

</td>
<td class="attributes"> &lt;optional><br>

</td>
<td class="default"> false </td>
<td class="description last"><p>Whether to return a clone so that getBytes/getText can be called again</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L63">line 63</a> </li></ul></dd>


</dl>














<h5>Returns:</h5>
<div class="param-desc"> <p>Literal data as text.</p></div>


<dl> <dt> Type </dt> <dd> <span class="param-type">String</span>|
<span class="param-type">ReadableStream.&lt;String></span>

</dd></dl>







<h4 class="name" id="read"><span class="type-signature">(async) </span>read<span class="signature">(input)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="LiteralDataPacket.html">LiteralDataPacket</a>>}</span></h4>



<div class="description"> <p>Parsing function for a literal data packet (tag 11).</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>input</code></td>
<td class="type"> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.&lt;Uint8Array></span>

</td>


<td class="description last"><p>Payload of a tag 11 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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L123">line 123</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">Promise.&lt;<a href="LiteralDataPacket.html">LiteralDataPacket</a>></span>

</dd></dl>







<h4 class="name" id="setBytes"><span class="type-signature"></span>setBytes<span class="signature">(bytes, format)</span><span class="type-signature"></span></h4>



<div class="description"> <p>Set the packet data to value represented by the provided string of bytes.</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">Uint8Array</span>|
<span class="param-type">ReadableStream.&lt;Uint8Array></span>

</td>


<td class="description last"><p>The string of bytes</p></td> </tr>

<tr> <td class="name"><code>format</code></td>
<td class="type"> <span class="param-type">enums.literal</span>

</td>


<td class="description last"><p>The format of the string of bytes</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L75">line 75</a> </li></ul></dd>


</dl>





















<h4 class="name" id="setFilename"><span class="type-signature"></span>setFilename<span class="signature">(filename)</span><span class="type-signature"></span></h4>



<div class="description"> <p>Sets the filename of the literal packet 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>filename</code></td>
<td class="type"> <span class="param-type">String</span>

</td>


<td class="description last"><p>Any native javascript string</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L103">line 103</a> </li></ul></dd>


</dl>





















<h4 class="name" id="setText"><span class="type-signature"></span>setText<span class="signature">(text, format<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>



<div class="description"> <p>Set the packet data to a javascript native string, end of linewill be normalized to \r\n and by default text is converted to UTF8</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>text</code></td>
<td class="type"> <span class="param-type">String</span>|
<span class="param-type">ReadableStream.&lt;String></span>

</td>
<td class="attributes">

</td>

<td class="description last"><p>Any native javascript string</p></td> </tr>

<tr> <td class="name"><code>format</code></td>
<td class="type"> <span class="param-type">enums.literal</span>

</td>
<td class="attributes"> &lt;optional><br>

</td>

<td class="description last"><p>The format of the string of bytes</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L51">line 51</a> </li></ul></dd>


</dl>





















<h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">()</span><span class="type-signature"> &rarr; {Uint8Array|ReadableStream.&lt;Uint8Array>}</span></h4>



<div class="description"> <p>Creates a Uint8Array representation of the packet</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L159">line 159</a> </li></ul></dd>


</dl>














<h5>Returns:</h5>
<div class="param-desc"> <p>Uint8Array representation of the packet.</p></div>


<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>|
<span class="param-type">ReadableStream.&lt;Uint8Array></span>

</dd></dl>







<h4 class="name" id="writeHeader"><span class="type-signature"></span>writeHeader<span class="signature">()</span><span class="type-signature"> &rarr; {Uint8Array}</span></h4>



<div class="description"> <p>Creates a Uint8Array representation of the packet, excluding the data</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.3.0/src/packet/literal_data.js">packet/literal_data.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v5.3.0/src/packet/literal_data.js#L144">line 144</a> </li></ul></dd>


</dl>














<h5>Returns:</h5>
<div class="param-desc"> <p>Uint8Array representation of the packet.</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>