From: Pauli Date: Wed, 24 Mar 2021 04:02:48 +0000 (+1000) Subject: doc: life-cycle descritpion for MACs X-Git-Tag: openssl-3.0.0-alpha14~119 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4551763efc8c9d2e39f3d39430cb4657d155cde6;p=thirdparty%2Fopenssl.git doc: life-cycle descritpion for MACs Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/14522) --- diff --git a/doc/man7/life_cycle-mac.pod b/doc/man7/life_cycle-mac.pod new file mode 100644 index 00000000000..b9812f7cae5 --- /dev/null +++ b/doc/man7/life_cycle-mac.pod @@ -0,0 +1,210 @@ +=pod + +=head1 NAME + +life_cycle-mac - The MAC algorithm life-cycle + +=head1 DESCRIPTION + +All message authentication codes (MACs) +go through a number of stages in their life-cycle: + +=over 4 + +=item start + +This state represents the MAC before it has been allocated. It is the +starting state for any life-cycle transitions. + +=item newed + +This state represents the MAC after it has been allocated. + +=item initialised + +This state represents the MAC when it is set up and capable of processing +input. + +=item updated + +This state represents the MAC when it is set up and capable of processing +additional input or generating output. + +=item finaled + +This state represents the MAC when it has generated output. + +=item freed + +This state is entered when the MAC is freed. It is the terminal state +for all life-cycle transitions. + +=back + +=head2 State Transition Diagram + +The usual life-cycle of a MAC is illustrated: + +=begin man + + +-------------------+ + | 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 + | v + | +-------------------+ + +- | finaled | + +-------------------+ + | + | EVP_MAC_CTX_free + v + +-------------------+ + | freed | + +-------------------+ + +=end man + +=for html + +=head2 Formal State Transitions + +This section defines all of the legal state transitions. +This is the canonical list. + +=begin man + + 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_CTX_free freed freed freed freed freed + EVP_MAC_gettable_ctx_params newed initialised updated + EVP_MAC_settable_ctx_params newed initialised updated + EVP_MAC_CTX_gettable_params newed initialised updated + EVP_MAC_CTX_settable_params newed initialised updated + +=end man + +=begin html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Function CallCurrent State
startnewedinitialisedupdatedfinaledfreed
EVP_MAC_CTX_newnewed
EVP_MAC_initinitialisedinitialisedinitialisedinitialised
EVP_MAC_updateupdatedupdated
EVP_MAC_finalfinaled
EVP_MAC_CTX_freefreedfreedfreedfreedfreed
EVP_MAC_gettable_ctx_paramsnewedinitialisedupdated
EVP_MAC_settable_ctx_paramsnewedinitialisedupdated
EVP_MAC_CTX_gettable_paramsnewedinitialisedupdated
EVP_MAC_CTX_settable_paramsnewedinitialisedupdated
+ +=end html + +=head1 NOTES + +At some point the EVP layer will begin enforcing the transitions described +herein. + +=head1 SEE ALSO + +L, L. + +=head1 HISTORY + +The provider MAC interface was introduced in OpenSSL 3.0. + +=head1 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 +L. + +=cut diff --git a/doc/man7/mac.png b/doc/man7/mac.png new file mode 100644 index 00000000000..1c486e1ba40 Binary files /dev/null and b/doc/man7/mac.png differ