From: Pauli Date: Wed, 24 Mar 2021 03:38:57 +0000 (+1000) Subject: doc: note that MAC lifecycle transitions will be enforced at some point X-Git-Tag: openssl-3.0.0-alpha14~120 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=10b63e9756cf932cbaba5f725445a2a032a7f271;p=thirdparty%2Fopenssl.git doc: note that MAC lifecycle transitions will be enforced at some point Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/14522) --- diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod index 928ef52407..b4ad7209dd 100644 --- a/doc/man3/EVP_MAC.pod +++ b/doc/man3/EVP_MAC.pod @@ -304,6 +304,13 @@ EVP_MAC_init(), EVP_MAC_update() and EVP_MAC_final() for a full computation. Anything else may give undefined results. +=head1 NOTES + +The MAC life-cycle is described in L. 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. + + =head1 RETURN VALUES EVP_MAC_fetch() returns a pointer to a newly fetched EVP_MAC, or @@ -428,7 +435,9 @@ L, L, L, L, -L +L, +L, +L =head1 HISTORY diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod index 82bbdb9aa2..1f7810c16c 100644 --- a/doc/man7/provider-mac.pod +++ b/doc/man7/provider-mac.pod @@ -185,6 +185,12 @@ should have as well, see the documentation of the implementation. =back +=head1 NOTES + +The MAC life-cycle is described in L. Providers should +ensure that the various transitions listed there are supported. At some point +the EVP layer will begin enforcing the listed transitions. + =head1 RETURN VALUES OSSL_FUNC_mac_newctx() and OSSL_FUNC_mac_dupctx() should return the newly created @@ -203,8 +209,8 @@ array, or NULL if none is offered. L, L, L, L, L, L, L, -L - +L, +L, L =head1 HISTORY