]>
Commit | Line | Data |
---|---|---|
b8086652 SL |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | EVP_SIGNATURE-RSA | |
6 | - The EVP_PKEY RSA signature implementation | |
7 | ||
8 | =head1 DESCRIPTION | |
9 | ||
10 | Support for computing RSA signatures. | |
11 | See L<EVP_PKEY-RSA(7)> for information related to RSA keys. | |
12 | ||
13 | =head2 Signature Parameters | |
14 | ||
15 | The following signature parameters can be set using EVP_PKEY_CTX_set_params(). | |
16 | This may be called after EVP_PKEY_sign_init() or EVP_PKEY_verify_init(), | |
17 | and 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 | ||
25 | These common parameters are described in L<provider-signature(7)>. | |
26 | ||
27 | =item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string> | |
28 | ||
29 | The 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 | ||
b8086652 SL |
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 | ||
45 | The 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 | ||
49 | Sets the name of the property query associated with the "mgf1-digest" algorithm. | |
50 | NULL is used if this optional value is not set. | |
51 | ||
52 | =item "pss-saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <UTF8 string> | |
53 | ||
54 | Set or get the "pss" mode minimum salt length. The value can either be a string | |
55 | value representing a number or one of the following: | |
56 | ||
57 | =over 4 | |
58 | ||
59 | =item "digest" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST>) | |
60 | ||
61 | Use the same length as the digest size. | |
62 | ||
63 | =item "max" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_MAX>) | |
64 | ||
65 | Use the maximum salt length. | |
66 | ||
67 | =item "auto" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO>) | |
68 | ||
69 | Auto detect the salt length. | |
70 | ||
71 | =back | |
72 | ||
73 | =back | |
74 | ||
75 | The following signature parameters can be retrieved using | |
76 | EVP_PKEY_CTX_get_params(). | |
77 | ||
78 | =over 4 | |
79 | ||
80 | =item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string> | |
81 | ||
82 | This 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 | These parameters are as described above. | |
91 | ||
92 | =back | |
93 | ||
94 | =head1 SEE ALSO | |
95 | ||
96 | L<EVP_PKEY_CTX_set_params(3)>, | |
97 | L<EVP_PKEY_sign(3)>, | |
98 | L<EVP_PKEY_verify(3)>, | |
99 | L<provider-signature(7)>, | |
100 | ||
101 | =head1 COPYRIGHT | |
102 | ||
8020d79b | 103 | Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved. |
b8086652 SL |
104 | |
105 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
106 | this file except in compliance with the License. You can obtain a copy | |
107 | in the file LICENSE in the source distribution or at | |
108 | L<https://www.openssl.org/source/license.html>. | |
109 | ||
110 | =cut |