secure/lib/libcrypto/man/dsa.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:43:04 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "dsa 3"
 141 .TH dsa 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 dsa \- Digital Signature Algorithm
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 2
 148 \& #include <openssl/dsa.h>
 149 \& #include <openssl/engine.h>
 150 .Ve
 151 .Vb 2
 152 \& DSA *  DSA_new(void);
 153 \& void   DSA_free(DSA *dsa);
 154 .Ve
 155 .Vb 1
 156 \& int    DSA_size(const DSA *dsa);
 157 .Ve
 158 .Vb 3
 159 \& DSA *  DSA_generate_parameters(int bits, unsigned char *seed,
 160 \&                int seed_len, int *counter_ret, unsigned long *h_ret,
 161 \&                void (*callback)(int, int, void *), void *cb_arg);
 162 .Ve
 163 .Vb 1
 164 \& DH *   DSA_dup_DH(const DSA *r);
 165 .Ve
 166 .Vb 1
 167 \& int    DSA_generate_key(DSA *dsa);
 168 .Ve
 169 .Vb 6
 170 \& int    DSA_sign(int dummy, const unsigned char *dgst, int len,
 171 \&                unsigned char *sigret, unsigned int *siglen, DSA *dsa);
 172 \& int    DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
 173 \&                BIGNUM **rp);
 174 \& int    DSA_verify(int dummy, const unsigned char *dgst, int len,
 175 \&                const unsigned char *sigbuf, int siglen, DSA *dsa);
 176 .Ve
 177 .Vb 5
 178 \& void DSA_set_default_method(const DSA_METHOD *meth);
 179 \& const DSA_METHOD *DSA_get_default_method(void);
 180 \& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
 181 \& DSA *DSA_new_method(ENGINE *engine);
 182 \& const DSA_METHOD *DSA_OpenSSL(void);
 183 .Ve
 184 .Vb 4
 185 \& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 186 \&             int (*dup_func)(), void (*free_func)());
 187 \& int DSA_set_ex_data(DSA *d, int idx, char *arg);
 188 \& char *DSA_get_ex_data(DSA *d, int idx);
 189 .Ve
 190 .Vb 4
 191 \& DSA_SIG *DSA_SIG_new(void);
 192 \& void   DSA_SIG_free(DSA_SIG *a);
 193 \& int    i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 194 \& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 195 .Ve
 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 .Vb 6
 202 \& DSA *  d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 203 \& DSA *  d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 204 \& DSA *  d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 205 \& int    i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 206 \& int    i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 207 \& int    i2d_DSAparams(const DSA *a,unsigned char **pp);
 208 .Ve
 209 .Vb 4
 210 \& int    DSAparams_print(BIO *bp, const DSA *x);
 211 \& int    DSAparams_print_fp(FILE *fp, const DSA *x);
 212 \& int    DSA_print(BIO *bp, const DSA *x, int off);
 213 \& int    DSA_print_fp(FILE *bp, const DSA *x, int off);
 214 .Ve
 215 .SH "DESCRIPTION"
 216 .IX Header "DESCRIPTION"
 217 These functions implement the Digital Signature Algorithm (\s-1DSA\s0).  The
 218 generation of shared \s-1DSA\s0 parameters is described in
 219 DSA_generate_parameters(3);
 220 DSA_generate_key(3) describes how to
 221 generate a signature key. Signature generation and verification are
 222 described in DSA_sign(3).
 223 .PP
 224 The \fB\s-1DSA\s0\fR structure consists of several \s-1BIGNUM\s0 components.
 225 .PP
 226 .Vb 10
 227 \& struct
 228 \&        {
 229 \&        BIGNUM *p;              // prime number (public)
 230 \&        BIGNUM *q;              // 160-bit subprime, q | p-1 (public)
 231 \&        BIGNUM *g;              // generator of subgroup (public)
 232 \&        BIGNUM *priv_key;       // private key x
 233 \&        BIGNUM *pub_key;        // public key y = g^x
 234 \&        // ...
 235 \&        }
 236 \& DSA;
 237 .Ve
 238 In public keys, \fBpriv_key\fR is \s-1NULL\s0.
 239 .PP
 240 Note that \s-1DSA\s0 keys may use non-standard \fB\s-1DSA_METHOD\s0\fR implementations,
 241 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 242 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 243 will not be used by the implementation or may be used for alternative data
 244 storage. For this reason, applications should generally avoid using \s-1DSA\s0
 245 structure elements directly and instead use \s-1API\s0 functions to query or
 246 modify keys.
 247 .SH "CONFORMING TO"
 248 .IX Header "CONFORMING TO"
 249 \&\s-1US\s0 Federal Information Processing Standard \s-1FIPS\s0 186 (Digital Signature
 250 Standard, \s-1DSS\s0), \s-1ANSI\s0 X9.30
 251 .SH "SEE ALSO"
 252 .IX Header "SEE ALSO"
 253 bn(3), dh(3), err(3), rand(3),
 254 rsa(3), sha(3), engine(3),
 255 DSA_new(3),
 256 DSA_size(3),
 257 DSA_generate_parameters(3),
 258 DSA_dup_DH(3),
 259 DSA_generate_key(3),
 260 DSA_sign(3), DSA_set_method(3),
 261 DSA_get_ex_new_index(3),
 262 RSA_print(3)