sha256.js 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  2. /* SHA-256 (FIPS 180-4) implementation in JavaScript (c) Chris Veness 2002-2016 */
  3. /* MIT Licence */
  4. /* www.movable-type.co.uk/scripts/sha256.html */
  5. /* */
  6. /* - see http://csrc.nist.gov/groups/ST/toolkit/secure_hashing.html */
  7. /* http://csrc.nist.gov/groups/ST/toolkit/examples.html */
  8. /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  9. 'use strict';
  10. /**
  11. * SHA-256 hash function reference implementation.
  12. *
  13. * This is a direct implementation of FIPS 180-4, without any optimisations. It is intended to aid
  14. * understanding of the algorithm rather than for production use, though it could be used where
  15. * performance is not critical.
  16. *
  17. * @namespace
  18. */
  19. let Sha256 = {};
  20. /**
  21. * Generates SHA-256 hash of string.
  22. *
  23. * @param {string} msg - (Unicode) string to be hashed.
  24. * @param {Object} [options]
  25. * @param {string} [options.msgFormat=string] - Message format: 'string' for JavaScript string
  26. * (gets converted to UTF-8 for hashing); 'hex-bytes' for string of hex bytes ('616263' ≡ 'abc') .
  27. * @param {string} [options.outFormat=hex] - Output format: 'hex' for string of contiguous
  28. * hex bytes; 'hex-w' for grouping hex bytes into groups of (4 byte / 8 character) words.
  29. * @returns {string} Hash of msg as hex character string.
  30. */
  31. Sha256.hash = function(msg, options) {
  32. let defaults = { msgFormat: 'string', outFormat: 'hex' };
  33. let opt = Object.assign(defaults, options);
  34. // note use throughout this routine of 'n >>> 0' to coerce Number 'n' to unsigned 32-bit integer
  35. switch (opt.msgFormat) {
  36. default: // default is to convert string to UTF-8, as SHA only deals with byte-streams
  37. case 'string': msg = Sha256.utf8Encode(msg); break;
  38. case 'hex-bytes':msg = Sha256.hexBytesToString(msg); break; // mostly for running tests
  39. }
  40. // constants [§4.2.2]
  41. let K = [
  42. 0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
  43. 0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
  44. 0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
  45. 0x983e5152, 0xa831c66d, 0xb00327c8, 0xbf597fc7, 0xc6e00bf3, 0xd5a79147, 0x06ca6351, 0x14292967,
  46. 0x27b70a85, 0x2e1b2138, 0x4d2c6dfc, 0x53380d13, 0x650a7354, 0x766a0abb, 0x81c2c92e, 0x92722c85,
  47. 0xa2bfe8a1, 0xa81a664b, 0xc24b8b70, 0xc76c51a3, 0xd192e819, 0xd6990624, 0xf40e3585, 0x106aa070,
  48. 0x19a4c116, 0x1e376c08, 0x2748774c, 0x34b0bcb5, 0x391c0cb3, 0x4ed8aa4a, 0x5b9cca4f, 0x682e6ff3,
  49. 0x748f82ee, 0x78a5636f, 0x84c87814, 0x8cc70208, 0x90befffa, 0xa4506ceb, 0xbef9a3f7, 0xc67178f2 ];
  50. // initial hash value [§5.3.3]
  51. let H = [
  52. 0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a, 0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19 ];
  53. // PREPROCESSING [§6.2.1]
  54. msg += String.fromCharCode(0x80); // add trailing '1' bit (+ 0's padding) to string [§5.1.1]
  55. // convert string msg into 512-bit blocks (array of 16 32-bit integers) [§5.2.1]
  56. let l = msg.length/4 + 2; // length (in 32-bit integers) of msg + ‘1’ + appended length
  57. let N = Math.ceil(l/16); // number of 16-integer (512-bit) blocks required to hold 'l' ints
  58. let M = new Array(N); // message M is N×16 array of 32-bit integers
  59. for (let i=0; i<N; i++) {
  60. M[i] = new Array(16);
  61. for (let j=0; j<16; j++) { // encode 4 chars per integer (64 per block), big-endian encoding
  62. M[i][j] = (msg.charCodeAt(i*64+j*4)<<24) | (msg.charCodeAt(i*64+j*4+1)<<16) |
  63. (msg.charCodeAt(i*64+j*4+2)<<8) | (msg.charCodeAt(i*64+j*4+3));
  64. } // note running off the end of msg is ok 'cos bitwise ops on NaN return 0
  65. }
  66. // add length (in bits) into final pair of 32-bit integers (big-endian) [§5.1.1]
  67. // note: most significant word would be (len-1)*8 >>> 32, but since JS converts
  68. // bitwise-op args to 32 bits, we need to simulate this by arithmetic operators
  69. let lenHi = ((msg.length-1)*8) / Math.pow(2, 32);
  70. let lenLo = ((msg.length-1)*8) >>> 0;
  71. M[N-1][14] = Math.floor(lenHi);
  72. M[N-1][15] = lenLo;
  73. // HASH COMPUTATION [§6.2.2]
  74. for (let i=0; i<N; i++) {
  75. let W = new Array(64);
  76. // 1 - prepare message schedule 'W'
  77. for (let t=0; t<16; t++) W[t] = M[i][t];
  78. for (let t=16; t<64; t++) {
  79. W[t] = (Sha256.σ1(W[t-2]) + W[t-7] + Sha256.σ0(W[t-15]) + W[t-16]) >>> 0;
  80. }
  81. // 2 - initialise working variables a, b, c, d, e, f, g, h with previous hash value
  82. let a = H[0], b = H[1], c = H[2], d = H[3], e = H[4], f = H[5], g = H[6], h = H[7];
  83. // 3 - main loop (note 'addition modulo 2^32')
  84. for (let t=0; t<64; t++) {
  85. let T1 = h + Sha256.Σ1(e) + Sha256.Ch(e, f, g) + K[t] + W[t];
  86. let T2 = Sha256.Σ0(a) + Sha256.Maj(a, b, c);
  87. h = g;
  88. g = f;
  89. f = e;
  90. e = (d + T1) >>> 0;
  91. d = c;
  92. c = b;
  93. b = a;
  94. a = (T1 + T2) >>> 0;
  95. }
  96. // 4 - compute the new intermediate hash value (note '>>> 0' for 'addition modulo 2^32')
  97. H[0] = (H[0]+a) >>> 0;
  98. H[1] = (H[1]+b) >>> 0;
  99. H[2] = (H[2]+c) >>> 0;
  100. H[3] = (H[3]+d) >>> 0;
  101. H[4] = (H[4]+e) >>> 0;
  102. H[5] = (H[5]+f) >>> 0;
  103. H[6] = (H[6]+g) >>> 0;
  104. H[7] = (H[7]+h) >>> 0;
  105. }
  106. // convert H0..H7 to hex strings (with leading zeros)
  107. for (let h=0; h<H.length; h++) H[h] = ('00000000'+H[h].toString(16)).slice(-8);
  108. // concatenate H0..H7, with separator if required
  109. let separator = opt.outFormat=='hex-w' ? ' ' : '';
  110. return H.join(separator);
  111. };
  112. /**
  113. * Rotates right (circular right shift) value x by n positions [§3.2.4].
  114. * @private
  115. */
  116. Sha256.ROTR = function(n, x) {
  117. return (x >>> n) | (x << (32-n));
  118. };
  119. /**
  120. * Logical functions [§4.1.2].
  121. * @private
  122. */
  123. Sha256.Σ0 = function(x) { return Sha256.ROTR(2, x) ^ Sha256.ROTR(13, x) ^ Sha256.ROTR(22, x); };
  124. Sha256.Σ1 = function(x) { return Sha256.ROTR(6, x) ^ Sha256.ROTR(11, x) ^ Sha256.ROTR(25, x); };
  125. Sha256.σ0 = function(x) { return Sha256.ROTR(7, x) ^ Sha256.ROTR(18, x) ^ (x>>>3); };
  126. Sha256.σ1 = function(x) { return Sha256.ROTR(17, x) ^ Sha256.ROTR(19, x) ^ (x>>>10); };
  127. Sha256.Ch = function(x, y, z) { return (x & y) ^ (~x & z); }; // 'choice'
  128. Sha256.Maj = function(x, y, z) { return (x & y) ^ (x & z) ^ (y & z); }; // 'majority'
  129. /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
  130. /**
  131. * Encodes multi-byte string to utf8 - monsur.hossa.in/2012/07/20/utf-8-in-javascript.html
  132. */
  133. Sha256.utf8Encode = function(str) {
  134. return unescape(encodeURIComponent(str));
  135. };
  136. /**
  137. * Converts a string of a sequence of hex numbers to a string of characters (eg '616263' => 'abc').
  138. */
  139. Sha256.hexBytesToString = function(hexStr) {
  140. hexStr = hexStr.replace(' ', ''); // allow space-separated groups
  141. let str = '';
  142. for (let i=0; i<hexStr.length; i+=2) {
  143. str += String.fromCharCode(parseInt(hexStr.slice(i, i+2), 16));
  144. }
  145. return str;
  146. };
  147. function sha256 (string) {
  148. return Sha256.hash(string);
  149. }