summaryrefslogtreecommitdiffstats
path: root/doc/man7/EVP_SIGNATURE-RSA.pod
diff options
context:
space:
mode:
authorShane Lontis <shane.lontis@oracle.com>2020-05-26 13:53:07 +1000
committerShane Lontis <shane.lontis@oracle.com>2020-05-26 13:53:07 +1000
commitb8086652650c0782bc8d63b620663e04a3c6a3a7 (patch)
tree831362a2004a3b79808f04eb4e387b7e649177ab /doc/man7/EVP_SIGNATURE-RSA.pod
parentf32af93c924dca25728d8e7b85b8e4b660154e12 (diff)
Update core_names.h fields and document most fields.
Renamed some values in core_names i.e Some DH specific names were changed to use DH instead of FFC. Added some strings values related to RSA keys. Moved set_params related docs out of EVP_PKEY_CTX_ctrl.pod into its own file. Updated Keyexchange and signature code and docs. Moved some common DSA/DH docs into a shared EVP_PKEY-FFC.pod. Moved Ed25519.pod into EVP_SIGNATURE-ED25519.pod and reworked it. Added some usage examples. As a result of the usage examples the following change was also made: ec allows OSSL_PKEY_PARAM_USE_COFACTOR_ECDH as a settable gen parameter. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/11610)
Diffstat (limited to 'doc/man7/EVP_SIGNATURE-RSA.pod')
-rw-r--r--doc/man7/EVP_SIGNATURE-RSA.pod112
1 files changed, 112 insertions, 0 deletions
diff --git a/doc/man7/EVP_SIGNATURE-RSA.pod b/doc/man7/EVP_SIGNATURE-RSA.pod
new file mode 100644
index 0000000000..0cc3336bc9
--- /dev/null
+++ b/doc/man7/EVP_SIGNATURE-RSA.pod
@@ -0,0 +1,112 @@
+=pod
+
+=head1 NAME
+
+EVP_SIGNATURE-RSA
+- The EVP_PKEY RSA signature implementation
+
+=head1 DESCRIPTION
+
+Support for computing RSA signatures.
+See L<EVP_PKEY-RSA(7)> for information related to RSA keys.
+
+=head2 Signature Parameters
+
+The following signature parameters can be set using EVP_PKEY_CTX_set_params().
+This may be called after EVP_PKEY_sign_init() or EVP_PKEY_verify_init(),
+and before calling EVP_PKEY_sign() or EVP_PKEY_verify().
+
+=over 4
+
+=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
+
+=item "properties" (B<OSSL_SIGNATURE_PARAM_PROPERTIES>) <UTF8 string>
+
+These common parameters are described in L<provider-signature(7)>.
+
+=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>
+
+The type of padding to be used. Its value can be one of the following:
+
+=over 4
+
+=item "none" (B<OSSL_PKEY_RSA_PAD_MODE_NONE>)
+
+=item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)
+
+=item "sslv23" (B<OSSL_PKEY_RSA_PAD_MODE_SSLV23>)
+
+=item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)
+
+=item "pss" (B<OSSL_PKEY_RSA_PAD_MODE_PSS>)
+
+=back
+
+=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>
+
+The digest algorithm name to use for the maskGenAlgorithm used by "pss" mode.
+
+=item "mgf1-properties" (B<OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES>) <UTF8 string>
+
+Sets the name of the property query associated with the "mgf1-digest" algorithm.
+NULL is used if this optional value is not set.
+
+=item "pss-saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <UTF8 string>
+
+Set or get the "pss" mode minimum salt length. The value can either be a string
+value representing a number or one of the following:
+
+=over 4
+
+=item "digest" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST>)
+
+Use the same length as the digest size.
+
+=item "max" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_MAX>)
+
+Use the maximum salt length.
+
+=item "auto" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO>)
+
+Auto detect the salt length.
+
+=back
+
+=back
+
+The following signature parameters can be retrieved using
+EVP_PKEY_CTX_get_params().
+
+=over 4
+
+=item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string>
+
+This common parameter is described in L<provider-signature(7)>.
+
+=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
+
+=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>
+
+=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>
+
+These parameters are as described above.
+
+=back
+
+=head1 SEE ALSO
+
+L<EVP_PKEY_CTX_set_params(3)>,
+L<EVP_PKEY_sign(3)>,
+L<EVP_PKEY_verify(3)>,
+L<provider-signature(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