doc/man7/EVP_MAC-KMAC.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256
   6 - The KMAC EVP_MAC implementations
   7
   8 =head1 DESCRIPTION
   9
  10 Support for computing KMAC MACs through the B<EVP_MAC> API.
  11
  12 =head2 Identity
  13
  14 These implementations are identified with one of these names and
  15 properties, to be used with EVP_MAC_fetch():
  16
  17 =over 4
  18
  19 =item "KMAC-128", "provider=default" or "provider=fips"
  20
  21 =item "KMAC-256", "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 All these parameters can be set with EVP_MAC_CTX_set_params().
  31 Furthermore, the "size" parameter can be retrieved with
  32 EVP_MAC_CTX_get_params(), or with EVP_MAC_size().
  33 The length of the "size" parameter should not exceed that of a B<size_t>.
  34
  35 =over 4
  36
  37 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  38
  39 =item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
  40
  41 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  42
  43 =item "xof" (B<OSSL_MAC_PARAM_XOF>) <integer>
  44
  45 =back
  46
  47 The "xof" parameter value is expected to be 1 or 0. Use 1 to enable XOF
  48 mode. If XOF is enabled then the output length that is encoded as part of
  49 the input stream is set to zero.
  50
  51 =head1 SEE ALSO
  52
  53 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  54 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
  59
  60 Licensed under the Apache License 2.0 (the "License").  You may not use
  61 this file except in compliance with the License.  You can obtain a copy
  62 in the file LICENSE in the source distribution or at
  63 L<https://www.openssl.org/source/license.html>.
  64
  65 =cut