xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/EVP_SIGNATURE-RSA.7 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: EVP_SIGNATURE-RSA.7,v 1.5 2024/09/08 13:08:24 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

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'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "EVP_SIGNATURE-RSA 7"
EVP_SIGNATURE-RSA 7 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
EVP_SIGNATURE-RSA \- The EVP_PKEY RSA signature implementation
DESCRIPTION
Header "DESCRIPTION" Support for computing RSA signatures. See EVP_PKEY-RSA\|(7) for information related to RSA keys.
"Signature Parameters"
Subsection "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().
"""digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>" 4
Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"

0

"""properties"" (OSSL_SIGNATURE_PARAM_PROPERTIES) <UTF8 string>" 4
Item """properties"" (OSSL_SIGNATURE_PARAM_PROPERTIES) <UTF8 string>"

These common parameters are described in provider-signature\|(7).

"""pad-mode"" (OSSL_SIGNATURE_PARAM_PAD_MODE) <UTF8 string>" 4
Item """pad-mode"" (OSSL_SIGNATURE_PARAM_PAD_MODE) <UTF8 string>" The type of padding to be used. Its value can be one of the following:

"""none"" (OSSL_PKEY_RSA_PAD_MODE_NONE)" 4
Item """none"" (OSSL_PKEY_RSA_PAD_MODE_NONE)"

0

"""pkcs1"" (OSSL_PKEY_RSA_PAD_MODE_PKCSV15)" 4
Item """pkcs1"" (OSSL_PKEY_RSA_PAD_MODE_PKCSV15)"
"""x931"" (OSSL_PKEY_RSA_PAD_MODE_X931)" 4
Item """x931"" (OSSL_PKEY_RSA_PAD_MODE_X931)"
"""pss"" (OSSL_PKEY_RSA_PAD_MODE_PSS)" 4
Item """pss"" (OSSL_PKEY_RSA_PAD_MODE_PSS)"

"""mgf1-digest"" (OSSL_SIGNATURE_PARAM_MGF1_DIGEST) <UTF8 string>" 4
Item """mgf1-digest"" (OSSL_SIGNATURE_PARAM_MGF1_DIGEST) <UTF8 string>"

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

"""mgf1-properties"" (OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES) <UTF8 string>" 4
Item """mgf1-properties"" (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.
"""saltlen"" (OSSL_SIGNATURE_PARAM_PSS_SALTLEN) <integer> or <UTF8 string>" 4
Item """saltlen"" (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:

"""digest"" (OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST)" 4
Item """digest"" (OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST)" Use the same length as the digest size.
"""max"" (OSSL_PKEY_RSA_PSS_SALT_LEN_MAX)" 4
Item """max"" (OSSL_PKEY_RSA_PSS_SALT_LEN_MAX)" Use the maximum salt length.
"""auto"" (OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO)" 4
Item """auto"" (OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO)" Auto detect the salt length.

The following signature parameters can be retrieved using \fBEVP_PKEY_CTX_get_params().

"""algorithm-id"" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>" 4
Item """algorithm-id"" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>" This common parameter is described in provider-signature\|(7).
"""digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>" 4
Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"

0

"""pad-mode"" (OSSL_SIGNATURE_PARAM_PAD_MODE) <UTF8 string>" 4
Item """pad-mode"" (OSSL_SIGNATURE_PARAM_PAD_MODE) <UTF8 string>"
"""mgf1-digest"" (OSSL_SIGNATURE_PARAM_MGF1_DIGEST) <UTF8 string>" 4
Item """mgf1-digest"" (OSSL_SIGNATURE_PARAM_MGF1_DIGEST) <UTF8 string>"
"""saltlen"" (OSSL_SIGNATURE_PARAM_PSS_SALTLEN) <integer> or <UTF8 string>" 4
Item """saltlen"" (OSSL_SIGNATURE_PARAM_PSS_SALTLEN) <integer> or <UTF8 string>"

These parameters are as described above.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_PKEY_CTX_set_params\|(3), \fBEVP_PKEY_sign\|(3), \fBEVP_PKEY_verify\|(3), \fBprovider-signature\|(7),
COPYRIGHT
Header "COPYRIGHT" Copyright 2020-2022 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 <https://www.openssl.org/source/license.html>.