Debian Codegraph @

upstream/debian-unstable/man7/EVP_SIGNATURE-DSA.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_SIGNATURE-DSA 7SSL"
58 .TH EVP_SIGNATURE-DSA 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_SIGNATURE\-DSA
65 \&\- The EVP_PKEY DSA signature implementation
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Support for computing DSA signatures. The signature produced with
69 \&\fBEVP_PKEY_sign\fR\|(3) is DER encoded ASN.1 in the form described in
70 RFC 3279, section 2.2.2.
71 See \fBEVP_PKEY\-DSA\fR\|(7) for information related to DSA keys.
72 .PP
73 As part of FIPS 140\-3 DSA is not longer FIPS approved for key generation and
74 signature validation, but is still allowed for signature verification.
75 .SS "Algorithm Names"
76 .IX Subsection "Algorithm Names"
77 In this list, names are grouped together to signify that they are the same
78 algorithm having multiple names. This also includes the OID in canonical
79 decimal form (which means that they are possible to fetch if the caller has a
80 mere OID which came out in this form after a call to \fBOBJ_obj2txt\fR\|(3)).
81 .IP """DSA"", ""dsaEncryption"", ""1.2.840.10040.4.1""" 4
82 .IX Item """DSA"", ""dsaEncryption"", ""1.2.840.10040.4.1"""
83 The base signature algorithm, supported explicitly fetched with
84 \&\fBEVP_PKEY_sign_init_ex2\fR\|(3), and implicitly fetched (through
85 EC keys) with \fBEVP_DigestSignInit\fR\|(3) and
86 \&\fBEVP_DigestVerifyInit\fR\|(3).
87 .Sp
88 It can't be used with \fBEVP_PKEY_sign_message_init\fR\|(3)
89 .IP """DSA\-SHA1"", ""DSA\-SHA\-1"", ""dsaWithSHA1"", ""1.2.840.10040.4.3""" 4
90 .IX Item """DSA-SHA1"", ""DSA-SHA-1"", ""dsaWithSHA1"", ""1.2.840.10040.4.3"""
91 .PD 0
92 .IP """DSA\-SHA2\-224"", ""DSA\-SHA224"", ""dsa_with_SHA224"", ""2.16.840.1.101.3.4.3.1""" 4
93 .IX Item """DSA-SHA2-224"", ""DSA-SHA224"", ""dsa_with_SHA224"", ""2.16.840.1.101.3.4.3.1"""
94 .IP """DSA\-SHA2\-256"", ""DSA\-SHA256"", ""dsa_with_SHA256"", ""2.16.840.1.101.3.4.3.2""" 4
95 .IX Item """DSA-SHA2-256"", ""DSA-SHA256"", ""dsa_with_SHA256"", ""2.16.840.1.101.3.4.3.2"""
96 .IP """DSA\-SHA2\-384"", ""DSA\-SHA384"", ""dsa_with_SHA384"", ""id\-dsa\-with\-sha384"", ""1.2.840.1.101.3.4.3.3""" 4
97 .IX Item """DSA-SHA2-384"", ""DSA-SHA384"", ""dsa_with_SHA384"", ""id-dsa-with-sha384"", ""1.2.840.1.101.3.4.3.3"""
98 .IP """DSA\-SHA2\-512"", ""DSA\-SHA512"", ""dsa_with_SHA512"", ""id\-dsa\-with\-sha512"", ""1.2.840.1.101.3.4.3.4""" 4
99 .IX Item """DSA-SHA2-512"", ""DSA-SHA512"", ""dsa_with_SHA512"", ""id-dsa-with-sha512"", ""1.2.840.1.101.3.4.3.4"""
100 .IP """DSA\-SHA3\-224"", ""dsa_with_SHA3\-224"", ""id\-dsa\-with\-sha3\-224"", ""2.16.840.1.101.3.4.3.5""" 4
101 .IX Item """DSA-SHA3-224"", ""dsa_with_SHA3-224"", ""id-dsa-with-sha3-224"", ""2.16.840.1.101.3.4.3.5"""
102 .IP """DSA\-SHA3\-256"", ""dsa_with_SHA3\-256"", ""id\-dsa\-with\-sha3\-256"", ""2.16.840.1.101.3.4.3.6""" 4
103 .IX Item """DSA-SHA3-256"", ""dsa_with_SHA3-256"", ""id-dsa-with-sha3-256"", ""2.16.840.1.101.3.4.3.6"""
104 .IP """DSA\-SHA3\-384"", ""dsa_with_SHA3\-384"", ""id\-dsa\-with\-sha3\-384"", ""2.16.840.1.101.3.4.3.7""" 4
105 .IX Item """DSA-SHA3-384"", ""dsa_with_SHA3-384"", ""id-dsa-with-sha3-384"", ""2.16.840.1.101.3.4.3.7"""
106 .IP """DSA\-SHA3\-512"", ""dsa_with_SHA3\-512"", ""id\-dsa\-with\-sha3\-512"", ""2.16.840.1.101.3.4.3.8""" 4
107 .IX Item """DSA-SHA3-512"", ""dsa_with_SHA3-512"", ""id-dsa-with-sha3-512"", ""2.16.840.1.101.3.4.3.8"""
108 .PD
109 DSA signature schemes with diverse message digest algorithms. They are all
110 supported explicitly fetched with \fBEVP_PKEY_sign_init_ex2\fR\|(3) and
111 \&\fBEVP_PKEY_sign_message_init\fR\|(3).
112 .SS "Signature Parameters"
113 .IX Subsection "Signature Parameters"
114 The following signature parameters can be set using \fBEVP_PKEY_CTX_set_params()\fR.
115 This may be called after \fBEVP_PKEY_sign_init()\fR or \fBEVP_PKEY_verify_init()\fR,
116 and before calling \fBEVP_PKEY_sign()\fR or \fBEVP_PKEY_verify()\fR. They may also be set
117 using \fBEVP_PKEY_sign_init_ex()\fR or \fBEVP_PKEY_verify_init_ex()\fR.
118 .IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
119 .IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
120 .PD 0
121 .IP """properties"" (\fBOSSL_SIGNATURE_PARAM_PROPERTIES\fR) <UTF8 string>" 4
122 .IX Item """properties"" (OSSL_SIGNATURE_PARAM_PROPERTIES) <UTF8 string>"
123 .PD
124 These two are not supported with the DSA signature schemes that already
125 include a message digest algorithm, See "Algorithm Names" above.
126 .IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
127 .IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
128 .PD 0
129 .IP """key-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
130 .IX Item """key-check"" (OSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK) <integer>"
131 .IP """digest-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK\fR) <integer>" 4
132 .IX Item """digest-check"" (OSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK) <integer>"
133 .IP """sign-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_SIGN_CHECK\fR) <int>" 4
134 .IX Item """sign-check"" (OSSL_SIGNATURE_PARAM_FIPS_SIGN_CHECK) <int>"
135 .PD
136 The settable parameters are described in \fBprovider\-signature\fR\|(7).
137 .PP
138 The following signature parameters can be retrieved using
139 \&\fBEVP_PKEY_CTX_get_params()\fR.
140 .IP """algorithm-id"" (\fBOSSL_SIGNATURE_PARAM_ALGORITHM_ID\fR) <octet string>" 4
141 .IX Item """algorithm-id"" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>"
142 .PD 0
143 .IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
144 .IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
145 .IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
146 .IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
147 .IP """fips-indicator"" (\fBOSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
148 .IX Item """fips-indicator"" (OSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
149 .PD
150 The gettable parameters are described in \fBprovider\-signature\fR\|(7).
151 .SH "SEE ALSO"
152 .IX Header "SEE ALSO"
153 \&\fBEVP_PKEY_CTX_set_params\fR\|(3),
154 \&\fBEVP_PKEY_sign\fR\|(3),
155 \&\fBEVP_PKEY_verify\fR\|(3),
156 \&\fBprovider\-signature\fR\|(7),
157 .SH HISTORY
158 .IX Header "HISTORY"
159 DSA Key generation and signature generation are no longer FIPS approved in
160 OpenSSL 3.4. See "FIPS indicators" in \fBfips_module\fR\|(7) for more information.
161 .SH COPYRIGHT
162 .IX Header "COPYRIGHT"
163 Copyright 2020\-2026 The OpenSSL Project Authors. All Rights Reserved.
164 .PP
165 Licensed under the Apache License 2.0 (the "License"). You may not use
166 this file except in compliance with the License. You can obtain a copy
167 in the file LICENSE in the source distribution or at
168 <https://www.openssl.org/source/license.html>.