.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "EVP_ASYM_CIPHER-RSA 7ssl" .TH EVP_ASYM_CIPHER-RSA 7ssl 2024-10-23 3.4.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME EVP_ASYM_CIPHER\-RSA \&\- RSA Asymmetric Cipher algorithm support .SH DESCRIPTION .IX Header "DESCRIPTION" Asymmetric Cipher support for the \fBRSA\fR key type. .SS "RSA Asymmetric Cipher parameters" .IX Subsection "RSA Asymmetric Cipher parameters" .IP """pad-mode"" (\fBOSSL_ASYM_CIPHER_PARAM_PAD_MODE\fR) " 4 .IX Item """pad-mode"" (OSSL_ASYM_CIPHER_PARAM_PAD_MODE) " The default provider understands these RSA padding modes in string form: .RS 4 .IP """none"" (\fBOSSL_PKEY_RSA_PAD_MODE_NONE\fR)" 4 .IX Item """none"" (OSSL_PKEY_RSA_PAD_MODE_NONE)" .PD 0 .IP """oaep"" (\fBOSSL_PKEY_RSA_PAD_MODE_OAEP\fR)" 4 .IX Item """oaep"" (OSSL_PKEY_RSA_PAD_MODE_OAEP)" .IP """pkcs1"" (\fBOSSL_PKEY_RSA_PAD_MODE_PKCSV15\fR)" 4 .IX Item """pkcs1"" (OSSL_PKEY_RSA_PAD_MODE_PKCSV15)" .PD This padding mode is no longer supported by the FIPS provider for key agreement and key transport. (This is a FIPS 140\-3 requirement) .IP """x931"" (\fBOSSL_PKEY_RSA_PAD_MODE_X931\fR)" 4 .IX Item """x931"" (OSSL_PKEY_RSA_PAD_MODE_X931)" .RE .RS 4 .RE .PD 0 .IP """pad-mode"" (\fBOSSL_ASYM_CIPHER_PARAM_PAD_MODE\fR) " 4 .IX Item """pad-mode"" (OSSL_ASYM_CIPHER_PARAM_PAD_MODE) " .PD The default provider understands these RSA padding modes in integer form: .RS 4 .IP "1 (\fBRSA_PKCS1_PADDING\fR)" 4 .IX Item "1 (RSA_PKCS1_PADDING)" This padding mode is no longer supported by the FIPS provider for key agreement and key transport. (This is a FIPS 140\-3 requirement) .IP "3 (\fBRSA_NO_PADDING\fR)" 4 .IX Item "3 (RSA_NO_PADDING)" .PD 0 .IP "4 (\fBRSA_PKCS1_OAEP_PADDING\fR)" 4 .IX Item "4 (RSA_PKCS1_OAEP_PADDING)" .IP "5 (\fBRSA_X931_PADDING\fR)" 4 .IX Item "5 (RSA_X931_PADDING)" .RE .RS 4 .PD .Sp See \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3) for further details. .RE .IP """digest"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST\fR) " 4 .IX Item """digest"" (OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST) " .PD 0 .IP """digest-props"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS\fR) " 4 .IX Item """digest-props"" (OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS) " .IP """mgf1\-digest"" (\fBOSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST\fR) " 4 .IX Item """mgf1-digest"" (OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST) " .IP """mgf1\-digest\-props"" (\fBOSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS\fR) " 4 .IX Item """mgf1-digest-props"" (OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS) " .IP """oaep-label"" (\fBOSSL_ASYM_CIPHER_PARAM_OAEP_LABEL\fR) " 4 .IX Item """oaep-label"" (OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL) " .IP """tls-client-version"" (\fBOSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION\fR) " 4 .IX Item """tls-client-version"" (OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION) " .PD See \fBRSA_PKCS1_WITH_TLS_PADDING\fR on the page \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3). .IP """tls-negotiated-version"" (\fBOSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION\fR) " 4 .IX Item """tls-negotiated-version"" (OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION) " See \fBRSA_PKCS1_WITH_TLS_PADDING\fR on the page \fBEVP_PKEY_CTX_set_rsa_padding\fR\|(3). .Sp See "Asymmetric Cipher Parameters" in \fBprovider\-asym_cipher\fR\|(7) for more information. .PP The OpenSSL FIPS provider also supports the following parameters: .IP """fips-indicator"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_APPROVED_INDICATOR\fR) " 4 .IX Item """fips-indicator"" (OSSL_ASYM_CIPHER_PARAM_FIPS_APPROVED_INDICATOR) " .PD 0 .IP """key-check"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_KEY_CHECK\fR) " 4 .IX Item """key-check"" (OSSL_ASYM_CIPHER_PARAM_FIPS_KEY_CHECK) " .PD See "Asymmetric Cipher Parameters" in \fBprovider\-asym_cipher\fR\|(7) for more information. .IP """pkcs15\-pad\-disabled"" (\fBOSSL_ASYM_CIPHER_PARAM_FIPS_RSA_PKCS15_PAD_DISABLED\fR) " 4 .IX Item """pkcs15-pad-disabled"" (OSSL_ASYM_CIPHER_PARAM_FIPS_RSA_PKCS15_PAD_DISABLED) " The default value of 1 causes an error during encryption if the RSA padding mode is set to "pkcs1". Setting this to zero will ignore the error and set the approved "fips-indicator" to 0. This option breaks FIPS compliance if it causes the approved "fips-indicator" to return 0. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBEVP_PKEY\-RSA\fR\|(7), \&\fBEVP_PKEY\fR\|(3), \&\fBprovider\-asym_cipher\fR\|(7), \&\fBprovider\-keymgmt\fR\|(7), \&\fBOSSL_PROVIDER\-default\fR\|(7) \&\fBOSSL_PROVIDER\-FIPS\fR\|(7) .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2022\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at .