secure/lib/libcrypto/man/dsa.3

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH dsa 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 dsa \- Digital Signature Algorithm
 192 .SH "SYNOPSIS"
 193 .PP
 194 .Vb 2
 195 \& #include <openssl/dsa.h>
 196 \& #include <openssl/engine.h>
 197 .Ve
 198 .Vb 2
 199 \& DSA *  DSA_new(void);
 200 \& void   DSA_free(DSA *dsa);
 201 .Ve
 202 .Vb 1
 203 \& int    DSA_size(const DSA *dsa);
 204 .Ve
 205 .Vb 3
 206 \& DSA *  DSA_generate_parameters(int bits, unsigned char *seed,
 207 \&                int seed_len, int *counter_ret, unsigned long *h_ret,
 208 \&                void (*callback)(int, int, void *), void *cb_arg);
 209 .Ve
 210 .Vb 1
 211 \& DH *   DSA_dup_DH(const DSA *r);
 212 .Ve
 213 .Vb 1
 214 \& int    DSA_generate_key(DSA *dsa);
 215 .Ve
 216 .Vb 6
 217 \& int    DSA_sign(int dummy, const unsigned char *dgst, int len,
 218 \&                unsigned char *sigret, unsigned int *siglen, DSA *dsa);
 219 \& int    DSA_sign_setup(DSA *dsa, BN_CTX *ctx, BIGNUM **kinvp,
 220 \&                BIGNUM **rp);
 221 \& int    DSA_verify(int dummy, const unsigned char *dgst, int len,
 222 \&                const unsigned char *sigbuf, int siglen, DSA *dsa);
 223 .Ve
 224 .Vb 5
 225 \& void DSA_set_default_method(const DSA_METHOD *meth);
 226 \& const DSA_METHOD *DSA_get_default_method(void);
 227 \& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
 228 \& DSA *DSA_new_method(ENGINE *engine);
 229 \& const DSA_METHOD *DSA_OpenSSL(void);
 230 .Ve
 231 .Vb 4
 232 \& int DSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 233 \&             int (*dup_func)(), void (*free_func)());
 234 \& int DSA_set_ex_data(DSA *d, int idx, char *arg);
 235 \& char *DSA_get_ex_data(DSA *d, int idx);
 236 .Ve
 237 .Vb 4
 238 \& DSA_SIG *DSA_SIG_new(void);
 239 \& void   DSA_SIG_free(DSA_SIG *a);
 240 \& int    i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 241 \& DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, unsigned char **pp, long length);
 242 .Ve
 243 .Vb 3
 244 \& DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
 245 \& int    DSA_do_verify(const unsigned char *dgst, int dgst_len,
 246 \&             DSA_SIG *sig, DSA *dsa);
 247 .Ve
 248 .Vb 6
 249 \& DSA *  d2i_DSAPublicKey(DSA **a, unsigned char **pp, long length);
 250 \& DSA *  d2i_DSAPrivateKey(DSA **a, unsigned char **pp, long length);
 251 \& DSA *  d2i_DSAparams(DSA **a, unsigned char **pp, long length);
 252 \& int    i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 253 \& int    i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 254 \& int    i2d_DSAparams(const DSA *a,unsigned char **pp);
 255 .Ve
 256 .Vb 4
 257 \& int    DSAparams_print(BIO *bp, const DSA *x);
 258 \& int    DSAparams_print_fp(FILE *fp, const DSA *x);
 259 \& int    DSA_print(BIO *bp, const DSA *x, int off);
 260 \& int    DSA_print_fp(FILE *bp, const DSA *x, int off);
 261 .Ve
 262 .SH "DESCRIPTION"
 263 These functions implement the Digital Signature Algorithm (DSA).  The
 264 generation of shared DSA parameters is described in
 265 DSA_generate_parameters(3);
 266 DSA_generate_key(3) describes how to
 267 generate a signature key. Signature generation and verification are
 268 described in DSA_sign(3).
 269 .PP
 270 The \fBDSA\fR structure consists of several BIGNUM components.
 271 .PP
 272 .Vb 10
 273 \& struct
 274 \&        {
 275 \&        BIGNUM *p;              // prime number (public)
 276 \&        BIGNUM *q;              // 160-bit subprime, q | p-1 (public)
 277 \&        BIGNUM *g;              // generator of subgroup (public)
 278 \&        BIGNUM *priv_key;       // private key x
 279 \&        BIGNUM *pub_key;        // public key y = g^x
 280 \&        // ...
 281 \&        }
 282 \& DSA;
 283 .Ve
 284 In public keys, \fBpriv_key\fR is NULL.
 285 .PP
 286 Note that DSA keys may use non-standard \fBDSA_METHOD\fR implementations,
 287 either directly or by the use of \fBENGINE\fR modules. In some cases (eg. an
 288 ENGINE providing support for hardware-embedded keys), these BIGNUM values
 289 will not be used by the implementation or may be used for alternative data
 290 storage. For this reason, applications should generally avoid using DSA
 291 structure elements directly and instead use API functions to query or
 292 modify keys.
 293 .SH "CONFORMING TO"
 294 US Federal Information Processing Standard FIPS 186 (Digital Signature
 295 Standard, DSS), ANSI X9.30
 296 .SH "SEE ALSO"
 297 bn(3), dh(3), err(3), rand(3),
 298 rsa(3), sha(3), engine(3),
 299 DSA_new(3),
 300 DSA_size(3),
 301 DSA_generate_parameters(3),
 302 DSA_dup_DH(3),
 303 DSA_generate_key(3),
 304 DSA_sign(3), DSA_set_method(3),
 305 DSA_get_ex_new_index(3),
 306 RSA_print(3)
 307
 308 .rn }` ''
 309 .IX Title "dsa 3"
 310 .IX Name "dsa - Digital Signature Algorithm"
 311
 312 .IX Header "NAME"
 313
 314 .IX Header "SYNOPSIS"
 315
 316 .IX Header "DESCRIPTION"
 317
 318 .IX Header "CONFORMING TO"
 319
 320 .IX Header "SEE ALSO"
 321