secure/lib/libcrypto/man/dsa.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 "dsa 3"
 132 .TH dsa 3 "2007-03-28" "0.9.8e" "OpenSSL"
 133 .SH "NAME"
 134 dsa \- Digital Signature Algorithm
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \& #include <openssl/dsa.h>
 139 \& #include <openssl/engine.h>
 140 .Ve
 141 .PP
 142 .Vb 2
 143 \& DSA *  DSA_new(void);
 144 \& void   DSA_free(DSA *dsa);
 145 .Ve
 146 .PP
 147 .Vb 1
 148 \& int    DSA_size(const DSA *dsa);
 149 .Ve
 150 .PP
 151 .Vb 3
 152 \& DSA *  DSA_generate_parameters(int bits, unsigned char *seed,
 153 \&                int seed_len, int *counter_ret, unsigned long *h_ret,
 154 \&                void (*callback)(int, int, void *), void *cb_arg);
 155 .Ve
 156 .PP
 157 .Vb 1
 158 \& DH *   DSA_dup_DH(const DSA *r);
 159 .Ve
 160 .PP
 161 .Vb 1
 162 \& int    DSA_generate_key(DSA *dsa);
 163 .Ve
 164 .PP
 165 .Vb 6
 166 \& int    DSA_sign(int dummy, const unsigned char *dgst, int len,
 167 \&                unsigned char *sigret, unsigned int *siglen, DSA *dsa);
 168 \& int    DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
 169 \&                BIGNUM **rp);
 170 \& int    DSA_verify(int dummy, const unsigned char *dgst, int len,
 171 \&                const unsigned char *sigbuf, int siglen, DSA *dsa);
 172 .Ve
 173 .PP
 174 .Vb 5
 175 \& void DSA_set_default_method(const DSA_METHOD *meth);
 176 \& const DSA_METHOD *DSA_get_default_method(void);
 177 \& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
 178 \& DSA *DSA_new_method(ENGINE *engine);
 179 \& const DSA_METHOD *DSA_OpenSSL(void);
 180 .Ve
 181 .PP
 182 .Vb 4
 183 \& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 184 \&             int (*dup_func)(), void (*free_func)());
 185 \& int DSA_set_ex_data(DSA *d, int idx, char *arg);
 186 \& char *DSA_get_ex_data(DSA *d, int idx);
 187 .Ve
 188 .PP
 189 .Vb 4
 190 \& DSA_SIG *DSA_SIG_new(void);
 191 \& void   DSA_SIG_free(DSA_SIG *a);
 192 \& int    i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 193 \& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 194 .Ve
 195 .PP
 196 .Vb 3
 197 \& DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
 198 \& int    DSA_do_verify(const unsigned char *dgst, int dgst_len,
 199 \&             DSA_SIG *sig, DSA *dsa);
 200 .Ve
 201 .PP
 202 .Vb 6
 203 \& DSA *  d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 204 \& DSA *  d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 205 \& DSA *  d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 206 \& int    i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 207 \& int    i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 208 \& int    i2d_DSAparams(const DSA *a,unsigned char **pp);
 209 .Ve
 210 .PP
 211 .Vb 4
 212 \& int    DSAparams_print(BIO *bp, const DSA *x);
 213 \& int    DSAparams_print_fp(FILE *fp, const DSA *x);
 214 \& int    DSA_print(BIO *bp, const DSA *x, int off);
 215 \& int    DSA_print_fp(FILE *bp, const DSA *x, int off);
 216 .Ve
 217 .SH "DESCRIPTION"
 218 .IX Header "DESCRIPTION"
 219 These functions implement the Digital Signature Algorithm (\s-1DSA\s0).  The
 220 generation of shared \s-1DSA\s0 parameters is described in
 221 \&\fIDSA_generate_parameters\fR\|(3);
 222 \&\fIDSA_generate_key\fR\|(3) describes how to
 223 generate a signature key. Signature generation and verification are
 224 described in \fIDSA_sign\fR\|(3).
 225 .PP
 226 The \fB\s-1DSA\s0\fR structure consists of several \s-1BIGNUM\s0 components.
 227 .PP
 228 .Vb 10
 229 \& struct
 230 \&        {
 231 \&        BIGNUM *p;              // prime number (public)
 232 \&        BIGNUM *q;              // 160-bit subprime, q | p-1 (public)
 233 \&        BIGNUM *g;              // generator of subgroup (public)
 234 \&        BIGNUM *priv_key;       // private key x
 235 \&        BIGNUM *pub_key;        // public key y = g^x
 236 \&        // ...
 237 \&        }
 238 \& DSA;
 239 .Ve
 240 .PP
 241 In public keys, \fBpriv_key\fR is \s-1NULL\s0.
 242 .PP
 243 Note that \s-1DSA\s0 keys may use non-standard \fB\s-1DSA_METHOD\s0\fR implementations,
 244 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 245 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 246 will not be used by the implementation or may be used for alternative data
 247 storage. For this reason, applications should generally avoid using \s-1DSA\s0
 248 structure elements directly and instead use \s-1API\s0 functions to query or
 249 modify keys.
 250 .SH "CONFORMING TO"
 251 .IX Header "CONFORMING TO"
 252 \&\s-1US\s0 Federal Information Processing Standard \s-1FIPS\s0 186 (Digital Signature
 253 Standard, \s-1DSS\s0), \s-1ANSI\s0 X9.30
 254 .SH "SEE ALSO"
 255 .IX Header "SEE ALSO"
 256 \&\fIbn\fR\|(3), \fIdh\fR\|(3), \fIerr\fR\|(3), \fIrand\fR\|(3),
 257 \&\fIrsa\fR\|(3), \fIsha\fR\|(3), \fIengine\fR\|(3),
 258 \&\fIDSA_new\fR\|(3),
 259 \&\fIDSA_size\fR\|(3),
 260 \&\fIDSA_generate_parameters\fR\|(3),
 261 \&\fIDSA_dup_DH\fR\|(3),
 262 \&\fIDSA_generate_key\fR\|(3),
 263 \&\fIDSA_sign\fR\|(3), \fIDSA_set_method\fR\|(3),
 264 \&\fIDSA_get_ex_new_index\fR\|(3),
 265 \&\fIRSA_print\fR\|(3)