Debian Codegraph @

upstream/debian-unstable/man7/EVP_SIGNATURE-ECDSA.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-ECDSA 7SSL"
58 .TH EVP_SIGNATURE-ECDSA 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\-ECDSA \- The EVP_PKEY ECDSA signature implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for computing ECDSA signatures.
68 See \fBEVP_PKEY\-EC\fR\|(7) for information related to EC keys.
69 .SS "Algorithm Names"
70 .IX Subsection "Algorithm Names"
71 In this list, names are grouped together to signify that they are the same
72 algorithm having multiple names. This also includes the OID in canonical
73 decimal form (which means that they are possible to fetch if the caller has a
74 mere OID which came out in this form after a call to \fBOBJ_obj2txt\fR\|(3)).
75 .IP """ECDSA""" 4
76 .IX Item """ECDSA"""
77 The base signature algorithm, supported explicitly fetched with
78 \&\fBEVP_PKEY_sign_init_ex2\fR\|(3), and implicitly fetched (through
79 EC keys) with \fBEVP_DigestSignInit\fR\|(3) and
80 \&\fBEVP_DigestVerifyInit\fR\|(3).
81 .Sp
82 It can't be used with \fBEVP_PKEY_sign_message_init\fR\|(3)
83 .IP """ECDSA\-SHA1"", ""ECDSA\-SHA\-1"", ""ecdsa\-with\-SHA1"", ""1.2.840.10045.4.1""" 4
84 .IX Item """ECDSA-SHA1"", ""ECDSA-SHA-1"", ""ecdsa-with-SHA1"", ""1.2.840.10045.4.1"""
85 .PD 0
86 .IP """ECDSA\-SHA2\-224"", ""ECDSA\-SHA224"", ""ecdsa\-with\-SHA224"", ""1.2.840.10045.4.3.1""" 4
87 .IX Item """ECDSA-SHA2-224"", ""ECDSA-SHA224"", ""ecdsa-with-SHA224"", ""1.2.840.10045.4.3.1"""
88 .IP """ECDSA\-SHA2\-256"", ""ECDSA\-SHA256"", ""ecdsa\-with\-SHA256"", ""1.2.840.10045.4.3.2""" 4
89 .IX Item """ECDSA-SHA2-256"", ""ECDSA-SHA256"", ""ecdsa-with-SHA256"", ""1.2.840.10045.4.3.2"""
90 .IP """ECDSA\-SHA2\-384"", ""ECDSA\-SHA384"", ""ecdsa\-with\-SHA384"", ""1.2.840.10045.4.3.3""" 4
91 .IX Item """ECDSA-SHA2-384"", ""ECDSA-SHA384"", ""ecdsa-with-SHA384"", ""1.2.840.10045.4.3.3"""
92 .IP """ECDSA\-SHA2\-512"", ""ECDSA\-SHA512"", ""ecdsa\-with\-SHA512"", ""1.2.840.10045.4.3.4""" 4
93 .IX Item """ECDSA-SHA2-512"", ""ECDSA-SHA512"", ""ecdsa-with-SHA512"", ""1.2.840.10045.4.3.4"""
94 .IP """ECDSA\-SHA3\-224"", ""ecdsa_with_SHA3\-224"", ""id\-ecdsa\-with\-sha3\-224"", ""2.16.840.1.101.3.4.3.9""" 4
95 .IX Item """ECDSA-SHA3-224"", ""ecdsa_with_SHA3-224"", ""id-ecdsa-with-sha3-224"", ""2.16.840.1.101.3.4.3.9"""
96 .IP """ECDSA\-SHA3\-256"", ""ecdsa_with_SHA3\-256"", ""id\-ecdsa\-with\-sha3\-256"", ""2.16.840.1.101.3.4.3.10""" 4
97 .IX Item """ECDSA-SHA3-256"", ""ecdsa_with_SHA3-256"", ""id-ecdsa-with-sha3-256"", ""2.16.840.1.101.3.4.3.10"""
98 .IP """ECDSA\-SHA3\-384"", ""ecdsa_with_SHA3\-384"", ""id\-ecdsa\-with\-sha3\-384"", ""2.16.840.1.101.3.4.3.11""" 4
99 .IX Item """ECDSA-SHA3-384"", ""ecdsa_with_SHA3-384"", ""id-ecdsa-with-sha3-384"", ""2.16.840.1.101.3.4.3.11"""
100 .IP """ECDSA\-SHA3\-512"", ""ecdsa_with_SHA3\-512"", ""id\-ecdsa\-with\-sha3\-512"", ""2.16.840.1.101.3.4.3.12""" 4
101 .IX Item """ECDSA-SHA3-512"", ""ecdsa_with_SHA3-512"", ""id-ecdsa-with-sha3-512"", ""2.16.840.1.101.3.4.3.12"""
102 .PD
103 ECDSA signature schemes with diverse message digest algorithms. They are all
104 supported explicitly fetched with \fBEVP_PKEY_sign_init_ex2\fR\|(3) and
105 \&\fBEVP_PKEY_sign_message_init\fR\|(3).
106 .SS "ECDSA Signature Parameters"
107 .IX Subsection "ECDSA Signature Parameters"
108 The following signature parameters can be set using \fBEVP_PKEY_CTX_set_params()\fR.
109 This may be called after \fBEVP_PKEY_sign_init()\fR or \fBEVP_PKEY_verify_init()\fR,
110 and before calling \fBEVP_PKEY_sign()\fR or \fBEVP_PKEY_verify()\fR.
111 .IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
112 .IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
113 .PD 0
114 .IP """properties"" (\fBOSSL_SIGNATURE_PARAM_PROPERTIES\fR) <UTF8 string>" 4
115 .IX Item """properties"" (OSSL_SIGNATURE_PARAM_PROPERTIES) <UTF8 string>"
116 .PD
117 These two are not supported with the ECDSA signature schemes that already
118 include a message digest algorithm, See "Algorithm Names" above.
119 .IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
120 .IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
121 .PD 0
122 .IP """key-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
123 .IX Item """key-check"" (OSSL_SIGNATURE_PARAM_FIPS_KEY_CHECK) <integer>"
124 .IP """digest-check"" (\fBOSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK\fR) <integer>" 4
125 .IX Item """digest-check"" (OSSL_SIGNATURE_PARAM_FIPS_DIGEST_CHECK) <integer>"
126 .PD
127 These parameters are described in \fBprovider\-signature\fR\|(7).
128 .PP
129 The following signature parameters can be retrieved using
130 \&\fBEVP_PKEY_CTX_get_params()\fR.
131 .IP """algorithm-id"" (\fBOSSL_SIGNATURE_PARAM_ALGORITHM_ID\fR) <octet string>" 4
132 .IX Item """algorithm-id"" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string>"
133 .PD 0
134 .IP """digest"" (\fBOSSL_SIGNATURE_PARAM_DIGEST\fR) <UTF8 string>" 4
135 .IX Item """digest"" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>"
136 .IP """nonce-type"" (\fBOSSL_SIGNATURE_PARAM_NONCE_TYPE\fR) <unsigned integer>" 4
137 .IX Item """nonce-type"" (OSSL_SIGNATURE_PARAM_NONCE_TYPE) <unsigned integer>"
138 .IP """fips-indicator"" (\fBOSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
139 .IX Item """fips-indicator"" (OSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
140 .IP """verify-message"" (\fBOSSL_SIGNATURE_PARAM_FIPS_VERIFY_MESSAGE\fR <integer>" 4
141 .IX Item """verify-message"" (OSSL_SIGNATURE_PARAM_FIPS_VERIFY_MESSAGE <integer>"
142 .PD
143 The parameters are described in \fBprovider\-signature\fR\|(7).
144 .SH "SEE ALSO"
145 .IX Header "SEE ALSO"
146 \&\fBEVP_PKEY_CTX_set_params\fR\|(3),
147 \&\fBEVP_PKEY_sign\fR\|(3),
148 \&\fBEVP_PKEY_verify\fR\|(3),
149 \&\fBprovider\-signature\fR\|(7),
150 .SH COPYRIGHT
151 .IX Header "COPYRIGHT"
152 Copyright 2020\-2026 The OpenSSL Project Authors. All Rights Reserved.
153 .PP
154 Licensed under the Apache License 2.0 (the "License"). You may not use
155 this file except in compliance with the License. You can obtain a copy
156 in the file LICENSE in the source distribution or at
157 <https://www.openssl.org/source/license.html>.