xref: /freebsd/crypto/openssl/doc/man7/EVP_SIGNATURE-RSA.pod (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
1=pod
2
3=head1 NAME
4
5EVP_SIGNATURE-RSA
6- The EVP_PKEY RSA signature implementation
7
8=head1 DESCRIPTION
9
10Support for computing RSA signatures.
11See L<EVP_PKEY-RSA(7)> for information related to RSA keys.
12
13=head2 Signature Parameters
14
15The following signature parameters can be set using EVP_PKEY_CTX_set_params().
16This may be called after EVP_PKEY_sign_init() or EVP_PKEY_verify_init(),
17and before calling EVP_PKEY_sign() or EVP_PKEY_verify().
18
19=over 4
20
21=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
22
23=item "properties" (B<OSSL_SIGNATURE_PARAM_PROPERTIES>) <UTF8 string>
24
25These common parameters are described in L<provider-signature(7)>.
26
27=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>
28
29The type of padding to be used. Its value can be one of the following:
30
31=over 4
32
33=item "none" (B<OSSL_PKEY_RSA_PAD_MODE_NONE>)
34
35=item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)
36
37=item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)
38
39=item "pss" (B<OSSL_PKEY_RSA_PAD_MODE_PSS>)
40
41=back
42
43=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>
44
45The digest algorithm name to use for the maskGenAlgorithm used by "pss" mode.
46
47=item "mgf1-properties" (B<OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES>) <UTF8 string>
48
49Sets the name of the property query associated with the "mgf1-digest" algorithm.
50NULL is used if this optional value is not set.
51
52=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>
53
54The "pss" mode minimum salt length. The value can either be an integer,
55a string value representing a number or one of the following string values:
56
57=over 4
58
59=item "digest" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST>)
60
61Use the same length as the digest size.
62
63=item "max" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_MAX>)
64
65Use the maximum salt length.
66
67=item "auto" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO>)
68
69Auto detect the salt length.
70
71=back
72
73=back
74
75The following signature parameters can be retrieved using
76EVP_PKEY_CTX_get_params().
77
78=over 4
79
80=item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string>
81
82This common parameter is described in L<provider-signature(7)>.
83
84=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
85
86=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>
87
88=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>
89
90=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>
91
92These parameters are as described above.
93
94=back
95
96=head1 SEE ALSO
97
98L<EVP_PKEY_CTX_set_params(3)>,
99L<EVP_PKEY_sign(3)>,
100L<EVP_PKEY_verify(3)>,
101L<provider-signature(7)>,
102
103=head1 COPYRIGHT
104
105Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
106
107Licensed under the Apache License 2.0 (the "License").  You may not use
108this file except in compliance with the License.  You can obtain a copy
109in the file LICENSE in the source distribution or at
110L<https://www.openssl.org/source/license.html>.
111
112=cut
113