Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / d2i_DSAPublicKey.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "d2i_DSAPublicKey 3"
aac4ff6f 132.TH d2i_DSAPublicKey 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134d2i_DSAPublicKey, i2d_DSAPublicKey, d2i_DSAPrivateKey, i2d_DSAPrivateKey,
74dab6c2 135d2i_DSA_PUBKEY, i2d_DSA_PUBKEY, d2i_DSA_SIG, i2d_DSA_SIG \- DSA key encoding
984263bc
MD
136and parsing functions.
137.SH "SYNOPSIS"
8b0cefbb 138.IX Header "SYNOPSIS"
74dab6c2 139.Vb 2
984263bc 140\& #include <openssl/dsa.h>
74dab6c2 141\& #include <openssl/x509.h>
aac4ff6f
PA
142.Ve
143.PP
144.Vb 1
984263bc 145\& DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
aac4ff6f
PA
146.Ve
147.PP
148.Vb 1
984263bc 149\& int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
aac4ff6f
PA
150.Ve
151.PP
152.Vb 1
984263bc 153\& DSA * d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length);
aac4ff6f
PA
154.Ve
155.PP
156.Vb 1
984263bc 157\& int i2d_DSA_PUBKEY(const DSA *a, unsigned char **pp);
aac4ff6f
PA
158.Ve
159.PP
160.Vb 1
984263bc 161\& DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
aac4ff6f
PA
162.Ve
163.PP
164.Vb 1
984263bc 165\& int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
aac4ff6f
PA
166.Ve
167.PP
168.Vb 1
984263bc 169\& DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
aac4ff6f
PA
170.Ve
171.PP
172.Vb 1
984263bc 173\& int i2d_DSAparams(const DSA *a, unsigned char **pp);
aac4ff6f
PA
174.Ve
175.PP
176.Vb 1
984263bc 177\& DSA * d2i_DSA_SIG(DSA_SIG **a, const unsigned char **pp, long length);
aac4ff6f
PA
178.Ve
179.PP
180.Vb 1
984263bc
MD
181\& int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
182.Ve
183.SH "DESCRIPTION"
8b0cefbb
JR
184.IX Header "DESCRIPTION"
185\&\fId2i_DSAPublicKey()\fR and \fIi2d_DSAPublicKey()\fR decode and encode the \s-1DSA\s0 public key
984263bc
MD
186components structure.
187.PP
8b0cefbb 188\&\fId2i_DSA_PUBKEY()\fR and \fIi2d_DSA_PUBKEY()\fR decode and encode an \s-1DSA\s0 public key using
74dab6c2 189a SubjectPublicKeyInfo (certificate public key) structure.
984263bc 190.PP
8b0cefbb 191\&\fId2i_DSAPrivateKey()\fR, \fIi2d_DSAPrivateKey()\fR decode and encode the \s-1DSA\s0 private key
984263bc
MD
192components.
193.PP
8b0cefbb
JR
194\&\fId2i_DSAparams()\fR, \fIi2d_DSAparams()\fR decode and encode the \s-1DSA\s0 parameters using
195a \fBDss-Parms\fR structure as defined in \s-1RFC2459\s0.
984263bc 196.PP
8b0cefbb
JR
197\&\fId2i_DSA_SIG()\fR, \fIi2d_DSA_SIG()\fR decode and encode a \s-1DSA\s0 signature using a
198\&\fBDss-Sig-Value\fR structure as defined in \s-1RFC2459\s0.
984263bc
MD
199.PP
200The usage of all of these functions is similar to the \fId2i_X509()\fR and
8b0cefbb 201\&\fIi2d_X509()\fR described in the \fId2i_X509\fR\|(3) manual page.
984263bc 202.SH "NOTES"
8b0cefbb
JR
203.IX Header "NOTES"
204The \fB\s-1DSA\s0\fR structure passed to the private key encoding functions should have
984263bc
MD
205all the private key components present.
206.PP
207The data encoded by the private key functions is unencrypted and therefore
208offers no private key security.
209.PP
8b0cefbb 210The \fB\s-1DSA_PUBKEY\s0\fR functions should be used in preference to the \fBDSAPublicKey\fR
984263bc
MD
211functions when encoding public keys because they use a standard format.
212.PP
213The \fBDSAPublicKey\fR functions use an non standard format the actual data encoded
214depends on the value of the \fBwrite_params\fR field of the \fBa\fR key parameter.
215If \fBwrite_params\fR is zero then only the \fBpub_key\fR field is encoded as an
8b0cefbb
JR
216\&\fB\s-1INTEGER\s0\fR. If \fBwrite_params\fR is 1 then a \fB\s-1SEQUENCE\s0\fR consisting of the
217\&\fBp\fR, \fBq\fR, \fBg\fR and \fBpub_key\fR respectively fields are encoded.
984263bc
MD
218.PP
219The \fBDSAPrivateKey\fR functions also use a non standard structure consiting
8b0cefbb
JR
220consisting of a \s-1SEQUENCE\s0 containing the \fBp\fR, \fBq\fR, \fBg\fR and \fBpub_key\fR and
221\&\fBpriv_key\fR fields respectively.
984263bc 222.SH "SEE ALSO"
74dab6c2 223.IX Header "SEE ALSO"
8b0cefbb
JR
224\&\fId2i_X509\fR\|(3)
225.SH "HISTORY"
984263bc 226.IX Header "HISTORY"
8b0cefbb 227\&\s-1TBA\s0