summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/d2i_DSAPublicKey.3
diff options
context:
space:
mode:
authorschwarze <>2016-11-05 13:36:33 +0000
committerschwarze <>2016-11-05 13:36:33 +0000
commit71b431bd059aaefaa67b54a34adfaadc4014902c (patch)
tree7bf60aef63735e9638d12b0d8302b14d9860466e /src/lib/libcrypto/man/d2i_DSAPublicKey.3
parent5074288f0801a2b426584402e81b5953f706a44f (diff)
downloadopenbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.gz
openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.bz2
openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.zip
convert the remaining manual pages from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/man/d2i_DSAPublicKey.3')
-rw-r--r--src/lib/libcrypto/man/d2i_DSAPublicKey.3159
1 files changed, 159 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/d2i_DSAPublicKey.3 b/src/lib/libcrypto/man/d2i_DSAPublicKey.3
new file mode 100644
index 0000000000..aff5d0f814
--- /dev/null
+++ b/src/lib/libcrypto/man/d2i_DSAPublicKey.3
@@ -0,0 +1,159 @@
1.Dd $Mdocdate: November 5 2016 $
2.Dt D2I_DSAPUBLICKEY 3
3.Os
4.Sh NAME
5.Nm d2i_DSAPublicKey ,
6.Nm i2d_DSAPublicKey ,
7.Nm d2i_DSAPrivateKey ,
8.Nm i2d_DSAPrivateKey ,
9.Nm d2i_DSA_PUBKEY ,
10.Nm i2d_DSA_PUBKEY ,
11.Nm d2i_DSAparams ,
12.Nm i2d_DSAparams ,
13.Nm d2i_DSA_SIG ,
14.Nm i2d_DSA_SIG
15.Nd DSA key encoding and parsing functions
16.Sh SYNOPSIS
17.In openssl/dsa.h
18.In openssl/x509.h
19.Ft DSA *
20.Fo d2i_DSAPublicKey
21.Fa "DSA **a"
22.Fa "const unsigned char **pp"
23.Fa "long length"
24.Fc
25.Ft int
26.Fo i2d_DSAPublicKey
27.Fa "const DSA *a"
28.Fa "unsigned char **pp"
29.Fc
30.Ft DSA *
31.Fo d2i_DSA_PUBKEY
32.Fa "DSA **a"
33.Fa "const unsigned char **pp"
34.Fa "long length"
35.Fc
36.Ft int
37.Fo i2d_DSA_PUBKEY
38.Fa "const DSA *a"
39.Fa "unsigned char **pp"
40.Fc
41.Ft DSA *
42.Fo d2i_DSAPrivateKey
43.Fa "DSA **a"
44.Fa "const unsigned char **pp"
45.Fa "long length"
46.Fc
47.Ft int
48.Fo i2d_DSAPrivateKey
49.Fa "const DSA *a"
50.Fa "unsigned char **pp"
51.Fc
52.Ft DSA *
53.Fo d2i_DSAparams
54.Fa "DSA **a"
55.Fa "const unsigned char **pp"
56.Fa "long length"
57.Fc
58.Ft int
59.Fo i2d_DSAparams
60.Fa "const DSA *a"
61.Fa "unsigned char **pp"
62.Fc
63.Ft DSA *
64.Fo d2i_DSA_SIG
65.Fa "DSA_SIG **a"
66.Fa "const unsigned char **pp"
67.Fa "long length"
68.Fc
69.Ft int
70.Fo i2d_DSA_SIG
71.Fa "const DSA_SIG *a"
72.Fa "unsigned char **pp"
73.Fc
74.Sh DESCRIPTION
75.Fn d2i_DSAPublicKey
76and
77.Fn i2d_DSAPublicKey
78decode and encode the DSA public key components structure.
79.Pp
80.Fn d2i_DSA_PUBKEY
81and
82.Fn i2d_DSA_PUBKEY
83decode and encode a DSA public key using a SubjectPublicKeyInfo
84(certificate public key) structure.
85.Pp
86.Fn d2i_DSAPrivateKey
87and
88.Fn i2d_DSAPrivateKey
89decode and encode the DSA private key components.
90.Pp
91.Fn d2i_DSAparams
92and
93.Fn i2d_DSAparams
94decode and encode the DSA parameters using a
95.Sy Dss-Parms
96structure as defined in RFC2459.
97.Pp
98.Fn d2i_DSA_SIG
99and
100.Fn i2d_DSA_SIG
101decode and encode a DSA signature using a
102.Sy Dss-Sig-Value
103structure as defined in RFC2459.
104.Pp
105The usage of all of these functions is similar to
106.Xr d2i_X509 3
107and
108.Xr i2d_X509 3 .
109.Pp
110The
111.Vt DSA
112structure passed to the private key encoding functions should have all
113the private key components present.
114.Pp
115The data encoded by the private key functions is unencrypted and
116therefore offers no private key security.
117.Pp
118The
119.Fn *_DSA_PUBKEY
120functions should be used in preference to the
121.Fn *_DSAPublicKey
122functions when encoding public keys because they use a standard format.
123.Pp
124The
125.Fn *_DSAPublicKey
126functions use an non-standard format.
127The actual data encoded depends on the value of
128.Fa a->write_params .
129If
130.Fa a->write_params
131is zero, then only the
132.Fa a->pub_key
133field is encoded as an
134.Sy INTEGER .
135If
136.Fa a->write_params
137is 1, then a
138.Sy SEQUENCE
139consisting of the
140.Fa a->p ,
141.Fa a->q ,
142.Fa a->g ,
143and
144.Fa a->pub_key
145fields is encoded.
146.Pp
147The
148.Fn *_DSAPrivateKey
149functions also use a non-standard structure consisting consisting of a
150SEQUENCE containing the
151.Fa a->p ,
152.Fa a->q ,
153.Fa a->g ,
154.Fa a->pub_key ,
155and
156.Fa a->priv_key
157fields.
158.Sh SEE ALSO
159.Xr d2i_X509 3