• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1'use strict';
2const common = require('../common');
3if (!common.hasCrypto)
4  common.skip('missing crypto');
5
6const assert = require('assert');
7const crypto = require('crypto');
8
9{
10  const Hmac = crypto.Hmac;
11  const instance = crypto.Hmac('sha256', 'Node');
12  assert(instance instanceof Hmac, 'Hmac is expected to return a new instance' +
13                                   ' when called without `new`');
14}
15
16assert.throws(
17  () => crypto.createHmac(null),
18  {
19    code: 'ERR_INVALID_ARG_TYPE',
20    name: 'TypeError',
21    message: 'The "hmac" argument must be of type string. Received null'
22  });
23
24// This used to segfault. See: https://github.com/nodejs/node/issues/9819
25assert.throws(
26  () => crypto.createHmac('sha256', 'key').digest({
27    toString: () => { throw new Error('boom'); },
28  }),
29  {
30    name: 'Error',
31    message: 'boom'
32  });
33
34assert.throws(
35  () => crypto.createHmac('sha1', null),
36  {
37    code: 'ERR_INVALID_ARG_TYPE',
38    name: 'TypeError',
39    message: 'The "key" argument must be of type string or an instance of ' +
40             'Buffer, TypedArray, DataView, or KeyObject. Received null'
41  });
42
43function testHmac(algo, key, data, expected) {
44  // FIPS does not support MD5.
45  if (common.hasFipsCrypto && algo === 'md5')
46    return;
47
48  if (!Array.isArray(data))
49    data = [data];
50
51  // If the key is a Buffer, test Hmac with a key object as well.
52  const keyWrappers = [
53    (key) => key,
54    ...(typeof key === 'string' ? [] : [crypto.createSecretKey]),
55  ];
56
57  for (const keyWrapper of keyWrappers) {
58    const hmac = crypto.createHmac(algo, keyWrapper(key));
59    for (const chunk of data)
60      hmac.update(chunk);
61    const actual = hmac.digest('hex');
62    assert.strictEqual(actual, expected);
63  }
64}
65
66{
67  // Test HMAC with multiple updates.
68  testHmac('sha1', 'Node', ['some data', 'to hmac'],
69           '19fd6e1ba73d9ed2224dd5094a71babe85d9a892');
70}
71
72// Test HMAC (Wikipedia Test Cases)
73const wikipedia = [
74  {
75    key: 'key', data: 'The quick brown fox jumps over the lazy dog',
76    hmac: {  // HMACs lifted from Wikipedia.
77      md5: '80070713463e7749b90c2dc24911e275',
78      sha1: 'de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9',
79      sha256:
80          'f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc' +
81          '2d1a3cd8'
82    }
83  },
84  {
85    key: 'key', data: '',
86    hmac: {  // Intermediate test to help debugging.
87      md5: '63530468a04e386459855da0063b6596',
88      sha1: 'f42bb0eeb018ebbd4597ae7213711ec60760843f',
89      sha256:
90          '5d5d139563c95b5967b9bd9a8c9b233a9dedb45072794cd232dc1b74' +
91          '832607d0'
92    }
93  },
94  {
95    key: '', data: 'The quick brown fox jumps over the lazy dog',
96    hmac: {  // Intermediate test to help debugging.
97      md5: 'ad262969c53bc16032f160081c4a07a0',
98      sha1: '2ba7f707ad5f187c412de3106583c3111d668de8',
99      sha256:
100          'fb011e6154a19b9a4c767373c305275a5a69e8b68b0b4c9200c383dc' +
101          'ed19a416'
102    }
103  },
104  {
105    key: '', data: '',
106    hmac: {  // HMACs lifted from Wikipedia.
107      md5: '74e6f7298a9c2d168935f58c001bad88',
108      sha1: 'fbdb1d1b18aa6c08324b7d64b71fb76370690e1d',
109      sha256:
110          'b613679a0814d9ec772f95d778c35fc5ff1697c493715653c6c71214' +
111          '4292c5ad'
112    }
113  },
114];
115
116for (const { key, data, hmac } of wikipedia) {
117  for (const hash in hmac)
118    testHmac(hash, key, data, hmac[hash]);
119}
120
121// Test HMAC-SHA-* (rfc 4231 Test Cases)
122const rfc4231 = [
123  {
124    key: Buffer.from('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'),
125    data: Buffer.from('4869205468657265', 'hex'), // 'Hi There'
126    hmac: {
127      sha224: '896fb1128abbdf196832107cd49df33f47b4b1169912ba4f53684b22',
128      sha256:
129          'b0344c61d8db38535ca8afceaf0bf12b881dc200c9833da726e9376c' +
130          '2e32cff7',
131      sha384:
132          'afd03944d84895626b0825f4ab46907f15f9dadbe4101ec682aa034c' +
133          '7cebc59cfaea9ea9076ede7f4af152e8b2fa9cb6',
134      sha512:
135          '87aa7cdea5ef619d4ff0b4241a1d6cb02379f4e2ce4ec2787ad0b305' +
136          '45e17cdedaa833b7d6b8a702038b274eaea3f4e4be9d914eeb61f170' +
137          '2e696c203a126854'
138    }
139  },
140  {
141    key: Buffer.from('4a656665', 'hex'), // 'Jefe'
142    data: Buffer.from('7768617420646f2079612077616e7420666f72206e6f74686' +
143                     '96e673f', 'hex'), // 'what do ya want for nothing?'
144    hmac: {
145      sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f8bbea2a39e6148008fd05e44',
146      sha256:
147          '5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b9' +
148          '64ec3843',
149      sha384:
150          'af45d2e376484031617f78d2b58a6b1b9c7ef464f5a01b47e42ec373' +
151          '6322445e8e2240ca5e69e2c78b3239ecfab21649',
152      sha512:
153          '164b7a7bfcf819e2e395fbe73b56e0a387bd64222e831fd610270cd7' +
154          'ea2505549758bf75c05a994a6d034f65f8f0e6fdcaeab1a34d4a6b4b' +
155          '636e070a38bce737'
156    }
157  },
158  {
159    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'),
160    data: Buffer.from('ddddddddddddddddddddddddddddddddddddddddddddddddd' +
161                     'ddddddddddddddddddddddddddddddddddddddddddddddddddd',
162                      'hex'),
163    hmac: {
164      sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad2649365b0c1f65d69d1ec8333ea',
165      sha256:
166          '773ea91e36800e46854db8ebd09181a72959098b3ef8c122d9635514' +
167          'ced565fe',
168      sha384:
169          '88062608d3e6ad8a0aa2ace014c8a86f0aa635d947ac9febe83ef4e5' +
170          '5966144b2a5ab39dc13814b94e3ab6e101a34f27',
171      sha512:
172          'fa73b0089d56a284efb0f0756c890be9b1b5dbdd8ee81a3655f83e33' +
173          'b2279d39bf3e848279a722c806b485a47e67c807b946a337bee89426' +
174          '74278859e13292fb'
175    }
176  },
177  {
178    key: Buffer.from('0102030405060708090a0b0c0d0e0f10111213141516171819',
179                     'hex'),
180    data: Buffer.from('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' +
181                     'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd',
182                      'hex'),
183    hmac: {
184      sha224: '6c11506874013cac6a2abc1bb382627cec6a90d86efc012de7afec5a',
185      sha256:
186          '82558a389a443c0ea4cc819899f2083a85f0faa3e578f8077a2e3ff4' +
187          '6729665b',
188      sha384:
189          '3e8a69b7783c25851933ab6290af6ca77a9981480850009cc5577c6e' +
190          '1f573b4e6801dd23c4a7d679ccf8a386c674cffb',
191      sha512:
192          'b0ba465637458c6990e5a8c5f61d4af7e576d97ff94b872de76f8050' +
193          '361ee3dba91ca5c11aa25eb4d679275cc5788063a5f19741120c4f2d' +
194          'e2adebeb10a298dd'
195    }
196  },
197
198  {
199    key: Buffer.from('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'),
200    // 'Test With Truncation'
201    data: Buffer.from('546573742057697468205472756e636174696f6e', 'hex'),
202    hmac: {
203      sha224: '0e2aea68a90c8d37c988bcdb9fca6fa8',
204      sha256: 'a3b6167473100ee06e0c796c2955552b',
205      sha384: '3abf34c3503b2a23a46efc619baef897',
206      sha512: '415fad6271580a531d4179bc891d87a6'
207    },
208    truncate: true
209  },
210  {
211    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
212                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
213                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
214                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
215                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
216                    'aaaaaaaaaaaa', 'hex'),
217    // 'Test Using Larger Than Block-Size Key - Hash Key First'
218    data: Buffer.from('54657374205573696e67204c6172676572205468616e20426' +
219                     'c6f636b2d53697a65204b6579202d2048617368204b657920' +
220                     '4669727374', 'hex'),
221    hmac: {
222      sha224: '95e9a0db962095adaebe9b2d6f0dbce2d499f112f2d2b7273fa6870e',
223      sha256:
224          '60e431591ee0b67f0d8a26aacbf5b77f8e0bc6213728c5140546040f' +
225          '0ee37f54',
226      sha384:
227          '4ece084485813e9088d2c63a041bc5b44f9ef1012a2b588f3cd11f05' +
228          '033ac4c60c2ef6ab4030fe8296248df163f44952',
229      sha512:
230          '80b24263c7c1a3ebb71493c1dd7be8b49b46d1f41b4aeec1121b0137' +
231          '83f8f3526b56d037e05f2598bd0fd2215d6a1e5295e64f73f63f0aec' +
232          '8b915a985d786598'
233    }
234  },
235  {
236    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
237                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
238                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
239                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
240                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
241                    'aaaaaaaaaaaa', 'hex'),
242    // 'This is a test using a larger than block-size key and a larger ' +
243    // 'than block-size data. The key needs to be hashed before being ' +
244    // 'used by the HMAC algorithm.'
245    data: Buffer.from('5468697320697320612074657374207573696e672061206c6' +
246                     '172676572207468616e20626c6f636b2d73697a65206b6579' +
247                     '20616e642061206c6172676572207468616e20626c6f636b2' +
248                     'd73697a6520646174612e20546865206b6579206e65656473' +
249                     '20746f20626520686173686564206265666f7265206265696' +
250                     'e6720757365642062792074686520484d414320616c676f72' +
251                     '6974686d2e', 'hex'),
252    hmac: {
253      sha224: '3a854166ac5d9f023f54d517d0b39dbd946770db9c2b95c9f6f565d1',
254      sha256:
255          '9b09ffa71b942fcb27635fbcd5b0e944bfdc63644f0713938a7f5153' +
256          '5c3a35e2',
257      sha384:
258          '6617178e941f020d351e2f254e8fd32c602420feb0b8fb9adccebb82' +
259          '461e99c5a678cc31e799176d3860e6110c46523e',
260      sha512:
261          'e37b6a775dc87dbaa4dfa9f96e5e3ffddebd71f8867289865df5a32d' +
262          '20cdc944b6022cac3c4982b10d5eeb55c3e4de15134676fb6de04460' +
263          '65c97440fa8c6a58'
264    }
265  },
266];
267
268for (let i = 0, l = rfc4231.length; i < l; i++) {
269  for (const hash in rfc4231[i].hmac) {
270    const str = crypto.createHmac(hash, rfc4231[i].key);
271    str.end(rfc4231[i].data);
272    let strRes = str.read().toString('hex');
273    let actual = crypto.createHmac(hash, rfc4231[i].key)
274                       .update(rfc4231[i].data)
275                       .digest('hex');
276    if (rfc4231[i].truncate) {
277      actual = actual.substr(0, 32); // first 128 bits == 32 hex chars
278      strRes = strRes.substr(0, 32);
279    }
280    const expected = rfc4231[i].hmac[hash];
281    assert.strictEqual(
282      actual,
283      expected,
284      `Test HMAC-${hash} rfc 4231 case ${i + 1}: ${actual} must be ${expected}`
285    );
286    assert.strictEqual(
287      actual,
288      strRes,
289      `Should get same result from stream (hash: ${hash} and case: ${i + 1})` +
290      ` => ${actual} must be ${strRes}`
291    );
292  }
293}
294
295// Test HMAC-MD5/SHA1 (rfc 2202 Test Cases)
296const rfc2202_md5 = [
297  {
298    key: Buffer.from('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'),
299    data: 'Hi There',
300    hmac: '9294727a3638bb1c13f48ef8158bfc9d'
301  },
302  {
303    key: 'Jefe',
304    data: 'what do ya want for nothing?',
305    hmac: '750c783e6ab0b503eaa86e310a5db738'
306  },
307  {
308    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'),
309    data: Buffer.from('ddddddddddddddddddddddddddddddddddddddddddddddddd' +
310                     'ddddddddddddddddddddddddddddddddddddddddddddddddddd',
311                      'hex'),
312    hmac: '56be34521d144c88dbb8c733f0e8b3f6'
313  },
314  {
315    key: Buffer.from('0102030405060708090a0b0c0d0e0f10111213141516171819',
316                     'hex'),
317    data: Buffer.from('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' +
318                     'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' +
319                     'cdcdcdcdcd',
320                      'hex'),
321    hmac: '697eaf0aca3a3aea3a75164746ffaa79'
322  },
323  {
324    key: Buffer.from('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'),
325    data: 'Test With Truncation',
326    hmac: '56461ef2342edc00f9bab995690efd4c'
327  },
328  {
329    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
330                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
331                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
332                    'aaaaaaaaaaaaaaaaaaaaaa',
333                     'hex'),
334    data: 'Test Using Larger Than Block-Size Key - Hash Key First',
335    hmac: '6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd'
336  },
337  {
338    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
339                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
340                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
341                    'aaaaaaaaaaaaaaaaaaaaaa',
342                     'hex'),
343    data:
344        'Test Using Larger Than Block-Size Key and Larger Than One ' +
345        'Block-Size Data',
346    hmac: '6f630fad67cda0ee1fb1f562db3aa53e'
347  },
348];
349
350for (const { key, data, hmac } of rfc2202_md5)
351  testHmac('md5', key, data, hmac);
352
353const rfc2202_sha1 = [
354  {
355    key: Buffer.from('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'),
356    data: 'Hi There',
357    hmac: 'b617318655057264e28bc0b6fb378c8ef146be00'
358  },
359  {
360    key: 'Jefe',
361    data: 'what do ya want for nothing?',
362    hmac: 'effcdf6ae5eb2fa2d27416d5f184df9c259a7c79'
363  },
364  {
365    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'),
366    data: Buffer.from('ddddddddddddddddddddddddddddddddddddddddddddd' +
367                     'ddddddddddddddddddddddddddddddddddddddddddddd' +
368                     'dddddddddd',
369                      'hex'),
370    hmac: '125d7342b9ac11cd91a39af48aa17b4f63f175d3'
371  },
372  {
373    key: Buffer.from('0102030405060708090a0b0c0d0e0f10111213141516171819',
374                     'hex'),
375    data: Buffer.from('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' +
376                     'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' +
377                     'cdcdcdcdcd',
378                      'hex'),
379    hmac: '4c9007f4026250c6bc8414f9bf50c86c2d7235da'
380  },
381  {
382    key: Buffer.from('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'),
383    data: 'Test With Truncation',
384    hmac: '4c1a03424b55e07fe7f27be1d58bb9324a9a5a04'
385  },
386  {
387    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
388                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
389                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
390                    'aaaaaaaaaaaaaaaaaaaaaa',
391                     'hex'),
392    data: 'Test Using Larger Than Block-Size Key - Hash Key First',
393    hmac: 'aa4ae5e15272d00e95705637ce8a3b55ed402112'
394  },
395  {
396    key: Buffer.from('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
397                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
398                    'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' +
399                    'aaaaaaaaaaaaaaaaaaaaaa',
400                     'hex'),
401    data:
402        'Test Using Larger Than Block-Size Key and Larger Than One ' +
403        'Block-Size Data',
404    hmac: 'e8e99d0f45237d786d6bbaa7965c7808bbff1a91'
405  },
406];
407
408for (const { key, data, hmac } of rfc2202_sha1)
409  testHmac('sha1', key, data, hmac);
410
411assert.strictEqual(
412  crypto.createHmac('sha256', 'w00t').digest('ucs2'),
413  crypto.createHmac('sha256', 'w00t').digest().toString('ucs2'));
414
415// Check initialized -> uninitialized state transition after calling digest().
416{
417  const expected =
418      '\u0010\u0041\u0052\u00c5\u00bf\u00dc\u00a0\u007b\u00c6\u0033' +
419      '\u00ee\u00bd\u0046\u0019\u009f\u0002\u0055\u00c9\u00f4\u009d';
420  {
421    const h = crypto.createHmac('sha1', 'key').update('data');
422    assert.deepStrictEqual(h.digest('buffer'), Buffer.from(expected, 'latin1'));
423    assert.deepStrictEqual(h.digest('buffer'), Buffer.from(''));
424  }
425  {
426    const h = crypto.createHmac('sha1', 'key').update('data');
427    assert.deepStrictEqual(h.digest('latin1'), expected);
428    assert.deepStrictEqual(h.digest('latin1'), '');
429  }
430}
431
432// Check initialized -> uninitialized state transition after calling digest().
433// Calls to update() omitted intentionally.
434{
435  const expected =
436      '\u00f4\u002b\u00b0\u00ee\u00b0\u0018\u00eb\u00bd\u0045\u0097' +
437      '\u00ae\u0072\u0013\u0071\u001e\u00c6\u0007\u0060\u0084\u003f';
438  {
439    const h = crypto.createHmac('sha1', 'key');
440    assert.deepStrictEqual(h.digest('buffer'), Buffer.from(expected, 'latin1'));
441    assert.deepStrictEqual(h.digest('buffer'), Buffer.from(''));
442  }
443  {
444    const h = crypto.createHmac('sha1', 'key');
445    assert.deepStrictEqual(h.digest('latin1'), expected);
446    assert.deepStrictEqual(h.digest('latin1'), '');
447  }
448}
449
450{
451  assert.throws(
452    () => crypto.createHmac('sha7', 'key'),
453    /Unknown message digest/);
454}
455