doc/crypto/hmac.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 HMAC, HMAC_Init, HMAC_Update, HMAC_Final - HMAC message authentication code
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/hmac.h>
  10
  11  unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
  12                int key_len, const unsigned char *d, int n,
  13                unsigned char *md, unsigned int *md_len);
  14
  15  void HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
  16                const EVP_MD *md);
  17  void HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
  18  void HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
  19
  20  void HMAC_cleanup(HMAC_CTX *ctx);
  21
  22 =head1 DESCRIPTION
  23
  24 HMAC is a MAC (message authentication code), i.e. a keyed hash
  25 function used for message authentication, which is based on a hash
  26 function.
  27
  28 HMAC() computes the message authentication code of the B<n> bytes at
  29 B<d> using the hash function B<evp_md> and the key B<key> which is
  30 B<key_len> bytes long.
  31
  32 It places the result in B<md> (which must have space for the output of
  33 the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes).
  34 If B<md> is NULL, the digest is placed in a static array.  The size of
  35 the output is placed in B<md_len>, unless it is B<NULL>.
  36
  37 B<evp_md> can be EVP_sha1(), EVP_ripemd160() etc.
  38 B<key> and B<evp_md> may be B<NULL> if a key and hash function have
  39 been set in a previous call to HMAC_Init() for that B<HMAC_CTX>.
  40
  41 HMAC_cleanup() erases the key and other data from the B<HMAC_CTX>.
  42
  43 The following functions may be used if the message is not completely
  44 stored in memory:
  45
  46 HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash
  47 function B<evp_md> and the key B<key> which is B<key_len> bytes long.
  48
  49 HMAC_Update() can be called repeatedly with chunks of the message to
  50 be authenticated (B<len> bytes at B<data>).
  51
  52 HMAC_Final() places the message authentication code in B<md>, which
  53 must have space for the hash function output.
  54
  55 =head1 RETURN VALUES
  56
  57 HMAC() returns a pointer to the message authentication code.
  58
  59 HMAC_Init(), HMAC_Update(), HMAC_Final() and HMAC_cleanup() do not
  60 return values.
  61
  62 =head1 CONFORMING TO
  63
  64 RFC 2104
  65
  66 =head1 SEE ALSO
  67
  68 L<sha(3)|sha(3)>, L<evp(3)|evp(3)>
  69
  70 =head1 HISTORY
  71
  72 HMAC(), HMAC_Init(), HMAC_Update(), HMAC_Final() and HMAC_cleanup()
  73 are available since SSLeay 0.9.0.
  74
  75 =cut