dsa.pod 3.4 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4 5 6 7 8 9
=pod

=head1 NAME

dsa - Digital Signature Algorithm

=head1 SYNOPSIS

 #include <openssl/dsa.h>
10
 #include <openssl/engine.h>
U
Ulf Möller 已提交
11 12 13 14

 DSA *	DSA_new(void);
 void	DSA_free(DSA *dsa);

15
 int	DSA_size(const DSA *dsa);
U
Ulf Möller 已提交
16 17 18

 DSA *	DSA_generate_parameters(int bits, unsigned char *seed,
                int seed_len, int *counter_ret, unsigned long *h_ret,
U
Ulf Möller 已提交
19
		void (*callback)(int, int, void *), void *cb_arg);
U
Ulf Möller 已提交
20

21
 DH *	DSA_dup_DH(const DSA *r);
U
Ulf Möller 已提交
22 23 24 25 26 27 28 29

 int	DSA_generate_key(DSA *dsa);

 int	DSA_sign(int dummy, const unsigned char *dgst, int len,
		unsigned char *sigret, unsigned int *siglen, DSA *dsa);
 int	DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
                BIGNUM **rp);
 int	DSA_verify(int dummy, const unsigned char *dgst, int len,
30
		const unsigned char *sigbuf, int siglen, DSA *dsa);
U
Ulf Möller 已提交
31

32 33 34
 void DSA_set_default_method(const DSA_METHOD *meth);
 const DSA_METHOD *DSA_get_default_method(void);
 int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
35
 DSA *DSA_new_method(ENGINE *engine);
36
 const DSA_METHOD *DSA_OpenSSL(void);
U
Ulf Möller 已提交
37 38 39

 DSA_SIG *DSA_SIG_new(void);
 void	DSA_SIG_free(DSA_SIG *a);
40
 int	i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
U
Ulf Möller 已提交
41 42 43 44 45 46 47 48 49
 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);

 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
 int	DSA_do_verify(const unsigned char *dgst, int dgst_len,
	     DSA_SIG *sig, DSA *dsa);

 DSA *	d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 DSA *	d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 DSA * 	d2i_DSAparams(DSA **a, unsigned char **pp, long length);
50 51 52
 int	i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 int 	i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 int	i2d_DSAparams(const DSA *a,unsigned char **pp);
U
Ulf Möller 已提交
53

54 55 56 57
 int	DSAparams_print(BIO *bp, const DSA *x);
 int	DSAparams_print_fp(FILE *fp, const DSA *x);
 int	DSA_print(BIO *bp, const DSA *x, int off);
 int	DSA_print_fp(FILE *bp, const DSA *x, int off);
U
Ulf Möller 已提交
58 59 60 61 62

=head1 DESCRIPTION

These functions implement the Digital Signature Algorithm (DSA).  The
generation of shared DSA parameters is described in
R
Rich Salz 已提交
63 64
L<DSA_generate_parameters(3)>;
L<DSA_generate_key(3)> describes how to
U
Ulf Möller 已提交
65
generate a signature key. Signature generation and verification are
R
Rich Salz 已提交
66
described in L<DSA_sign(3)>.
U
Ulf Möller 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

The B<DSA> structure consists of several BIGNUM components.

 struct
        {
        BIGNUM *p;		// prime number (public)
        BIGNUM *q;		// 160-bit subprime, q | p-1 (public)
        BIGNUM *g;		// generator of subgroup (public)
        BIGNUM *priv_key;	// private key x
        BIGNUM *pub_key;	// public key y = g^x
        // ...
        }
 DSA;

In public keys, B<priv_key> is NULL.

83 84 85 86 87 88 89 90
Note that DSA keys may use non-standard B<DSA_METHOD> implementations,
either directly or by the use of B<ENGINE> modules. In some cases (eg. an
ENGINE providing support for hardware-embedded keys), these BIGNUM values
will not be used by the implementation or may be used for alternative data
storage. For this reason, applications should generally avoid using DSA
structure elements directly and instead use API functions to query or
modify keys.

U
Ulf Möller 已提交
91 92 93 94 95 96 97
=head1 CONFORMING TO

US Federal Information Processing Standard FIPS 186 (Digital Signature
Standard, DSS), ANSI X9.30

=head1 SEE ALSO

R
Rich Salz 已提交
98 99 100 101 102 103 104 105 106 107
L<bn(3)>, L<dh(3)>, L<err(3)>, L<rand(3)>,
L<rsa(3)>, L<sha(3)>, L<engine(3)>,
L<DSA_new(3)>,
L<DSA_size(3)>,
L<DSA_generate_parameters(3)>,
L<DSA_dup_DH(3)>,
L<DSA_generate_key(3)>,
L<DSA_sign(3)>, L<DSA_set_method(3)>,
L<DSA_get_ex_new_index(3)>,
L<RSA_print(3)>
U
Ulf Möller 已提交
108 109

=cut