doc: note that MAC lifecycle transitions will be enforced at some point

Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14522)
This commit is contained in:
Pauli 2021-03-24 13:38:57 +10:00
parent b0b63654e9
commit 10b63e9756
2 changed files with 18 additions and 3 deletions

View File

@ -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<life_cycle-mac(7)>. 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<EVP_MAC-GMAC(7)>,
L<EVP_MAC-HMAC(7)>,
L<EVP_MAC-KMAC(7)>,
L<EVP_MAC-Siphash(7)>,
L<EVP_MAC-Poly1305(7)>
L<EVP_MAC-Poly1305(7)>,
L<provider-mac(7)>,
L<life_cycle-mac(7)>
=head1 HISTORY

View File

@ -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<life_cycle-rand(7)>. 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<provider(7)>,
L<EVP_MAC-BLAKE2(7)>, L<EVP_MAC-CMAC(7)>, L<EVP_MAC-GMAC(7)>,
L<EVP_MAC-HMAC(7)>, L<EVP_MAC-KMAC(7)>, L<EVP_MAC-Poly1305(7)>,
L<EVP_MAC-Siphash(7)>
L<EVP_MAC-Siphash(7)>,
L<life_cycle-mac(7)>, L<EVP_MAC(3)>
=head1 HISTORY