diff options
author | Richard Levitte <levitte@openssl.org> | 2020-03-06 14:29:00 +0100 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2020-03-10 13:32:06 +0100 |
commit | 1e55cbc874826af63e178a3fd26d23981599effe (patch) | |
tree | 0304b0a474dd37ab7a54ba95d7400c51deb83143 /doc/man7/EVP_MD-MDC2.pod | |
parent | c5926e930cc9a4bdf0932d14e17f1f122a70205b (diff) |
DOCS: Move implementation specific docs away from provider-digest(7)
The provider- manuals are meant to describe the general interface for
their respective operation. This is not the place to describe
implementation specific details.
This change creates a number of doc/man7/EVP_MD manuals, one for each
algorithm or set of algorithms, as well as doc/man7/EVP_MD-common.pod
to describe what's common to them all.
While we're at it, correct the SHA3 settable context params array to
match what's actually settable.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11270)
Diffstat (limited to 'doc/man7/EVP_MD-MDC2.pod')
-rw-r--r-- | doc/man7/EVP_MD-MDC2.pod | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/man7/EVP_MD-MDC2.pod b/doc/man7/EVP_MD-MDC2.pod new file mode 100644 index 0000000000..516e19da19 --- /dev/null +++ b/doc/man7/EVP_MD-MDC2.pod @@ -0,0 +1,50 @@ +=pod + +=head1 NAME + +EVP_MD-MDC2 - The MDC2 EVP_MD implementation + +=head1 DESCRIPTION + +Support for computing MDC2 digests through the B<EVP_MD> API. + +=head2 Identity + +This implementation is only available with the legacy provider, and is +identified with the name "MDC2". + +=head2 Gettable Parameters + +This implementation supports the common gettable parameters described +in L<EVP_MD-common(7)>. + +=head2 Settable Context Parameters + +This implementation supports the following L<OSSL_PARAM(3)> entries, +settable for an B<EVP_MD_CTX> with L<EVP_MD_CTX_set_params(3)>: + +=over 4 + +=item "pad_type" (B<OSSL_DIGEST_PARAM_PAD_TYPE>) <unsigned integer> + +Sets the padding type to be used. +Normally the final MDC2 block is padded with zeros. +If the pad type is set to 2 then the final block is padded with 0x80 followed by +zeros. + +=back + +=head1 SEE ALSO + +L<EVP_MD_CTX_set_params(3)>, L<provider-digest(7)>, L<OSSL_PROVIDER-legacy(7)> + +=head1 COPYRIGHT + +Copyright 2020 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<https://www.openssl.org/source/license.html>. + +=cut |