RT1665,2300: Crypto doc cleanups
[openssl.git] / doc / crypto / DSA_do_sign.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_do_sign, DSA_do_verify - raw DSA signature operations
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dsa.h>
10
11  DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
12
13  int DSA_do_verify(const unsigned char *dgst, int dgst_len,
14              DSA_SIG *sig, DSA *dsa);
15
16 =head1 DESCRIPTION
17
18 DSA_do_sign() computes a digital signature on the B<len> byte message
19 digest B<dgst> using the private key B<dsa> and returns it in a
20 newly allocated B<DSA_SIG> structure.
21
22 L<DSA_sign_setup(3)|DSA_sign_setup(3)> may be used to precompute part
23 of the signing operation in case signature generation is
24 time-critical.
25
26 DSA_do_verify() verifies that the signature B<sig> matches a given
27 message digest B<dgst> of size B<len>.  B<dsa> is the signer's public
28 key.
29
30 =head1 RETURN VALUES
31
32 DSA_do_sign() returns the signature, NULL on error.  DSA_do_verify()
33 returns 1 for a valid signature, 0 for an incorrect signature and -1
34 on error. The error codes can be obtained by
35 L<ERR_get_error(3)|ERR_get_error(3)>.
36
37 =head1 SEE ALSO
38
39 L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>,
40 L<DSA_SIG_new(3)|DSA_SIG_new(3)>,
41 L<DSA_sign(3)|DSA_sign(3)>
42
43 =head1 HISTORY
44
45 DSA_do_sign() and DSA_do_verify() were added in OpenSSL 0.9.3.
46
47 =cut