240 lines
12 KiB
HTML
240 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: keyring/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: keyring/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
|
|
|
|
/**
|
|
* The class that deals with storage of the keyring. Currently the only option is to use HTML5 local storage.
|
|
* @requires openpgp
|
|
* @module keyring/keyring
|
|
*/
|
|
|
|
var openpgp = require('openpgp');
|
|
|
|
/**
|
|
* Callback to check if a key matches the input
|
|
* @callback module:keyring/keyring.checkCallback
|
|
* @param {String} input input to search for
|
|
* @param {module:key~Key} key The key to be checked.
|
|
* @return {Boolean} True if the input matches the specified key
|
|
*/
|
|
|
|
module.exports = Keyring;
|
|
|
|
/**
|
|
* Initialization routine for the keyring. This method reads the
|
|
* keyring from HTML5 local storage and initializes this instance.
|
|
* @constructor
|
|
* @param {class} [storeHandler] class implementing load() and store() methods
|
|
*/
|
|
function Keyring(storeHandler) {
|
|
this.storeHandler = storeHandler || new (require('./localstore.js'))();
|
|
this.keys = this.storeHandler.load();
|
|
};
|
|
|
|
/**
|
|
* Calls the storeHandler to save the keys
|
|
*/
|
|
Keyring.prototype.store = function () {
|
|
this.storeHandler.store(this.keys);
|
|
};
|
|
|
|
/**
|
|
* Clear the keyring - erase all the keys
|
|
*/
|
|
Keyring.prototype.clear = function() {
|
|
this.keys = [];
|
|
};
|
|
|
|
/**
|
|
* Checks a key to see if it matches the specified email address
|
|
* @param {String} email email address to search for
|
|
* @param {module:key~Key} key The key to be checked.
|
|
* @return {Boolean} True if the email address is defined in the specified key
|
|
*/
|
|
function emailCheck(email, key) {
|
|
email = email.toLowerCase();
|
|
var keyEmails = key.getUserIds();
|
|
for (var i; i < keyEmails.length; i++) {
|
|
//we need to get just the email from the userid key
|
|
keyEmail = keyEmails[i].split('<')[1].split('>')[0].trim().toLowerCase();
|
|
if (keyEmail == email) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks a key to see if it matches the specified keyid
|
|
* @param {String} id hex string keyid to search for
|
|
* @param {module:key~Key} key the key to be checked.
|
|
* @return {Boolean} true if the email address is defined in the specified key
|
|
* @inner
|
|
*/
|
|
function idCheck(id, key) {
|
|
var keyids = key.getKeyIds();
|
|
for (var i = 0; i < keyids.length; i++) {
|
|
if (openpgp.util.hexstrdump(keyids[i].write()) == id) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* searches all public keys in the keyring matching the address or address part of the user ids
|
|
* @param {Array<module:key~Key>} keys array of keys to search
|
|
* @param {module:keyring/keyring.checkCallback} identityFunction callback function which checks for a match
|
|
* @param {String} identityInput input to check against
|
|
* @param {module:enums.packet} keyType packet types of keys to check
|
|
* @return {Array<module:key~Key>} array of keys which match
|
|
*/
|
|
function checkForIdentityAndKeyTypeMatch(keys, identityFunction, identityInput, keyType) {
|
|
var results = [];
|
|
for (var p = 0; p < keys.length; p++) {
|
|
var key = keys[p];
|
|
switch (keyType) {
|
|
case openpgp.enums.packet.publicKey:
|
|
if (key.isPublic() && identityFunction(identityInput, key)) {
|
|
results.push(key);
|
|
}
|
|
break;
|
|
case openpgp.enums.packet.private_key:
|
|
if (key.isPrivate() && identityFunction(identityInput, key)) {
|
|
results.push(key);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* searches all public keys in the keyring matching the address or address part of the user ids
|
|
* @param {String} email email address to search for
|
|
* @return {Array<module:key~Key>} The public keys associated with provided email address.
|
|
*/
|
|
Keyring.prototype.getPublicKeyForAddress = function (email) {
|
|
return checkForIdentityAndKeyTypeMatch(this.keys, emailCheck, email, openpgp.enums.packet.publicKey);
|
|
};
|
|
|
|
/**
|
|
* Searches the keyring for a private key containing the specified email address
|
|
* @param {String} email email address to search for
|
|
* @return {Array<module:key~Key>} private keys found
|
|
*/
|
|
Keyring.prototype.getPrivateKeyForAddress = function (email) {
|
|
return checkForIdentityAndKeyTypeMatch(this.keys, emailCheck, email, openpgp.enums.packet.secretKey);
|
|
};
|
|
|
|
/**
|
|
* Searches the keyring for public keys having the specified key id
|
|
* @param {String} keyId provided as string of hex number (lowercase)
|
|
* @return {Array<module:key~Key>} public keys found
|
|
*/
|
|
Keyring.prototype.getKeysForKeyId = function (keyId) {
|
|
return checkForIdentityAndKeyTypeMatch(this.keys, idCheck, keyId, openpgp.enums.packet.publicKey);
|
|
};
|
|
|
|
/**
|
|
* Imports a key from an ascii armored message
|
|
* @param {String} armored message to read the keys/key from
|
|
*/
|
|
Keyring.prototype.importKey = function (armored) {
|
|
this.keys = this.keys.concat(openpgp.key.readArmored(armored).keys);
|
|
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* returns the armored message representation of the key at key ring index
|
|
* @param {Integer} index the index of the key within the array
|
|
* @return {String} armored message representing the key object
|
|
*/
|
|
Keyring.prototype.exportKey = function (index) {
|
|
return this.keys[index].armor();
|
|
};
|
|
|
|
/**
|
|
* 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 {module:key~Key} The public key object which has been removed
|
|
*/
|
|
Keyring.prototype.removeKey = function (index) {
|
|
var removed = this.keys.splice(index, 1);
|
|
|
|
return removed;
|
|
};
|
|
|
|
/**
|
|
* returns the armored message representation of the public key portion of the key at key ring index
|
|
* @param {Integer} index the index of the key within the array
|
|
* @return {String} armored message representing the public key object
|
|
*/
|
|
Keyring.prototype.exportPublicKey = function (index) {
|
|
return this.keys[index].toPublic().armor();
|
|
};
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-armor.html">armor</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-keyid.html">keyid</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-mpi.html">mpi</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="module-s2k.html">s2k</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><li><a href="util.html">util/util</a></li></ul><h3>Classes</h3><ul><li><a href="JXG.Util.html">Util</a></li><li><a href="module-cleartext-CleartextMessage.html">CleartextMessage</a></li><li><a href="localStorage-LocalStorage.html">LocalStorage</a></li><li><a href="keyring-Keyring.html">Keyring</a></li><li><a href="module-key-Key.html">Key</a></li><li><a href="module-key-SubKey.html">SubKey</a></li><li><a href="module-key-User.html">User</a></li><li><a href="module-message-Message.html">Message</a></li><li><a href="compressed-Compressed.html">Compressed</a></li><li><a href="literal-Literal.html">Literal</a></li><li><a href="marker-Marker.html">Marker</a></li><li><a href="one_pass_signature-OnePassSignature.html">OnePassSignature</a></li><li><a href="packetlist-Packetlist.html">Packetlist</a></li><li><a href="public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html">PublicKeyEncryptedSessionKey</a></li><li><a href="public_key-PublicKey.html">PublicKey</a></li><li><a href="public_subkey-PublicSubkey.html">PublicSubkey</a></li><li><a href="secret_subkey-SecretSubkey.html">SecretSubkey</a></li><li><a href="signature-Signature.html">Signature</a></li><li><a href="sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html">SymEncryptedIntegrityProtected</a></li><li><a href="sym_encrypted_session_key-SymEncryptedSessionKey.html">SymEncryptedSessionKey</a></li><li><a href="symmetrically_encrypted-SymmetricallyEncrypted.html">SymmetricallyEncrypted</a></li><li><a href="trust-Trust.html">Trust</a></li><li><a href="user_attribute-UserAttribute.html">UserAttribute</a></li><li><a href="userid-Userid.html">Userid</a></li><li><a href="keyid-Keyid.html">Keyid</a></li><li><a href="mpi-Mpi.html">Mpi</a></li><li><a href="s2k-S2k.html">S2k</a></li></ul>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Sun Jan 05 2014 10:08:07 GMT-0800 (PST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|