HMAC-SHA-2

The keyed message authentication codes HMAC-SHA-256, HMAC-SHA-512 and HMAC-SHA512-256 (truncated HMAC-SHA-512) are provided.

The crypto_auth API provides a simplified interface for message authentication.

If required, a streaming API is available to process a message as a sequence of multiple chunks.

Single-part example

  1. #define MESSAGE ((const unsigned char *) "Arbitrary data to hash")
  2. #define MESSAGE_LEN 22
  4. unsigned char hash[crypto_auth_hmacsha512_BYTES];
  5. unsigned char key[crypto_auth_hmacsha512_KEYBYTES];
  7. crypto_auth_hmacsha512_keygen(key);
  8. crypto_auth_hmacsha512(hash, MESSAGE, MESSAGE_LEN, key);

Multi-part example

  1. #define MESSAGE_PART1 \
  2.     ((const unsigned char *) "Arbitrary data to hash")
  3. #define MESSAGE_PART1_LEN 22
  5. #define MESSAGE_PART2 \
  6.     ((const unsigned char *) "is longer than expected")
  7. #define MESSAGE_PART2_LEN 23
  9. unsigned char hash[crypto_auth_hmacsha512_BYTES];
  10. unsigned char key[crypto_auth_hmacsha512_KEYBYTES];
  11. crypto_auth_hmacsha512_state state;
  13. crypto_auth_hmacsha512_keygen(key);
  15. crypto_auth_hmacsha512_init(&state, key, sizeof key);
  17. crypto_auth_hmacsha512_update(&state, MESSAGE_PART1, MESSAGE_PART1_LEN);
  18. crypto_auth_hmacsha512_update(&state, MESSAGE_PART2, MESSAGE_PART2_LEN);
  20. crypto_auth_hmacsha512_final(&state, hash);

Usage

HMAC-SHA-256

  1. int crypto_auth_hmacsha256(unsigned char *out,
  2.                            const unsigned char *in,
  3.                            unsigned long long inlen,
  4.                            const unsigned char *k);

The crypto_auth_hmacsha256() function authenticates a message in whose length is inlen using the secret key k whose length is crypto_auth_hmacsha256_KEYBYTES, and puts the authenticator into out (crypto_auth_hmacsha256_BYTES bytes).

  1. int crypto_auth_hmacsha256_verify(const unsigned char *h,
  2.                                   const unsigned char *in,
  3.                                   unsigned long long inlen,
  4.                                   const unsigned char *k);

The crypto_auth_hmacsha256_verify() function verifies in constant time that h is a correct authenticator for the message in whose length is inlen under a secret key k (crypto_auth_hmacsha256_KEYBYTES bytes).

It returns -1 if the verification fails, and 0 on success.

A multi-part (streaming) API can be used instead of crypto_auth_hmacsha256():

  1. int crypto_auth_hmacsha256_init(crypto_auth_hmacsha256_state *state,
  2.                                 const unsigned char *key,
  3.                                 size_t keylen);
  1. int crypto_auth_hmacsha256_update(crypto_auth_hmacsha256_state *state,
  2.                                   const unsigned char *in,
  3.                                   unsigned long long inlen);
  1. int crypto_auth_hmacsha256_final(crypto_auth_hmacsha256_state *state,
  2.                                  unsigned char *out);

This alternative API supports a key of arbitrary length keylen.

However, please note that in the HMAC construction, a key larger than the block size gets reduced to h(key).

  1. void crypto_auth_hmacsha256_keygen(unsigned char k[crypto_auth_hmacsha256_KEYBYTES]);

This helper function introduced in libsodium 1.0.12 creates a random key k.

It is equivalent to calling randombytes_buf() but improves code clarity and can prevent misuse by ensuring that the provided key length is always be correct.

HMAC-SHA-512

Similarly to the crypto_auth_hmacsha256_*() set of functions, the crypto_auth_hmacsha512_*() set of functions implements HMAC-SHA512:

  1. int crypto_auth_hmacsha512(unsigned char *out,
  2.                            const unsigned char *in,
  3.                            unsigned long long inlen,
  4.                            const unsigned char *k);
  1. int crypto_auth_hmacsha512_verify(const unsigned char *h,
  2.                                   const unsigned char *in,
  3.                                   unsigned long long inlen,
  4.                                   const unsigned char *k);
  1. int crypto_auth_hmacsha512_init(crypto_auth_hmacsha512_state *state,
  2.                                 const unsigned char *key,
  3.                                 size_t keylen);
  1. int crypto_auth_hmacsha512_update(crypto_auth_hmacsha512_state *state,
  2.                                   const unsigned char *in,
  3.                                   unsigned long long inlen);
  1. int crypto_auth_hmacsha512_final(crypto_auth_hmacsha512_state *state,
  2.                                  unsigned char *out);
  1. void crypto_auth_hmacsha512_keygen(unsigned char k[crypto_auth_hmacsha512_KEYBYTES]);

HMAC-SHA-512-256

HMAC-SHA-512-256 is implemented as HMAC-SHA-512 with the output truncated to 256 bits. This is slightly faster than HMAC-SHA-256. Note that this construction is not the same as HMAC-SHA-512/256, which is HMAC using the SHA-512/256 function.

  1. int crypto_auth_hmacsha512256(unsigned char *out,
  2.                               const unsigned char *in,
  3.                               unsigned long long inlen,
  4.                               const unsigned char *k);
  1. int crypto_auth_hmacsha512256_verify(const unsigned char *h,
  2.                                      const unsigned char *in,
  3.                                      unsigned long long inlen,
  4.                                      const unsigned char *k);
  1. int crypto_auth_hmacsha512256_init(crypto_auth_hmacsha512256_state *state,
  2.                                    const unsigned char *key,
  3.                                    size_t keylen);
  1. int crypto_auth_hmacsha512256_update(crypto_auth_hmacsha512256_state *state,
  2.                                      const unsigned char *in,
  3.                                      unsigned long long inlen);
  1. int crypto_auth_hmacsha512256_final(crypto_auth_hmacsha512256_state *state,
  2.                                     unsigned char *out);
  1. void crypto_auth_hmacsha512256_keygen(unsigned char k[crypto_auth_hmacsha512256_KEYBYTES]);

Constants

  • crypto_auth_hmacsha256_BYTES
  • crypto_auth_hmacsha256_KEYBYTES
  • crypto_auth_hmacsha512_BYTES
  • crypto_auth_hmacsha512_KEYBYTES
  • crypto_auth_hmacsha512256_BYTES
  • crypto_auth_hmacsha512256_KEYBYTES

Data types

  • crypto_auth_hmacsha256_state
  • crypto_auth_hmacsha512_state
  • crypto_auth_hmacsha512256_state

Notes

  • The state must be initialized with crypto_auth_hmacsha*_init() before updating or finalizing it. After crypto_auth_hmacsha*_final() returns, the state should not be used any more, unless it is reinitialized using crypto_auth_hmacsha*_init().

  • Arbitrary key lengths are supported using the multi-part interface. However, keys larger than 32 bytes are generally useless, even with SHA-512. It has been proven that HMAC offers PRF security with any sufficiently large key length.

  • crypto_auth_hmacsha256_*() can be used to create AWS HMAC-SHA256 request signatures.

  • crypto_auth_hmacsha512_*() is only provided for compatibility with legacy protocols specifically requiring that construction. The 32-byte authenticator offered by other functions is more than enough to guarantee that collisions will never occur.

  • Only use these functions for interoperability with 3rd party services. For everything else, you should probably use crypto_auth()/crypto_auth_verify() or crypto_generichash_*() instead.

References