From 01ddec6431d8982245cccf7599c4226c15fcf654 Mon Sep 17 00:00:00 2001 From: Sean Colyer <sean@colyer.name> Date: Wed, 5 Sep 2012 22:01:17 -0400 Subject: [PATCH] New jsdoc files. --- doc/openpgp_keyring.html | 1651 +++++++++++++++++++++++++++++++ doc/openpgp_msg_message.html | 587 +++++++++++ doc/openpgp_msg_privatekey.html | 288 ++++++ doc/openpgp_msg_publickey.html | 418 ++++++++ 4 files changed, 2944 insertions(+) create mode 100644 doc/openpgp_keyring.html create mode 100644 doc/openpgp_msg_message.html create mode 100644 doc/openpgp_msg_privatekey.html create mode 100644 doc/openpgp_msg_publickey.html diff --git a/doc/openpgp_keyring.html b/doc/openpgp_keyring.html new file mode 100644 index 00000000..64793a69 --- /dev/null +++ b/doc/openpgp_keyring.html @@ -0,0 +1,1651 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: openpgp_keyring</title> + + <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script> + <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.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/node-dark.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: openpgp_keyring</h1> + + + + + +<section> + +<header> + <h2> + openpgp_keyring + </h2> + + <div class="class-description">The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.</div> + +</header> + +<article> + <div class="container-overview"> + + + + +<dt> + <h4 class="name" id="openpgp_keyring"><span class="type-signature"></span>new openpgp_keyring</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12660</li></ul></dd> + + + + + + + +</dl> + + + + + + + + + +</dd> + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<dt> + <h4 class="name" id="exportPrivateKey"><span class="type-signature"><inner> </span>exportPrivateKey</h4> + + +</dt> +<dd> + + + <div class="description"> + returns the openpgp_msg_privatekey representation of the private key at private key ring index + </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>index</code></td> + + + <td class="type"> + + Integer + + + </td> + + + + + + <td class="description last">the index of the private key within the privateKeys array</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12876</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + the private key object +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">openpgp_msg_privatekey</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="exportPublicKey"><span class="type-signature"><inner> </span>exportPublicKey</h4> + + +</dt> +<dd> + + + <div class="description"> + returns the openpgp_msg_privatekey representation of the public key at public key ring index + </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>index</code></td> + + + <td class="type"> + + Integer + + + </td> + + + + + + <td class="description last">the index of the public key within the publicKeys array</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12853</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + the public key object +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">openpgp_msg_privatekey</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="getPrivateKeyForAddress"><span class="type-signature"><inner> </span>getPrivateKeyForAddress</h4> + + +</dt> +<dd> + + + <div class="description"> + Searches the keyring for a private key containing the specified email address + </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>email_address</code></td> + + + <td class="type"> + + String + + + </td> + + + + + + <td class="description last">email address to search for</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12757</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + private keys found +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">Array[openpgp_msg_privatekey</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="getPrivateKeyForKeyId"><span class="type-signature"><inner> </span>getPrivateKeyForKeyId</h4> + + +</dt> +<dd> + + + <div class="description"> + Searches the keyring for private keys having the specified key id + </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>keyId</code></td> + + + <td class="type"> + + String + + + </td> + + + + + + <td class="description last">8 bytes as string containing the key id to look for</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12799</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + private keys found +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">Array[openpgp_msg_privatekey]</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="getPublicKeyForAddress"><span class="type-signature"><inner> </span>getPublicKeyForAddress</h4> + + +</dt> +<dd> + + + <div class="description"> + searches all public keys in the keyring matching the address or address part of the user ids + </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>email_address</code></td> + + + <td class="type"> + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12729</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + the public keys associated with provided email address. +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">array[openpgp_msg_publickey]</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="getPublicKeysForKeyId"><span class="type-signature"><inner> </span>getPublicKeysForKeyId</h4> + + +</dt> +<dd> + + + <div class="description"> + Searches the keyring for public keys having the specified key id + </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>keyId</code></td> + + + <td class="type"> + + </td> + + + + + + <td class="description last">provided as string of hex number (lowercase)</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12785</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + public keys found +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">Array[openpgp_msg_privatekey]</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="hasPrivateKey"><span class="type-signature"><inner> </span>hasPrivateKey</h4> + + +</dt> +<dd> + + + <div class="description"> + Checks if at least one private key is in the keyring + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12701</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + True if there are private keys, else false. +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">boolean</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="importPrivateKey"><span class="type-signature"><inner> </span>importPrivateKey</h4> + + +</dt> +<dd> + + + <div class="description"> + Imports a private key from an exported ascii armored 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>armored_text</code></td> + + + <td class="type"> + + String + + + </td> + + + + + + <td class="description last">PRIVATE KEY BLOCK message to read the private key from</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12835</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + nothing +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">null</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="importPublicKey"><span class="type-signature"><inner> </span>importPublicKey</h4> + + +</dt> +<dd> + + + <div class="description"> + Imports a public key from an exported ascii armored 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>armored_text</code></td> + + + <td class="type"> + + String + + + </td> + + + + + + <td class="description last">PUBLIC KEY BLOCK message to read the public key from</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12822</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + nothing +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">null</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="init"><span class="type-signature"><inner> </span>init</h4> + + +</dt> +<dd> + + + <div class="description"> + Initialization routine for the keyring. This method reads the +keyring from HTML5 local storage and initializes this instance. +This method is called by openpgp.init(). + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12668</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + undefined +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">null</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="removePrivateKey"><span class="type-signature"><inner> </span>removePrivateKey</h4> + + +</dt> +<dd> + + + <div class="description"> + Removes a private key from the private key keyring at the specified index + </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>index</code></td> + + + <td class="type"> + + Integer + + + </td> + + + + + + <td class="description last">the index of the private key within the privateKeys array</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12886</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + The private key object which has been removed +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">openpgp_msg_privatekey</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="removePublicKey"><span class="type-signature"><inner> </span>removePublicKey</h4> + + +</dt> +<dd> + + + <div class="description"> + Removes a public key from the public key keyring at the specified index + </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>index</code></td> + + + <td class="type"> + + Integer + + + </td> + + + + + + <td class="description last">the index of the public key within the publicKeys array</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12864</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + The public key object which has been removed +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">openpgp_msg_privatekey</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="store"><span class="type-signature"><inner> </span>store</h4> + + +</dt> +<dd> + + + <div class="description"> + Saves the current state of the keyring to HTML5 local storage. +The privateKeys array and publicKeys array gets Stringified using JSON + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12711</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + undefined +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">null</span> + + </dd> +</dl> + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_keyring.html">openpgp_keyring</a></li><li><a href="openpgp_msg_message.html">openpgp_msg_message</a></li><li><a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a></li><li><a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MD5">MD5</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</a></li><li><a href="global.html#bin2str">bin2str</a></li><li><a href="global.html#calc_checksum">calc_checksum</a></li><li><a href="global.html#crc_table">crc_table</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#default_config">default_config</a></li><li><a href="global.html#getCheckSum">getCheckSum</a></li><li><a href="global.html#getPGPMessageType">getPGPMessageType</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</a></li><li><a href="global.html#hash_headers">hash_headers</a></li><li><a href="global.html#hex2bin">hex2bin</a></li><li><a href="global.html#hexidump">hexidump</a></li><li><a href="global.html#hexstrdump">hexstrdump</a></li><li><a href="global.html#openpgp_cfb_decrypt">openpgp_cfb_decrypt</a></li><li><a href="global.html#openpgp_cfb_encrypt">openpgp_cfb_encrypt</a></li><li><a href="global.html#openpgp_cfb_mdc">openpgp_cfb_mdc</a></li><li><a href="global.html#openpgp_config">openpgp_config</a></li><li><a href="global.html#openpgp_crypto_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</a></li><li><a href="global.html#openpgp_crypto_asymetricDecrypt">openpgp_crypto_asymetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_asymetricEncrypt">openpgp_crypto_asymetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_generateKeyPair">openpgp_crypto_generateKeyPair</a></li><li><a href="global.html#openpgp_crypto_generateSessionKey">openpgp_crypto_generateSessionKey</a></li><li><a href="global.html#openpgp_crypto_getHashByteLength">openpgp_crypto_getHashByteLength</a></li><li><a href="global.html#openpgp_crypto_getPrefixRandom">openpgp_crypto_getPrefixRandom</a></li><li><a href="global.html#openpgp_crypto_getPseudoRandom">openpgp_crypto_getPseudoRandom</a></li><li><a href="global.html#openpgp_crypto_getRandomBigInteger">openpgp_crypto_getRandomBigInteger</a></li><li><a href="global.html#openpgp_crypto_getRandomBytes">openpgp_crypto_getRandomBytes</a></li><li><a href="global.html#openpgp_crypto_getSecureRandom">openpgp_crypto_getSecureRandom</a></li><li><a href="global.html#openpgp_crypto_hashData">openpgp_crypto_hashData</a></li><li><a href="global.html#openpgp_crypto_signData">openpgp_crypto_signData</a></li><li><a href="global.html#openpgp_crypto_symmetricDecrypt">openpgp_crypto_symmetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_symmetricEncrypt">openpgp_crypto_symmetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_verifySignature">openpgp_crypto_verifySignature</a></li><li><a href="global.html#openpgp_encoding_armor">openpgp_encoding_armor</a></li><li><a href="global.html#openpgp_encoding_armor_addheader">openpgp_encoding_armor_addheader</a></li><li><a href="global.html#openpgp_encoding_base64_decode">openpgp_encoding_base64_decode</a></li><li><a href="global.html#openpgp_encoding_base64_encode">openpgp_encoding_base64_encode</a></li><li><a href="global.html#openpgp_encoding_deArmor">openpgp_encoding_deArmor</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_decode">openpgp_encoding_eme_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_encode">openpgp_encoding_eme_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_decode">openpgp_encoding_emsa_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_encode">openpgp_encoding_emsa_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_html_encode">openpgp_encoding_html_encode</a></li><li><a href="global.html#openpgp_packet_compressed">openpgp_packet_compressed</a></li><li><a href="global.html#openpgp_packet_encrypteddata">openpgp_packet_encrypteddata</a></li><li><a href="global.html#openpgp_packet_encryptedintegrityprotecteddata">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a></li><li><a href="global.html#openpgp_packet_keymaterial">openpgp_packet_keymaterial</a></li><li><a href="global.html#openpgp_packet_literaldata">openpgp_packet_literaldata</a></li><li><a href="global.html#openpgp_packet_marker">openpgp_packet_marker</a></li><li><a href="global.html#openpgp_packet_modificationdetectioncode">openpgp_packet_modificationdetectioncode</a></li><li><a href="global.html#openpgp_packet_onepasssignature">openpgp_packet_onepasssignature</a></li><li><a href="global.html#openpgp_packet_signature">openpgp_packet_signature</a></li><li><a href="global.html#openpgp_packet_userattribute">openpgp_packet_userattribute</a></li><li><a href="global.html#openpgp_packet_userid">openpgp_packet_userid</a></li><li><a href="global.html#openpgp_type_keyid">openpgp_type_keyid</a></li><li><a href="global.html#openpgp_type_mpi">openpgp_type_mpi</a></li><li><a href="global.html#openpgp_type_s2k">openpgp_type_s2k</a></li><li><a href="global.html#print_debug">print_debug</a></li><li><a href="global.html#print_debug_hexstr_dump">print_debug_hexstr_dump</a></li><li><a href="global.html#print_error">print_error</a></li><li><a href="global.html#print_info">print_info</a></li><li><a href="global.html#shiftRight">shiftRight</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#str2bin">str2bin</a></li><li><a href="global.html#util">util</a></li><li><a href="global.html#verifyCheckSum">verifyCheckSum</a></li></ul> +</nav> + +<br clear="both"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Wed Sep 05 2012 21:56:17 GMT-0400 (EDT) +</footer> + +<script> sh_highlightDocument(); </script> +</body> +</html> diff --git a/doc/openpgp_msg_message.html b/doc/openpgp_msg_message.html new file mode 100644 index 00000000..388acfba --- /dev/null +++ b/doc/openpgp_msg_message.html @@ -0,0 +1,587 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: openpgp_msg_message</title> + + <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script> + <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.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/node-dark.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: openpgp_msg_message</h1> + + + + + +<section> + +<header> + <h2> + openpgp_msg_message + </h2> + + <div class="class-description">Top-level message object. Contains information from one or more packets</div> + +</header> + +<article> + <div class="container-overview"> + + + + +<dt> + <h4 class="name" id="openpgp_msg_message"><span class="type-signature"><protected> </span>new openpgp_msg_message</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12199</li></ul></dd> + + + + + + + +</dl> + + + + + + + + + +</dd> + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<dt> + <h4 class="name" id="decrypt"><span class="type-signature"><inner> </span>decrypt</h4> + + +</dt> +<dd> + + + <div class="description"> + Decrypts a message and generates user interface message out of the found. +MDC will be verified as well as message 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>private_key</code></td> + + + <td class="type"> + + <a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a> + + + </td> + + + + + + <td class="description last">the private the message is encrypted with (corresponding to the session key)</td> + </tr> + + + + <tr> + + <td class="name"><code>sessionkey</code></td> + + + <td class="type"> + + <a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a> + + + </td> + + + + + + <td class="description last">the session key to be used to decrypt the message</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12214</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + plaintext of the message or null on error +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">String</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="decryptAndVerifySignature"><span class="type-signature"><inner> </span>decryptAndVerifySignature</h4> + + +</dt> +<dd> + + + <div class="description"> + Decrypts a message and generates user interface message out of the found. +MDC will be verified as well as message 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>private_key</code></td> + + + <td class="type"> + + <a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a> + + + </td> + + + + + + <td class="description last">the private the message is encrypted with (corresponding to the session key)</td> + </tr> + + + + <tr> + + <td class="name"><code>sessionkey</code></td> + + + <td class="type"> + + <a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a> + + + </td> + + + + + + <td class="description last">the session key to be used to decrypt the message</td> + </tr> + + + + <tr> + + <td class="name"><code>pubkey</code></td> + + + <td class="type"> + + <a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a> + + + </td> + + + + + + <td class="description last">Array of public keys to check signature against. If not provided, checks local keystore.</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12226</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + plaintext of the message or null on error +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">String</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="verifySignature"><span class="type-signature"><inner> </span>verifySignature</h4> + + +</dt> +<dd> + + + <div class="description"> + Verifies a message signature. This function can be called after read_message if the message was signed only. + </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>pubkey</code></td> + + + <td class="type"> + + <a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a> + + + </td> + + + + + + <td class="description last">Array of public keys to check signature against. If not provided, checks local keystore.</td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 12285</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + true if the signature was correct; otherwise false +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">boolean</span> + + </dd> +</dl> + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_keyring.html">openpgp_keyring</a></li><li><a href="openpgp_msg_message.html">openpgp_msg_message</a></li><li><a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a></li><li><a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MD5">MD5</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</a></li><li><a href="global.html#bin2str">bin2str</a></li><li><a href="global.html#calc_checksum">calc_checksum</a></li><li><a href="global.html#crc_table">crc_table</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#default_config">default_config</a></li><li><a href="global.html#getCheckSum">getCheckSum</a></li><li><a href="global.html#getPGPMessageType">getPGPMessageType</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</a></li><li><a href="global.html#hash_headers">hash_headers</a></li><li><a href="global.html#hex2bin">hex2bin</a></li><li><a href="global.html#hexidump">hexidump</a></li><li><a href="global.html#hexstrdump">hexstrdump</a></li><li><a href="global.html#openpgp_cfb_decrypt">openpgp_cfb_decrypt</a></li><li><a href="global.html#openpgp_cfb_encrypt">openpgp_cfb_encrypt</a></li><li><a href="global.html#openpgp_cfb_mdc">openpgp_cfb_mdc</a></li><li><a href="global.html#openpgp_config">openpgp_config</a></li><li><a href="global.html#openpgp_crypto_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</a></li><li><a href="global.html#openpgp_crypto_asymetricDecrypt">openpgp_crypto_asymetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_asymetricEncrypt">openpgp_crypto_asymetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_generateKeyPair">openpgp_crypto_generateKeyPair</a></li><li><a href="global.html#openpgp_crypto_generateSessionKey">openpgp_crypto_generateSessionKey</a></li><li><a href="global.html#openpgp_crypto_getHashByteLength">openpgp_crypto_getHashByteLength</a></li><li><a href="global.html#openpgp_crypto_getPrefixRandom">openpgp_crypto_getPrefixRandom</a></li><li><a href="global.html#openpgp_crypto_getPseudoRandom">openpgp_crypto_getPseudoRandom</a></li><li><a href="global.html#openpgp_crypto_getRandomBigInteger">openpgp_crypto_getRandomBigInteger</a></li><li><a href="global.html#openpgp_crypto_getRandomBytes">openpgp_crypto_getRandomBytes</a></li><li><a href="global.html#openpgp_crypto_getSecureRandom">openpgp_crypto_getSecureRandom</a></li><li><a href="global.html#openpgp_crypto_hashData">openpgp_crypto_hashData</a></li><li><a href="global.html#openpgp_crypto_signData">openpgp_crypto_signData</a></li><li><a href="global.html#openpgp_crypto_symmetricDecrypt">openpgp_crypto_symmetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_symmetricEncrypt">openpgp_crypto_symmetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_verifySignature">openpgp_crypto_verifySignature</a></li><li><a href="global.html#openpgp_encoding_armor">openpgp_encoding_armor</a></li><li><a href="global.html#openpgp_encoding_armor_addheader">openpgp_encoding_armor_addheader</a></li><li><a href="global.html#openpgp_encoding_base64_decode">openpgp_encoding_base64_decode</a></li><li><a href="global.html#openpgp_encoding_base64_encode">openpgp_encoding_base64_encode</a></li><li><a href="global.html#openpgp_encoding_deArmor">openpgp_encoding_deArmor</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_decode">openpgp_encoding_eme_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_encode">openpgp_encoding_eme_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_decode">openpgp_encoding_emsa_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_encode">openpgp_encoding_emsa_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_html_encode">openpgp_encoding_html_encode</a></li><li><a href="global.html#openpgp_packet_compressed">openpgp_packet_compressed</a></li><li><a href="global.html#openpgp_packet_encrypteddata">openpgp_packet_encrypteddata</a></li><li><a href="global.html#openpgp_packet_encryptedintegrityprotecteddata">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a></li><li><a href="global.html#openpgp_packet_keymaterial">openpgp_packet_keymaterial</a></li><li><a href="global.html#openpgp_packet_literaldata">openpgp_packet_literaldata</a></li><li><a href="global.html#openpgp_packet_marker">openpgp_packet_marker</a></li><li><a href="global.html#openpgp_packet_modificationdetectioncode">openpgp_packet_modificationdetectioncode</a></li><li><a href="global.html#openpgp_packet_onepasssignature">openpgp_packet_onepasssignature</a></li><li><a href="global.html#openpgp_packet_signature">openpgp_packet_signature</a></li><li><a href="global.html#openpgp_packet_userattribute">openpgp_packet_userattribute</a></li><li><a href="global.html#openpgp_packet_userid">openpgp_packet_userid</a></li><li><a href="global.html#openpgp_type_keyid">openpgp_type_keyid</a></li><li><a href="global.html#openpgp_type_mpi">openpgp_type_mpi</a></li><li><a href="global.html#openpgp_type_s2k">openpgp_type_s2k</a></li><li><a href="global.html#print_debug">print_debug</a></li><li><a href="global.html#print_debug_hexstr_dump">print_debug_hexstr_dump</a></li><li><a href="global.html#print_error">print_error</a></li><li><a href="global.html#print_info">print_info</a></li><li><a href="global.html#shiftRight">shiftRight</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#str2bin">str2bin</a></li><li><a href="global.html#util">util</a></li><li><a href="global.html#verifyCheckSum">verifyCheckSum</a></li></ul> +</nav> + +<br clear="both"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Wed Sep 05 2012 21:56:17 GMT-0400 (EDT) +</footer> + +<script> sh_highlightDocument(); </script> +</body> +</html> diff --git a/doc/openpgp_msg_privatekey.html b/doc/openpgp_msg_privatekey.html new file mode 100644 index 00000000..8e62460d --- /dev/null +++ b/doc/openpgp_msg_privatekey.html @@ -0,0 +1,288 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: openpgp_msg_privatekey</title> + + <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script> + <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.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/node-dark.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: openpgp_msg_privatekey</h1> + + + + + +<section> + +<header> + <h2> + openpgp_msg_privatekey + </h2> + + <div class="class-description">Class that represents a decoded private key for internal openpgp.js use</div> + +</header> + +<article> + <div class="container-overview"> + + + + +<dt> + <h4 class="name" id="openpgp_msg_privatekey"><span class="type-signature"></span>new openpgp_msg_privatekey</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10324</li></ul></dd> + + + + + + + +</dl> + + + + + + + + + +</dd> + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<dt> + <h4 class="name" id="extractPublicKey"><span class="type-signature"><inner> </span>extractPublicKey</h4> + + +</dt> +<dd> + + + <div class="description"> + extracts the public key part + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10448</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + OpenPGP armored text containing the public key + returns null if no sufficient data to extract public key +</div> + + + + +<dl> + <dt> + Type + </dt> + <dd> + + <span class="param-type">String</span> + + </dd> +</dl> + + + + +</dd> + + + +<dt> + <h4 class="name" id="read_nodes"><span class="type-signature"><inner> </span>read_nodes</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10336</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + last position +</div> + + + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_keyring.html">openpgp_keyring</a></li><li><a href="openpgp_msg_message.html">openpgp_msg_message</a></li><li><a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a></li><li><a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MD5">MD5</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</a></li><li><a href="global.html#bin2str">bin2str</a></li><li><a href="global.html#calc_checksum">calc_checksum</a></li><li><a href="global.html#crc_table">crc_table</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#default_config">default_config</a></li><li><a href="global.html#getCheckSum">getCheckSum</a></li><li><a href="global.html#getPGPMessageType">getPGPMessageType</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</a></li><li><a href="global.html#hash_headers">hash_headers</a></li><li><a href="global.html#hex2bin">hex2bin</a></li><li><a href="global.html#hexidump">hexidump</a></li><li><a href="global.html#hexstrdump">hexstrdump</a></li><li><a href="global.html#openpgp_cfb_decrypt">openpgp_cfb_decrypt</a></li><li><a href="global.html#openpgp_cfb_encrypt">openpgp_cfb_encrypt</a></li><li><a href="global.html#openpgp_cfb_mdc">openpgp_cfb_mdc</a></li><li><a href="global.html#openpgp_config">openpgp_config</a></li><li><a href="global.html#openpgp_crypto_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</a></li><li><a href="global.html#openpgp_crypto_asymetricDecrypt">openpgp_crypto_asymetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_asymetricEncrypt">openpgp_crypto_asymetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_generateKeyPair">openpgp_crypto_generateKeyPair</a></li><li><a href="global.html#openpgp_crypto_generateSessionKey">openpgp_crypto_generateSessionKey</a></li><li><a href="global.html#openpgp_crypto_getHashByteLength">openpgp_crypto_getHashByteLength</a></li><li><a href="global.html#openpgp_crypto_getPrefixRandom">openpgp_crypto_getPrefixRandom</a></li><li><a href="global.html#openpgp_crypto_getPseudoRandom">openpgp_crypto_getPseudoRandom</a></li><li><a href="global.html#openpgp_crypto_getRandomBigInteger">openpgp_crypto_getRandomBigInteger</a></li><li><a href="global.html#openpgp_crypto_getRandomBytes">openpgp_crypto_getRandomBytes</a></li><li><a href="global.html#openpgp_crypto_getSecureRandom">openpgp_crypto_getSecureRandom</a></li><li><a href="global.html#openpgp_crypto_hashData">openpgp_crypto_hashData</a></li><li><a href="global.html#openpgp_crypto_signData">openpgp_crypto_signData</a></li><li><a href="global.html#openpgp_crypto_symmetricDecrypt">openpgp_crypto_symmetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_symmetricEncrypt">openpgp_crypto_symmetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_verifySignature">openpgp_crypto_verifySignature</a></li><li><a href="global.html#openpgp_encoding_armor">openpgp_encoding_armor</a></li><li><a href="global.html#openpgp_encoding_armor_addheader">openpgp_encoding_armor_addheader</a></li><li><a href="global.html#openpgp_encoding_base64_decode">openpgp_encoding_base64_decode</a></li><li><a href="global.html#openpgp_encoding_base64_encode">openpgp_encoding_base64_encode</a></li><li><a href="global.html#openpgp_encoding_deArmor">openpgp_encoding_deArmor</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_decode">openpgp_encoding_eme_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_encode">openpgp_encoding_eme_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_decode">openpgp_encoding_emsa_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_encode">openpgp_encoding_emsa_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_html_encode">openpgp_encoding_html_encode</a></li><li><a href="global.html#openpgp_packet_compressed">openpgp_packet_compressed</a></li><li><a href="global.html#openpgp_packet_encrypteddata">openpgp_packet_encrypteddata</a></li><li><a href="global.html#openpgp_packet_encryptedintegrityprotecteddata">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a></li><li><a href="global.html#openpgp_packet_keymaterial">openpgp_packet_keymaterial</a></li><li><a href="global.html#openpgp_packet_literaldata">openpgp_packet_literaldata</a></li><li><a href="global.html#openpgp_packet_marker">openpgp_packet_marker</a></li><li><a href="global.html#openpgp_packet_modificationdetectioncode">openpgp_packet_modificationdetectioncode</a></li><li><a href="global.html#openpgp_packet_onepasssignature">openpgp_packet_onepasssignature</a></li><li><a href="global.html#openpgp_packet_signature">openpgp_packet_signature</a></li><li><a href="global.html#openpgp_packet_userattribute">openpgp_packet_userattribute</a></li><li><a href="global.html#openpgp_packet_userid">openpgp_packet_userid</a></li><li><a href="global.html#openpgp_type_keyid">openpgp_type_keyid</a></li><li><a href="global.html#openpgp_type_mpi">openpgp_type_mpi</a></li><li><a href="global.html#openpgp_type_s2k">openpgp_type_s2k</a></li><li><a href="global.html#print_debug">print_debug</a></li><li><a href="global.html#print_debug_hexstr_dump">print_debug_hexstr_dump</a></li><li><a href="global.html#print_error">print_error</a></li><li><a href="global.html#print_info">print_info</a></li><li><a href="global.html#shiftRight">shiftRight</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#str2bin">str2bin</a></li><li><a href="global.html#util">util</a></li><li><a href="global.html#verifyCheckSum">verifyCheckSum</a></li></ul> +</nav> + +<br clear="both"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Wed Sep 05 2012 21:56:17 GMT-0400 (EDT) +</footer> + +<script> sh_highlightDocument(); </script> +</body> +</html> diff --git a/doc/openpgp_msg_publickey.html b/doc/openpgp_msg_publickey.html new file mode 100644 index 00000000..7b2b243b --- /dev/null +++ b/doc/openpgp_msg_publickey.html @@ -0,0 +1,418 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: openpgp_msg_publickey</title> + + <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script> + <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.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/node-dark.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: openpgp_msg_publickey</h1> + + + + + +<section> + +<header> + <h2> + openpgp_msg_publickey + </h2> + + <div class="class-description">Decoded public key object for internal openpgp.js use</div> + +</header> + +<article> + <div class="container-overview"> + + + + +<dt> + <h4 class="name" id="openpgp_msg_publickey"><span class="type-signature"></span>new openpgp_msg_publickey</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 9987</li></ul></dd> + + + + + + + +</dl> + + + + + + + + + +</dd> + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<dt> + <h4 class="name" id="getEncryptionKey"><span class="type-signature"><inner> </span>getEncryptionKey</h4> + + +</dt> +<dd> + + + <div class="description"> + finds an encryption key for this public key + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10184</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + null if no encryption key has been found +</div> + + + + + + +</dd> + + + +<dt> + <h4 class="name" id="read_nodes"><span class="type-signature"><inner> </span>read_nodes</h4> + + +</dt> +<dd> + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10004</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + last position +</div> + + + + + + +</dd> + + + +<dt> + <h4 class="name" id="verifyBasicSignatures"><span class="type-signature"><inner> </span>verifyBasicSignatures</h4> + + +</dt> +<dd> + + + <div class="description"> + verifies: + - revocation certificates directly on key + - self signatures + - subkey binding and revocation certificates + + This is useful for validating the key + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10125</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + true if the basic signatures are all valid +</div> + + + + + + +</dd> + + + +<dt> + <h4 class="name" id="verifyCertificationSignatures"><span class="type-signature"><inner> </span>verifyCertificationSignatures</h4> + + +</dt> +<dd> + + + <div class="description"> + verifies all signatures + </div> + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li>openpgp.js, line 10107</li></ul></dd> + + + + + + + +</dl> + + + + + + + + <h5>Returns:</h5> + + +<div class="param-desc"> + a 2 dimensional array. the first dimension corresponds to the userids available +</div> + + + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_keyring.html">openpgp_keyring</a></li><li><a href="openpgp_msg_message.html">openpgp_msg_message</a></li><li><a href="openpgp_msg_privatekey.html">openpgp_msg_privatekey</a></li><li><a href="openpgp_msg_publickey.html">openpgp_msg_publickey</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MD5">MD5</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</a></li><li><a href="global.html#bin2str">bin2str</a></li><li><a href="global.html#calc_checksum">calc_checksum</a></li><li><a href="global.html#crc_table">crc_table</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#default_config">default_config</a></li><li><a href="global.html#getCheckSum">getCheckSum</a></li><li><a href="global.html#getPGPMessageType">getPGPMessageType</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</a></li><li><a href="global.html#hash_headers">hash_headers</a></li><li><a href="global.html#hex2bin">hex2bin</a></li><li><a href="global.html#hexidump">hexidump</a></li><li><a href="global.html#hexstrdump">hexstrdump</a></li><li><a href="global.html#openpgp_cfb_decrypt">openpgp_cfb_decrypt</a></li><li><a href="global.html#openpgp_cfb_encrypt">openpgp_cfb_encrypt</a></li><li><a href="global.html#openpgp_cfb_mdc">openpgp_cfb_mdc</a></li><li><a href="global.html#openpgp_config">openpgp_config</a></li><li><a href="global.html#openpgp_crypto_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</a></li><li><a href="global.html#openpgp_crypto_asymetricDecrypt">openpgp_crypto_asymetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_asymetricEncrypt">openpgp_crypto_asymetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_generateKeyPair">openpgp_crypto_generateKeyPair</a></li><li><a href="global.html#openpgp_crypto_generateSessionKey">openpgp_crypto_generateSessionKey</a></li><li><a href="global.html#openpgp_crypto_getHashByteLength">openpgp_crypto_getHashByteLength</a></li><li><a href="global.html#openpgp_crypto_getPrefixRandom">openpgp_crypto_getPrefixRandom</a></li><li><a href="global.html#openpgp_crypto_getPseudoRandom">openpgp_crypto_getPseudoRandom</a></li><li><a href="global.html#openpgp_crypto_getRandomBigInteger">openpgp_crypto_getRandomBigInteger</a></li><li><a href="global.html#openpgp_crypto_getRandomBytes">openpgp_crypto_getRandomBytes</a></li><li><a href="global.html#openpgp_crypto_getSecureRandom">openpgp_crypto_getSecureRandom</a></li><li><a href="global.html#openpgp_crypto_hashData">openpgp_crypto_hashData</a></li><li><a href="global.html#openpgp_crypto_signData">openpgp_crypto_signData</a></li><li><a href="global.html#openpgp_crypto_symmetricDecrypt">openpgp_crypto_symmetricDecrypt</a></li><li><a href="global.html#openpgp_crypto_symmetricEncrypt">openpgp_crypto_symmetricEncrypt</a></li><li><a href="global.html#openpgp_crypto_verifySignature">openpgp_crypto_verifySignature</a></li><li><a href="global.html#openpgp_encoding_armor">openpgp_encoding_armor</a></li><li><a href="global.html#openpgp_encoding_armor_addheader">openpgp_encoding_armor_addheader</a></li><li><a href="global.html#openpgp_encoding_base64_decode">openpgp_encoding_base64_decode</a></li><li><a href="global.html#openpgp_encoding_base64_encode">openpgp_encoding_base64_encode</a></li><li><a href="global.html#openpgp_encoding_deArmor">openpgp_encoding_deArmor</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_decode">openpgp_encoding_eme_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_eme_pkcs1_encode">openpgp_encoding_eme_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_decode">openpgp_encoding_emsa_pkcs1_decode</a></li><li><a href="global.html#openpgp_encoding_emsa_pkcs1_encode">openpgp_encoding_emsa_pkcs1_encode</a></li><li><a href="global.html#openpgp_encoding_html_encode">openpgp_encoding_html_encode</a></li><li><a href="global.html#openpgp_packet_compressed">openpgp_packet_compressed</a></li><li><a href="global.html#openpgp_packet_encrypteddata">openpgp_packet_encrypteddata</a></li><li><a href="global.html#openpgp_packet_encryptedintegrityprotecteddata">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="global.html#openpgp_packet_encryptedsessionkey">openpgp_packet_encryptedsessionkey</a></li><li><a href="global.html#openpgp_packet_keymaterial">openpgp_packet_keymaterial</a></li><li><a href="global.html#openpgp_packet_literaldata">openpgp_packet_literaldata</a></li><li><a href="global.html#openpgp_packet_marker">openpgp_packet_marker</a></li><li><a href="global.html#openpgp_packet_modificationdetectioncode">openpgp_packet_modificationdetectioncode</a></li><li><a href="global.html#openpgp_packet_onepasssignature">openpgp_packet_onepasssignature</a></li><li><a href="global.html#openpgp_packet_signature">openpgp_packet_signature</a></li><li><a href="global.html#openpgp_packet_userattribute">openpgp_packet_userattribute</a></li><li><a href="global.html#openpgp_packet_userid">openpgp_packet_userid</a></li><li><a href="global.html#openpgp_type_keyid">openpgp_type_keyid</a></li><li><a href="global.html#openpgp_type_mpi">openpgp_type_mpi</a></li><li><a href="global.html#openpgp_type_s2k">openpgp_type_s2k</a></li><li><a href="global.html#print_debug">print_debug</a></li><li><a href="global.html#print_debug_hexstr_dump">print_debug_hexstr_dump</a></li><li><a href="global.html#print_error">print_error</a></li><li><a href="global.html#print_info">print_info</a></li><li><a href="global.html#shiftRight">shiftRight</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#str2bin">str2bin</a></li><li><a href="global.html#util">util</a></li><li><a href="global.html#verifyCheckSum">verifyCheckSum</a></li></ul> +</nav> + +<br clear="both"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Wed Sep 05 2012 21:56:17 GMT-0400 (EDT) +</footer> + +<script> sh_highlightDocument(); </script> +</body> +</html>