Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "EVP_MAC-KMAC 7" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
EVP_MAC-KMAC, EVP_MAC-KMAC128, EVP_MAC-KMAC256 \- The KMAC EVP_MAC implementations Header "DESCRIPTION" Support for computing \s-1KMAC\s0 MACs through the \s-1EVP_MAC\s0 \s-1API.\s0 Subsection "Identity" These implementations are identified with one of these names and properties, to be used with EVP_MAC_fetch(): Item "KMAC-128, provider=default or provider=fips"

0 Item "KMAC-256, provider=default or provider=fips"

Subsection "Supported parameters" The general description of these parameters can be found in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_MAC\s0\|(3).

All these parameters can be set with EVP_MAC_CTX_set_params(). Furthermore, the \*(L"size\*(R" parameter can be retrieved with \fBEVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size(). The length of the \*(L"size\*(R" parameter should not exceed that of a size_t. Likewise, the \*(L"block-size\*(R" parameter can be retrieved with \fBEVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_block_size(). Item "key (OSSL_MAC_PARAM_KEY) <octet string>" Sets the \s-1MAC\s0 key. Setting this parameter is identical to passing a key to EVP_MAC_init\|(3). The length of the key (in bytes) must be in the range 4...512. Item "custom (OSSL_MAC_PARAM_CUSTOM) <octet string>" Sets the custom value. It is an optional value with a length of at most 512 bytes, and is empty by default. Item "size (OSSL_MAC_PARAM_SIZE) <unsigned integer>" Sets the \s-1MAC\s0 size. By default, it is 16 for \*(C`KMAC-128\*(C' and 32 for \*(C`KMAC-256\*(C'. Item "block-size (OSSL_MAC_PARAM_SIZE) <unsigned integer>" Gets the \s-1MAC\s0 block size. By default, it is 168 for \*(C`KMAC-128\*(C' and 136 for \*(C`KMAC-256\*(C'. Item "xof (OSSL_MAC_PARAM_XOF) <integer>" The \*(L"xof\*(R" parameter value is expected to be 1 or 0. Use 1 to enable \s-1XOF\s0 mode. The default value is 0.

The \*(L"custom\*(R" parameter must be set as part of or before the EVP_MAC_init() call. The \*(L"xof\*(R" and \*(L"size\*(R" parameters can be set at any time before EVP_MAC_final(). The \*(L"key\*(R" parameter is set as part of the EVP_MAC_init() call, but can be set before it instead.

Header "EXAMPLES" .Vb 2 #include <openssl/evp.h> #include <openssl/params.h> \& static int do_kmac(const unsigned char *in, size_t in_len, const unsigned char *key, size_t key_len, const unsigned char *custom, size_t custom_len, int xof_enabled, unsigned char *out, int out_len) { EVP_MAC_CTX *ctx = NULL; EVP_MAC *mac = NULL; OSSL_PARAM params[4], *p; int ret = 0; size_t l = 0; \& mac = EVP_MAC_fetch(NULL, "KMAC-128", NULL); if (mac == NULL) goto err; ctx = EVP_MAC_CTX_new(mac); /* The mac can be freed after it is used by EVP_MAC_CTX_new */ EVP_MAC_free(mac); if (ctx == NULL) goto err; \& /* * Setup parameters required before calling EVP_MAC_init() * The parameters OSSL_MAC_PARAM_XOF and OSSL_MAC_PARAM_SIZE may also be * used at this point. */ p = params; *p++ = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY, (void *)key, key_len); if (custom != NULL && custom_len != 0) *p++ = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_CUSTOM, (void *)custom, custom_len); *p = OSSL_PARAM_construct_end(); if (!EVP_MAC_CTX_set_params(ctx, params)) goto err; \& if (!EVP_MAC_init(ctx)) goto err; \& /* * Note: the following optional parameters can be set any time * before EVP_MAC_final(). */ p = params; *p++ = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_XOF, &xof_enabled); *p++ = OSSL_PARAM_construct_int(OSSL_MAC_PARAM_SIZE, &out_len); *p = OSSL_PARAM_construct_end(); if (!EVP_MAC_CTX_set_params(ctx, params)) goto err; \& /* The update may be called multiple times here for streamed input */ if (!EVP_MAC_update(ctx, in, in_len)) goto err; if (!EVP_MAC_final(ctx, out, &l, out_len)) goto err; ret = 1; err: EVP_MAC_CTX_free(ctx); return ret; } .Ve Header "SEE ALSO" \fBEVP_MAC_CTX_get_params\|(3), EVP_MAC_CTX_set_params\|(3), \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_MAC\s0\|(3), \s-1OSSL_PARAM\s0\|(3) Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.