Document updates from wiki.
[openssl.git] / doc / crypto / d2i_DSAPublicKey.pod
1 =pod
2
3 =head1 NAME
4
5 d2i_DSAPublicKey, i2d_DSAPublicKey, d2i_DSAPrivateKey, i2d_DSAPrivateKey,
6 d2i_DSA_PUBKEY, i2d_DSA_PUBKEY, d2i_DSAparams, i2d_DSAparams, d2i_DSA_SIG, i2d_DSA_SIG - DSA key encoding
7 and parsing functions.
8
9 =head1 SYNOPSIS
10
11  #include <openssl/dsa.h>
12  #include <openssl/x509.h>
13
14  DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
15
16  int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
17
18  DSA * d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length);
19
20  int i2d_DSA_PUBKEY(const DSA *a, unsigned char **pp);
21
22  DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
23
24  int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
25
26  DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
27
28  int i2d_DSAparams(const DSA *a, unsigned char **pp);
29
30  DSA * d2i_DSA_SIG(DSA_SIG **a, const unsigned char **pp, long length);
31
32  int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
33
34 =head1 DESCRIPTION
35
36 d2i_DSAPublicKey() and i2d_DSAPublicKey() decode and encode the DSA public key
37 components structure.
38
39 d2i_DSA_PUBKEY() and i2d_DSA_PUBKEY() decode and encode an DSA public key using
40 a SubjectPublicKeyInfo (certificate public key) structure.
41
42 d2i_DSAPrivateKey(), i2d_DSAPrivateKey() decode and encode the DSA private key
43 components.
44
45 d2i_DSAparams(), i2d_DSAparams() decode and encode the DSA parameters using
46 a B<Dss-Parms> structure as defined in RFC2459.
47
48 d2i_DSA_SIG(), i2d_DSA_SIG() decode and encode a DSA signature using a
49 B<Dss-Sig-Value> structure as defined in RFC2459.
50
51 The usage of all of these functions is similar to the d2i_X509() and
52 i2d_X509() described in the L<d2i_X509(3)|d2i_X509(3)> manual page.
53
54 =head1 NOTES
55
56 The B<DSA> structure passed to the private key encoding functions should have
57 all the private key components present.
58
59 The data encoded by the private key functions is unencrypted and therefore 
60 offers no private key security.
61
62 The B<DSA_PUBKEY> functions should be used in preference to the B<DSAPublicKey>
63 functions when encoding public keys because they use a standard format.
64
65 The B<DSAPublicKey> functions use an non standard format the actual data encoded
66 depends on the value of the B<write_params> field of the B<a> key parameter.
67 If B<write_params> is zero then only the B<pub_key> field is encoded as an
68 B<INTEGER>. If B<write_params> is 1 then a B<SEQUENCE> consisting of the
69 B<p>, B<q>, B<g> and B<pub_key> respectively fields are encoded.
70
71 The B<DSAPrivateKey> functions also use a non standard structure consiting
72 consisting of a SEQUENCE containing the B<p>, B<q>, B<g> and B<pub_key> and
73 B<priv_key> fields respectively.
74
75 =head1 SEE ALSO
76
77 L<d2i_X509(3)|d2i_X509(3)>
78
79 =head1 HISTORY
80
81 TBA
82
83 =cut