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 Identity
  12
  13 This implementation is identified with this name and properties, to be
  14 used with EVP_MAC_fetch():
  15
  16 =over 4
  17
  18 =item "HMAC", "provider=default" or "provider=fips"
  19
  20 =back
  21
  22 =head2 Supported parameters
  23
  24 The general description of these parameters can be found in
  25 L<EVP_MAC(3)/PARAMETERS>.
  26
  27 The following parameter can be set with EVP_MAC_CTX_set_params():
  28
  29 =over 4
  30
  31 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  32
  33 =item "digest" (B<OSSL_MAC_PARAM_DIGEST>) <UTF8 string>
  34
  35 =item "digest-noinit" (B<OSSL_MAC_PARAM_DIGEST_NOINIT>) <integer>
  36
  37 =item "digest-oneshot" (B<OSSL_MAC_PARAM_DIGEST_ONESHOT>) <integer>
  38
  39 =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
  40
  41 =item "tls-data-size" (B<OSSL_MAC_PARAM_TLS_DATA_SIZE>) <unsigned integer>
  42
  43 =back
  44
  45 The "flags" parameter is passed directly to HMAC_CTX_set_flags().
  46
  47 The following parameter can be retrieved with
  48 EVP_MAC_CTX_get_params():
  49
  50 =over 4
  51
  52 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  53
  54 =back
  55
  56 The "size" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size().
  57 The length of the "size" parameter is equal to that of an B<unsigned int>.
  58
  59 =head1 SEE ALSO
  60
  61 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  62 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>, L<HMAC(3)>
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
  67
  68 Licensed under the Apache License 2.0 (the "License").  You may not use
  69 this file except in compliance with the License.  You can obtain a copy
  70 in the file LICENSE in the source distribution or at
  71 L<https://www.openssl.org/source/license.html>.
  72
  73 =cut