Debian Codegraph @

upstream/debian-unstable/man7/EVP_ASYM_CIPHER-RSA.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_ASYM_CIPHER-RSA 7SSL"
58 .TH EVP_ASYM_CIPHER-RSA 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_ASYM_CIPHER\-RSA
65 \&\- RSA Asymmetric Cipher algorithm support
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Asymmetric Cipher support for the \fBRSA\fR key type.
69 .SS "RSA Asymmetric Cipher parameters"
70 .IX Subsection "RSA Asymmetric Cipher parameters"
71 .IP """pad-mode"" (\fBOSSL_ASYM_CIPHER_PARAM_PAD_MODE\fR) <UTF8 string>" 4
72 .IX Item """pad-mode"" (OSSL_ASYM_CIPHER_PARAM_PAD_MODE) <UTF8 string>"
73 The default provider understands these RSA padding modes in string form:
74 .RS 4
75 .IP """none"" (\fBOSSL_PKEY_RSA_PAD_MODE_NONE\fR)" 4
76 .IX Item """none"" (OSSL_PKEY_RSA_PAD_MODE_NONE)"
77 .PD 0
78 .IP """oaep"" (\fBOSSL_PKEY_RSA_PAD_MODE_OAEP\fR)" 4
79 .IX Item """oaep"" (OSSL_PKEY_RSA_PAD_MODE_OAEP)"
80 .IP """pkcs1"" (\fBOSSL_PKEY_RSA_PAD_MODE_PKCSV15\fR)" 4
81 .IX Item """pkcs1"" (OSSL_PKEY_RSA_PAD_MODE_PKCSV15)"
82 .PD
83 This padding mode is no longer supported by the FIPS provider for key
84 agreement and key transport.
85 (This is a FIPS 140\-3 requirement).
86 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-rsa_pkcs15_pad_disabled\fR.
87 .IP """x931"" (\fBOSSL_PKEY_RSA_PAD_MODE_X931\fR)" 4
88 .IX Item """x931"" (OSSL_PKEY_RSA_PAD_MODE_X931)"
89 .RE
90 .RS 4
91 .RE
92 .PD 0
93 .IP """pad-mode"" (\fBOSSL_ASYM_CIPHER_PARAM_PAD_MODE\fR) <integer>" 4
94 .IX Item """pad-mode"" (OSSL_ASYM_CIPHER_PARAM_PAD_MODE) <integer>"
95 .PD
96 The default provider understands these RSA padding modes in integer form:
97 .RS 4
98 .IP "1 (\fBRSA_PKCS1_PADDING\fR)" 4
99 .IX Item "1 (RSA_PKCS1_PADDING)"
100 This padding mode is no longer supported by the FIPS provider for key
101 agreement and key transport.
102 (This is a FIPS 140\-3 requirement)
103 .IP "3 (\fBRSA_NO_PADDING\fR)" 4
104 .IX Item "3 (RSA_NO_PADDING)"
105 .PD 0
106 .IP "4 (\fBRSA_PKCS1_OAEP_PADDING\fR)" 4
107 .IX Item "4 (RSA_PKCS1_OAEP_PADDING)"
108 .IP "5 (\fBRSA_X931_PADDING\fR)" 4
109 .IX Item "5 (RSA_X931_PADDING)"
110 .RE
111 .RS 4
112 .PD
113 .Sp
114 See \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3) for further details.
115 .RE
116 .IP """digest"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST\fR) <UTF8 string>" 4
117 .IX Item """digest"" (OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST) <UTF8 string>"
118 .PD 0
119 .IP """digest-props"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS\fR) <UTF8 string>" 4
120 .IX Item """digest-props"" (OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS) <UTF8 string>"
121 .IP """mgf1\-digest"" (\fBOSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST\fR) <UTF8 string>" 4
122 .IX Item """mgf1-digest"" (OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST) <UTF8 string>"
123 .IP """mgf1\-digest\-props"" (\fBOSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS\fR) <UTF8 string>" 4
124 .IX Item """mgf1-digest-props"" (OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS) <UTF8 string>"
125 .IP """oaep-label"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_LABEL\fR) <octet string>" 4
126 .IX Item """oaep-label"" (OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL) <octet string>"
127 .IP """tls-client-version"" (\fBOSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION\fR) <unsigned integer>" 4
128 .IX Item """tls-client-version"" (OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION) <unsigned integer>"
129 .PD
130 See \fBRSA_PKCS1_WITH_TLS_PADDING\fR on the page \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3).
131 .IP """tls-negotiated-version"" (\fBOSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION\fR) <unsigned integer>" 4
132 .IX Item """tls-negotiated-version"" (OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION) <unsigned integer>"
133 See \fBRSA_PKCS1_WITH_TLS_PADDING\fR on the page \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3).
134 .Sp
135 See "Asymmetric Cipher Parameters" in \fBprovider\-asym_cipher\fR\|(7) for more information.
136 .PP
137 The OpenSSL FIPS provider also supports the following parameters:
138 .IP """fips-indicator"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
139 .IX Item """fips-indicator"" (OSSL_ASYM_CIPHER_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
140 .PD 0
141 .IP """key-check"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
142 .IX Item """key-check"" (OSSL_ASYM_CIPHER_PARAM_FIPS_KEY_CHECK) <integer>"
143 .PD
144 See "Asymmetric Cipher Parameters" in \fBprovider\-asym_cipher\fR\|(7) for more information.
145 .IP """pkcs15\-pad\-disabled"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_RSA_PKCS15_PAD_DISABLED\fR) <integer>" 4
146 .IX Item """pkcs15-pad-disabled"" (OSSL_ASYM_CIPHER_PARAM_FIPS_RSA_PKCS15_PAD_DISABLED) <integer>"
147 The default value of 1 causes an error during encryption if the RSA padding
148 mode is set to "pkcs1".
149 Setting this to zero will ignore the error and set the approved
150 "fips-indicator" to 0.
151 This option breaks FIPS compliance if it causes the approved "fips-indicator"
152 to return 0.
153 .SH "SEE ALSO"
154 .IX Header "SEE ALSO"
155 \&\fBEVP_PKEY\-RSA\fR\|(7),
156 \&\fBEVP_PKEY\fR\|(3),
157 \&\fBprovider\-asym_cipher\fR\|(7),
158 \&\fBprovider\-keymgmt\fR\|(7),
159 \&\fBOSSL_PROVIDER\-default\fR\|(7)
160 \&\fBOSSL_PROVIDER\-FIPS\fR\|(7)
161 .SH COPYRIGHT
162 .IX Header "COPYRIGHT"
163 Copyright 2022\-2025 The OpenSSL Project Authors. All Rights Reserved.
164 .PP
165 Licensed under the Apache License 2.0 (the "License"). You may not use
166 this file except in compliance with the License. You can obtain a copy
167 in the file LICENSE in the source distribution or at
168 <https://www.openssl.org/source/license.html>.