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 This implementation uses EVP_MD functions to get access to the underlying
  12 digest.
  13
  14 =head2 Identity
  15
  16 This implementation is identified with this name and properties, to be
  17 used with EVP_MAC_fetch():
  18
  19 =over 4
  20
  21 =item "HMAC", "provider=default" or "provider=fips"
  22
  23 =back
  24
  25 =head2 Supported parameters
  26
  27 The general description of these parameters can be found in
  28 L<EVP_MAC(3)/PARAMETERS>.
  29
  30 The following parameter can be set with EVP_MAC_CTX_set_params():
  31
  32 =over 4
  33
  34 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  35
  36 Sets the MAC key.
  37 Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
  38
  39 =item "digest" (B<OSSL_MAC_PARAM_DIGEST>) <UTF8 string>
  40
  41 Sets the name of the underlying digest to be used.
  42
  43 =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
  44
  45 Sets the properties to be queried when trying to fetch the underlying digest.
  46 This must be given together with the digest naming parameter ("digest", or
  47 B<OSSL_MAC_PARAM_DIGEST>) to be considered valid.
  48
  49 =item "digest-noinit" (B<OSSL_MAC_PARAM_DIGEST_NOINIT>) <integer>
  50
  51 A flag to set the MAC digest to not initialise the implementation
  52 specific data.
  53 The value 0 or 1 is expected.
  54 This option is deprecated and will be removed in a future release.
  55 It may be set but is currently ignored
  56
  57 =item "digest-oneshot" (B<OSSL_MAC_PARAM_DIGEST_ONESHOT>) <integer>
  58
  59 A flag to set the MAC digest to be a one-shot operation.
  60 The value 0 or 1 is expected.
  61 This option is deprecated and will be removed in a future release.
  62 It may be set but is currently ignored.
  63
  64 =item "tls-data-size" (B<OSSL_MAC_PARAM_TLS_DATA_SIZE>) <unsigned integer>
  65
  66 =back
  67
  68 =for comment The "flags" parameter is passed directly to HMAC_CTX_set_flags().
  69
  70 The following parameter can be retrieved with EVP_MAC_CTX_get_params():
  71
  72 =over 4
  73
  74 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  75
  76 The "size" parameter can also be retrieved with EVP_MAC_CTX_get_mac_size().
  77 The length of the "size" parameter is equal to that of an B<unsigned int>.
  78
  79 =back
  80
  81 =over 4
  82
  83 =item "block-size" (B<OSSL_MAC_PARAM_BLOCK_SIZE>) <unsigned integer>
  84
  85 Gets the MAC block size.  The "block-size" parameter can also be retrieved with
  86 EVP_MAC_CTX_get_block_size().
  87
  88 =back
  89
  90 =head1 SEE ALSO
  91
  92 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  93 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>, L<HMAC(3)>
  94
  95 =head1 COPYRIGHT
  96
  97 Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
  98
  99 Licensed under the Apache License 2.0 (the "License").  You may not use
 100 this file except in compliance with the License.  You can obtain a copy
 101 in the file LICENSE in the source distribution or at
 102 L<https://www.openssl.org/source/license.html>.
 103
 104 =cut