xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/life_cycle-digest.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: life_cycle-digest.7,v 1.5 2024/09/08 13:08:38 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "LIFE_CYCLE-DIGEST 7"
LIFE_CYCLE-DIGEST 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
life_cycle-digest - The digest algorithm life-cycle
DESCRIPTION
Header "DESCRIPTION" All message digests (MDs) go through a number of stages in their life-cycle:
start 4
Item "start" This state represents the MD before it has been allocated. It is the starting state for any life-cycle transitions.
newed 4
Item "newed" This state represents the MD after it has been allocated.
initialised 4
Item "initialised" This state represents the MD when it is set up and capable of processing input.
updated 4
Item "updated" This state represents the MD when it is set up and capable of processing additional input or generating output.
finaled 4
Item "finaled" This state represents the MD when it has generated output.
freed 4
Item "freed" This state is entered when the MD 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 MD is illustrated: +-------------------+ | start | +-------------------+ | | EVP_MD_CTX_new v +-------------------+ EVP_MD_CTX_reset | newed | <------------------------------+ +-------------------+ | | | | EVP_DigestInit | v | +-------------------+ | +--> | initialised | <+ EVP_DigestInit | | +-------------------+ | | | | | EVP_DigestUpdate | | | EVP_DigestUpdate | +------------------+ | | v | v | | | +------------------------------------------------+ | EVP_DigestInit | | updated | --+ | +------------------------------------------------+ | | | | | | | EVP_DigestFinal | EVP_DigestFinalXOF | | v v | | +------------------------------------------------+ | +--- | finaled | --+ +------------------------------------------------+ | | EVP_MD_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_MD_CTX_new newed EVP_DigestInit initialised initialised initialised initialised EVP_DigestUpdate updated updated EVP_DigestFinal finaled EVP_DigestFinalXOF finaled EVP_MD_CTX_free freed freed freed freed freed EVP_MD_CTX_reset newed newed newed newed EVP_MD_CTX_get_params newed initialised updated EVP_MD_CTX_set_params newed initialised updated EVP_MD_CTX_gettable_params newed initialised updated EVP_MD_CTX_settable_params newed initialised updated
NOTES
Header "NOTES" At some point the EVP layer will begin enforcing the transitions described herein.
"SEE ALSO"
Header "SEE ALSO" \fBprovider-digest\|(7), EVP_DigestInit\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.

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