doc/man3/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_size
  17 - HMAC message authentication code
  18
  19 =head1 SYNOPSIS
  20
  21  #include <openssl/hmac.h>
  22
  23 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  24 B<OPENSSL_API_COMPAT> with a suitable version value, see
  25 L<openssl_user_macros(7)>:
  26
  27  unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
  28                      int key_len, const unsigned char *d, size_t n,
  29                      unsigned char *md, unsigned int *md_len);
  30
  31  HMAC_CTX *HMAC_CTX_new(void);
  32  int HMAC_CTX_reset(HMAC_CTX *ctx);
  33
  34  int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
  35                   const EVP_MD *md, ENGINE *impl);
  36  int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len);
  37  int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
  38
  39  void HMAC_CTX_free(HMAC_CTX *ctx);
  40
  41  int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx);
  42  void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags);
  43  const EVP_MD *HMAC_CTX_get_md(const HMAC_CTX *ctx);
  44
  45  size_t HMAC_size(const HMAC_CTX *e);
  46
  47 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
  48 B<OPENSSL_API_COMPAT> with a suitable version value, see
  49 L<openssl_user_macros(7)>:
  50
  51  int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
  52                const EVP_MD *md);
  53
  54 =head1 DESCRIPTION
  55
  56 All of the functions described on this page are deprecated. Applications should
  57 instead use L<EVP_MAC_CTX_new(3)>, L<EVP_MAC_CTX_free(3)>, L<EVP_MAC_init(3)>,
  58 L<EVP_MAC_update(3)> and L<EVP_MAC_final(3)>.
  59
  60 HMAC is a MAC (message authentication code), i.e. a keyed hash
  61 function used for message authentication, which is based on a hash
  62 function.
  63
  64 HMAC() computes the message authentication code of the B<n> bytes at
  65 B<d> using the hash function B<evp_md> and the key B<key> which is
  66 B<key_len> bytes long.
  67
  68 It places the result in B<md> (which must have space for the output of
  69 the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes).
  70 If B<md> is NULL, the digest is placed in a static array.  The size of
  71 the output is placed in B<md_len>, unless it is B<NULL>. Note: passing a NULL
  72 value for B<md>  to use the static array is not thread safe.
  73
  74 B<evp_md> is a message digest such as EVP_sha1(), EVP_ripemd160() etc. HMAC does
  75 not support variable output length digests such as EVP_shake128() and
  76 EVP_shake256().
  77
  78 HMAC_CTX_new() creates a new HMAC_CTX in heap memory.
  79
  80 HMAC_CTX_reset() clears an existing B<HMAC_CTX> and associated
  81 resources, making it suitable for new computations as if it was newly
  82 created with HMAC_CTX_new().
  83
  84 HMAC_CTX_free() erases the key and other data from the B<HMAC_CTX>,
  85 releases any associated resources and finally frees the B<HMAC_CTX>
  86 itself.
  87
  88 The following functions may be used if the message is not completely
  89 stored in memory:
  90
  91 HMAC_Init_ex() initializes or reuses a B<HMAC_CTX> structure to use the hash
  92 function B<evp_md> and key B<key>. If both are NULL, or if B<key> is NULL
  93 and B<evp_md> is the same as the previous call, then the
  94 existing key is
  95 reused. B<ctx> must have been created with HMAC_CTX_new() before the first use
  96 of an B<HMAC_CTX> in this function.
  97
  98 If HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the
  99 same as the previous digest used by B<ctx> then an error is returned
 100 because reuse of an existing key with a different digest is not supported.
 101
 102 HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash
 103 function B<evp_md> and the key B<key> which is B<key_len> bytes
 104 long.
 105
 106 HMAC_Update() can be called repeatedly with chunks of the message to
 107 be authenticated (B<len> bytes at B<data>).
 108
 109 HMAC_Final() places the message authentication code in B<md>, which
 110 must have space for the hash function output.
 111
 112 HMAC_CTX_copy() copies all of the internal state from B<sctx> into B<dctx>.
 113
 114 HMAC_CTX_set_flags() applies the specified flags to the internal EVP_MD_CTXs.
 115 These flags have the same meaning as for L<EVP_MD_CTX_set_flags(3)>.
 116
 117 HMAC_CTX_get_md() returns the EVP_MD that has previously been set for the
 118 supplied HMAC_CTX.
 119
 120 HMAC_size() returns the length in bytes of the underlying hash function output.
 121
 122 =head1 RETURN VALUES
 123
 124 HMAC() returns a pointer to the message authentication code or NULL if
 125 an error occurred.
 126
 127 HMAC_CTX_new() returns a pointer to a new B<HMAC_CTX> on success or
 128 B<NULL> if an error occurred.
 129
 130 HMAC_CTX_reset(), HMAC_Init_ex(), HMAC_Update(), HMAC_Final() and
 131 HMAC_CTX_copy() return 1 for success or 0 if an error occurred.
 132
 133 HMAC_CTX_get_md() return the EVP_MD previously set for the supplied HMAC_CTX or
 134 NULL if no EVP_MD has been set.
 135
 136 HMAC_size() returns the length in bytes of the underlying hash function output
 137 or zero on error.
 138
 139 =head1 CONFORMING TO
 140
 141 RFC 2104
 142
 143 =head1 SEE ALSO
 144
 145 L<SHA1(3)>, L<evp(7)>
 146
 147 =head1 HISTORY
 148
 149 All of these functions were deprecated in OpenSSL 3.0.
 150
 151 HMAC_CTX_init() was replaced with HMAC_CTX_reset() in OpenSSL 1.1.0.
 152
 153 HMAC_CTX_cleanup() existed in OpenSSL before version 1.1.0.
 154
 155 HMAC_CTX_new(), HMAC_CTX_free() and HMAC_CTX_get_md() are new in OpenSSL 1.1.0.
 156
 157 HMAC_Init_ex(), HMAC_Update() and HMAC_Final() did not return values in
 158 OpenSSL before version 1.0.0.
 159
 160 =head1 COPYRIGHT
 161
 162 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 163
 164 Licensed under the Apache License 2.0 (the "License").  You may not use
 165 this file except in compliance with the License.  You can obtain a copy
 166 in the file LICENSE in the source distribution or at
 167 L<https://www.openssl.org/source/license.html>.
 168
 169 =cut