8923813580
Add jsdoc @module definitions. Fix references to old class names. Make keyring a multiple instance module. Eliminate unit test dependency on running npm test.
424 lines
16 KiB
HTML
424 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: key.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: key.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
|
|
|
|
/** @module key */
|
|
|
|
var packet = require('./packet');
|
|
var enums = require('./enums.js');
|
|
var armor = require('./encoding/armor.js');
|
|
var config = require('./config');
|
|
|
|
/**
|
|
* @class
|
|
* @classdesc Class that represents an OpenPGP key. Must contain a primary key.
|
|
* Can contain additional subkeys, signatures, user ids, user attributes.
|
|
* @param {packet.list} packetlist The packets that form this key
|
|
*/
|
|
|
|
function Key(packetlist) {
|
|
if (!(this instanceof Key)) {
|
|
return new Key(packetlist);
|
|
}
|
|
this.packets = packetlist || new packet.list();
|
|
}
|
|
|
|
/**
|
|
* Returns the primary key packet (secret or public)
|
|
* @returns {(packet_secret_key|packet_public_key|null)}
|
|
*/
|
|
Key.prototype.getKeyPacket = function() {
|
|
for (var i = 0; i < this.packets.length; i++) {
|
|
if (this.packets[i].tag == enums.packet.public_key ||
|
|
this.packets[i].tag == enums.packet.secret_key) {
|
|
return this.packets[i];
|
|
}
|
|
}
|
|
return null;
|
|
};
|
|
|
|
/**
|
|
* Returns all the private and public subkey packets
|
|
* @returns {Array<(public_subkey|secret_subkey)>}
|
|
*/
|
|
Key.prototype.getSubkeyPackets = function() {
|
|
|
|
var subkeys = [];
|
|
|
|
for (var i = 0; i < this.packets.length; i++) {
|
|
if (this.packets[i].tag == enums.packet.public_subkey ||
|
|
this.packets[i].tag == enums.packet.secret_subkey) {
|
|
subkeys.push(this.packets[i]);
|
|
}
|
|
}
|
|
|
|
return subkeys;
|
|
};
|
|
|
|
/**
|
|
* Returns all the private and public key and subkey packets
|
|
* @returns {Array<(public_subkey|secret_subkey|packet_secret_key|packet_public_key)>}
|
|
*/
|
|
Key.prototype.getAllKeyPackets = function() {
|
|
return [this.getKeyPacket()].concat(this.getSubkeyPackets());
|
|
};
|
|
|
|
/**
|
|
* Returns key IDs of all key packets
|
|
* @returns {Array<keyid>}
|
|
*/
|
|
Key.prototype.getKeyIds = function() {
|
|
var keyIds = [];
|
|
var keys = this.getAllKeyPackets();
|
|
for (var i = 0; i < keys.length; i++) {
|
|
keyIds.push(keys[i].getKeyId());
|
|
}
|
|
return keyIds;
|
|
};
|
|
|
|
function findKey(keys, keyIds) {
|
|
for (var i = 0; i < keys.length; i++) {
|
|
var keyId = keys[i].getKeyId();
|
|
for (var j = 0; j < keyIds.length; j++) {
|
|
if (keyId.equals(keyIds[j])) {
|
|
return keys[i];
|
|
}
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns first public key packet for given array of key IDs
|
|
* @param {Array<keyid>} keyIds
|
|
* @return {(public_subkey|packet_public_key|null)}
|
|
*/
|
|
Key.prototype.getPublicKeyPacket = function(keyIds) {
|
|
var keys = this.packets.filterByTag(enums.packet.public_key, enums.packet.public_subkey);
|
|
return findKey(keys, keyIds);
|
|
};
|
|
|
|
/**
|
|
* Returns first private key packet for given array of key IDs
|
|
* @param {Array<keyid>} keyIds
|
|
* @return {(secret_subkey|packet_secret_key|null)}
|
|
*/
|
|
Key.prototype.getPrivateKeyPacket = function(keyIds) {
|
|
var keys = this.packets.filterByTag(enums.packet.secret_key, enums.packet.secret_subkey);
|
|
return findKey(keys, keyIds);
|
|
};
|
|
|
|
/**
|
|
* Returns userids
|
|
* @return {Array<string>} array of userids
|
|
*/
|
|
Key.prototype.getUserIds = function() {
|
|
var userids = [];
|
|
var useridPackets = this.packets.filterByTag(enums.packet.userid);
|
|
for (var i = 0; i < useridPackets.length; i++) {
|
|
userids.push(useridPackets[i].write());
|
|
}
|
|
return userids;
|
|
};
|
|
|
|
/**
|
|
* Returns true if this is a public key
|
|
* @return {Boolean}
|
|
*/
|
|
Key.prototype.isPublic = function() {
|
|
var publicKeyPackets = this.packets.filterByTag(enums.packet.public_key);
|
|
return publicKeyPackets.length ? true : false;
|
|
};
|
|
|
|
/**
|
|
* Returns true if this is a private key
|
|
* @return {Boolean}
|
|
*/
|
|
Key.prototype.isPrivate = function() {
|
|
var privateKeyPackets = this.packets.filterByTag(enums.packet.private_key);
|
|
return privateKeyPackets.length ? true : false;
|
|
};
|
|
|
|
/**
|
|
* Returns key as public key
|
|
* @return {Key} public key
|
|
*/
|
|
Key.prototype.toPublic = function() {
|
|
var packetlist = new packet.list();
|
|
for (var i = 0; i < this.packets.length; i++) {
|
|
switch (this.packets[i].tag) {
|
|
case enums.packet.secret_key:
|
|
var bytes = this.packets[i].writePublicKey();
|
|
var pubKeyPacket = new packet.public_key();
|
|
pubKeyPacket.read(bytes);
|
|
packetlist.push(pubKeyPacket);
|
|
break;
|
|
case enums.packet.secret_subkey:
|
|
var bytes = this.packets[i].writePublicKey();
|
|
var pubSubkeyPacket = new packet.public_subkey();
|
|
pubSubkeyPacket.read(bytes);
|
|
packetlist.push(pubSubkeyPacket);
|
|
break;
|
|
default:
|
|
packetlist.push(this.packets[i]);
|
|
}
|
|
}
|
|
return new Key(packetlist);
|
|
};
|
|
|
|
/**
|
|
* Returns ASCII armored text of key
|
|
* @return {String} ASCII armor
|
|
*/
|
|
Key.prototype.armor = function() {
|
|
var type = this.isPublic() ? enums.armor.public_key : enums.armor.private_key;
|
|
return armor.encode(type, this.packets.write());
|
|
};
|
|
|
|
/**
|
|
* Returns first key packet that is available for signing
|
|
* @return {(public_subkey|secret_subkey|packet_secret_key|packet_public_key|null)}
|
|
*/
|
|
Key.prototype.getSigningKeyPacket = function() {
|
|
|
|
var signing = [ enums.publicKey.rsa_encrypt_sign, enums.publicKey.rsa_sign, enums.publicKey.dsa];
|
|
|
|
signing = signing.map(function(s) {
|
|
return enums.read(enums.publicKey, s);
|
|
});
|
|
|
|
var keys = this.getAllKeyPackets();
|
|
|
|
for (var i = 0; i < keys.length; i++) {
|
|
if (signing.indexOf(keys[i].algorithm) !== -1) {
|
|
return keys[i];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
};
|
|
|
|
/**
|
|
* Returns preferred signature hash algorithm of this key
|
|
* @return {String}
|
|
*/
|
|
Key.prototype.getPreferredSignatureHashAlgorithm = function() {
|
|
//TODO implement: https://tools.ietf.org/html/rfc4880#section-5.2.3.8
|
|
//separate private key preference from digest preferences
|
|
return config.prefer_hash_algorithm;
|
|
};
|
|
|
|
/**
|
|
* Returns the first valid encryption key packet for this key
|
|
* @returns {(public_subkey|secret_subkey|packet_secret_key|packet_public_key|null)} key packet or null if no encryption key has been found
|
|
*/
|
|
Key.prototype.getEncryptionKeyPacket = function() {
|
|
// V4: by convention subkeys are prefered for encryption service
|
|
// V3: keys MUST NOT have subkeys
|
|
var isValidEncryptionKey = function(key) {
|
|
//TODO evaluate key flags: http://tools.ietf.org/html/rfc4880#section-5.2.3.21
|
|
return key.algorithm != enums.read(enums.publicKey, enums.publicKey.dsa) && key.algorithm != enums.read(enums.publicKey,
|
|
enums.publicKey.rsa_sign);
|
|
//TODO verify key
|
|
//&& keys.verifyKey()
|
|
};
|
|
|
|
var subkeys = this.getSubkeyPackets();
|
|
|
|
for (var j = 0; j < subkeys.length; j++) {
|
|
if (isValidEncryptionKey(subkeys[j])) {
|
|
return subkeys[j];
|
|
}
|
|
}
|
|
// if no valid subkey for encryption, use primary key
|
|
var primaryKey = this.getKeyPacket();
|
|
if (isValidEncryptionKey(primaryKey)) {
|
|
return primaryKey;
|
|
}
|
|
return null;
|
|
};
|
|
|
|
/**
|
|
* Decrypts all secret key and subkey packets
|
|
* @param {String} passphrase
|
|
* @return {Boolean} true if all key and subkey packets decrypted successfully
|
|
*/
|
|
Key.prototype.decrypt = function(passphrase) {
|
|
var keys = this.packets.filterByTag(enums.packet.secret_key, enums.packet.secret_subkey);
|
|
for (var i = 0; i < keys.length; i++) {
|
|
var success = keys[i].decrypt(passphrase);
|
|
if (!success) return false;
|
|
}
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Decrypts specific key packets by key ID
|
|
* @param {Array<keyid>} keyIds
|
|
* @param {String} passphrase
|
|
* @return {Boolean} true if all key packets decrypted successfully
|
|
*/
|
|
Key.prototype.decryptKeyPacket = function(keyIds, passphrase) {
|
|
//TODO return value
|
|
var keys = this.packets.filterByTag(enums.packet.secret_key, enums.packet.secret_subkey);
|
|
for (var i = 0; i < keys.length; i++) {
|
|
var keyId = keys[i].getKeyId();
|
|
for (var j = 0; j < keyIds.length; j++) {
|
|
if (keyId.equals(keyIds[j])) {
|
|
var success = keys[i].decrypt(passphrase);
|
|
if (!success) return false;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
};
|
|
|
|
// TODO
|
|
Key.prototype.verify = function() {
|
|
|
|
};
|
|
// TODO
|
|
Key.prototype.revoke = function() {
|
|
|
|
};
|
|
|
|
/**
|
|
* Reads an OpenPGP armored text and returns a key object
|
|
* @param {String} armoredText text to be parsed
|
|
* @return {Key} new key object
|
|
*/
|
|
function readArmored(armoredText) {
|
|
var input = armor.decode(armoredText);
|
|
if (!(input.type == enums.armor.public_key || input.type == enums.armor.private_key)) {
|
|
throw new Error('Armored text not of type key');
|
|
}
|
|
var packetlist = new packet.list();
|
|
packetlist.read(input.data);
|
|
var newKey = new Key(packetlist);
|
|
return newKey;
|
|
}
|
|
|
|
/**
|
|
* Generates a new OpenPGP key. Currently only supports RSA keys.
|
|
* Primary and subkey will be of same type.
|
|
* @param {Integer} keyType to indicate what type of key to make.
|
|
* RSA is 1. See http://tools.ietf.org/html/rfc4880#section-9.1
|
|
* @param {Integer} numBits number of bits for the key creation.
|
|
* @param {String} userId assumes already in form of "User Name <username@email.com>"
|
|
* @param {String} passphrase The passphrase used to encrypt the resulting private key
|
|
* @return {Key}
|
|
*/
|
|
function generate(keyType, numBits, userId, passphrase) {
|
|
var packetlist = new packet.list();
|
|
|
|
var secretKeyPacket = new packet.secret_key();
|
|
secretKeyPacket.algorithm = enums.read(enums.publicKey, keyType);
|
|
secretKeyPacket.generate(numBits);
|
|
secretKeyPacket.encrypt(passphrase);
|
|
|
|
var userIdPacket = new packet.userid();
|
|
userIdPacket.read(userId);
|
|
|
|
var dataToSign = {};
|
|
dataToSign.userid = userIdPacket;
|
|
dataToSign.key = secretKeyPacket;
|
|
var signaturePacket = new packet.signature();
|
|
signaturePacket.signatureType = enums.signature.cert_generic;
|
|
signaturePacket.publicKeyAlgorithm = keyType;
|
|
//TODO we should load preferred hash from config, or as input to this function
|
|
signaturePacket.hashAlgorithm = enums.hash.sha256;
|
|
signaturePacket.keyFlags = [enums.keyFlags.certify_keys | enums.keyFlags.sign_data];
|
|
signaturePacket.sign(secretKeyPacket, dataToSign);
|
|
|
|
var secretSubkeyPacket = new packet.secret_subkey();
|
|
secretSubkeyPacket.algorithm = enums.read(enums.publicKey, keyType);
|
|
secretSubkeyPacket.generate(numBits);
|
|
secretSubkeyPacket.encrypt(passphrase);
|
|
|
|
dataToSign = {};
|
|
dataToSign.key = secretKeyPacket;
|
|
dataToSign.bind = secretSubkeyPacket;
|
|
var subkeySignaturePacket = new packet.signature();
|
|
subkeySignaturePacket.signatureType = enums.signature.subkey_binding;
|
|
subkeySignaturePacket.publicKeyAlgorithm = keyType;
|
|
//TODO we should load preferred hash from config, or as input to this function
|
|
subkeySignaturePacket.hashAlgorithm = enums.hash.sha256;
|
|
subkeySignaturePacket.keyFlags = [enums.keyFlags.encrypt_communication | enums.keyFlags.encrypt_storage];
|
|
subkeySignaturePacket.sign(secretKeyPacket, dataToSign);
|
|
|
|
packetlist.push(secretKeyPacket);
|
|
packetlist.push(userIdPacket);
|
|
packetlist.push(signaturePacket);
|
|
packetlist.push(secretSubkeyPacket);
|
|
packetlist.push(subkeySignaturePacket);
|
|
|
|
return new Key(packetlist);
|
|
}
|
|
|
|
exports.Key = Key;
|
|
exports.readArmored = readArmored;
|
|
exports.generate = generate;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cleartext.html">cleartext</a></li><li><a href="config.html">config/config</a></li><li><a href="config_localStorage.html">config/config_localStorage</a></li><li><a href="cfb.html">crypto/cfb</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="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="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-key.html">key</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="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="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="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="config-config.html">config</a></li><li><a href="module-key-Key.html">Key</a></li><li><a href="module-message-Message.html">Message</a></li><li><a href="util-Util.html">Util</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha2</a> on Sun Dec 22 2013 12:37:01 GMT-0800 (PST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|