3680695a69
Rename resources to dist. Eliminate keyring bundle and expose keyring class in openpgp module. Add mochaTest grunt task to run node server-side tests. Add node_pack grunt task to create npm package into dist and install it for testing. Add node_store config property which specifies location of localStorage emulation when using node. Add repository info to package.json. Move util.js to src directory from util since it is the only file there. Rename class properties in openpgp to the new class names.
231 lines
11 KiB
HTML
231 lines
11 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
|
|
|
|
/**
|
|
* Implementation of the String-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC4880 3.7})<br/>
|
|
* <br/>
|
|
* 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.
|
|
* @requires crypto
|
|
* @requires enums
|
|
* @requires util
|
|
* @module type/s2k
|
|
*/
|
|
|
|
module.exports = S2K;
|
|
|
|
var enums = require('../enums.js'),
|
|
util = require('../util.js'),
|
|
crypto = require('../crypto');
|
|
|
|
/**
|
|
* @constructor
|
|
*/
|
|
function S2K() {
|
|
/** @type {module:enums.hash} */
|
|
this.algorithm = 'sha256';
|
|
/** @type {module:enums.s2k} */
|
|
this.type = 'iterated';
|
|
this.c = 96;
|
|
/** Eight bytes of salt in a binary string.
|
|
* @type {String}
|
|
*/
|
|
this.salt = crypto.random.getRandomBytes(8);
|
|
}
|
|
|
|
S2K.prototype.get_count = function () {
|
|
// Exponent bias, defined in RFC4880
|
|
var expbias = 6;
|
|
|
|
return (16 + (this.c & 15)) << ((this.c >> 4) + expbias);
|
|
};
|
|
|
|
/**
|
|
* Parsing function for a string-to-key specifier ({@link http://tools.ietf.org/html/rfc4880#section-3.7|RFC 4880 3.7}).
|
|
* @param {String} input Payload of string-to-key specifier
|
|
* @return {Integer} Actual length of the object
|
|
*/
|
|
S2K.prototype.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.");
|
|
}
|
|
|
|
return i;
|
|
};
|
|
|
|
|
|
/**
|
|
* writes an s2k hash based on the inputs.
|
|
* @return {String} Produced key of hashAlgorithm hash length
|
|
*/
|
|
S2K.prototype.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
|
|
*/
|
|
S2K.prototype.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="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-keyring.html">keyring</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="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="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></ul><h3>Classes</h3><ul><li><a href="JXG.Util.html">JXG.Util</a></li><li><a href="module-cleartext-CleartextMessage.html">cleartext~CleartextMessage</a></li><li><a href="localStorage-LocalStorage.html">config/localStorage~LocalStorage</a></li><li><a href="keyring-Keyring.html">keyring/keyring~Keyring</a></li><li><a href="module-key-Key.html">key~Key</a></li><li><a href="module-key-SubKey.html">key~SubKey</a></li><li><a href="module-key-User.html">key~User</a></li><li><a href="module-message-Message.html">message~Message</a></li><li><a href="compressed-Compressed.html">packet/compressed~Compressed</a></li><li><a href="literal-Literal.html">packet/literal~Literal</a></li><li><a href="marker-Marker.html">packet/marker~Marker</a></li><li><a href="one_pass_signature-OnePassSignature.html">packet/one_pass_signature~OnePassSignature</a></li><li><a href="packetlist-Packetlist.html">packet/packetlist~Packetlist</a></li><li><a href="public_key_encrypted_session_key-PublicKeyEncryptedSessionKey.html">packet/public_key_encrypted_session_key~PublicKeyEncryptedSessionKey</a></li><li><a href="public_key-PublicKey.html">packet/public_key~PublicKey</a></li><li><a href="public_subkey-PublicSubkey.html">packet/public_subkey~PublicSubkey</a></li><li><a href="secret_key-SecretKey.html">packet/secret_key~SecretKey</a></li><li><a href="secret_subkey-SecretSubkey.html">packet/secret_subkey~SecretSubkey</a></li><li><a href="signature-Signature.html">packet/signature~Signature</a></li><li><a href="sym_encrypted_integrity_protected-SymEncryptedIntegrityProtected.html">packet/sym_encrypted_integrity_protected~SymEncryptedIntegrityProtected</a></li><li><a href="sym_encrypted_session_key-SymEncryptedSessionKey.html">packet/sym_encrypted_session_key~SymEncryptedSessionKey</a></li><li><a href="symmetrically_encrypted-SymmetricallyEncrypted.html">packet/symmetrically_encrypted~SymmetricallyEncrypted</a></li><li><a href="trust-Trust.html">packet/trust~Trust</a></li><li><a href="user_attribute-UserAttribute.html">packet/user_attribute~UserAttribute</a></li><li><a href="userid-Userid.html">packet/userid~Userid</a></li><li><a href="keyid-Keyid.html">type/keyid~Keyid</a></li><li><a href="mpi-MPI.html">type/mpi~MPI</a></li><li><a href="s2k-S2K.html">type/s2k~S2K</a></li></ul>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Jan 09 2014 02:24:28 GMT-0800 (PST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|