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