doc/crypto/HMAC.pod

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