doc/man7/EVP_MAC_HMAC.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_MAC_HMAC - The HMAC EVP_MAC implementation
   6
   7 =head1 DESCRIPTION
   8
   9 Support for computing HMAC MACs through the B<EVP_MAC> API.
  10
  11 =head2 Numeric identity
  12
  13 B<EVP_MAC_HMAC> is the numeric identity for this implementation, and
  14 can be used in functions like EVP_MAC_CTX_new_id() and
  15 EVP_get_macbynid().
  16
  17 =head2 Supported controls
  18
  19 The supported controls are:
  20
  21 =over 4
  22
  23 =item B<EVP_MAC_CTRL_SET_KEY>
  24
  25 EVP_MAC_ctrl_str() takes two type strings for this control:
  26
  27 =over 4
  28
  29 =item "key"
  30
  31 The value string is used as is.
  32
  33 =item "hexkey"
  34
  35 The value string is expected to be a hexadecimal number, which will be
  36 decoded before passing on as control value.
  37
  38 =back
  39
  40 =item B<EVP_MAC_CTRL_SET_FLAGS>
  41
  42 Sets HMAC flags.  This is passed directly to HMAC_CTX_set_flags().
  43
  44 There are no corresponding string control types.
  45
  46 =item B<EVP_MAC_CTRL_SET_ENGINE>
  47
  48 =item B<EVP_MAC_CTRL_SET_MD>
  49
  50 These work as described in L<EVP_MAC(3)/CONTROLS>.
  51
  52 EVP_MAC_ctrl_str() type string for B<EVP_MAC_CTRL_SET_MD>: "digest"
  53
  54 The value is expected to be the name of a cipher.
  55
  56 =back
  57
  58 =head1 SEE ALSO
  59
  60 L<EVP_MAC_ctrl(3)>, L<EVP_MAC(3)/CONTROLS>
  61
  62 =head1 COPYRIGHT
  63
  64 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
  65
  66 Licensed under the Apache License 2.0 (the "License").  You may not use
  67 this file except in compliance with the License.  You can obtain a copy
  68 in the file LICENSE in the source distribution or at
  69 L<https://www.openssl.org/source/license.html>.
  70
  71 =cut