secure/lib/libcrypto/man/d2i_DSAPublicKey.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  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
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  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' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  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"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  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 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 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
 112 .    \" corrections for vroff
 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'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "d2i_DSAPublicKey 3"
 132 .TH d2i_DSAPublicKey 3 "2004-12-18" "0.9.7e" "OpenSSL"
 133 .SH "NAME"
 134 d2i_DSAPublicKey, i2d_DSAPublicKey, d2i_DSAPrivateKey, i2d_DSAPrivateKey,
 135 d2i_DSA_PUBKEY, i2d_DSA_PUBKEY, d2i_DSA_SIG, i2d_DSA_SIG \- DSA key encoding
 136 and parsing functions.
 137 .SH "SYNOPSIS"
 138 .IX Header "SYNOPSIS"
 139 .Vb 2
 140 \& #include <openssl/dsa.h>
 141 \& #include <openssl/x509.h>
 142 .Ve
 143 .PP
 144 .Vb 1
 145 \& DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
 146 .Ve
 147 .PP
 148 .Vb 1
 149 \& int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 150 .Ve
 151 .PP
 152 .Vb 1
 153 \& DSA * d2i_DSA_PUBKEY(DSA **a, const unsigned char **pp, long length);
 154 .Ve
 155 .PP
 156 .Vb 1
 157 \& int i2d_DSA_PUBKEY(const DSA *a, unsigned char **pp);
 158 .Ve
 159 .PP
 160 .Vb 1
 161 \& DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
 162 .Ve
 163 .PP
 164 .Vb 1
 165 \& int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 166 .Ve
 167 .PP
 168 .Vb 1
 169 \& DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
 170 .Ve
 171 .PP
 172 .Vb 1
 173 \& int i2d_DSAparams(const DSA *a, unsigned char **pp);
 174 .Ve
 175 .PP
 176 .Vb 1
 177 \& DSA * d2i_DSA_SIG(DSA_SIG **a, const unsigned char **pp, long length);
 178 .Ve
 179 .PP
 180 .Vb 1
 181 \& int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 182 .Ve
 183 .SH "DESCRIPTION"
 184 .IX Header "DESCRIPTION"
 185 \&\fId2i_DSAPublicKey()\fR and \fIi2d_DSAPublicKey()\fR decode and encode the \s-1DSA\s0 public key
 186 components structure.
 187 .PP
 188 \&\fId2i_DSA_PUBKEY()\fR and \fIi2d_DSA_PUBKEY()\fR decode and encode an \s-1DSA\s0 public key using
 189 a SubjectPublicKeyInfo (certificate public key) structure.
 190 .PP
 191 \&\fId2i_DSAPrivateKey()\fR, \fIi2d_DSAPrivateKey()\fR decode and encode the \s-1DSA\s0 private key
 192 components.
 193 .PP
 194 \&\fId2i_DSAparams()\fR, \fIi2d_DSAparams()\fR decode and encode the \s-1DSA\s0 parameters using
 195 a \fBDss-Parms\fR structure as defined in \s-1RFC2459\s0.
 196 .PP
 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.
 199 .PP
 200 The usage of all of these functions is similar to the \fId2i_X509()\fR and
 201 \&\fIi2d_X509()\fR described in the \fId2i_X509\fR\|(3) manual page.
 202 .SH "NOTES"
 203 .IX Header "NOTES"
 204 The \fB\s-1DSA\s0\fR structure passed to the private key encoding functions should have
 205 all the private key components present.
 206 .PP
 207 The data encoded by the private key functions is unencrypted and therefore
 208 offers no private key security.
 209 .PP
 210 The \fB\s-1DSA_PUBKEY\s0\fR functions should be used in preference to the \fBDSAPublicKey\fR
 211 functions when encoding public keys because they use a standard format.
 212 .PP
 213 The \fBDSAPublicKey\fR functions use an non standard format the actual data encoded
 214 depends on the value of the \fBwrite_params\fR field of the \fBa\fR key parameter.
 215 If \fBwrite_params\fR is zero then only the \fBpub_key\fR field is encoded as an
 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.
 218 .PP
 219 The \fBDSAPrivateKey\fR functions also use a non standard structure consiting
 220 consisting of a \s-1SEQUENCE\s0 containing the \fBp\fR, \fBq\fR, \fBg\fR and \fBpub_key\fR and
 221 \&\fBpriv_key\fR fields respectively.
 222 .SH "SEE ALSO"
 223 .IX Header "SEE ALSO"
 224 \&\fId2i_X509\fR\|(3)
 225 .SH "HISTORY"
 226 .IX Header "HISTORY"
 227 \&\s-1TBA\s0