js-sha1 - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+# v0.1.3 / 2015-01-07
+
+* Add bower package.
+* Fixed JSHint warnings.
+* Add travis.
+* Add coveralls.
+
 # v0.1.2 / 2014-07-27
@@ -2,0 +9,0 @@

LICENSE.txt

@@ -1,2 +0,2 @@
-Copyright 2014 [e-mail]
+Copyright 2014-2015 [e-mail]
 
@@ -3,0 +3,0 @@ Permission is hereby granted, free of charge, to any person obtaining

package.json

 {
   "name": "js-sha1",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A simple SHA1 hash function for JavaScript supports UTF-8 encoding.",
   "main": "src/sha1.js",
+  "devDependencies": {
+    "expect.js": "~0.3.1",
+    "jscoverage": "~0.5.9"
+  },
   "scripts": {
-    "test": "node tests/node-test.js"
+    "test": "mocha tests/node-test.js -r jscoverage",
+    "coveralls": "mocha tests/node-test.js -R mocha-lcov-reporter -r jscoverage | coveralls"
   },
@@ -9,0 +14,0 @@ "repository": {

README.md

 # js-sha1
+[![Build Status](https://api.travis-ci.org/emn178/js-sha1.png)](https://travis-ci.org/emn178/js-sha1)
+[![Build Status](https://coveralls.io/repos/emn178/js-sha1/badge.png?branch=master)](https://coveralls.io/r/emn178/js-sha1?branch=master)  
+[![NPM](https://nodei.co/npm/js-sha1.png?stars&downloads)](https://nodei.co/npm/js-sha1/)  
 A simple SHA1 hash function for JavaScript supports UTF-8 encoding.
 
-## Install
+## Demo
+[SHA1 Online](http://emn178.github.io/online-tools/sha1.html)
+
+## Download
+[Compress](https://raw.github.com/emn178/js-sha1/master/build/sha1.min.js)  
+[Uncompress](https://raw.github.com/emn178/js-sha1/master/src/sha1.js)
+
+## Installation
+You can also install js-sha1 by using Bower.
+
+    bower install js-sha1
+
 For node.js, you can use this command to install:
@@ -10,2 +24,6 @@
 ## Usage
+You could use like this:
+```JavaScript
+sha1('Message to hash');
+```
 If you use node.js, you should require the module first:
@@ -15,6 +33,17 @@ ```JavaScript
 ```
-And you could use like this:
-```JavaScript
-sha1('Message to hash');
-```
+
+### Methods
+
+#### sha1(str, asciiOnly)
+
+Hash string to sha1, set asciiOnly to true for better performace if you ensure input is ascii.
+
+##### *str: `String`*
+
+String to hash.
+
+##### *asciiOnly: `Boolean` (default: `false`)*
+
+Specify the string encoding is ASCII.
+
 ## Example
@@ -43,11 +72,2 @@ Code
 
-## Tests
-You can open `tests/index.html` in browser or use node.js to run test
-
-    node tests/node-test.js
-
-or
-
-    npm test
-
 ## Extensions
@@ -54,0 +74,0 @@ ### jQuery

src/sha1.js

 /*
- * js-sha1 v0.1.2
+ * js-sha1 v0.1.3
  * https://github.com/emn178/js-sha1
  *
- * Copyright 2014, [e-mail]
+ * Copyright 2014-2015, [e-mail]
  *
@@ -10,28 +10,26 @@ * Licensed under the MIT license:
  */
-
-(function(root, undefined){
+;(function(root, undefined){
   'use strict';
 
-  var HEX_CHARS = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'];
-  var HEX_TABLE = {
-    '0': 0, '1': 1, '2': 2, '3': 3, '4': 4, '5': 5, '6': 6, '7': 7, '8': 8, '9': 9,
-    'a': 10, 'b': 11, 'c': 12, 'd': 13, 'e': 14, 'f': 15,
-    'A': 10, 'B': 11, 'C': 12, 'D': 13, 'E': 14, 'F': 15
-  };
+  var HEX_CHARS = '0123456789abcdef'.split('');
 
-  var sha1 = function(message) {
-    var blocks = hasUTF8(message) ? UTF8toBlocks(message) : ASCIItoBlocks(message);
-    var h0 = 0x67452301;
-    var h1 = 0xEFCDAB89;
-    var h2 = 0x98BADCFE;
-    var h3 = 0x10325476;
-    var h4 = 0xC3D2E1F0;
+  var sha1 = function(message, asciiOnly) {
+    var blocks, h0, h1, h2, h3, h4;
+    if(!asciiOnly && /[^\x00-\x7F]/.test(message)) {
+      blocks = getBlocksFromUtf8(message);
+    } else {
+      blocks = getBlocksFromAscii(message);
+    }
+    h0 = 0x67452301;
+    h1 = 0xEFCDAB89;
+    h2 = 0x98BADCFE;
+    h3 = 0x10325476;
+    h4 = 0xC3D2E1F0;
 
-    for(var i = 0, length = blocks.length;i < length;i += 16)
-    {
-      var w = [];
-      for(var j = 0;j < 16;++j)
+    for(var i = 0, length = blocks.length;i < length;i += 16) {
+      var w = [], j;
+      for(j = 0;j < 16;++j) {
         w[j] = blocks[i + j];
-      for(var j = 16;j < 80;++j)
-      {
+      }
+      for(j = 16;j < 80;++j) {
         var x = w[j - 3] ^ w[j - 8] ^ w[j - 14] ^ w[j - 16];
@@ -46,6 +44,5 @@ w[j] = leftrotate(x, 1);
       var e = h4;
-      var f, k, tmp;
+      var f, tmp;
 
-      for(var j = 0;j < 20;++j)
-      {
+      for(j = 0;j < 20;++j) {
         f = (b & c) | ((~b) & d);
@@ -60,4 +57,3 @@ tmp = leftrotate(a, 5) + f + e + 0x5A827999 + w[j];
 
-      for(;j < 40;++j)
-      {
+      for(;j < 40;++j) {
         f = b ^ c ^ d;
@@ -73,4 +69,3 @@ tmp = leftrotate(a, 5) + f + e + 0x6ED9EBA1 + w[j];
       // k = 0x8F1BBCDC;
-      for(;j < 60;++j)
-      {
+      for(;j < 60;++j) {
         f = (b & c) | (b & d) | (c & d);
@@ -85,4 +80,3 @@ tmp = leftrotate(a, 5) + f + e + 0x8F1BBCDC + w[j];
 
-      for(;j < 80;++j)
-      {
+      for(;j < 80;++j) {
         f = b ^ c ^ d;
@@ -112,5 +106,4 @@ tmp = leftrotate(a, 5) + f + e + 0xCA62C1D6 + w[j];
   var toHexString = function(num) {
-    var hex = "";
-    for(var i = 0; i < 4; i++)
-    {
+    var hex = '';
+    for(var i = 0; i < 4; i++) {
       var offset = 3 - i << 3;
@@ -122,11 +115,27 @@ hex += HEX_CHARS[(num >> (offset + 4)) & 0x0F] + HEX_CHARS[(num >> offset) & 0x0F];
 
-  var hasUTF8 = function(message) {
-    var i = message.length;
-    while(i--)
-      if(message.charCodeAt(i) > 127)
-        return true;
-    return false;
+  var getBytesFromUtf8 = function(str) {
+    var bytes = [], index = 0;
+    for (var i = 0;i < str.length; i++) {
+      var c = str.charCodeAt(i);
+      if (c < 0x80) {
+        bytes[index++] = c;
+      } else if (c < 0x800) {
+        bytes[index++] = 0xc0 | (c >> 6);
+        bytes[index++] = 0x80 | (c & 0x3f);
+      } else if (c < 0xd800 || c >= 0xe000) {
+        bytes[index++] = 0xe0 | (c >> 12);
+        bytes[index++] = 0x80 | ((c >> 6) & 0x3f);
+        bytes[index++] = 0x80 | (c & 0x3f);
+      } else {
+        c = 0x10000 + (((c & 0x3ff) << 10) | (str.charCodeAt(++i) & 0x3ff));
+        bytes[index++] = 0xf0 | (c >> 18);
+        bytes[index++] = 0x80 | ((c >> 12) & 0x3f);
+        bytes[index++] = 0x80 | ((c >> 6) & 0x3f);
+        bytes[index++] = 0x80 | (c & 0x3f);
+      }
+    }
+    return bytes;
   };
 
-  var ASCIItoBlocks = function(message) {
+  var getBlocksFromAscii = function(message) {
     // a block is 32 bits(4 bytes), a chunk is 512 bits(64 bytes)
@@ -136,9 +145,10 @@ var length = message.length;
     var blockCount = chunkCount << 4; // chunkCount * 16
-    var blocks = [];
-    var i;
-    for(i = 0;i < blockCount;++i)
+    var blocks = [], i;
+    for(i = 0;i < blockCount;++i) {
       blocks[i] = 0;
-    for(i = 0;i < length;++i)
-      blocks[i >> 2] |= message.charCodeAt(i) << (3 - (i % 4) << 3);
-    blocks[i >> 2] |= 0x80 << (3 - (i % 4) << 3);
+    }
+    for(i = 0;i < length;++i) {
+      blocks[i >> 2] |= message.charCodeAt(i) << (3 - (i & 3) << 3);
+    }
+    blocks[i >> 2] |= 0x80 << (3 - (i & 3) << 3);
     blocks[blockCount - 1] = length << 3; // length * 8
@@ -148,28 +158,25 @@ return blocks;
 
-  var UTF8toBlocks = function(message) {
-    var uri = encodeURIComponent(message);
-    var blocks = [];
-    for(var i = 0, bytes = 0, length = uri.length;i < length;++i)
-    {
-      var c = uri.charCodeAt(i);
-      if(c == 37) // %
-        blocks[bytes >> 2] |= ((HEX_TABLE[uri.charAt(++i)] << 4) | HEX_TABLE[uri.charAt(++i)]) << (3 - (bytes % 4) << 3);
-      else
-        blocks[bytes >> 2] |= c << (3 - (bytes % 4) << 3);
-      ++bytes;
-    }
-    var chunkCount = ((bytes + 8) >> 6) + 1;
+  var getBlocksFromUtf8 = function(message) {
+    var bytes = getBytesFromUtf8(message);
+    var length = bytes.length;
+    var chunkCount = ((length + 8) >> 6) + 1;
     var blockCount = chunkCount << 4; // chunkCount * 16
-    var index = bytes >> 2;
-    blocks[index] |= 0x80 << (3 - (bytes % 4) << 3);
-    for(var i = index + 1;i < blockCount;++i)
+    var blocks = [], i;
+    for(i = 0;i < blockCount;++i) {
       blocks[i] = 0;
-    blocks[blockCount - 1] = bytes << 3; // bytes * 8
+    }
+    for(i = 0;i < length;++i) {
+      blocks[i >> 2] |= bytes[i] << (3 - (i & 3) << 3);
+    }
+    blocks[i >> 2] |= 0x80 << (3 - (i & 3) << 3);
+    blocks[blockCount - 1] = length << 3; // length * 8
     return blocks;
   };
 
-  if(typeof(module) != 'undefined')
+  if(typeof(module) != 'undefined') {
     module.exports = sha1;
-  else if(root)
+  }
+  else if(root) {
     root.sha1 = sha1;
+  }
 }(this));

tests/node-test.js

 sha1 = require('../src/sha1.js');
-require('./debug.js');
+expect = require('expect.js');
 require('./test.js');

tests/test.js

@@ -1,5 +0,30 @@
-assert('sha1 1', 'da39a3ee5e6b4b0d3255bfef95601890afd80709', sha1(''));
-assert('sha1 2', '2fd4e1c67a2d28fced849ee1bb76e7391b93eb12', sha1('The quick brown fox jumps over the lazy dog'));
-assert('sha1 3', '408d94384216f890ff7a0c3528e8bed1e0b01621', sha1('The quick brown fox jumps over the lazy dog.'));
-assert('sha1 4', '7be2d2d20c106eee0836c9bc2b939890a78e8fb3', sha1('中文'));
-assert('sha1 5', '9e4e5d978deced901d621475b03f1ded19e945bf', sha1('aécio'));
+describe('ascii', function() {
+  describe('less than 64 bytes', function() {
+    it('should be successful', function() {
+      expect(sha1('')).to.be('da39a3ee5e6b4b0d3255bfef95601890afd80709');
+      expect(sha1('The quick brown fox jumps over the lazy dog')).to.be('2fd4e1c67a2d28fced849ee1bb76e7391b93eb12');
+      expect(sha1('The quick brown fox jumps over the lazy dog.', true)).to.be('408d94384216f890ff7a0c3528e8bed1e0b01621');
+    });
+  });
+
+  describe('more than 64 bytes', function() {
+    it('should be successful', function() {
+      expect(sha1('The MD5 message-digest algorithm is a widely used cryptographic hash function producing a 128-bit (16-byte) hash value, typically expressed in text format as a 32 digit hexadecimal number. MD5 has been utilized in a wide variety of cryptographic applications, and is also commonly used to verify data integrity.')).to.be('8690faab7755408a03875895176fac318f14a699');
+    });
+  });
+});
+
+describe('UTF8', function() {
+  describe('less than 64 bytes', function() {
+    it('should be successful', function() {
+      expect(sha1('中文')).to.be('7be2d2d20c106eee0836c9bc2b939890a78e8fb3');
+      expect(sha1('aécio')).to.be('9e4e5d978deced901d621475b03f1ded19e945bf');
+    });
+  });
+
+  describe('more than 64 bytes', function() {
+    it('should be successful', function() {
+      expect(sha1('訊息摘要演算法第五版（英語：Message-Digest Algorithm 5，縮寫為MD5），是當前電腦領域用於確保資訊傳輸完整一致而廣泛使用的雜湊演算法之一（又譯雜湊演算法、摘要演算法等），主流程式語言普遍已有MD5的實作。')).to.be('3a15ad3ce9efdd4bf982eaaaecdeda36a887a3f9');
+    });
+  });
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13132

increased by29.16%

Number of package files

13

increased by30%

Lines of code

204

increased by16.57%

Number of lines in readme file

101

increased by24.69%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes