[thirdparty/openssl.git] / doc / man7 / EVP_SIGNATURE-RSA.pod

=pod

=head1 NAME

EVP_SIGNATURE-RSA
- The EVP_PKEY RSA signature implementation

=head1 DESCRIPTION

Support for computing RSA signatures.
See L<EVP_PKEY-RSA(7)> for information related to RSA keys.

=head2 Signature Parameters

The following signature parameters can be set using EVP_PKEY_CTX_set_params().
This may be called after EVP_PKEY_sign_init() or EVP_PKEY_verify_init(),
and before calling EVP_PKEY_sign() or EVP_PKEY_verify().

=over 4

=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>

=item "properties" (B<OSSL_SIGNATURE_PARAM_PROPERTIES>) <UTF8 string>

These common parameters are described in L<provider-signature(7)>.

=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>

The type of padding to be used. Its value can be one of the following:

=over 4

=item "none" (B<OSSL_PKEY_RSA_PAD_MODE_NONE>)

=item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)

=item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)

=item "pss" (B<OSSL_PKEY_RSA_PAD_MODE_PSS>)

=back

=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>

The digest algorithm name to use for the maskGenAlgorithm used by "pss" mode.

=item "mgf1-properties" (B<OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES>) <UTF8 string>

Sets the name of the property query associated with the "mgf1-digest" algorithm.
NULL is used if this optional value is not set.

=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>

The "pss" mode minimum salt length. The value can either be an integer,
a string value representing a number or one of the following string values:

=over 4

=item "digest" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST>)

Use the same length as the digest size.

=item "max" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_MAX>)

Use the maximum salt length.

=item "auto" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO>)

Auto detect the salt length.

=item "auto-digestmax" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO_DIGEST_MAX>)

Auto detect the salt length when verifying.  Maximize the salt length up to the
digest size when signing to comply with FIPS 186-4 section 5.5.

=back

=back

The following signature parameters can be retrieved using
EVP_PKEY_CTX_get_params().

=over 4

=item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string>

This common parameter is described in L<provider-signature(7)>.

=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>

=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>

=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>

=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>

These parameters are as described above.

=back

=head1 SEE ALSO

L<EVP_PKEY_CTX_set_params(3)>,
L<EVP_PKEY_sign(3)>,
L<EVP_PKEY_verify(3)>,
L<provider-signature(7)>,

=head1 COPYRIGHT

Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

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
L<https://www.openssl.org/source/license.html>.

=cut
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(),
57cd10dd	17	and before calling EVP_PKEY_sign() or EVP_PKEY_verify().
b8086652 SL	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
57cd10dd	35	=item "pkcs1" (B<OSSL_PKEY_RSA_PAD_MODE_PKCSV15>)
b8086652	36
b8086652 SL	37	=item "x931" (B<OSSL_PKEY_RSA_PAD_MODE_X931>)
b8086652 SL	38
57cd10dd	39	=item "pss" (B<OSSL_PKEY_RSA_PAD_MODE_PSS>)
b8086652 SL	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
d104c6ff	52	=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>
b8086652	53
d104c6ff A	54	The "pss" mode minimum salt length. The value can either be an integer,
d104c6ff A	55	a string value representing a number or one of the following string values:
b8086652 SL	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
6c73ca4a CL	71	=item "auto-digestmax" (B<OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO_DIGEST_MAX>)
	72
	73	Auto detect the salt length when verifying. Maximize the salt length up to the
	74	digest size when signing to comply with FIPS 186-4 section 5.5.
	75
b8086652 SL	76	=back
	77
	78	=back
	79
	80	The following signature parameters can be retrieved using
	81	EVP_PKEY_CTX_get_params().
	82
	83	=over 4
	84
	85	=item "algorithm-id" (B<OSSL_SIGNATURE_PARAM_ALGORITHM_ID>) <octet string>
	86
	87	This common parameter is described in L<provider-signature(7)>.
	88
	89	=item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
	90
	91	=item "pad-mode" (B<OSSL_SIGNATURE_PARAM_PAD_MODE>) <UTF8 string>
	92
	93	=item "mgf1-digest" (B<OSSL_SIGNATURE_PARAM_MGF1_DIGEST>) <UTF8 string>
	94
d104c6ff A	95	=item "saltlen" (B<OSSL_SIGNATURE_PARAM_PSS_SALTLEN>) <integer> or <UTF8 string>
d104c6ff A	96
b8086652 SL	97	These parameters are as described above.
	98
	99	=back
	100
	101	=head1 SEE ALSO
	102
	103	L<EVP_PKEY_CTX_set_params(3)>,
	104	L<EVP_PKEY_sign(3)>,
	105	L<EVP_PKEY_verify(3)>,
	106	L<provider-signature(7)>,
	107
	108	=head1 COPYRIGHT
	109
8020d79b	110	Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
b8086652 SL	111
	112	Licensed under the Apache License 2.0 (the "License"). You may not use
	113	this file except in compliance with the License. You can obtain a copy
	114	in the file LICENSE in the source distribution or at
	115	L<https://www.openssl.org/source/license.html>.
	116
	117	=cut