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