Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586<!DOCTYPE html><html lang="en"><head> <meta charset="utf-8"> <title>JSDoc: Class: PublicSubkeyPacket</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: PublicSubkeyPacket</h1>
<section>
<header> <h2><span class="attribs"><span class="type-signature"></span></span>PublicSubkeyPacket<span class="signature">(date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> <div class="class-description"><p>A Public-Subkey packet (tag 14) has exactly the same format as aPublic-Key packet, but denotes a subkey. One or more subkeys may beassociated with a top-level key. By convention, the top-level keyprovides signature services, and the subkeys provide encryptionservices.</p></div> </header>
<article> <div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="PublicSubkeyPacket"><span class="type-signature"></span>new PublicSubkeyPacket<span class="signature">(date<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<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>Creation date</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="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/v6.0.0-beta.3.patch.1/src/packet/public_subkey.js">packet/public_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_subkey.js#L29">line 29</a> </li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul> <li><a href="PublicKeyPacket.html">PublicKeyPacket</a></li> </ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="algorithm"><span class="type-signature"></span>algorithm<span class="type-signature"> :enums.publicKey</span></h4>
<div class="description"> <p>Public key algorithm.</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">enums.publicKey</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#algorithm">PublicKeyPacket#algorithm</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L60">line 60</a> </li></ul></dd>
</dl>
<h4 class="name" id="created"><span class="type-signature"></span>created<span class="type-signature"> :Date</span></h4>
<div class="description"> <p>Key creation date.</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Date</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#created">PublicKeyPacket#created</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L55">line 55</a> </li></ul></dd>
</dl>
<h4 class="name" id="expirationTimeV3"><span class="type-signature"></span>expirationTimeV3<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Time until expiration in days (V3 only)</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#expirationTimeV3">PublicKeyPacket#expirationTimeV3</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L70">line 70</a> </li></ul></dd>
</dl>
<h4 class="name" id="fingerprint"><span class="type-signature"></span>fingerprint<span class="type-signature"> :Uint8Array</span></h4>
<div class="description"> <p>Fingerprint bytes</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Uint8Array</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#fingerprint">PublicKeyPacket#fingerprint</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L75">line 75</a> </li></ul></dd>
</dl>
<h4 class="name" id="keyID"><span class="type-signature"></span>keyID<span class="type-signature"> :<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span></h4>
<div class="description"> <p>KeyID</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#keyID">PublicKeyPacket#keyID</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L80">line 80</a> </li></ul></dd>
</dl>
<h4 class="name" id="publicParams"><span class="type-signature"></span>publicParams<span class="type-signature"> :Object</span></h4>
<div class="description"> <p>Algorithm specific public params</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Object</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#publicParams">PublicKeyPacket#publicParams</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L65">line 65</a> </li></ul></dd>
</dl>
<h4 class="name" id="readPublicKey"><span class="type-signature"></span>readPublicKey<span class="type-signature"></span></h4>
<div class="description"> <p>Alias of read()</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#readPublicKey">PublicKeyPacket#readPublicKey</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L287">line 287</a> </li></ul></dd>
<dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="PublicKeyPacket.html#read">PublicKeyPacket#read</a></li> </ul> </dd>
</dl>
<h4 class="name" id="version"><span class="type-signature"></span>version<span class="type-signature"> :Integer</span></h4>
<div class="description"> <p>Packet version</p></div>
<h5>Type:</h5> <ul> <li> <span class="param-type">Integer</span>
</li> </ul>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#version">PublicKeyPacket#version</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L50">line 50</a> </li></ul></dd>
</dl>
<h4 class="name" id="writePublicKey"><span class="type-signature"></span>writePublicKey<span class="type-signature"></span></h4>
<div class="description"> <p>Alias of write()</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#writePublicKey">PublicKeyPacket#writePublicKey</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L293">line 293</a> </li></ul></dd>
<dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="PublicKeyPacket.html#write">PublicKeyPacket#write</a></li> </ul> </dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".fromSecretSubkeyPacket"><span class="type-signature">(static) </span>fromSecretSubkeyPacket<span class="signature">(secretSubkeyPacket)</span><span class="type-signature"> → {<a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a>}</span></h4>
<div class="description"> <p>Create a PublicSubkeyPacket from a SecretSubkeyPacket</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>secretSubkeyPacket</code></td>
<td class="type"> <span class="param-type"><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></span>
</td>
<td class="description last"><p>subkey packet to convert</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.3.patch.1/src/packet/public_subkey.js">packet/public_subkey.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_subkey.js#L49">line 49</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>public key packet</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type"><a href="SecretSubkeyPacket.html">SecretSubkeyPacket</a></span>
</dd></dl>
<h4 class="name" id="computeFingerprint"><span class="type-signature">(async) </span>computeFingerprint<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description"> <p>Computes and set the fingerprint of the key</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#computeFingerprint">PublicKeyPacket#computeFingerprint</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L229">line 229</a> </li></ul></dd>
</dl>
<h4 class="name" id="computeFingerprintAndKeyID"><span class="type-signature">(async) </span>computeFingerprintAndKeyID<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description"> <p>Computes and set the key ID and fingerprint of the key</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#computeFingerprintAndKeyID">PublicKeyPacket#computeFingerprintAndKeyID</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L213">line 213</a> </li></ul></dd>
</dl>
<h4 class="name" id="getAlgorithmInfo"><span class="type-signature"></span>getAlgorithmInfo<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<div class="description"> <p>Returns algorithm information</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#getAlgorithmInfo">PublicKeyPacket#getAlgorithmInfo</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L269">line 269</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>An object of the form {algorithm: String, bits:int, curve:String}.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Object</span>
</dd></dl>
<h4 class="name" id="getCreationTime"><span class="type-signature"></span>getCreationTime<span class="signature">()</span><span class="type-signature"> → {Date}</span></h4>
<div class="description"> <p>Returns the creation time of the key</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#getCreationTime">PublicKeyPacket#getCreationTime</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L197">line 197</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">Date</span>
</dd></dl>
<h4 class="name" id="getFingerprint"><span class="type-signature"></span>getFingerprint<span class="signature">()</span><span class="type-signature"> → {String}</span></h4>
<div class="description"> <p>Calculates and returns the fingerprint of the key, as a string</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#getFingerprint">PublicKeyPacket#getFingerprint</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L253">line 253</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>A string containing the fingerprint in lowercase hex</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">String</span>
</dd></dl>
<h4 class="name" id="getFingerprintBytes"><span class="type-signature"></span>getFingerprintBytes<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4>
<div class="description"> <p>Returns the fingerprint of the key, as an array of bytes</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#getFingerprintBytes">PublicKeyPacket#getFingerprintBytes</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L245">line 245</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>A Uint8Array containing the fingerprint</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>
</dd></dl>
<h4 class="name" id="getKeyID"><span class="type-signature"></span>getKeyID<span class="signature">()</span><span class="type-signature"> → {<a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a>}</span></h4>
<div class="description"> <p>Return the key ID of the key</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#getKeyID">PublicKeyPacket#getKeyID</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L205">line 205</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>The 8-byte key ID</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type"><a href="module-type_keyid-KeyID.html">module:type/keyid~KeyID</a></span>
</dd></dl>
<h4 class="name" id="hasSameFingerprintAs"><span class="type-signature"></span>hasSameFingerprintAs<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description"> <p>Calculates whether two keys have the same fingerprint without actually calculating the fingerprint</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#hasSameFingerprintAs">PublicKeyPacket#hasSameFingerprintAs</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L261">line 261</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Whether the two keys have the same version and public key data.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Boolean</span>
</dd></dl>
<h4 class="name" id="isDecrypted"><span class="type-signature"></span>isDecrypted<span class="signature">()</span><span class="type-signature"> → {Boolean|null}</span></h4>
<div class="description"> <p>Check whether secret-key data is available in decrypted form. Returns null for public keys.</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#isDecrypted">PublicKeyPacket#isDecrypted</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L189">line 189</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl> <dt> Type </dt> <dd> <span class="param-type">Boolean</span>|
<span class="param-type">null</span>
</dd></dl>
<h4 class="name" id="read"><span class="type-signature">(async) </span>read<span class="signature">(bytes)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description"> <p>Internal Parser for public keys as specified in <a href="https://tools.ietf.org/html/rfc4880#section-5.5.2">RFC 4880 section 5.5.2 Public-Key Packet Formats</a></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>
</td>
<td class="description last"><p>Input array to read the packet from</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#read">PublicKeyPacket#read</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L107">line 107</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>This object with attributes set by the parser</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Object</span>
</dd></dl>
<h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">()</span><span class="type-signature"> → {Uint8Array}</span></h4>
<div class="description"> <p>Creates an OpenPGP public key packet for the given key.</p></div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#write">PublicKeyPacket#write</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L155">line 155</a> </li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc"> <p>Bytes encoding the public key OpenPGP packet.</p></div>
<dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span>
</dd></dl>
<h4 class="name" id="writeForHash"><span class="type-signature"></span>writeForHash<span class="signature">(version)</span><span class="type-signature"></span></h4>
<div class="description"> <p>Write packet in order to be hashed; either for a signature or a fingerprint</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>version</code></td>
<td class="type"> <span class="param-type">Integer</span>
</td>
<td class="description last"><p>target version of signature or key</p></td> </tr>
</tbody></table>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="PublicKeyPacket.html#writeForHash">PublicKeyPacket#writeForHash</a> </li></ul></dd>
<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.3.patch.1/src/packet/public_key.js">packet/public_key.js</a>, <a href="https://github.com/openpgpjs/openpgpjs/blob/v6.0.0-beta.3.patch.1/src/packet/public_key.js#L177">line 177</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#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#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_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>