xref: /freebsd/secure/lib/libcrypto/man/man7/life_cycle-mac.7 (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

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 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 "LIFE_CYCLE-MAC 7ossl"
LIFE_CYCLE-MAC 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
life_cycle-mac - The MAC algorithm life-cycle
"DESCRIPTION"
Header "DESCRIPTION" All message authentication codes (MACs) go through a number of stages in their life-cycle:
"start" 4
Item "start" This state represents the \s-1MAC\s0 before it has been allocated. It is the starting state for any life-cycle transitions.
"newed" 4
Item "newed" This state represents the \s-1MAC\s0 after it has been allocated.
"initialised" 4
Item "initialised" This state represents the \s-1MAC\s0 when it is set up and capable of processing input.
"updated" 4
Item "updated" This state represents the \s-1MAC\s0 when it is set up and capable of processing additional input or generating output.
"finaled" 4
Item "finaled" This state represents the \s-1MAC\s0 when it has generated output.
"freed" 4
Item "freed" This state is entered when the \s-1MAC\s0 is freed. It is the terminal state for all life-cycle transitions.
"State Transition Diagram"
Subsection "State Transition Diagram" The usual life-cycle of a \s-1MAC\s0 is illustrated: +-------------------+ | start | +-------------------+ | | EVP_MAC_CTX_new v +-------------------+ | newed | +-------------------+ | | EVP_MAC_init v +-------------------+ +> | initialised | <+ | +-------------------+ | | | | | | EVP_MAC_update | EVP_MAC_init | v | EVP_MAC_init | +-------------------+ | | | updated | -+ | +-------------------+ | | | | | EVP_MAC_final | EVP_MAC_finalXOF | v v | +-------------------+ +- | finaled | +-------------------+ | | EVP_MAC_CTX_free v +-------------------+ | freed | +-------------------+
"Formal State Transitions"
Subsection "Formal State Transitions" This section defines all of the legal state transitions. This is the canonical list. Function Call --------------------- Current State ---------------------- start newed initialised updated finaled freed EVP_MAC_CTX_new newed EVP_MAC_init initialised initialised initialised initialised EVP_MAC_update updated updated EVP_MAC_final finaled EVP_MAC_finalXOF finaled EVP_MAC_CTX_free freed freed freed freed freed EVP_MAC_CTX_get_params newed initialised updated EVP_MAC_CTX_set_params newed initialised updated EVP_MAC_CTX_gettable_params newed initialised updated EVP_MAC_CTX_settable_params newed initialised updated
"NOTES"
Header "NOTES" At some point the \s-1EVP\s0 layer will begin enforcing the transitions described herein.
"SEE ALSO"
Header "SEE ALSO" \fBprovider-mac\|(7), \s-1EVP_MAC\s0\|(3).
"HISTORY"
Header "HISTORY" The provider \s-1MAC\s0 interface was introduced in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 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>.