From: Pauli Date: Wed, 24 Mar 2021 03:35:41 +0000 (+1000) Subject: doc: life-cycle descritpion for RANDs X-Git-Tag: openssl-3.0.0-alpha14~121 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b0b63654e9da02a6f336c5660e659a87a29e916e;p=thirdparty%2Fopenssl.git doc: life-cycle descritpion for RANDs Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/14522) --- diff --git a/doc/man7/life_cycle-rand.pod b/doc/man7/life_cycle-rand.pod new file mode 100644 index 00000000000..b78b8484d23 --- /dev/null +++ b/doc/man7/life_cycle-rand.pod @@ -0,0 +1,193 @@ +=pod + +=head1 NAME + +life_cycle-rand - The RAND algorithm life-cycle + +=head1 DESCRIPTION + +All random number generator (RANDs) +go through a number of stages in their life-cycle: + +=over 4 + +=item start + +This state represents the RAND before it has been allocated. It is the +starting state for any life-cycle transitions. + +=item newed + +This state represents the RAND after it has been allocated but unable to +generate any output. + +=item instantiated + +This state represents the RAND when it is set up and capable of generating +output. + +=item uninstantiated + +This state represents the RAND when it has been shutdown and it is no longer +capable of generating output. + +=item freed + +This state is entered when the RAND is freed. It is the terminal state +for all life-cycle transitions. + +=back + +=head2 State Transition Diagram + +The usual life-cycle of a RAND is illustrated: + +=begin man + + +-------------------------+ + | start | + +-------------------------+ + | + | EVP_RAND_CTX_new + v + +-------------------------+ + | newed | + +-------------------------+ + | + | EVP_RAND_instantiate + v + EVP_RAND_generate +-------------------------+ + +-------------------- | | + | | instantiated | + +-------------------> | | <+ + +-------------------------+ ' + | ' + | EVP_RAND_uninstantiate ' EVP_RAND_instantiate + v ' + +-------------------------+ ' + | uninstantiated | -+ + +-------------------------+ + | + | EVP_RAND_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 instantiated uninstantiated freed + EVP_RAND_CTX_new newed + EVP_RAND_instantiate instantiated + EVP_RAND_generate instantiated + EVP_RAND_uninstantiate uninstantiated + EVP_RAND_CTX_free freed freed freed freed + EVP_RAND_get_ctx_params newed instantiated uninstantiated freed + EVP_RAND_set_ctx_params newed instantiated uninstantiated freed + EVP_RAND_CTX_gettable_params newed instantiated uninstantiated freed + EVP_RAND_CTX_settable_params newed instantiated uninstantiated freed + +=end man + +=begin html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Function CallCurrent State
startnewedinstantiateduninstantiatedfreed
EVP_RAND_CTX_newnewed
EVP_RAND_instantiateinstantiated
EVP_RAND_generateinstantiated
EVP_RAND_uninstantiateuninstantiated
EVP_RAND_CTX_freefreedfreedfreedfreed
EVP_RAND_get_ctx_paramsnewedinstantiateduninstantiated
EVP_RAND_set_ctx_paramsnewedinstantiateduninstantiated
EVP_RAND_CTX_gettable_paramsnewedinstantiateduninstantiated
EVP_RAND_CTX_settable_paramsnewedinstantiateduninstantiated
+ +=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 RAND 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/rand.png b/doc/man7/rand.png new file mode 100644 index 00000000000..56d213f3894 Binary files /dev/null and b/doc/man7/rand.png differ