diff options
Diffstat (limited to 'src/lib/libcrypto/doc/dsa.pod')
-rw-r--r-- | src/lib/libcrypto/doc/dsa.pod | 113 |
1 files changed, 0 insertions, 113 deletions
diff --git a/src/lib/libcrypto/doc/dsa.pod b/src/lib/libcrypto/doc/dsa.pod deleted file mode 100644 index ae2e5d81f9..0000000000 --- a/src/lib/libcrypto/doc/dsa.pod +++ /dev/null | |||
@@ -1,113 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | dsa - Digital Signature Algorithm | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/dsa.h> | ||
10 | #include <openssl/engine.h> | ||
11 | |||
12 | DSA * DSA_new(void); | ||
13 | void DSA_free(DSA *dsa); | ||
14 | |||
15 | int DSA_size(const DSA *dsa); | ||
16 | |||
17 | DSA * DSA_generate_parameters(int bits, unsigned char *seed, | ||
18 | int seed_len, int *counter_ret, unsigned long *h_ret, | ||
19 | void (*callback)(int, int, void *), void *cb_arg); | ||
20 | |||
21 | DH * DSA_dup_DH(const DSA *r); | ||
22 | |||
23 | int DSA_generate_key(DSA *dsa); | ||
24 | |||
25 | int DSA_sign(int dummy, const unsigned char *dgst, int len, | ||
26 | unsigned char *sigret, unsigned int *siglen, DSA *dsa); | ||
27 | int DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp, | ||
28 | BIGNUM **rp); | ||
29 | int DSA_verify(int dummy, const unsigned char *dgst, int len, | ||
30 | const unsigned char *sigbuf, int siglen, DSA *dsa); | ||
31 | |||
32 | void DSA_set_default_method(const DSA_METHOD *meth); | ||
33 | const DSA_METHOD *DSA_get_default_method(void); | ||
34 | int DSA_set_method(DSA *dsa, const DSA_METHOD *meth); | ||
35 | DSA *DSA_new_method(ENGINE *engine); | ||
36 | const DSA_METHOD *DSA_OpenSSL(void); | ||
37 | |||
38 | int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(), | ||
39 | int (*dup_func)(), void (*free_func)()); | ||
40 | int DSA_set_ex_data(DSA *d, int idx, char *arg); | ||
41 | char *DSA_get_ex_data(DSA *d, int idx); | ||
42 | |||
43 | DSA_SIG *DSA_SIG_new(void); | ||
44 | void DSA_SIG_free(DSA_SIG *a); | ||
45 | int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); | ||
46 | DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length); | ||
47 | |||
48 | DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa); | ||
49 | int DSA_do_verify(const unsigned char *dgst, int dgst_len, | ||
50 | DSA_SIG *sig, DSA *dsa); | ||
51 | |||
52 | DSA * d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length); | ||
53 | DSA * d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length); | ||
54 | DSA * d2i_DSAparams(DSA **a, unsigned char **pp, long length); | ||
55 | int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); | ||
56 | int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); | ||
57 | int i2d_DSAparams(const DSA *a,unsigned char **pp); | ||
58 | |||
59 | int DSAparams_print(BIO *bp, const DSA *x); | ||
60 | int DSAparams_print_fp(FILE *fp, const DSA *x); | ||
61 | int DSA_print(BIO *bp, const DSA *x, int off); | ||
62 | int DSA_print_fp(FILE *bp, const DSA *x, int off); | ||
63 | |||
64 | =head1 DESCRIPTION | ||
65 | |||
66 | These functions implement the Digital Signature Algorithm (DSA). The | ||
67 | generation of shared DSA parameters is described in | ||
68 | L<DSA_generate_parameters(3)|DSA_generate_parameters(3)>; | ||
69 | L<DSA_generate_key(3)|DSA_generate_key(3)> describes how to | ||
70 | generate a signature key. Signature generation and verification are | ||
71 | described in L<DSA_sign(3)|DSA_sign(3)>. | ||
72 | |||
73 | The B<DSA> structure consists of several BIGNUM components. | ||
74 | |||
75 | struct | ||
76 | { | ||
77 | BIGNUM *p; // prime number (public) | ||
78 | BIGNUM *q; // 160-bit subprime, q | p-1 (public) | ||
79 | BIGNUM *g; // generator of subgroup (public) | ||
80 | BIGNUM *priv_key; // private key x | ||
81 | BIGNUM *pub_key; // public key y = g^x | ||
82 | // ... | ||
83 | } | ||
84 | DSA; | ||
85 | |||
86 | In public keys, B<priv_key> is NULL. | ||
87 | |||
88 | Note that DSA keys may use non-standard B<DSA_METHOD> implementations, | ||
89 | either directly or by the use of B<ENGINE> modules. In some cases (eg. an | ||
90 | ENGINE providing support for hardware-embedded keys), these BIGNUM values | ||
91 | will not be used by the implementation or may be used for alternative data | ||
92 | storage. For this reason, applications should generally avoid using DSA | ||
93 | structure elements directly and instead use API functions to query or | ||
94 | modify keys. | ||
95 | |||
96 | =head1 CONFORMING TO | ||
97 | |||
98 | US Federal Information Processing Standard FIPS 186 (Digital Signature | ||
99 | Standard, DSS), ANSI X9.30 | ||
100 | |||
101 | =head1 SEE ALSO | ||
102 | |||
103 | L<bn(3)|bn(3)>, L<dh(3)|dh(3)>, L<err(3)|err(3)>, L<rand(3)|rand(3)>, | ||
104 | L<rsa(3)|rsa(3)>, L<SHA1(3)|SHA1(3)>, L<DSA_new(3)|DSA_new(3)>, | ||
105 | L<DSA_size(3)|DSA_size(3)>, | ||
106 | L<DSA_generate_parameters(3)|DSA_generate_parameters(3)>, | ||
107 | L<DSA_dup_DH(3)|DSA_dup_DH(3)>, | ||
108 | L<DSA_generate_key(3)|DSA_generate_key(3)>, | ||
109 | L<DSA_sign(3)|DSA_sign(3)>, L<DSA_set_method(3)|DSA_set_method(3)>, | ||
110 | L<DSA_get_ex_new_index(3)|DSA_get_ex_new_index(3)>, | ||
111 | L<RSA_print(3)|RSA_print(3)> | ||
112 | |||
113 | =cut | ||