23295342fc
work correctly with utf8 strings. Fixeda visibility issue with the testing suite and added relevant unit tests.
314 lines
16 KiB
HTML
314 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: openpgp.keyring.js</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">Source: openpgp.keyring.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source"><code>// GPG4Browsers - An OpenPGP implementation in javascript
|
|
// Copyright (C) 2011 Recurity Labs GmbH
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2.1 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
/**
|
|
* @class
|
|
* @classdesc The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
|
|
*/
|
|
function openpgp_keyring() {
|
|
|
|
/**
|
|
* 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().
|
|
*/
|
|
function init() {
|
|
var sprivatekeys = JSON.parse(window.localStorage.getItem("privatekeys"));
|
|
var spublickeys = JSON.parse(window.localStorage.getItem("publickeys"));
|
|
if (sprivatekeys == null || sprivatekeys.length == 0) {
|
|
sprivatekeys = new Array();
|
|
}
|
|
|
|
if (spublickeys == null || spublickeys.length == 0) {
|
|
spublickeys = new Array();
|
|
}
|
|
this.publicKeys = new Array();
|
|
this.privateKeys = new Array();
|
|
var k = 0;
|
|
for (var i =0; i < sprivatekeys.length; i++) {
|
|
var r = openpgp.read_privateKey(sprivatekeys[i]);
|
|
this.privateKeys[k] = { armored: sprivatekeys[i], obj: r[0], keyId: r[0].getKeyId()};
|
|
k++;
|
|
}
|
|
k = 0;
|
|
for (var i =0; i < spublickeys.length; i++) {
|
|
var r = openpgp.read_publicKey(spublickeys[i]);
|
|
if (r[0] != null) {
|
|
this.publicKeys[k] = { armored: spublickeys[i], obj: r[0], keyId: r[0].getKeyId()};
|
|
k++;
|
|
}
|
|
}
|
|
}
|
|
this.init = init;
|
|
|
|
/**
|
|
* Checks if at least one private key is in the keyring
|
|
* @return {Boolean} True if there are private keys, else false.
|
|
*/
|
|
function hasPrivateKey() {
|
|
return this.privateKeys.length > 0;
|
|
}
|
|
this.hasPrivateKey = hasPrivateKey;
|
|
|
|
/**
|
|
* Saves the current state of the keyring to HTML5 local storage.
|
|
* The privateKeys array and publicKeys array gets Stringified using JSON
|
|
*/
|
|
function store() {
|
|
var priv = new Array();
|
|
for (var i = 0; i < this.privateKeys.length; i++) {
|
|
priv[i] = this.privateKeys[i].armored;
|
|
}
|
|
var pub = new Array();
|
|
for (var i = 0; i < this.publicKeys.length; i++) {
|
|
pub[i] = this.publicKeys[i].armored;
|
|
}
|
|
window.localStorage.setItem("privatekeys",JSON.stringify(priv));
|
|
window.localStorage.setItem("publickeys",JSON.stringify(pub));
|
|
}
|
|
this.store = store;
|
|
/**
|
|
* searches all public keys in the keyring matching the address or address part of the user ids
|
|
* @param {String} email_address
|
|
* @return {openpgp_msg_publickey[]} The public keys associated with provided email address.
|
|
*/
|
|
function getPublicKeyForAddress(email_address) {
|
|
var results = new Array();
|
|
var spl = email_address.split("<");
|
|
var email = "";
|
|
if (spl.length > 1) {
|
|
email = spl[1].split(">")[0];
|
|
} else {
|
|
email = email_address.trim();
|
|
}
|
|
email = email.toLowerCase();
|
|
if(!util.emailRegEx.test(email)){
|
|
return results;
|
|
}
|
|
for (var i =0; i < this.publicKeys.length; i++) {
|
|
for (var j = 0; j < this.publicKeys[i].obj.userIds.length; j++) {
|
|
if (this.publicKeys[i].obj.userIds[j].text.toLowerCase().indexOf(email) >= 0)
|
|
results[results.length] = this.publicKeys[i];
|
|
}
|
|
}
|
|
return results;
|
|
}
|
|
this.getPublicKeyForAddress = getPublicKeyForAddress;
|
|
|
|
/**
|
|
* Searches the keyring for a private key containing the specified email address
|
|
* @param {String} email_address email address to search for
|
|
* @return {openpgp_msg_privatekey[]} private keys found
|
|
*/
|
|
function getPrivateKeyForAddress(email_address) {
|
|
var results = new Array();
|
|
var spl = email_address.split("<");
|
|
var email = "";
|
|
if (spl.length > 1) {
|
|
email = spl[1].split(">")[0];
|
|
} else {
|
|
email = email_address.trim();
|
|
}
|
|
email = email.toLowerCase();
|
|
if(!util.emailRegEx.test(email)){
|
|
return results;
|
|
}
|
|
for (var i =0; i < this.privateKeys.length; i++) {
|
|
for (var j = 0; j < this.privateKeys[i].obj.userIds.length; j++) {
|
|
if (this.privateKeys[i].obj.userIds[j].text.toLowerCase().indexOf(email) >= 0)
|
|
results[results.length] = this.privateKeys[i];
|
|
}
|
|
}
|
|
return results;
|
|
}
|
|
|
|
this.getPrivateKeyForAddress = getPrivateKeyForAddress;
|
|
/**
|
|
* Searches the keyring for public keys having the specified key id
|
|
* @param {String} keyId provided as string of hex number (lowercase)
|
|
* @return {openpgp_msg_privatekey[]} public keys found
|
|
*/
|
|
function getPublicKeysForKeyId(keyId) {
|
|
var result = new Array();
|
|
for (var i=0; i < this.publicKeys.length; i++) {
|
|
var key = this.publicKeys[i];
|
|
if (keyId == key.obj.getKeyId())
|
|
result[result.length] = key;
|
|
else if (key.obj.subKeys != null) {
|
|
for (var j=0; j < key.obj.subKeys.length; j++) {
|
|
var subkey = key.obj.subKeys[j];
|
|
if (keyId == subkey.getKeyId()) {
|
|
result[result.length] = {
|
|
obj: key.obj.getSubKeyAsKey(j),
|
|
keyId: subkey.getKeyId()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
this.getPublicKeysForKeyId = getPublicKeysForKeyId;
|
|
|
|
/**
|
|
* Searches the keyring for private keys having the specified key id
|
|
* @param {String} keyId 8 bytes as string containing the key id to look for
|
|
* @return {openpgp_msg_privatekey[]} private keys found
|
|
*/
|
|
function getPrivateKeyForKeyId(keyId) {
|
|
var result = new Array();
|
|
for (var i=0; i < this.privateKeys.length; i++) {
|
|
if (keyId == this.privateKeys[i].obj.getKeyId()) {
|
|
result[result.length] = { key: this.privateKeys[i], keymaterial: this.privateKeys[i].obj.privateKeyPacket};
|
|
}
|
|
if (this.privateKeys[i].obj.subKeys != null) {
|
|
var subkeyids = this.privateKeys[i].obj.getSubKeyIds();
|
|
for (var j=0; j < subkeyids.length; j++)
|
|
if (keyId == util.hexstrdump(subkeyids[j])) {
|
|
result[result.length] = { key: this.privateKeys[i], keymaterial: this.privateKeys[i].obj.subKeys[j]};
|
|
}
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
this.getPrivateKeyForKeyId = getPrivateKeyForKeyId;
|
|
|
|
/**
|
|
* Imports a public key from an exported ascii armored message
|
|
* @param {String} armored_text PUBLIC KEY BLOCK message to read the public key from
|
|
*/
|
|
function importPublicKey (armored_text) {
|
|
var result = openpgp.read_publicKey(armored_text);
|
|
for (var i = 0; i < result.length; i++) {
|
|
this.publicKeys[this.publicKeys.length] = {armored: armored_text, obj: result[i], keyId: result[i].getKeyId()};
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Imports a private key from an exported ascii armored message
|
|
* @param {String} armored_text PRIVATE KEY BLOCK message to read the private key from
|
|
*/
|
|
function importPrivateKey (armored_text, password) {
|
|
var result = openpgp.read_privateKey(armored_text);
|
|
if(!result[0].decryptSecretMPIs(password))
|
|
return false;
|
|
for (var i = 0; i < result.length; i++) {
|
|
this.privateKeys[this.privateKeys.length] = {armored: armored_text, obj: result[i], keyId: result[i].getKeyId()};
|
|
}
|
|
return true;
|
|
}
|
|
|
|
this.importPublicKey = importPublicKey;
|
|
this.importPrivateKey = importPrivateKey;
|
|
|
|
/**
|
|
* returns the openpgp_msg_privatekey representation of the public key at public key ring index
|
|
* @param {Integer} index the index of the public key within the publicKeys array
|
|
* @return {openpgp_msg_privatekey} the public key object
|
|
*/
|
|
function exportPublicKey(index) {
|
|
return this.publicKey[index];
|
|
}
|
|
this.exportPublicKey = exportPublicKey;
|
|
|
|
|
|
/**
|
|
* Removes a public key from the public key keyring at the specified index
|
|
* @param {Integer} index the index of the public key within the publicKeys array
|
|
* @return {openpgp_msg_privatekey} The public key object which has been removed
|
|
*/
|
|
function removePublicKey(index) {
|
|
var removed = this.publicKeys.splice(index,1);
|
|
this.store();
|
|
return removed;
|
|
}
|
|
this.removePublicKey = removePublicKey;
|
|
|
|
/**
|
|
* returns the openpgp_msg_privatekey representation of the private key at private key ring index
|
|
* @param {Integer} index the index of the private key within the privateKeys array
|
|
* @return {openpgp_msg_privatekey} the private key object
|
|
*/
|
|
function exportPrivateKey(index) {
|
|
return this.privateKeys[index];
|
|
}
|
|
this.exportPrivateKey = exportPrivateKey;
|
|
|
|
/**
|
|
* Removes a private key from the private key keyring at the specified index
|
|
* @param {Integer} index the index of the private key within the privateKeys array
|
|
* @return {openpgp_msg_privatekey} The private key object which has been removed
|
|
*/
|
|
function removePrivateKey(index) {
|
|
var removed = this.privateKeys.splice(index,1);
|
|
this.store();
|
|
return removed;
|
|
}
|
|
this.removePrivateKey = removePrivateKey;
|
|
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="_openpgp_packet.html">_openpgp_packet</a></li><li><a href="JXG.Util.html">Util</a></li><li><a href="openpgp.html">openpgp</a></li><li><a href="openpgp_config.html">openpgp_config</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><li><a href="openpgp_packet_compressed.html">openpgp_packet_compressed</a></li><li><a href="openpgp_packet_encrypteddata.html">openpgp_packet_encrypteddata</a></li><li><a href="openpgp_packet_encryptedintegrityprotecteddata.html">openpgp_packet_encryptedintegrityprotecteddata</a></li><li><a href="openpgp_packet_encryptedsessionkey.html">openpgp_packet_encryptedsessionkey</a></li><li><a href="openpgp_packet_keymaterial.html">openpgp_packet_keymaterial</a></li><li><a href="openpgp_packet_literaldata.html">openpgp_packet_literaldata</a></li><li><a href="openpgp_packet_marker.html">openpgp_packet_marker</a></li><li><a href="openpgp_packet_modificationdetectioncode.html">openpgp_packet_modificationdetectioncode</a></li><li><a href="openpgp_packet_onepasssignature.html">openpgp_packet_onepasssignature</a></li><li><a href="openpgp_packet_signature.html">openpgp_packet_signature</a></li><li><a href="openpgp_packet_userattribute.html">openpgp_packet_userattribute</a></li><li><a href="openpgp_packet_userid.html">openpgp_packet_userid</a></li><li><a href="openpgp_type_keyid.html">openpgp_type_keyid</a></li><li><a href="openpgp_type_mpi.html">openpgp_type_mpi</a></li><li><a href="openpgp_type_s2k.html">openpgp_type_s2k</a></li></ul><h3>Global</h3><ul><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#decode_utf8">decode_utf8</a></li><li><a href="global.html#encode_utf8">encode_utf8</a></li><li><a href="global.html#get_hashAlgorithmString">get_hashAlgorithmString</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#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#MD5">MD5</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_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_MDCSystemBytes">openpgp_crypto_MDCSystemBytes</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#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#str2bin">str2bin</a></li><li><a href="global.html#str2Uint8Array">str2Uint8Array</a></li><li><a href="global.html#Uint8Array2str">Uint8Array2str</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.2.0-dev</a> on Tue Apr 16 2013 10:42:39 GMT+0200 (CEST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
</body>
|
|
</html>
|