diff options
| author | Pauli <pauli@openssl.org> | 2021-03-24 13:38:57 +1000 |
|---|---|---|
| committer | Pauli <pauli@openssl.org> | 2021-03-26 18:21:37 +1000 |
| commit | 10b63e9756cf932cbaba5f725445a2a032a7f271 (patch) | |
| tree | 576e7c5e913349bbd37064e6b721a82a3c353112 /doc | |
| parent | b0b63654e9da02a6f336c5660e659a87a29e916e (diff) | |
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)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/EVP_MAC.pod | 11 | ||||
| -rw-r--r-- | doc/man7/provider-mac.pod | 10 |
2 files changed, 18 insertions, 3 deletions
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<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 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<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 |