<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: AsyncProxy</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: AsyncProxy</h1> <section> <header> <h2> <span class="ancestors"><a href="module-async_proxy.html">async_proxy</a>~</span> AsyncProxy </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="AsyncProxy"><span class="type-signature"></span>new AsyncProxy<span class="signature">(path)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Initializes a new proxy and loads the web worker </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>path</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The path to the worker or 'openpgp.worker.js' by default</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line41">line 41</a> </li></ul></dd> </dl> </dd> </div> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name" id="decryptAndVerifyMessage"><span class="type-signature"></span>decryptAndVerifyMessage<span class="signature">(privateKey, publicKeys, message, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Decrypts message and verifies signatures </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>privateKey</code></td> <td class="type"> <span class="param-type"><a href="module-key-Key.html">module:key~Key</a></span> </td> <td class="description last">private key with decrypted secret key data</td> </tr> <tr> <td class="name"><code>publicKeys</code></td> <td class="type"> <span class="param-type">Array.<<a href="module-key-Key.html">module:key~Key</a>></span> </td> <td class="description last">public keys to verify signatures</td> </tr> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type"><a href="module-message-Message.html">module:message~Message</a></span> </td> <td class="description last">the message object with signed and encrypted data</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives decrypted message as as native JavaScript string with verified signatures or null if no literal data found</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line158">line 158</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="decryptKey"><span class="type-signature"></span>decryptKey<span class="signature">(privateKey, password, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Decrypts secret part of all secret key packets of key. </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>privateKey</code></td> <td class="type"> <span class="param-type"><a href="module-key-Key.html">module:key~Key</a></span> </td> <td class="description last">private key with encrypted secret key data</td> </tr> <tr> <td class="name"><code>password</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">password to unlock the key</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives decrypted key</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line257">line 257</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="decryptKeyPacket"><span class="type-signature"></span>decryptKeyPacket<span class="signature">(privateKey, keyIds, password, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Decrypts secret part of key packets matching array of keyids. </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>privateKey</code></td> <td class="type"> <span class="param-type"><a href="module-key-Key.html">module:key~Key</a></span> </td> <td class="description last">private key with encrypted secret key data</td> </tr> <tr> <td class="name"><code>keyIds</code></td> <td class="type"> <span class="param-type">Array.<<a href="keyid.html">module:type/keyid</a>></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>password</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">password to unlock the key</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives decrypted key</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line280">line 280</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="decryptMessage"><span class="type-signature"></span>decryptMessage<span class="signature">(privateKey, message, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Decrypts message </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>privateKey</code></td> <td class="type"> <span class="param-type"><a href="module-key-Key.html">module:key~Key</a></span> </td> <td class="description last">private key with decrypted secret key data</td> </tr> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type"><a href="module-message-Message.html">module:message~Message</a></span> </td> <td class="description last">the message object with the encrypted data</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives decrypted message as as native JavaScript string or null if no literal data found</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line140">line 140</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="encryptMessage"><span class="type-signature"></span>encryptMessage<span class="signature">(keys, text, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Encrypts message text with keys </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>keys</code></td> <td class="type"> <span class="param-type">Array.<<a href="module-key-Key.html">module:key~Key</a>></span> </td> <td class="description last">array of keys, used to encrypt the message</td> </tr> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">message as native JavaScript string</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives encrypted ASCII armored message</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line100">line 100</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="generateKeyPair"><span class="type-signature"></span>generateKeyPair<span class="signature">(keyType, numBits, userId, passphrase, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Generates a new OpenPGP key pair. Currently only supports RSA keys. Primary and subkey will be of same type. </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>keyType</code></td> <td class="type"> <span class="param-type"><a href="module-enums.html#publicKey">module:enums.publicKey</a></span> </td> <td class="description last">to indicate what type of key to make. RSA is 1. See <a href="http://tools.ietf.org/html/rfc4880#section-9.1">http://tools.ietf.org/html/rfc4880#section-9.1</a></td> </tr> <tr> <td class="name"><code>numBits</code></td> <td class="type"> <span class="param-type">Integer</span> </td> <td class="description last">number of bits for the key creation. (should be 1024+, generally)</td> </tr> <tr> <td class="name"><code>userId</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">assumes already in form of "User Name <username@email.com>"</td> </tr> <tr> <td class="name"><code>passphrase</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The passphrase used to encrypt the resulting private key</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives object with key and public and private armored texts</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line234">line 234</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="getRandomBuffer"><span class="type-signature"></span>getRandomBuffer<span class="signature">(size)</span><span class="type-signature"> → {Uint8Array}</span></h4> </dt> <dd> <div class="description"> Get Uint8Array with random numbers </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>size</code></td> <td class="type"> <span class="param-type">Integer</span> </td> <td class="description last">Length of buffer</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line80">line 80</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Uint8Array</span> </dd> </dl> </dd> <dt> <h4 class="name" id="onMessage"><span class="type-signature"></span>onMessage<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Message handling </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line52">line 52</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="seedRandom"><span class="type-signature"></span>seedRandom<span class="signature">(size)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Send message to worker with random data </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>size</code></td> <td class="type"> <span class="param-type">Integer</span> </td> <td class="description last">Number of bytes to send</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line70">line 70</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="signAndEncryptMessage"><span class="type-signature"></span>signAndEncryptMessage<span class="signature">(publicKeys, privateKey, text, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Signs message text and encrypts it </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>publicKeys</code></td> <td class="type"> <span class="param-type">Array.<<a href="module-key-Key.html">module:key~Key</a>></span> </td> <td class="description last">array of keys, used to encrypt the message</td> </tr> <tr> <td class="name"><code>privateKey</code></td> <td class="type"> <span class="param-type"><a href="module-key-Key.html">module:key~Key</a></span> </td> <td class="description last">private key with decrypted secret key data for signing</td> </tr> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">message as native JavaScript string</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives encrypted ASCII armored message</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line119">line 119</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="signClearMessage"><span class="type-signature"></span>signClearMessage<span class="signature">(privateKeys, text, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Signs a cleartext message </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>privateKeys</code></td> <td class="type"> <span class="param-type">Array.<<a href="module-key-Key.html">module:key~Key</a>></span> </td> <td class="description last">private key with decrypted secret key data to sign cleartext</td> </tr> <tr> <td class="name"><code>text</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">cleartext</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives ASCII armored message</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line186">line 186</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="terminate"><span class="type-signature"></span>terminate<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Terminates the worker </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line90">line 90</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="verifyClearSignedMessage"><span class="type-signature"></span>verifyClearSignedMessage<span class="signature">(publicKeys, message, callback)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Verifies signatures of cleartext signed message </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>publicKeys</code></td> <td class="type"> <span class="param-type">Array.<<a href="module-key-Key.html">module:key~Key</a>></span> </td> <td class="description last">public keys to verify signatures</td> </tr> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type"><a href="module-cleartext-CleartextMessage.html">module:cleartext~CleartextMessage</a></span> </td> <td class="description last">cleartext message object with signatures</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">receives cleartext with status of verified signatures</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="async_proxy.js.html">worker/async_proxy.js</a>, <a href="async_proxy.js.html#line204">line 204</a> </li></ul></dd> </dl> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-async_proxy.html">async_proxy</a></li><li><a href="module-cleartext.html">cleartext</a></li><li><a href="module-config.html">config</a></li><li><a href="config.html">config/config</a></li><li><a href="localStorage.html">config/localStorage</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="cfb.html">crypto/cfb</a></li><li><a href="cipher.html">crypto/cipher</a></li><li><a href="aes.html">crypto/cipher/aes</a></li><li><a href="blowfish.html">crypto/cipher/blowfish</a></li><li><a href="cast5.html">crypto/cipher/cast5</a></li><li><a href="des.html">crypto/cipher/des</a></li><li><a href="twofish.html">crypto/cipher/twofish</a></li><li><a href="crypto.html">crypto/crypto</a></li><li><a href="hash.html">crypto/hash</a></li><li><a href="md5.html">crypto/hash/md5</a></li><li><a href="ripe-md.html">crypto/hash/ripe-md</a></li><li><a href="sha.html">crypto/hash/sha</a></li><li><a href="pkcs1.html">crypto/pkcs1</a></li><li><a href="public_key.html">crypto/public_key</a></li><li><a href="dsa.html">crypto/public_key/dsa</a></li><li><a href="elgamal.html">crypto/public_key/elgamal</a></li><li><a href="jsbn.html">crypto/public_key/jsbn</a></li><li><a href="rsa.html">crypto/public_key/rsa</a></li><li><a href="random.html">crypto/random</a></li><li><a href="signature.html">crypto/signature</a></li><li><a href="armor.html">encoding/armor</a></li><li><a href="base64.html">encoding/base64</a></li><li><a href="module-enums.html">enums</a></li><li><a href="module-key.html">key</a></li><li><a href="module-keyring.html">keyring</a></li><li><a href="keyring.html">keyring/keyring</a></li><li><a href="localstore.html">keyring/localstore</a></li><li><a href="module-message.html">message</a></li><li><a href="module-openpgp.html">openpgp</a></li><li><a href="module-packet.html">packet</a></li><li><a href="compressed.html">packet/compressed</a></li><li><a href="literal.html">packet/literal</a></li><li><a href="marker.html">packet/marker</a></li><li><a href="one_pass_signature.html">packet/one_pass_signature</a></li><li><a href="packet.html">packet/packet</a></li><li><a href="packetlist.html">packet/packetlist</a></li><li><a href="public_key_.html">packet/public_key</a></li><li><a href="public_key_encrypted_session_key.html">packet/public_key_encrypted_session_key</a></li><li><a href="public_subkey.html">packet/public_subkey</a></li><li><a href="secret_key.html">packet/secret_key</a></li><li><a href="secret_subkey.html">packet/secret_subkey</a></li><li><a href="signature_.html">packet/signature</a></li><li><a href="sym_encrypted_integrity_protected.html">packet/sym_encrypted_integrity_protected</a></li><li><a href="sym_encrypted_session_key.html">packet/sym_encrypted_session_key</a></li><li><a href="symmetrically_encrypted.html">packet/symmetrically_encrypted</a></li><li><a href="trust.html">packet/trust</a></li><li><a href="user_attribute.html">packet/user_attribute</a></li><li><a href="userid.html">packet/userid</a></li><li><a href="keyid.html">type/keyid</a></li><li><a href="mpi.html">type/mpi</a></li><li><a href="s2k.html">type/s2k</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="JXG.Util.html">JXG.Util</a></li><li><a href="module-async_proxy-AsyncProxy.html">async_proxy~AsyncProxy</a></li><li><a href="module-cleartext-CleartextMessage.html">cleartext~CleartextMessage</a></li><li><a href="localStorage-LocalStorage.html">config/localStorage~LocalStorage</a></li><li><a href="keyring-Keyring.html">keyring/keyring~Keyring</a></li><li><a href="module-key-Key.html">key~Key</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-message-Message.html">message~Message</a></li><li><a href="compressed-Compressed.html">packet/compressed~Compressed</a></li><li><a href="literal-Literal.html">packet/literal~Literal</a></li><li><a href="marker-Marker.html">packet/marker~Marker</a></li><li><a href="one_pass_signature-OnePassSignature.html">packet/one_pass_signature~OnePassSignature</a></li><li><a href="packetlist-Packetlist.html">packet/packetlist~Packetlist</a></li><li><a href="public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html">packet/public_key_encrypted_session_key~PublicKeyEncryptedSessionKey</a></li><li><a href="public_key-PublicKey.html">packet/public_key~PublicKey</a></li><li><a href="public_subkey-PublicSubkey.html">packet/public_subkey~PublicSubkey</a></li><li><a href="secret_key-SecretKey.html">packet/secret_key~SecretKey</a></li><li><a href="secret_subkey-SecretSubkey.html">packet/secret_subkey~SecretSubkey</a></li><li><a href="signature-Signature.html">packet/signature~Signature</a></li><li><a href="sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html">packet/sym_encrypted_integrity_protected~SymEncryptedIntegrityProtected</a></li><li><a href="sym_encrypted_session_key-SymEncryptedSessionKey.html">packet/sym_encrypted_session_key~SymEncryptedSessionKey</a></li><li><a href="symmetrically_encrypted-SymmetricallyEncrypted.html">packet/symmetrically_encrypted~SymmetricallyEncrypted</a></li><li><a href="trust-Trust.html">packet/trust~Trust</a></li><li><a href="user_attribute-UserAttribute.html">packet/user_attribute~UserAttribute</a></li><li><a href="userid-Userid.html">packet/userid~Userid</a></li><li><a href="keyid-Keyid.html">type/keyid~Keyid</a></li><li><a href="mpi-MPI.html">type/mpi~MPI</a></li><li><a href="s2k-S2K.html">type/s2k~S2K</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Feb 12 2014 15:09:02 GMT+0100 (MEZ) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>