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.
225 lines
8.9 KiB
HTML
225 lines
8.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: type/s2k.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: type/s2k.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 type/s2k */
|
|
|
|
var enums = require('../enums.js'),
|
|
util = require('../util'),
|
|
crypto = require('../crypto');
|
|
|
|
/**
|
|
* @class
|
|
* @classdesc Implementation of the String-to-key specifier (RFC4880 3.7)
|
|
* String-to-key (S2K) specifiers are used to convert passphrase strings
|
|
into symmetric-key encryption/decryption keys. They are used in two
|
|
places, currently: to encrypt the secret part of private keys in the
|
|
private keyring, and to convert passphrases to encryption keys for
|
|
symmetrically encrypted messages.
|
|
*/
|
|
module.exports = function s2k() {
|
|
/** @type {openpgp.hash} */
|
|
this.algorithm = 'sha256';
|
|
/** @type {module:type/s2k} */
|
|
this.type = 'iterated';
|
|
this.c = 96;
|
|
/** Eight bytes of salt.
|
|
* @type {openpgp_byte_array}
|
|
*/
|
|
this.salt = crypto.random.getRandomBytes(8);
|
|
|
|
|
|
// Exponen bias, defined in RFC4880
|
|
var expbias = 6;
|
|
|
|
this.get_count = function() {
|
|
return (16 + (this.c & 15)) << ((this.c >> 4) + expbias);
|
|
}
|
|
|
|
/**
|
|
* Parsing function for a string-to-key specifier (RFC 4880 3.7).
|
|
* @param {String} input Payload of string-to-key specifier
|
|
* @return {Integer} Actual length of the object
|
|
*/
|
|
this.read = function(bytes) {
|
|
var i = 0;
|
|
this.type = enums.read(enums.s2k, bytes.charCodeAt(i++));
|
|
this.algorithm = enums.read(enums.hash, bytes.charCodeAt(i++));
|
|
|
|
switch (this.type) {
|
|
case 'simple':
|
|
break;
|
|
|
|
case 'salted':
|
|
this.salt = bytes.substr(i, 8);
|
|
i += 8;
|
|
break;
|
|
|
|
case 'iterated':
|
|
this.salt = bytes.substr(i, 8);
|
|
i += 8;
|
|
|
|
// Octet 10: count, a one-octet, coded value
|
|
this.c = bytes.charCodeAt(i++);
|
|
break;
|
|
|
|
case 'gnu':
|
|
if (bytes.substr(i, 3) == "GNU") {
|
|
i += 3; // GNU
|
|
var gnuExtType = 1000 + bytes.charCodeAt(i++);
|
|
if (gnuExtType == 1001) {
|
|
this.type = gnuExtType;
|
|
// GnuPG extension mode 1001 -- don't write secret key at all
|
|
} else {
|
|
throw new Error("Unknown s2k gnu protection mode.");
|
|
}
|
|
} else {
|
|
throw new Error("Unknown s2k type.");
|
|
}
|
|
break;
|
|
|
|
default:
|
|
throw new Error("Unknown s2k type.");
|
|
break;
|
|
}
|
|
|
|
return i;
|
|
}
|
|
|
|
|
|
/**
|
|
* writes an s2k hash based on the inputs.
|
|
* @return {String} Produced key of hashAlgorithm hash length
|
|
*/
|
|
this.write = function() {
|
|
var bytes = String.fromCharCode(enums.write(enums.s2k, this.type));
|
|
bytes += String.fromCharCode(enums.write(enums.hash, this.algorithm));
|
|
|
|
switch (this.type) {
|
|
case 'simple':
|
|
break;
|
|
case 'salted':
|
|
bytes += this.salt;
|
|
break;
|
|
case 'iterated':
|
|
bytes += this.salt;
|
|
bytes += String.fromCharCode(this.c);
|
|
break;
|
|
};
|
|
|
|
return bytes;
|
|
}
|
|
|
|
/**
|
|
* Produces a key using the specified passphrase and the defined
|
|
* hashAlgorithm
|
|
* @param {String} passphrase Passphrase containing user input
|
|
* @return {String} Produced key with a length corresponding to
|
|
* hashAlgorithm hash length
|
|
*/
|
|
this.produce_key = function(passphrase, numBytes) {
|
|
passphrase = util.encode_utf8(passphrase);
|
|
|
|
function round(prefix, s2k) {
|
|
var algorithm = enums.write(enums.hash, s2k.algorithm);
|
|
|
|
switch (s2k.type) {
|
|
case 'simple':
|
|
return crypto.hash.digest(algorithm, prefix + passphrase);
|
|
|
|
case 'salted':
|
|
return crypto.hash.digest(algorithm,
|
|
prefix + s2k.salt + passphrase);
|
|
|
|
case 'iterated':
|
|
var isp = [],
|
|
count = s2k.get_count();
|
|
data = s2k.salt + passphrase;
|
|
|
|
while (isp.length * data.length < count)
|
|
isp.push(data);
|
|
|
|
isp = isp.join('');
|
|
|
|
if (isp.length > count)
|
|
isp = isp.substr(0, count);
|
|
|
|
return crypto.hash.digest(algorithm, prefix + isp);
|
|
};
|
|
}
|
|
|
|
var result = '',
|
|
prefix = '';
|
|
|
|
while (result.length <= numBytes) {
|
|
result += round(prefix, this);
|
|
prefix += String.fromCharCode(0);
|
|
}
|
|
|
|
return result.substr(0, numBytes);
|
|
}
|
|
}
|
|
</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>
|