secure/lib/libcrypto/man/DSA_set_method.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Tue Jul 30 09:21:33 2002
   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_set_method 3"
 141 .TH DSA_set_method 3 "0.9.6e" "2000-11-12" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 DSA_set_default_method, DSA_get_default_method, DSA_set_method,
 145 DSA_new_method, DSA_OpenSSL \- select \s-1DSA\s0 method
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 1
 149 \& #include <openssl/dsa.h>
 150 .Ve
 151 .Vb 1
 152 \& void DSA_set_default_method(DSA_METHOD *meth);
 153 .Ve
 154 .Vb 1
 155 \& DSA_METHOD *DSA_get_default_method(void);
 156 .Ve
 157 .Vb 1
 158 \& DSA_METHOD *DSA_set_method(DSA *dsa, DSA_METHOD *meth);
 159 .Ve
 160 .Vb 1
 161 \& DSA *DSA_new_method(DSA_METHOD *meth);
 162 .Ve
 163 .Vb 1
 164 \& DSA_METHOD *DSA_OpenSSL(void);
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 A \fB\s-1DSA_METHOD\s0\fR specifies the functions that OpenSSL uses for \s-1DSA\s0
 169 operations. By modifying the method, alternative implementations
 170 such as hardware accelerators may be used.
 171 .PP
 172 Initially, the default is to use the OpenSSL internal implementation.
 173 \&\fIDSA_OpenSSL()\fR returns a pointer to that method.
 174 .PP
 175 \&\fIDSA_set_default_method()\fR makes \fBmeth\fR the default method for all \fB\s-1DSA\s0\fR
 176 structures created later.
 177 .PP
 178 \&\fIDSA_get_default_method()\fR returns a pointer to the current default
 179 method.
 180 .PP
 181 \&\fIDSA_set_method()\fR selects \fBmeth\fR for all operations using the structure \fBdsa\fR.
 182 .PP
 183 \&\fIDSA_new_method()\fR allocates and initializes a \fB\s-1DSA\s0\fR structure so that
 184 \&\fBmethod\fR will be used for the \s-1DSA\s0 operations. If \fBmethod\fR is \fB\s-1NULL\s0\fR,
 185 the default method is used.
 186 .SH "THE DSA_METHOD STRUCTURE"
 187 .IX Header "THE DSA_METHOD STRUCTURE"
 188 struct
 189  {
 190      /* name of the implementation */
 191         const char *name;
 192 .PP
 193 .Vb 3
 194 \&     /* sign */
 195 \&        DSA_SIG *(*dsa_do_sign)(const unsigned char *dgst, int dlen,
 196 \&                                 DSA *dsa);
 197 .Ve
 198 .Vb 3
 199 \&     /* pre-compute k^-1 and r */
 200 \&        int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
 201 \&                                 BIGNUM **rp);
 202 .Ve
 203 .Vb 3
 204 \&     /* verify */
 205 \&        int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
 206 \&                                 DSA_SIG *sig, DSA *dsa);
 207 .Ve
 208 .Vb 5
 209 \&     /* compute rr = a1^p1 * a2^p2 mod m (May be NULL for some
 210 \&                                          implementations) */
 211 \&        int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
 212 \&                                 BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 213 \&                                 BN_CTX *ctx, BN_MONT_CTX *in_mont);
 214 .Ve
 215 .Vb 4
 216 \&     /* compute r = a ^ p mod m (May be NULL for some implementations) */
 217 \&        int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a,
 218 \&                                 const BIGNUM *p, const BIGNUM *m,
 219 \&                                 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 220 .Ve
 221 .Vb 2
 222 \&     /* called at DSA_new */
 223 \&        int (*init)(DSA *DSA);
 224 .Ve
 225 .Vb 2
 226 \&     /* called at DSA_free */
 227 \&        int (*finish)(DSA *DSA);
 228 .Ve
 229 .Vb 1
 230 \&        int flags;
 231 .Ve
 232 .Vb 1
 233 \&        char *app_data; /* ?? */
 234 .Ve
 235 .Vb 1
 236 \& } DSA_METHOD;
 237 .Ve
 238 .SH "RETURN VALUES"
 239 .IX Header "RETURN VALUES"
 240 \&\fIDSA_OpenSSL()\fR and \fIDSA_get_default_method()\fR return pointers to the
 241 respective \fB\s-1DSA_METHOD\s0\fRs.
 242 .PP
 243 \&\fIDSA_set_default_method()\fR returns no value.
 244 .PP
 245 \&\fIDSA_set_method()\fR returns a pointer to the \fB\s-1DSA_METHOD\s0\fR previously
 246 associated with \fBdsa\fR.
 247 .PP
 248 \&\fIDSA_new_method()\fR returns \fB\s-1NULL\s0\fR and sets an error code that can be
 249 obtained by ERR_get_error(3) if the allocation
 250 fails. Otherwise it returns a pointer to the newly allocated
 251 structure.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 dsa(3), DSA_new(3)
 255 .SH "HISTORY"
 256 .IX Header "HISTORY"
 257 \&\fIDSA_set_default_method()\fR, \fIDSA_get_default_method()\fR, \fIDSA_set_method()\fR,
 258 \&\fIDSA_new_method()\fR and \fIDSA_OpenSSL()\fR were added in OpenSSL 0.9.4.