doc/crypto/HMAC.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 HMAC, HMAC_CTX_new, HMAC_CTX_reset, HMAC_CTX_free, HMAC_Init, HMAC_Init_ex, 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  HMAC_CTX *HMAC_CTX_new(void);
  16  int HMAC_CTX_reset(HMAC_CTX *ctx);
  17
  18  int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
  19                    const EVP_MD *md, ENGINE *impl);
  20  int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
  21  int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
  22
  23  void HMAC_CTX_free(HMAC_CTX *ctx);
  24
  25 Deprecated:
  26
  27  #if OPENSSL_API_COMPAT < 0x10100000L
  28  int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
  29                const EVP_MD *md);
  30  #endif
  31
  32 =head1 DESCRIPTION
  33
  34 HMAC is a MAC (message authentication code), i.e. a keyed hash
  35 function used for message authentication, which is based on a hash
  36 function.
  37
  38 HMAC() computes the message authentication code of the B<n> bytes at
  39 B<d> using the hash function B<evp_md> and the key B<key> which is
  40 B<key_len> bytes long.
  41
  42 It places the result in B<md> (which must have space for the output of
  43 the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes).
  44 If B<md> is NULL, the digest is placed in a static array.  The size of
  45 the output is placed in B<md_len>, unless it is B<NULL>.
  46
  47 B<evp_md> can be EVP_sha1(), EVP_ripemd160() etc.
  48
  49 HMAC_CTX_new() creates a new HMAC_CTX in heap memory.
  50
  51 HMAC_CTX_reset() zeroes an existing B<HMAC_CTX> and associated
  52 resources, making it suitable for new computations as if it was newly
  53 created with HMAC_CTX_new().
  54
  55 HMAC_CTX_free() erases the key and other data from the B<HMAC_CTX>,
  56 releases any associated resources and finally frees the B<HMAC_CTX>
  57 itself.
  58
  59 The following functions may be used if the message is not completely
  60 stored in memory:
  61
  62 HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash
  63 function B<evp_md> and the key B<key> which is B<key_len> bytes
  64 long. It is deprecated and only included for backward compatibility
  65 with OpenSSL 0.9.6b.
  66
  67 HMAC_Init_ex() initializes or reuses a B<HMAC_CTX> structure to use
  68 the function B<evp_md> and key B<key>. Either can be NULL, in which
  69 case the existing one will be reused. B<ctx> must have been created
  70 with HMAC_CTX_new() before the first use of an B<HMAC_CTX> in this
  71 function. B<N.B. HMAC_Init() had this undocumented behaviour in
  72 previous versions of OpenSSL - failure to switch to HMAC_Init_ex() in
  73 programs that expect it will cause them to stop working>.
  74
  75 HMAC_Update() can be called repeatedly with chunks of the message to
  76 be authenticated (B<len> bytes at B<data>).
  77
  78 HMAC_Final() places the message authentication code in B<md>, which
  79 must have space for the hash function output.
  80
  81 =head1 RETURN VALUES
  82
  83 HMAC() returns a pointer to the message authentication code or NULL if
  84 an error occurred.
  85
  86 HMAC_CTX_new() returns a pointer to a new B<HMAC_CTX> on success or
  87 B<NULL> if an error occurred.
  88
  89 HMAC_CTX_reset(), HMAC_Init_ex(), HMAC_Update() and HMAC_Final() return 1
  90 for success or 0 if an error occurred.
  91
  92 HMAC_CTX_free() do not return values.
  93
  94 =head1 CONFORMING TO
  95
  96 RFC 2104
  97
  98 =head1 SEE ALSO
  99
 100 L<sha(3)>, L<evp(3)>
 101
 102 =head1 HISTORY
 103
 104 HMAC_CTX_init() was replaced with HMAC_CTX_reset() in OpenSSL versions 1.1.
 105
 106 HMAC_CTX_cleanup() existed in OpenSSL versions before 1.1.
 107
 108 HMAC_CTX_new() and HMAC_CTX_free() are new in OpenSSL version 1.1.
 109
 110 HMAC_Init_ex(), HMAC_Update() and HMAC_Final() did not return values in
 111 versions of OpenSSL before 1.0.0.
 112
 113 =head1 COPYRIGHT
 114
 115 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 116
 117 Licensed under the OpenSSL license (the "License").  You may not use
 118 this file except in compliance with the License.  You can obtain a copy
 119 in the file LICENSE in the source distribution or at
 120 L<https://www.openssl.org/source/license.html>.
 121
 122 =cut