Debian Codegraph @

upstream/debian-unstable/man3/DSA_sign.3ssl

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 "DSA_SIGN 3SSL"
58 .TH DSA_SIGN 3SSL 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 DSA_sign, DSA_sign_setup, DSA_verify \- DSA signatures
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/dsa.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 2
76 \& int DSA_sign(int type, const unsigned char *dgst, int len,
77 \& unsigned char *sigret, unsigned int *siglen, DSA *dsa);
78 \&
79 \& int DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp, BIGNUM **rp);
80 \&
81 \& int DSA_verify(int type, const unsigned char *dgst, int len,
82 \& unsigned char *sigbuf, int siglen, DSA *dsa);
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 All of the functions described on this page are deprecated.
87 Applications should instead use \fBEVP_PKEY_sign_init\fR\|(3), \fBEVP_PKEY_sign\fR\|(3),
88 \&\fBEVP_PKEY_verify_init\fR\|(3) and \fBEVP_PKEY_verify\fR\|(3).
89 .PP
90 \&\fBDSA_sign()\fR computes a digital signature on the \fBlen\fR byte message
91 digest \fBdgst\fR using the private key \fBdsa\fR and places its ASN.1 DER
92 encoding at \fBsigret\fR. The length of the signature is places in
93 *\fBsiglen\fR. \fBsigret\fR must point to DSA_size(\fBdsa\fR) bytes of memory.
94 .PP
95 \&\fBDSA_sign_setup()\fR is defined only for backward binary compatibility and
96 should not be used.
97 Since OpenSSL 1.1.0 the DSA type is opaque and the output of
98 \&\fBDSA_sign_setup()\fR cannot be used anyway: calling this function will only
99 cause overhead, and does not affect the actual signature
100 (pre\-)computation.
101 .PP
102 \&\fBDSA_verify()\fR verifies that the signature \fBsigbuf\fR of size \fBsiglen\fR
103 matches a given message digest \fBdgst\fR of size \fBlen\fR.
104 \&\fBdsa\fR is the signer's public key.
105 .PP
106 The \fBtype\fR parameter is ignored.
107 .PP
108 The random generator must be seeded when \fBDSA_sign()\fR (or \fBDSA_sign_setup()\fR)
109 is called.
110 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
111 external circumstances (see \fBRAND\fR\|(7)), the operation will fail.
112 .SH "RETURN VALUES"
113 .IX Header "RETURN VALUES"
114 \&\fBDSA_sign()\fR and \fBDSA_sign_setup()\fR return 1 on success, 0 on error.
115 \&\fBDSA_verify()\fR returns 1 for a valid signature, 0 for an incorrect
116 signature and \-1 on error. The error codes can be obtained by
117 \&\fBERR_get_error\fR\|(3).
118 .SH "CONFORMING TO"
119 .IX Header "CONFORMING TO"
120 US Federal Information Processing Standard FIPS186\-4 (Digital Signature
121 Standard, DSS), ANSI X9.30
122 .SH "SEE ALSO"
123 .IX Header "SEE ALSO"
124 \&\fBDSA_new\fR\|(3), \fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3),
125 \&\fBDSA_do_sign\fR\|(3),
126 \&\fBRAND\fR\|(7)
127 .SH HISTORY
128 .IX Header "HISTORY"
129 All of these functions were deprecated in OpenSSL 3.0.
130 .SH COPYRIGHT
131 .IX Header "COPYRIGHT"
132 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
133 .PP
134 Licensed under the Apache License 2.0 (the "License"). You may not use
135 this file except in compliance with the License. You can obtain a copy
136 in the file LICENSE in the source distribution or at
137 <https://www.openssl.org/source/license.html>.