diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_MAC.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_MAC.3 | 49 |
1 files changed, 26 insertions, 23 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_MAC.3 b/secure/lib/libcrypto/man/man3/EVP_MAC.3 index 08b99f1be6f9..c6113995389a 100644 --- a/secure/lib/libcrypto/man/man3/EVP_MAC.3 +++ b/secure/lib/libcrypto/man/man3/EVP_MAC.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "EVP_MAC 3ossl" -.TH EVP_MAC 3ossl 2025-09-30 3.5.4 OpenSSL +.TH EVP_MAC 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -163,7 +166,7 @@ The returned value must eventually be freed with MAC. .PP \&\fBEVP_MAC_free()\fR frees a fetched algorithm. -NULL is a valid parameter, for which this function is a no-op. +NULL is a valid parameter, for which this function is a no\-op. .SS "Context manipulation functions" .IX Subsection "Context manipulation functions" \&\fBEVP_MAC_CTX_new()\fR creates a new context for the MAC type \fImac\fR. @@ -172,7 +175,7 @@ described here. .PP \&\fBEVP_MAC_CTX_free()\fR frees the contents of the context, including an underlying context if there is one, as well as the context itself. -NULL is a valid parameter, for which this function is a no-op. +NULL is a valid parameter, for which this function is a no\-op. .PP \&\fBEVP_MAC_CTX_dup()\fR duplicates the \fIsrc\fR context and returns a newly allocated context. @@ -199,10 +202,10 @@ via the \fIkey\fR and \fIparams\fR arguments. The MAC \fIkey\fR has a length of \&\fIkeylen\fR and the parameters in \fIparams\fR are processed before setting the key. If \fIkey\fR is NULL, the key must be set via \fIparams\fR either as part of this call or separately using \fBEVP_MAC_CTX_set_params()\fR. -Providing non-NULL \fIparams\fR to this function is equivalent to calling +Providing non\-NULL \fIparams\fR to this function is equivalent to calling \&\fBEVP_MAC_CTX_set_params()\fR with those \fIparams\fR for the same \fIctx\fR beforehand. Note: There are additional requirements for some MAC algorithms during -re-initalization (i.e. calling \fBEVP_MAC_init()\fR on an EVP_MAC after \fBEVP_MAC_final()\fR +re\-initalization (i.e. calling \fBEVP_MAC_init()\fR on an EVP_MAC after \fBEVP_MAC_final()\fR has been called on the same object). See the NOTES section below. .PP \&\fBEVP_MAC_init()\fR should be called before \fBEVP_MAC_update()\fR and \fBEVP_MAC_final()\fR. @@ -246,7 +249,7 @@ parameters are passed down. If \fIparams\fR are NULL, the underlying context should do nothing and return 1. Note that a parameter that is unknown in the underlying context is simply ignored. -Also, what happens when a needed parameter isn't passed down is +Also, what happens when a needed parameter isn\*(Aqt passed down is defined by the implementation. .PP \&\fBEVP_MAC_gettable_params()\fR returns an \fBOSSL_PARAM\fR\|(3) array that describes @@ -258,14 +261,14 @@ return constant \fBOSSL_PARAM\fR\|(3) arrays that describe the retrievable parameters that can be used with \fBEVP_MAC_CTX_get_params()\fR. \&\fBEVP_MAC_gettable_ctx_params()\fR returns the parameters that can be retrieved from the algorithm, whereas \fBEVP_MAC_CTX_gettable_params()\fR returns -the parameters that can be retrieved in the context's current state. +the parameters that can be retrieved in the context\*(Aqs current state. .PP \&\fBEVP_MAC_settable_ctx_params()\fR and \fBEVP_MAC_CTX_settable_params()\fR return constant \fBOSSL_PARAM\fR\|(3) arrays that describe the settable parameters that can be used with \fBEVP_MAC_CTX_set_params()\fR. \fBEVP_MAC_settable_ctx_params()\fR returns the parameters that can be retrieved from the algorithm, whereas \fBEVP_MAC_CTX_settable_params()\fR returns the parameters that can -be retrieved in the context's current state. +be retrieved in the context\*(Aqs current state. .SS "Information functions" .IX Subsection "Information functions" \&\fBEVP_MAC_CTX_get_mac_size()\fR returns the MAC output size for the given context. @@ -274,7 +277,7 @@ be retrieved in the context's current state. Not all MAC algorithms support this. .PP \&\fBEVP_MAC_is_a()\fR checks if the given \fImac\fR is an implementation of an -algorithm that's identifiable with \fIname\fR. +algorithm that\*(Aqs identifiable with \fIname\fR. .PP \&\fBEVP_MAC_get0_provider()\fR returns the provider that holds the implementation of the given \fImac\fR. @@ -285,7 +288,7 @@ implementations, calls the given function \fIfn\fR with the implementation metho and the given \fIarg\fR as argument. .PP \&\fBEVP_MAC_get0_name()\fR return the name of the given MAC. For fetched MACs -with multiple names, only one of them is returned; it's +with multiple names, only one of them is returned; it\*(Aqs recommended to use \fBEVP_MAC_names_do_all()\fR instead. .PP \&\fBEVP_MAC_names_do_all()\fR traverses all names for \fImac\fR, and calls @@ -323,17 +326,17 @@ empty string. This option is used by BLAKE2 MAC. .IP """xof"" (\fBOSSL_MAC_PARAM_XOF\fR) <integer>" 4 .IX Item """xof"" (OSSL_MAC_PARAM_XOF) <integer>" -It's a simple flag, the value 0 or 1 are expected. +It\*(Aqs a simple flag, the value 0 or 1 are expected. .Sp This option is used by KMAC. -.IP """digest-noinit"" (\fBOSSL_MAC_PARAM_DIGEST_NOINIT\fR) <integer>" 4 +.IP """digest\-noinit"" (\fBOSSL_MAC_PARAM_DIGEST_NOINIT\fR) <integer>" 4 .IX Item """digest-noinit"" (OSSL_MAC_PARAM_DIGEST_NOINIT) <integer>" A simple flag to set the MAC digest to not initialise the implementation specific data. The value 0 or 1 is expected. .Sp This option is deprecated and will be removed in a future release. The option may be set, but is ignored. -.IP """digest-oneshot"" (\fBOSSL_MAC_PARAM_DIGEST_ONESHOT\fR) <integer>" 4 +.IP """digest\-oneshot"" (\fBOSSL_MAC_PARAM_DIGEST_ONESHOT\fR) <integer>" 4 .IX Item """digest-oneshot"" (OSSL_MAC_PARAM_DIGEST_ONESHOT) <integer>" A simple flag to set the MAC digest to be a oneshot operation. The value 0 or 1 is expected. @@ -363,10 +366,10 @@ For MAC implementations that support it, set the output size that \&\fBEVP_MAC_final()\fR should produce. The allowed sizes vary between MAC implementations, but must never exceed what can be given with a \fBsize_t\fR. -.IP """tls-data-size"" (\fBOSSL_MAC_PARAM_TLS_DATA_SIZE\fR) <unsigned integer>" 4 +.IP """tls\-data\-size"" (\fBOSSL_MAC_PARAM_TLS_DATA_SIZE\fR) <unsigned integer>" 4 .IX Item """tls-data-size"" (OSSL_MAC_PARAM_TLS_DATA_SIZE) <unsigned integer>" This parameter is only supported by HMAC. If set then special handling is -activated for calculating the MAC of a received mac-then-encrypt TLS record +activated for calculating the MAC of a received mac\-then\-encrypt TLS record where variable length record padding has been used (as in the case of CBC mode ciphersuites). The value represents the total length of the record that is having the MAC calculated including the received MAC and the record padding. @@ -374,7 +377,7 @@ having the MAC calculated including the received MAC and the record padding. When used EVP_MAC_update must be called precisely twice. The first time with the 13 bytes of TLS "header" data, and the second time with the entire record including the MAC itself and any padding. The entire record length must equal -the value passed in the "tls-data-size" parameter. The length passed in the +the value passed in the "tls\-data\-size" parameter. The length passed in the \&\fBdatalen\fR parameter to \fBEVP_MAC_update()\fR should be equal to the length of the record after the MAC and any padding has been removed. .PP @@ -384,7 +387,7 @@ computation. Anything else may give undefined results. .SH NOTES .IX Header "NOTES" -The MAC life-cycle is described in \fBlife_cycle\-mac\fR\|(7). In the future, +The MAC life\-cycle is described in \fBlife_cycle\-mac\fR\|(7). In the future, the transitions described there will be enforced. When this is done, it will not be considered a breaking change to the API. .PP @@ -392,7 +395,7 @@ The usage of the parameter names "custom", "iv" and "salt" correspond to the names used in the standard where the algorithm was defined. .PP Some MAC algorithms store internal state that cannot be extracted during -re-initalization. For example GMAC cannot extract an \fBIV\fR from the +re\-initalization. For example GMAC cannot extract an \fBIV\fR from the underlying CIPHER context, and so calling \fBEVP_MAC_init()\fR on an EVP_MAC object after \fBEVP_MAC_final()\fR has been called cannot reset its cipher state to what it was when the \fBIV\fR was initially generated. For such instances, an @@ -430,11 +433,11 @@ success, 0 on error. \&\fBEVP_MAC_init()\fR, \fBEVP_MAC_init_SKEY()\fR, \fBEVP_MAC_update()\fR, \fBEVP_MAC_final()\fR, and \&\fBEVP_MAC_finalXOF()\fR return 1 on success, 0 on error. .PP -\&\fBEVP_MAC_CTX_get_mac_size()\fR returns the expected output size, or 0 if it isn't -set. If it isn't set, a call to \fBEVP_MAC_init()\fR will set it. +\&\fBEVP_MAC_CTX_get_mac_size()\fR returns the expected output size, or 0 if it isn\*(Aqt +set. If it isn\*(Aqt set, a call to \fBEVP_MAC_init()\fR will set it. .PP -\&\fBEVP_MAC_CTX_get_block_size()\fR returns the block size, or 0 if it isn't set. -If it isn't set, a call to \fBEVP_MAC_init()\fR will set it. +\&\fBEVP_MAC_CTX_get_block_size()\fR returns the block size, or 0 if it isn\*(Aqt set. +If it isn\*(Aqt set, a call to \fBEVP_MAC_init()\fR will set it. .PP \&\fBEVP_MAC_do_all_provided()\fR returns nothing at all. .SH EXAMPLES |