xref: /freebsd/crypto/openssl/doc/man7/EVP_ASYM_CIPHER-RSA.pod (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1=pod
2
3=head1 NAME
4
5EVP_ASYM_CIPHER-RSA
6- RSA Asymmetric Cipher algorithm support
7
8=head1 DESCRIPTION
9
10Asymmetric Cipher support for the B<RSA> key type.
11
12=head2 RSA Asymmetric Cipher parameters
13
14=over 4
15
16=item "pad-mode" (B<OSSL_ASYM_CIPHER_PARAM_PAD_MODE>) <UTF8 string>
17
18The default provider understands these RSA padding modes in string form:
19
20=over 4
21
22=item "none" (B<OSSL_PKEY_RSA_PAD_MODE_NONE>)
23
24=item "oaep" (B<OSSL_PKEY_RSA_PAD_MODE_OAEP>)
25
26=item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)
27
28=item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)
29
30=back
31
32=item "pad-mode" (B<OSSL_ASYM_CIPHER_PARAM_PAD_MODE>) <integer>
33
34The default provider understands these RSA padding modes in integer form:
35
36=over 4
37
38=item 1 (B<RSA_PKCS1_PADDING>)
39
40=item 3 (B<RSA_NO_PADDING>)
41
42=item 4 (B<RSA_PKCS1_OAEP_PADDING>)
43
44=item 5 (B<RSA_X931_PADDING>)
45
46=back
47
48See L<EVP_PKEY_CTX_set_rsa_padding(3)> for further details.
49
50=item "digest" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST>) <UTF8 string>
51
52=item "digest-props" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS>) <UTF8 string>
53
54=item "mgf1-digest" (B<OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST>) <UTF8 string>
55
56=item "mgf1-digest-props" (B<OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS>) <UTF8 string>
57
58=item "oaep-label" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL>) <octet string>
59
60=item "tls-client-version" (B<OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION>) <unsigned integer>
61
62See B<RSA_PKCS1_WITH_TLS_PADDING> on the page L<EVP_PKEY_CTX_set_rsa_padding(3)>.
63
64=item "tls-negotiated-version" (B<OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION>) <unsigned integer>
65
66See B<RSA_PKCS1_WITH_TLS_PADDING> on the page L<EVP_PKEY_CTX_set_rsa_padding(3)>.
67
68See L<provider-asym_cipher(7)/Asymmetric Cipher Parameters> for more information.
69
70=back
71
72=head1 SEE ALSO
73
74L<EVP_PKEY-RSA(7)>,
75L<EVP_PKEY(3)>,
76L<provider-asym_cipher(7)>,
77L<provider-keymgmt(7)>,
78L<OSSL_PROVIDER-default(7)>
79L<OSSL_PROVIDER-FIPS(7)>
80
81=head1 COPYRIGHT
82
83Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
84
85Licensed under the Apache License 2.0 (the "License").  You may not use
86this file except in compliance with the License.  You can obtain a copy
87in the file LICENSE in the source distribution or at
88L<https://www.openssl.org/source/license.html>.
89
90=cut
91