diff --git a/.travis.yml b/.travis.yml index 7fda1a1..1c0bada 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,13 +1,18 @@ sudo: false +os: + - linux language: node_js -before_install: - - "npm install npm -g" node_js: - "0.10" + - "0.11" - "0.12" - - "4.0.0" + - "4" + - "5" env: - - TEST_SUITE=standard - - TEST_SUITE=unit -script: "npm run-script $TEST_SUITE" - + matrix: + - TEST_SUITE=unit +matrix: + include: + - node_js: "4" + env: TEST_SUITE=lint +script: npm run $TEST_SUITE diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ac5fda --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# create-hash + +[![NPM Package](https://img.shields.io/npm/v/create-hash.svg?style=flat-square)](https://www.npmjs.org/package/create-hash) +[![Build Status](https://img.shields.io/travis/crypto-browserify/createHash.svg?branch=master&style=flat-square)](https://travis-ci.org/crypto-browserify/createHash) +[![Dependency status](https://img.shields.io/david/crypto-browserify/createHash.svg?style=flat-square)](https://david-dm.org/crypto-browserify/createHash#info=dependencies) + +[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) + +Node style [crypto.createHash](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm) on pure JavaScript. + +```js +var createHash = require('create-hash') +var hash = createHash('sha224') +hash.update('synchronous write') // optional encoding parameter +hash.digest() // synchronously get result with optional encoding parameter + +hash.write('write to it as a stream') +hash.end() // remember it's a stream +hash.read() // only if you ended it as a stream though +``` + +To get the JavaScript version even in node do `require('create-hash/browser')` + +## License + +MIT diff --git a/browser.js b/browser.js index 1642270..cc29d2c 100644 --- a/browser.js +++ b/browser.js @@ -1,52 +1,17 @@ 'use strict' -var inherits = require('inherits') -var md5 = require('./md5') -var rmd160 = require('ripemd160') -var sha = require('sha.js') - -var Base = require('cipher-base') - -function HashNoConstructor (hash) { - Base.call(this, 'digest') - - this._hash = hash - this.buffers = [] -} - -inherits(HashNoConstructor, Base) - -HashNoConstructor.prototype._update = function (data) { - this.buffers.push(data) -} - -HashNoConstructor.prototype._final = function () { - var buf = Buffer.concat(this.buffers) - var r = this._hash(buf) - this.buffers = null - - return r -} - -function Hash (hash) { - Base.call(this, 'digest') - - this._hash = hash -} - -inherits(Hash, Base) - -Hash.prototype._update = function (data) { - this._hash.update(data) -} - -Hash.prototype._final = function () { - return this._hash.digest() -} +var MD5 = require('md5.js') +var RIPEMD160 = require('ripemd160') +var shajs = require('sha.js') module.exports = function createHash (alg) { - alg = alg.toLowerCase() - if (alg === 'md5') return new HashNoConstructor(md5) - if (alg === 'rmd160' || alg === 'ripemd160') return new HashNoConstructor(rmd160) - - return new Hash(sha(alg)) + alg = alg.toUpperCase() + switch (alg) { + case 'MD5': + return new MD5() + case 'RIPEMD160': + case 'RMD160': + return new RIPEMD160() + default: + return shajs(alg) + } } diff --git a/make-hash.js b/make-hash.js deleted file mode 100644 index c9f7862..0000000 --- a/make-hash.js +++ /dev/null @@ -1,30 +0,0 @@ -'use strict' -var intSize = 4 -var zeroBuffer = new Buffer(intSize) -zeroBuffer.fill(0) - -var charSize = 8 -var hashSize = 16 - -function toArray (buf) { - if ((buf.length % intSize) !== 0) { - var len = buf.length + (intSize - (buf.length % intSize)) - buf = Buffer.concat([buf, zeroBuffer], len) - } - - var arr = new Array(buf.length >>> 2) - for (var i = 0, j = 0; i < buf.length; i += intSize, j++) { - arr[j] = buf.readInt32LE(i) - } - - return arr -} - -module.exports = function hash (buf, fn) { - var arr = fn(toArray(buf), buf.length * charSize) - buf = new Buffer(hashSize) - for (var i = 0; i < arr.length; i++) { - buf.writeInt32LE(arr[i], i << 2, true) - } - return buf -} diff --git a/md5.js b/md5.js deleted file mode 100644 index 55b5a94..0000000 --- a/md5.js +++ /dev/null @@ -1,151 +0,0 @@ -'use strict' -/* - * A JavaScript implementation of the RSA Data Security, Inc. MD5 Message - * Digest Algorithm, as defined in RFC 1321. - * Version 2.1 Copyright (C) Paul Johnston 1999 - 2002. - * Other contributors: Greg Holt, Andrew Kepert, Ydnar, Lostinet - * Distributed under the BSD License - * See http://pajhome.org.uk/crypt/md5 for more info. - */ - -var makeHash = require('./make-hash') - -/* - * Calculate the MD5 of an array of little-endian words, and a bit length - */ -function core_md5 (x, len) { - /* append padding */ - x[len >> 5] |= 0x80 << ((len) % 32) - x[(((len + 64) >>> 9) << 4) + 14] = len - - var a = 1732584193 - var b = -271733879 - var c = -1732584194 - var d = 271733878 - - for (var i = 0; i < x.length; i += 16) { - var olda = a - var oldb = b - var oldc = c - var oldd = d - - a = md5_ff(a, b, c, d, x[i + 0], 7, -680876936) - d = md5_ff(d, a, b, c, x[i + 1], 12, -389564586) - c = md5_ff(c, d, a, b, x[i + 2], 17, 606105819) - b = md5_ff(b, c, d, a, x[i + 3], 22, -1044525330) - a = md5_ff(a, b, c, d, x[i + 4], 7, -176418897) - d = md5_ff(d, a, b, c, x[i + 5], 12, 1200080426) - c = md5_ff(c, d, a, b, x[i + 6], 17, -1473231341) - b = md5_ff(b, c, d, a, x[i + 7], 22, -45705983) - a = md5_ff(a, b, c, d, x[i + 8], 7, 1770035416) - d = md5_ff(d, a, b, c, x[i + 9], 12, -1958414417) - c = md5_ff(c, d, a, b, x[i + 10], 17, -42063) - b = md5_ff(b, c, d, a, x[i + 11], 22, -1990404162) - a = md5_ff(a, b, c, d, x[i + 12], 7, 1804603682) - d = md5_ff(d, a, b, c, x[i + 13], 12, -40341101) - c = md5_ff(c, d, a, b, x[i + 14], 17, -1502002290) - b = md5_ff(b, c, d, a, x[i + 15], 22, 1236535329) - - a = md5_gg(a, b, c, d, x[i + 1], 5, -165796510) - d = md5_gg(d, a, b, c, x[i + 6], 9, -1069501632) - c = md5_gg(c, d, a, b, x[i + 11], 14, 643717713) - b = md5_gg(b, c, d, a, x[i + 0], 20, -373897302) - a = md5_gg(a, b, c, d, x[i + 5], 5, -701558691) - d = md5_gg(d, a, b, c, x[i + 10], 9, 38016083) - c = md5_gg(c, d, a, b, x[i + 15], 14, -660478335) - b = md5_gg(b, c, d, a, x[i + 4], 20, -405537848) - a = md5_gg(a, b, c, d, x[i + 9], 5, 568446438) - d = md5_gg(d, a, b, c, x[i + 14], 9, -1019803690) - c = md5_gg(c, d, a, b, x[i + 3], 14, -187363961) - b = md5_gg(b, c, d, a, x[i + 8], 20, 1163531501) - a = md5_gg(a, b, c, d, x[i + 13], 5, -1444681467) - d = md5_gg(d, a, b, c, x[i + 2], 9, -51403784) - c = md5_gg(c, d, a, b, x[i + 7], 14, 1735328473) - b = md5_gg(b, c, d, a, x[i + 12], 20, -1926607734) - - a = md5_hh(a, b, c, d, x[i + 5], 4, -378558) - d = md5_hh(d, a, b, c, x[i + 8], 11, -2022574463) - c = md5_hh(c, d, a, b, x[i + 11], 16, 1839030562) - b = md5_hh(b, c, d, a, x[i + 14], 23, -35309556) - a = md5_hh(a, b, c, d, x[i + 1], 4, -1530992060) - d = md5_hh(d, a, b, c, x[i + 4], 11, 1272893353) - c = md5_hh(c, d, a, b, x[i + 7], 16, -155497632) - b = md5_hh(b, c, d, a, x[i + 10], 23, -1094730640) - a = md5_hh(a, b, c, d, x[i + 13], 4, 681279174) - d = md5_hh(d, a, b, c, x[i + 0], 11, -358537222) - c = md5_hh(c, d, a, b, x[i + 3], 16, -722521979) - b = md5_hh(b, c, d, a, x[i + 6], 23, 76029189) - a = md5_hh(a, b, c, d, x[i + 9], 4, -640364487) - d = md5_hh(d, a, b, c, x[i + 12], 11, -421815835) - c = md5_hh(c, d, a, b, x[i + 15], 16, 530742520) - b = md5_hh(b, c, d, a, x[i + 2], 23, -995338651) - - a = md5_ii(a, b, c, d, x[i + 0], 6, -198630844) - d = md5_ii(d, a, b, c, x[i + 7], 10, 1126891415) - c = md5_ii(c, d, a, b, x[i + 14], 15, -1416354905) - b = md5_ii(b, c, d, a, x[i + 5], 21, -57434055) - a = md5_ii(a, b, c, d, x[i + 12], 6, 1700485571) - d = md5_ii(d, a, b, c, x[i + 3], 10, -1894986606) - c = md5_ii(c, d, a, b, x[i + 10], 15, -1051523) - b = md5_ii(b, c, d, a, x[i + 1], 21, -2054922799) - a = md5_ii(a, b, c, d, x[i + 8], 6, 1873313359) - d = md5_ii(d, a, b, c, x[i + 15], 10, -30611744) - c = md5_ii(c, d, a, b, x[i + 6], 15, -1560198380) - b = md5_ii(b, c, d, a, x[i + 13], 21, 1309151649) - a = md5_ii(a, b, c, d, x[i + 4], 6, -145523070) - d = md5_ii(d, a, b, c, x[i + 11], 10, -1120210379) - c = md5_ii(c, d, a, b, x[i + 2], 15, 718787259) - b = md5_ii(b, c, d, a, x[i + 9], 21, -343485551) - - a = safe_add(a, olda) - b = safe_add(b, oldb) - c = safe_add(c, oldc) - d = safe_add(d, oldd) - } - - return [a, b, c, d] -} - -/* - * These functions implement the four basic operations the algorithm uses. - */ -function md5_cmn (q, a, b, x, s, t) { - return safe_add(bit_rol(safe_add(safe_add(a, q), safe_add(x, t)), s), b) -} - -function md5_ff (a, b, c, d, x, s, t) { - return md5_cmn((b & c) | ((~b) & d), a, b, x, s, t) -} - -function md5_gg (a, b, c, d, x, s, t) { - return md5_cmn((b & d) | (c & (~d)), a, b, x, s, t) -} - -function md5_hh (a, b, c, d, x, s, t) { - return md5_cmn(b ^ c ^ d, a, b, x, s, t) -} - -function md5_ii (a, b, c, d, x, s, t) { - return md5_cmn(c ^ (b | (~d)), a, b, x, s, t) -} - -/* - * Add integers, wrapping at 2^32. This uses 16-bit operations internally - * to work around bugs in some JS interpreters. - */ -function safe_add (x, y) { - var lsw = (x & 0xFFFF) + (y & 0xFFFF) - var msw = (x >> 16) + (y >> 16) + (lsw >> 16) - return (msw << 16) | (lsw & 0xFFFF) -} - -/* - * Bitwise rotate a 32-bit number to the left. - */ -function bit_rol (num, cnt) { - return (num << cnt) | (num >>> (32 - cnt)) -} - -module.exports = function md5 (buf) { - return makeHash(buf, core_md5) -} diff --git a/package.json b/package.json index 7ba2de7..f836b88 100644 --- a/package.json +++ b/package.json @@ -2,36 +2,47 @@ "name": "create-hash", "version": "1.1.2", "description": "create hashes for browserify", - "browser": "browser.js", - "main": "index.js", - "scripts": { - "standard": "standard", - "test": "npm run-script standard && npm run-script unit", - "unit": "node test.js | tspec" - }, - "repository": { - "type": "git", - "url": "git@github.com:crypto-browserify/createHash.git" - }, "keywords": [ - "crypto" + "crypto", + "hash", + "md5", + "ripemd160", + "rpm160", + "sha", + "sha1", + "sha224", + "sha256", + "sha384", + "sha512" ], - "author": "", - "license": "MIT", + "homepage": "https://github.com/crypto-browserify/createHash", "bugs": { "url": "https://github.com/crypto-browserify/createHash/issues" }, - "homepage": "https://github.com/crypto-browserify/createHash", + "license": "MIT", + "files": [ + "browser.js", + "index.js" + ], + "main": "index.js", + "repository": { + "type": "git", + "url": "https://github.com/crypto-browserify/createHash.git" + }, + "scripts": { + "lint": "standard", + "test": "npm run lint && npm run unit", + "unit": "tape test/*.js" + }, + "dependencies": { + "md5.js": "^1.3.4", + "ripemd160": "^2.0.0", + "sha.js": "^3.0.0" + }, "devDependencies": { "hash-test-vectors": "^1.3.2", - "standard": "^5.3.1", - "tap-spec": "^2.1.2", - "tape": "^3.0.3" + "standard": "^6.0.8", + "tape": "^4.5.1" }, - "dependencies": { - "cipher-base": "^1.0.1", - "inherits": "^2.0.1", - "ripemd160": "^1.0.0", - "sha.js": "^2.4.0" - } + "browser": "browser.js" } diff --git a/readme.md b/readme.md deleted file mode 100644 index a4a6815..0000000 --- a/readme.md +++ /dev/null @@ -1,19 +0,0 @@ -create-hash -=== - -[![Build Status](https://travis-ci.org/crypto-browserify/createHash.svg)](https://travis-ci.org/crypto-browserify/createHash) - -Node style hashes for use in the browser, with native hash functions in node. Api is the same as hashes in node: - -```js -var createHash = require('create-hash'); -var hash = createHash('sha224'); -hash.update('synchronous write'); //optional encoding parameter -hash.digest();// synchronously get result with optional encoding parameter - -hash.write('write to it as a stream'); -hash.end();//remember it's a stream -hash.read();//only if you ended it as a stream though -``` - -To get the JavaScript version even in node do `require('create-hash/browser');` \ No newline at end of file diff --git a/test.js b/test.js deleted file mode 100644 index 3928d66..0000000 --- a/test.js +++ /dev/null @@ -1,40 +0,0 @@ -var test = require('tape') - -var algorithms = ['sha1', 'sha224', 'sha256', 'sha384', 'sha512', 'md5', 'rmd160', 'ripemd160'] -var encodings = ['hex', 'base64'] // ignore binary -var vectors = require('hash-test-vectors') -vectors.forEach(function (vector) { - vector.ripemd160 = vector.rmd160 -}) -var createHash = require('./browser') - -algorithms.forEach(function (algorithm) { - test('test ' + algorithm + ' against test vectors', function (t) { - vectors.forEach(function (obj, i) { - var input = new Buffer(obj.input, 'base64') - var node = obj[algorithm] - var js = createHash(algorithm).update(input).digest('hex') - t.equal(js, node, algorithm + '(testVector[' + i + ']) == ' + node) - }) - - encodings.forEach(function (encoding) { - vectors.forEach(function (obj, i) { - var input = new Buffer(obj.input, 'base64').toString(encoding) - var node = obj[algorithm] - var js = createHash(algorithm).update(input, encoding).digest('hex') - t.equal(js, node, algorithm + '(testVector[' + i + '], ' + encoding + ') == ' + node) - }) - }) - - vectors.forEach(function (obj, i) { - var input = new Buffer(obj.input, 'base64') - var node = obj[algorithm] - var hash = createHash(algorithm) - hash.end(input) - var js = hash.read().toString('hex') - t.equal(js, node, algorithm + '(testVector[' + i + ']) == ' + node) - }) - - t.end() - }) -}) diff --git a/test/index.js b/test/index.js new file mode 100644 index 0000000..cdc9c1e --- /dev/null +++ b/test/index.js @@ -0,0 +1,30 @@ +'use strict' +var test = require('tape').test +var vectors = require('hash-test-vectors') + +var algorithms = ['sha1', 'sha224', 'sha256', 'sha384', 'sha512', 'md5', 'rmd160', 'ripemd160'] + +function runTests (name, createHash) { + vectors.forEach(function (vector, index) { + var input = new Buffer(vector.input, 'base64') + + algorithms.forEach(function (alg) { + var desc = name + ': ' + alg + ' NIST vector #' + (index + 1) + + test(desc + ' with .update', function (t) { + t.same(createHash(alg).update(input).digest('hex'), vector[alg]) + t.end() + }) + + test(desc + ' with streams', function (t) { + var hash = createHash(alg) + hash.end(input) + t.same(hash.read().toString('hex'), vector[alg]) + t.end() + }) + }) + }) +} + +runTests('node', require('../index')) +runTests('pure js', require('../browser'))