Android_verify/third_party/openssl/share/man/man7/EVP_SIGNATURE-DSA.7ossl

.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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_SIGNATURE-DSA 7ossl"
.TH EVP_SIGNATURE-DSA 7ossl 2025-01-17 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_SIGNATURE\-DSA
\&\- The EVP_PKEY DSA signature implementation
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Support for computing DSA signatures. The signature produced with
\&\fBEVP_PKEY_sign\fR\|(3) is DER encoded ASN.1 in the form described in
RFC 3279, section 2.2.2.
See \fBEVP_PKEY\-DSA\fR\|(7) for information related to DSA keys.
.PP
As part of FIPS 140\-3 DSA is not longer FIPS approved for key generation and
signature validation, but is still allowed for signature verification.
.SS "Algorithm Names"
.IX Subsection "Algorithm Names"
In this list, names are grouped together to signify that they are the same
algorithm having multiple names.  This also includes the OID in canonical
decimal form (which means that they are possible to fetch if the caller has a
mere OID which came out in this form after a call to \fBOBJ_obj2txt\fR\|(3)).
.IP """DSA"", ""dsaEncryption"", ""1.2.840.10040.4.1""" 4
.IX Item """DSA"", ""dsaEncryption"", ""1.2.840.10040.4.1"""
The base signature algorithm, supported explicitly fetched with
\&\fBEVP_PKEY_sign_init_ex2\fR\|(3), and implicitly fetched (through
EC keys) with \fBEVP_DigestSignInit\fR\|(3) and
\&\fBEVP_DigestVerifyInit\fR\|(3).
.Sp
It can't be used with \fBEVP_PKEY_sign_message_init\fR\|(3)
.IP """DSA\-SHA1"", ""DSA\-SHA\-1"", ""dsaWithSHA1"", ""1.2.840.10040.4.3""" 4
.IX Item """DSA-SHA1"", ""DSA-SHA-1"", ""dsaWithSHA1"", ""1.2.840.10040.4.3"""
.PD 0
.IP """DSA\-SHA2\-224"", ""DSA\-SHA224"", ""dsa_with_SHA224"", ""2.16.840.1.101.3.4.3.1""" 4
.IX Item """DSA-SHA2-224"", ""DSA-SHA224"", ""dsa_with_SHA224"", ""2.16.840.1.101.3.4.3.1"""
.IP """DSA\-SHA2\-256"", ""DSA\-SHA256"", ""dsa_with_SHA256"", ""2.16.840.1.101.3.4.3.2""" 4
.IX Item """DSA-SHA2-256"", ""DSA-SHA256"", ""dsa_with_SHA256"", ""2.16.840.1.101.3.4.3.2"""
.IP """DSA\-SHA2\-384"", ""DSA\-SHA384"", ""dsa_with_SHA384"", ""id\-dsa\-with\-sha384"", ""1.2.840.1.101.3.4.3.3""" 4
.IX Item """DSA-SHA2-384"", ""DSA-SHA384"", ""dsa_with_SHA384"", ""id-dsa-with-sha384"", ""1.2.840.1.101.3.4.3.3"""
.IP """DSA\-SHA2\-512"", ""DSA\-SHA512"", ""dsa_with_SHA512"", ""id\-dsa\-with\-sha512"", ""1.2.840.1.101.3.4.3.4""" 4
.IX Item """DSA-SHA2-512"", ""DSA-SHA512"", ""dsa_with_SHA512"", ""id-dsa-with-sha512"", ""1.2.840.1.101.3.4.3.4"""
.IP """DSA\-SHA3\-224"", ""dsa_with_SHA3\-224"", ""id\-dsa\-with\-sha3\-224"", ""2.16.840.1.101.3.4.3.5""" 4
.IX Item """DSA-SHA3-224"", ""dsa_with_SHA3-224"", ""id-dsa-with-sha3-224"", ""2.16.840.1.101.3.4.3.5"""
.IP """DSA\-SHA3\-256"", ""dsa_with_SHA3\-256"", ""id\-dsa\-with\-sha3\-256"", ""2.16.840.1.101.3.4.3.6""" 4
.IX Item """DSA-SHA3-256"", ""dsa_with_SHA3-256"", ""id-dsa-with-sha3-256"", ""2.16.840.1.101.3.4.3.6"""
.IP """DSA\-SHA3\-384"", ""dsa_with_SHA3\-384"", ""id\-dsa\-with\-sha3\-384"", ""2.16.840.1.101.3.4.3.7""" 4
.IX Item """DSA-SHA3-384"", ""dsa_with_SHA3-384"", ""id-dsa-with-sha3-384"", ""2.16.840.1.101.3.4.3.7"""
.IP """DSA\-SHA3\-512"", ""dsa_with_SHA3\-512"", ""id\-dsa\-with\-sha3\-512"", ""2.16.840.1.101.3.4.3.8""" 4
.IX Item """DSA-SHA3-512"", ""dsa_with_SHA3-512"", ""id-dsa-with-sha3-512"", ""2.16.840.1.101.3.4.3.8"""
.PD
DSA signature schemes with diverse message digest algorithms.  They are all
supported explicitly fetched with \fBEVP_PKEY_sign_init_ex2\fR\|(3) and
\&\fBEVP_PKEY_sign_message_init\fR\|(3).
.SS "Signature Parameters"
.IX Subsection "Signature Parameters"
The following signature parameters can be set using \fBEVP_PKEY_CTX_set_params()\fR.
This may be called after \fBEVP_PKEY_sign_init()\fR or \fBEVP_PKEY_verify_init()\fR,
and before calling \fBEVP_PKEY_sign()\fR or \fBEVP_PKEY_verify()\fR. They may also be set
using \fBEVP_PKEY_sign_init_ex()\fR or \fBEVP_PKEY_verify_init_ex()\fR.
.IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
.IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
.PD 0
.IP """properties"" (\fBOSSL_SIGNATURE_PARAM_PROPERTIES\fR) <UTF8 string>" 4
.IX Item """properties"" (OSSL_SIGNATURE_PARAM_PROPERTIES) <UTF8 string>"
.PD
These two are not supported with the DSA signature schemes that already
include a message digest algorithm, See "Algorithm Names" above.
.IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
.IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
.PD 0
.IP """key-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
.IX Item """key-check"" (OSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK) <integer>"
.IP """digest-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK\fR) <integer>" 4
.IX Item """digest-check"" (OSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK) <integer>"
.IP """sign-check""  (\fBOSSL_SIGNATURE_PARAM_FIPS_SIGN_CHECK\fR) <int>" 4
.IX Item """sign-check"" (OSSL_SIGNATURE_PARAM_FIPS_SIGN_CHECK) <int>"
.PD
The settable parameters are described in \fBprovider\-signature\fR\|(7).
.PP
The following signature parameters can be retrieved using
\&\fBEVP_PKEY_CTX_get_params()\fR.
.IP """algorithm-id"" (\fBOSSL_SIGNATURE_PARAM_ALGORITHM_ID\fR) <octet string>" 4
.IX Item """algorithm-id"" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>"
.PD 0
.IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
.IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
.IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
.IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
.IP """fips-indicator"" (\fBOSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
.IX Item """fips-indicator"" (OSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
.PD
The gettable parameters are described in \fBprovider\-signature\fR\|(7).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBEVP_PKEY_CTX_set_params\fR\|(3),
\&\fBEVP_PKEY_sign\fR\|(3),
\&\fBEVP_PKEY_verify\fR\|(3),
\&\fBprovider\-signature\fR\|(7),
.SH HISTORY
.IX Header "HISTORY"
DSA Key generation and signature generation are no longer FIPS approved in
OpenSSL 3.4. See "FIPS indicators" in \fBfips_module\fR\|(7) for more information.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020\-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
<https://www.openssl.org/source/license.html>.