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