169 lines
6.0 KiB
HTML
169 lines
6.0 KiB
HTML
|
<?xml version="1.0" ?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<title>EVP_SIGNATURE-RSA</title>
|
||
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||
|
|
<link rev="made" href="mailto:" />
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<ul id="index">
|
||
|
|
<li><a href="#NAME">NAME</a></li>
|
||
|
|
<li><a href="#DESCRIPTION">DESCRIPTION</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#Signature-Parameters">Signature Parameters</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||
|
|
<li><a href="#COPYRIGHT">COPYRIGHT</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h1 id="NAME">NAME</h1>
|
||
|
|
|
||
|
|
<p>EVP_SIGNATURE-RSA - The EVP_PKEY RSA signature implementation</p>
|
||
|
|
|
||
|
|
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||
|
|
|
||
|
|
<p>Support for computing RSA signatures. See <a href="../man7/EVP_PKEY-RSA.html">EVP_PKEY-RSA(7)</a> for information related to RSA keys.</p>
|
||
|
|
|
||
|
|
<h2 id="Signature-Parameters">Signature Parameters</h2>
|
||
|
|
|
||
|
|
<p>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().</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt id="digest-OSSL_SIGNATURE_PARAM_DIGEST-UTF8-string">"digest" (<b>OSSL_SIGNATURE_PARAM_DIGEST</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="properties-OSSL_SIGNATURE_PARAM_PROPERTIES-UTF8-string">"properties" (<b>OSSL_SIGNATURE_PARAM_PROPERTIES</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>These common parameters are described in <a href="../man7/provider-signature.html">provider-signature(7)</a>.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="pad-mode-OSSL_SIGNATURE_PARAM_PAD_MODE-UTF8-string">"pad-mode" (<b>OSSL_SIGNATURE_PARAM_PAD_MODE</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>The type of padding to be used. Its value can be one of the following:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt id="none-OSSL_PKEY_RSA_PAD_MODE_NONE">"none" (<b>OSSL_PKEY_RSA_PAD_MODE_NONE</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="pkcs1-OSSL_PKEY_RSA_PAD_MODE_PKCSV15">"pkcs1" (<b>OSSL_PKEY_RSA_PAD_MODE_PKCSV15</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="x931-OSSL_PKEY_RSA_PAD_MODE_X931">"x931" (<b>OSSL_PKEY_RSA_PAD_MODE_X931</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="pss-OSSL_PKEY_RSA_PAD_MODE_PSS">"pss" (<b>OSSL_PKEY_RSA_PAD_MODE_PSS</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="mgf1-digest-OSSL_SIGNATURE_PARAM_MGF1_DIGEST-UTF8-string">"mgf1-digest" (<b>OSSL_SIGNATURE_PARAM_MGF1_DIGEST</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>The digest algorithm name to use for the maskGenAlgorithm used by "pss" mode.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="mgf1-properties-OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES-UTF8-string">"mgf1-properties" (<b>OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>Sets the name of the property query associated with the "mgf1-digest" algorithm. NULL is used if this optional value is not set.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="saltlen-OSSL_SIGNATURE_PARAM_PSS_SALTLEN-integer-or-UTF8-string">"saltlen" (<b>OSSL_SIGNATURE_PARAM_PSS_SALTLEN</b>) <integer> or <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>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:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt id="digest-OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST">"digest" (<b>OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>Use the same length as the digest size.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="max-OSSL_PKEY_RSA_PSS_SALT_LEN_MAX">"max" (<b>OSSL_PKEY_RSA_PSS_SALT_LEN_MAX</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>Use the maximum salt length.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="auto-OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO">"auto" (<b>OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>Auto detect the salt length.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="auto-digestmax-OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO_DIGEST_MAX">"auto-digestmax" (<b>OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO_DIGEST_MAX</b>)</dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>The following signature parameters can be retrieved using EVP_PKEY_CTX_get_params().</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt id="algorithm-id-OSSL_SIGNATURE_PARAM_ALGORITHM_ID-octet-string">"algorithm-id" (<b>OSSL_SIGNATURE_PARAM_ALGORITHM_ID</b>) <octet string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>This common parameter is described in <a href="../man7/provider-signature.html">provider-signature(7)</a>.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="digest-OSSL_SIGNATURE_PARAM_DIGEST-UTF8-string1">"digest" (<b>OSSL_SIGNATURE_PARAM_DIGEST</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="pad-mode-OSSL_SIGNATURE_PARAM_PAD_MODE-UTF8-string1">"pad-mode" (<b>OSSL_SIGNATURE_PARAM_PAD_MODE</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="mgf1-digest-OSSL_SIGNATURE_PARAM_MGF1_DIGEST-UTF8-string1">"mgf1-digest" (<b>OSSL_SIGNATURE_PARAM_MGF1_DIGEST</b>) <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id="saltlen-OSSL_SIGNATURE_PARAM_PSS_SALTLEN-integer-or-UTF8-string1">"saltlen" (<b>OSSL_SIGNATURE_PARAM_PSS_SALTLEN</b>) <integer> or <UTF8 string></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>These parameters are as described above.</p>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||
|
|
|
||
|
|
<p><a href="../man3/EVP_PKEY_CTX_set_params.html">EVP_PKEY_CTX_set_params(3)</a>, <a href="../man3/EVP_PKEY_sign.html">EVP_PKEY_sign(3)</a>, <a href="../man3/EVP_PKEY_verify.html">EVP_PKEY_verify(3)</a>, <a href="../man7/provider-signature.html">provider-signature(7)</a>,</p>
|
||
|
|
|
||
|
|
<h1 id="COPYRIGHT">COPYRIGHT</h1>
|
||
|
|
|
||
|
|
<p>Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.</p>
|
||
|
|
|
||
|
|
<p>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 <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|
||
|
|
|
||
|
|
|