/*! * ec.js - ecdsa wrapper for secp256k1 and elliptic * Copyright (c) 2014-2015, Fedor Indutny (MIT License) * Copyright (c) 2014-2016, Christopher Jeffrey (MIT License). * https://github.com/bcoin-org/bcoin */ 'use strict'; var elliptic = require('elliptic'); var bn = require('bn.js'); var utils = require('./utils'); var assert = utils.assert; var crypto, secp256k1; if (!utils.isBrowser) crypto = require('cry' + 'pto'); try { if (+process.env.BCOIN_USE_ELLIPTIC !== 1) secp256k1 = require('secp' + '256k1'); } catch (e) { ; } /** * @exports ec */ var ec = exports; /** * elliptic.js secp256k1 curve. * @type {Object} */ ec.elliptic = elliptic.ec('secp256k1'); /** * elliptic.js signature constructor. * @static * @type {Function} */ ec.signature = require('elliptic/lib/elliptic/ec/signature'); /** * elliptic.js keypair constructor. * @static * @type {Function} */ ec.keypair = require('elliptic/lib/elliptic/ec/key'); /** * A reference to the secp256k1 curve. * @const {Object} */ ec.curve = ec.elliptic.curve; /** * Generate a private key. * @returns {Buffer} Private key. */ ec.generatePrivateKey = function generatePrivateKey() { var key, priv; if (secp256k1 && crypto) { do { priv = crypto.randomBytes(32); } while (!secp256k1.privateKeyVerify(priv)); } else { key = ec.elliptic.genKeyPair(); priv = key.getPrivate().toArrayLike(Buffer, 'be', 32); } return priv; }; /** * Create a public key from a private key. * @param {Buffer} priv * @param {Boolean?} compressed * @returns {Buffer} */ ec.publicKeyCreate = function publicKeyCreate(priv, compressed) { assert(Buffer.isBuffer(priv)); if (secp256k1) return secp256k1.publicKeyCreate(priv, compressed); priv = ec.elliptic.keyPair({ priv: priv }); priv = priv.getPublic(compressed !== false, 'array'); return new Buffer(priv); }; /** * Compress or decompress public key. * @param {Buffer} pub * @returns {Buffer} */ ec.publicKeyConvert = function publicKeyConvert(key, compressed) { var point; if (secp256k1) return secp256k1.publicKeyConvert(key, compressed); point = ec.elliptic.curve.decodePoint(key); return new Buffer(point.encode('array', compressed !== false)); }; /** * ((tweak + key) % n) * @param {Buffer} privateKey * @param {Buffer} tweak * @returns {Buffer} privateKey */ ec.privateKeyTweakAdd = function privateKeyTweakAdd(privateKey, tweak) { var key; if (secp256k1) return secp256k1.privateKeyTweakAdd(privateKey, tweak); key = new bn(tweak) .add(new bn(privateKey)) .mod(ec.curve.n) .toArrayLike(Buffer, 'be', 32); // Only a 1 in 2^127 chance of happening. if (!ec.privateKeyVerify(key)) throw new Error('Private key is invalid.'); return key; }; /** * ((g * tweak) + key) * @param {Buffer} publicKey * @param {Buffer} tweak * @returns {Buffer} publicKey */ ec.publicKeyTweakAdd = function publicKeyTweakAdd(publicKey, tweak, compressed) { var point, key; if (secp256k1) return secp256k1.publicKeyTweakAdd(publicKey, tweak, compressed); point = ec.curve.decodePoint(publicKey); point = ec.curve.g.mul(new bn(tweak)).add(point); key = new Buffer(point.encode('array', compressed !== false)); if (!ec.publicKeyVerify(key)) throw new Error('Public key is invalid.'); return key; }; /** * Create an ecdh. * @param {Buffer} pub * @param {Buffer} priv * @returns {Buffer} */ ec.ecdh = function ecdh(pub, priv) { if (secp256k1) return secp256k1.ecdh(pub, priv); priv = ec.elliptic.keyPair({ priv: priv }); pub = ec.elliptic.keyPair({ pub: pub }); return priv.derive(pub.getPublic()).toArrayLike(Buffer, 'be', 32); }; /** * Recover a public key. * @param {Buffer} msg * @param {Buffer} sig * @param {Number?} j * @param {Boolean?} compressed * @returns {Buffer[]|Buffer|null} */ ec.recover = function recover(msg, sig, j, compressed) { var keys = []; var i, point, key; if (typeof j === 'boolean') { compressed = j; j = null; } if (secp256k1) { try { sig = secp256k1.signatureImport(sig); } catch (e) { ; } } for (i = 0; i <= 3; i++) { if (j != null && j !== i) continue; if (secp256k1) { try { key = secp256k1.recover(msg, sig, i, compressed); } catch (e) { continue; } keys.push(key); continue; } try { point = ec.elliptic.recoverPubKey(msg, sig, i); } catch (e) { continue; } key = ec.elliptic.keyPair({ pub: point }); key = key.getPublic(compressed !== false, 'array'); keys.push(new Buffer(key)); } if (j != null) return keys[0]; return keys; }; /** * Generate some random bytes. * @param {Number} size * @returns {Buffer} */ ec.random = function random(size) { if (crypto) return crypto.randomBytes(size); return new Buffer(elliptic.rand(size)); }; /** * Generate a random number within a range. * Probably more cryptographically sound than * `Math.random()`. * @param {Number} min - Inclusive. * @param {Number} max - Exclusive. * @returns {Number} */ ec.rand = function rand(min, max) { var num = ec.random(4).readUInt32LE(0, true); return Math.floor((num / 0x100000000) * (max - min) + min); }; /** * Verify a signature. * @param {Buffer} msg * @param {Buffer} sig - DER formatted. * @param {Buffer} key * @param {Boolean?} - Whether this should be treated as a * "historical" signature. This allows signatures to be of * odd lengths. * @param {Boolean?} high - Allow high S value. * @returns {Boolean} */ ec.verify = function verify(msg, sig, key, historical, high) { var result; if (key.getPublicKey) key = key.getPublicKey(); assert(Buffer.isBuffer(msg)); assert(Buffer.isBuffer(sig)); assert(Buffer.isBuffer(key)); if (sig.length === 0) return false; if (key.length === 0) return false; // Attempt to normalize the signature // length before passing to elliptic. // Note: We only do this for historical data! // https://github.com/indutny/elliptic/issues/78 if (historical) sig = ec.normalizeLength(sig); if (secp256k1) { // secp256k1 fails on high s values. This is // bad for verifying historical data. if (high) sig = ec.toLowS(sig); try { // Import from DER. sig = secp256k1.signatureImport(sig); result = secp256k1.verify(msg, sig, key); } catch (e) { result = false; } return result; } // Make elliptic mimic secp256k1's // failure with high S values. if (!high && !ec.isLowS(sig)) return false; try { result = ec.elliptic.verify(msg, sig, key); } catch (e) { result = false; } return result; }; /** * Validate a public key. * @param {Buffer} key * @returns {Boolean} True if buffer is a valid public key. */ ec.publicKeyVerify = function publicKeyVerify(key) { var result; if (secp256k1) return secp256k1.publicKeyVerify(key); try { result = ec.elliptic.keyPair({ pub: key }).validate(); } catch (e) { result = false; } return result; }; /** * Validate a private key. * @param {Buffer} key * @returns {Boolean} True if buffer is a valid private key. */ ec.privateKeyVerify = function privateKeyVerify(key) { if (secp256k1) return secp256k1.privateKeyVerify(key); key = new bn(key); return key.cmpn(0) !== 0 && key.cmp(ec.elliptic.curve.n) < 0; }; /** * Sign a message. * @param {Buffer} msg * @param {Buffer} key - Private key. * @returns {Buffer} DER-formatted signature. */ ec.sign = function sign(msg, key) { var sig; if (key.getPrivateKey) key = key.getPrivateKey(); if (secp256k1) { // Sign message sig = secp256k1.sign(msg, key); // Ensure low S value sig = secp256k1.signatureNormalize(sig.signature); // Convert to DER array sig = secp256k1.signatureExport(sig); } else { // Sign message and ensure low S value sig = ec.elliptic.sign(msg, key, { canonical: true }); // Convert to DER array sig = new Buffer(sig.toDER()); } return sig; }; /** * Normalize the length of a signature * (only done for historical data). * @param {Buffer} sig - DER formatted signature. * @returns {Buffer} Signature. */ ec.normalizeLength = function normalizeLength(sig) { var data = sig; var p = { place: 0 }; var len, rlen, slen; if (data[p.place++] !== 0x30) return sig; len = getLength(data, p); if (data.length > len + p.place) data = data.slice(0, len + p.place); if (data[p.place++] !== 0x02) return sig; rlen = getLength(data, p); p.place += rlen; if (data[p.place++] !== 0x02) return sig; slen = getLength(data, p); if (data.length > slen + p.place) data = data.slice(0, slen + p.place); return data; }; /** * Test whether a signature has a low S value. * @param {Buffer} sig * @returns {Boolean} */ ec.isLowS = function isLowS(sig) { if (Buffer.isBuffer(sig)) { try { sig = new ec.signature(sig); } catch (e) { return false; } } // If S is greater than half the order, // it's too high. if (sig.s.cmp(ec.elliptic.nh) > 0) return false; return true; }; /** * Lower the S value of a signature (used * for verifying historical data). * @param {Buffer} sig - DER formatted. * @returns {Buffer} */ ec.toLowS = function toLowS(sig) { if (Buffer.isBuffer(sig)) { try { sig = new ec.signature(sig); } catch (e) { return sig; } } // If S is greater than half the order, // it's too high. if (sig.s.cmp(ec.elliptic.nh) > 0) sig.s = ec.elliptic.n.sub(sig.s); return new Buffer(sig.toDER()); }; /* * Helpers */ function getLength(buf, p) { var initial = buf[p.place++]; var octetLen, val, i, off; if (!(initial & 0x80)) return initial; octetLen = initial & 0xf; val = 0; for (i = 0, off = p.place; i < octetLen; i++, off++) { val <<= 8; val |= buf[off]; } p.place = off; return val; }