projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 38e33cef UM |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | DSA_sign, DSA_sign_setup, DSA_verify - DSA signatures | |
| 6 | ||
| 7 | =head1 SYNOPSIS | |
| 8 | ||
| 9 | #include <openssl/dsa.h> | |
| 10 | ||
| e9b77246 BB |
11 | int DSA_sign(int type, const unsigned char *dgst, int len, |
| 12 | unsigned char *sigret, unsigned int *siglen, DSA *dsa); | |
| 38e33cef | 13 | |
| e9b77246 | 14 | int DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp, BIGNUM **rp); |
| 38e33cef | 15 | |
| e9b77246 | 16 | int DSA_verify(int type, const unsigned char *dgst, int len, |
| 1bc74519 | 17 | unsigned char *sigbuf, int siglen, DSA *dsa); |
| 38e33cef UM |
18 | |
| 19 | =head1 DESCRIPTION | |
| 20 | ||
| 21 | DSA_sign() computes a digital signature on the B<len> byte message | |
| 22 | digest B<dgst> using the private key B<dsa> and places its ASN.1 DER | |
| 23 | encoding at B<sigret>. The length of the signature is places in | |
| 24 | *B<siglen>. B<sigret> must point to DSA_size(B<dsa>) bytes of memory. | |
| 25 | ||
| 8fe4c0b0 NT |
26 | DSA_sign_setup() is defined only for backward binary compatibility and |
| 27 | should not be used. | |
| 28 | Since OpenSSL 1.1.0 the DSA type is opaque and the output of | |
| 29 | DSA_sign_setup() cannot be used anyway: calling this function will only | |
| 30 | cause overhead, and does not affect the actual signature | |
| 31 | (pre-)computation. | |
| 38e33cef UM |
32 | |
| 33 | DSA_verify() verifies that the signature B<sigbuf> of size B<siglen> | |
| 34 | matches a given message digest B<dgst> of size B<len>. | |
| 35 | B<dsa> is the signer's public key. | |
| 36 | ||
| 37 | The B<type> parameter is ignored. | |
| 38 | ||
| 74235cc9 UM |
39 | The PRNG must be seeded before DSA_sign() (or DSA_sign_setup()) |
| 40 | is called. | |
| 41 | ||
| 38e33cef UM |
42 | =head1 RETURN VALUES |
| 43 | ||
| 44 | DSA_sign() and DSA_sign_setup() return 1 on success, 0 on error. | |
| 45 | DSA_verify() returns 1 for a valid signature, 0 for an incorrect | |
| 46 | signature and -1 on error. The error codes can be obtained by | |
| 9b86974e | 47 | L<ERR_get_error(3)>. |
| 38e33cef UM |
48 | |
| 49 | =head1 CONFORMING TO | |
| 50 | ||
| 51 | US Federal Information Processing Standard FIPS 186 (Digital Signature | |
| 52 | Standard, DSS), ANSI X9.30 | |
| 53 | ||
| 54 | =head1 SEE ALSO | |
| 55 | ||
| b97fdb57 | 56 | L<DSA_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>, |
| 9b86974e | 57 | L<DSA_do_sign(3)> |
| 38e33cef | 58 | |
| e2f92610 RS |
59 | =head1 COPYRIGHT |
| 60 | ||
| fd38836b | 61 | Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. |
| e2f92610 | 62 | |
| 4746f25a | 63 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| e2f92610 RS |
64 | this file except in compliance with the License. You can obtain a copy |
| 65 | in the file LICENSE in the source distribution or at | |
| 66 | L<https://www.openssl.org/source/license.html>. | |
| 67 | ||
| 68 | =cut |