From f7d76c3d7d09d95a9ceb5b69c8f951f53237ef78 Mon Sep 17 00:00:00 2001 From: slontis Date: Wed, 22 Feb 2023 12:15:47 +1000 Subject: Add documentation for "NULL" cipher and digest algorithms. Fixes #20340 Reviewed-by: Matt Caswell Reviewed-by: Paul Dale (Merged from https://github.com/openssl/openssl/pull/20356) --- doc/man7/EVP_CIPHER-NULL.pod | 72 ++++++++++++++++++++++++++++++++++++++ doc/man7/EVP_MD-NULL.pod | 42 ++++++++++++++++++++++ doc/man7/OSSL_PROVIDER-default.pod | 4 +++ doc/man7/provider-cipher.pod | 2 +- doc/man7/provider-digest.pod | 1 + 5 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 doc/man7/EVP_CIPHER-NULL.pod create mode 100644 doc/man7/EVP_MD-NULL.pod (limited to 'doc/man7') diff --git a/doc/man7/EVP_CIPHER-NULL.pod b/doc/man7/EVP_CIPHER-NULL.pod new file mode 100644 index 0000000000..44e07dcf1b --- /dev/null +++ b/doc/man7/EVP_CIPHER-NULL.pod @@ -0,0 +1,72 @@ +=pod + +=head1 NAME + +EVP_CIPHER-NULL - The NULL EVP_CIPHER implementation + +=head1 DESCRIPTION + +Support for a NULL symmetric encryption using the B API. +This is used when the TLS cipher suite is TLS_NULL_WITH_NULL_NULL. +This does no encryption (just copies the data) and has a mac size of zero. + +=head2 Algorithm Name + +The following algorithm is available in the default provider: + +=over 4 + +=item "NULL" + +=back + +=head2 Parameters + +This implementation supports the following parameters: + +=head3 Gettable EVP_CIPHER parameters + +See L + +=head3 Gettable EVP_CIPHER_CTX parameters + +=over 4 + +=item "keylen" (B) + +=item "ivlen" (B and ) + +=item "tls-mac" (B) + +=back + +See L for further information. + +=head3 Settable EVP_CIPHER_CTX parameters + +=over 4 + +=item "tls-mac-size" (B) + +=back + +See L for further information. + +=head1 CONFORMING TO + +RFC 5246 section-6.2.3.1 + +=head1 SEE ALSO + +L, L + +=head1 COPYRIGHT + +Copyright 2023 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/EVP_MD-NULL.pod b/doc/man7/EVP_MD-NULL.pod new file mode 100644 index 0000000000..bce399a1e1 --- /dev/null +++ b/doc/man7/EVP_MD-NULL.pod @@ -0,0 +1,42 @@ +=pod + +=head1 NAME + +EVP_MD-NULL - The NULL EVP_MD implementation + +=head1 DESCRIPTION + +Support for a NULL digest through the B API. +This algorithm does nothing and returns 1 for its init, +update and final methods. + +=head2 Algorithm Name + +The following algorithm is available in the default provider: + +=over 4 + +=item "NULL" + +=back + +=head2 Gettable Parameters + +This implementation supports the common gettable parameters described +in L. + +=head1 SEE ALSO + +L, L, +L + +=head1 COPYRIGHT + +Copyright 2023 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/OSSL_PROVIDER-default.pod b/doc/man7/OSSL_PROVIDER-default.pod index 9724b0ab23..acb7bbb89a 100644 --- a/doc/man7/OSSL_PROVIDER-default.pod +++ b/doc/man7/OSSL_PROVIDER-default.pod @@ -73,6 +73,8 @@ The OpenSSL default provider supports these operations and algorithms: =item RIPEMD160, see L +=item NULL, see L + =back =head2 Symmetric Ciphers @@ -95,6 +97,8 @@ The OpenSSL default provider supports these operations and algorithms: =item ChaCha20-Poly1305, see L +=item NULL, see L + =back =head2 Message Authentication Code (MAC) diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod index 429a4173d6..cb79c18b9f 100644 --- a/doc/man7/provider-cipher.pod +++ b/doc/man7/provider-cipher.pod @@ -228,7 +228,7 @@ L, L, L, L, L, L, L, L, L, L, L, L, -L, +L, L, L, L =head1 HISTORY diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod index a3d79a48b3..62307c8a5f 100644 --- a/doc/man7/provider-digest.pod +++ b/doc/man7/provider-digest.pod @@ -268,6 +268,7 @@ L, L, L, L, L, L, L, L, L L, L, L, +L, L, L =head1 HISTORY -- cgit v1.2.3