secure/lib/libcrypto/man/DSA_set_method.3

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.23)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "DSA_set_method 3"
 127 .TH DSA_set_method 3 "2013-02-05" "1.0.1d" "OpenSSL"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 DSA_set_default_method, DSA_get_default_method,
 134 DSA_set_method, DSA_new_method, DSA_OpenSSL \- select DSA method
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \& #include <openssl/dsa.h>
 139 \& #include <openssl/engine.h>
 140 \&
 141 \& void DSA_set_default_method(const DSA_METHOD *meth);
 142 \&
 143 \& const DSA_METHOD *DSA_get_default_method(void);
 144 \&
 145 \& int DSA_set_method(DSA *dsa, const DSA_METHOD *meth);
 146 \&
 147 \& DSA *DSA_new_method(ENGINE *engine);
 148 \&
 149 \& DSA_METHOD *DSA_OpenSSL(void);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 A \fB\s-1DSA_METHOD\s0\fR specifies the functions that OpenSSL uses for \s-1DSA\s0
 154 operations. By modifying the method, alternative implementations
 155 such as hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
 156 important information about how these \s-1DSA\s0 \s-1API\s0 functions are affected by the use
 157 of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
 158 .PP
 159 Initially, the default \s-1DSA_METHOD\s0 is the OpenSSL internal implementation,
 160 as returned by \fIDSA_OpenSSL()\fR.
 161 .PP
 162 \&\fIDSA_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1DSA\s0
 163 structures created later. \fB\s-1NB\s0\fR: This is true only whilst no \s-1ENGINE\s0 has
 164 been set as a default for \s-1DSA\s0, so this function is no longer recommended.
 165 .PP
 166 \&\fIDSA_get_default_method()\fR returns a pointer to the current default
 167 \&\s-1DSA_METHOD\s0. However, the meaningfulness of this result is dependent on
 168 whether the \s-1ENGINE\s0 \s-1API\s0 is being used, so this function is no longer
 169 recommended.
 170 .PP
 171 \&\fIDSA_set_method()\fR selects \fBmeth\fR to perform all operations using the key
 172 \&\fBrsa\fR. This will replace the \s-1DSA_METHOD\s0 used by the \s-1DSA\s0 key and if the
 173 previous method was supplied by an \s-1ENGINE\s0, the handle to that \s-1ENGINE\s0 will
 174 be released during the change. It is possible to have \s-1DSA\s0 keys that only
 175 work with certain \s-1DSA_METHOD\s0 implementations (eg. from an \s-1ENGINE\s0 module
 176 that supports embedded hardware-protected keys), and in such cases
 177 attempting to change the \s-1DSA_METHOD\s0 for the key can have unexpected
 178 results.
 179 .PP
 180 \&\fIDSA_new_method()\fR allocates and initializes a \s-1DSA\s0 structure so that \fBengine\fR
 181 will be used for the \s-1DSA\s0 operations. If \fBengine\fR is \s-1NULL\s0, the default engine
 182 for \s-1DSA\s0 operations is used, and if no default \s-1ENGINE\s0 is set, the \s-1DSA_METHOD\s0
 183 controlled by \fIDSA_set_default_method()\fR is used.
 184 .SH "THE DSA_METHOD STRUCTURE"
 185 .IX Header "THE DSA_METHOD STRUCTURE"
 186 struct
 187  {
 188      /* name of the implementation */
 189         const char *name;
 190 .PP
 191 .Vb 3
 192 \&     /* sign */
 193 \&        DSA_SIG *(*dsa_do_sign)(const unsigned char *dgst, int dlen,
 194 \&                                 DSA *dsa);
 195 \&
 196 \&     /* pre\-compute k^\-1 and r */
 197 \&        int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
 198 \&                                 BIGNUM **rp);
 199 \&
 200 \&     /* verify */
 201 \&        int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
 202 \&                                 DSA_SIG *sig, DSA *dsa);
 203 \&
 204 \&     /* compute rr = a1^p1 * a2^p2 mod m (May be NULL for some
 205 \&                                          implementations) */
 206 \&        int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
 207 \&                                 BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 208 \&                                 BN_CTX *ctx, BN_MONT_CTX *in_mont);
 209 \&
 210 \&     /* compute r = a ^ p mod m (May be NULL for some implementations) */
 211 \&        int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a,
 212 \&                                 const BIGNUM *p, const BIGNUM *m,
 213 \&                                 BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 214 \&
 215 \&     /* called at DSA_new */
 216 \&        int (*init)(DSA *DSA);
 217 \&
 218 \&     /* called at DSA_free */
 219 \&        int (*finish)(DSA *DSA);
 220 \&
 221 \&        int flags;
 222 \&
 223 \&        char *app_data; /* ?? */
 224 \&
 225 \& } DSA_METHOD;
 226 .Ve
 227 .SH "RETURN VALUES"
 228 .IX Header "RETURN VALUES"
 229 \&\fIDSA_OpenSSL()\fR and \fIDSA_get_default_method()\fR return pointers to the respective
 230 \&\fB\s-1DSA_METHOD\s0\fRs.
 231 .PP
 232 \&\fIDSA_set_default_method()\fR returns no value.
 233 .PP
 234 \&\fIDSA_set_method()\fR returns non-zero if the provided \fBmeth\fR was successfully set as
 235 the method for \fBdsa\fR (including unloading the \s-1ENGINE\s0 handle if the previous
 236 method was supplied by an \s-1ENGINE\s0).
 237 .PP
 238 \&\fIDSA_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be
 239 obtained by \fIERR_get_error\fR\|(3) if the allocation
 240 fails. Otherwise it returns a pointer to the newly allocated structure.
 241 .SH "NOTES"
 242 .IX Header "NOTES"
 243 As of version 0.9.7, \s-1DSA_METHOD\s0 implementations are grouped together with other
 244 algorithmic APIs (eg. \s-1RSA_METHOD\s0, \s-1EVP_CIPHER\s0, etc) in \fB\s-1ENGINE\s0\fR modules. If a
 245 default \s-1ENGINE\s0 is specified for \s-1DSA\s0 functionality using an \s-1ENGINE\s0 \s-1API\s0 function,
 246 that will override any \s-1DSA\s0 defaults set using the \s-1DSA\s0 \s-1API\s0 (ie.
 247 \&\fIDSA_set_default_method()\fR). For this reason, the \s-1ENGINE\s0 \s-1API\s0 is the recommended way
 248 to control default implementations for use in \s-1DSA\s0 and other cryptographic
 249 algorithms.
 250 .SH "SEE ALSO"
 251 .IX Header "SEE ALSO"
 252 \&\fIdsa\fR\|(3), \fIDSA_new\fR\|(3)
 253 .SH "HISTORY"
 254 .IX Header "HISTORY"
 255 \&\fIDSA_set_default_method()\fR, \fIDSA_get_default_method()\fR, \fIDSA_set_method()\fR,
 256 \&\fIDSA_new_method()\fR and \fIDSA_OpenSSL()\fR were added in OpenSSL 0.9.4.
 257 .PP
 258 \&\fIDSA_set_default_openssl_method()\fR and \fIDSA_get_default_openssl_method()\fR replaced
 259 \&\fIDSA_set_default_method()\fR and \fIDSA_get_default_method()\fR respectively, and
 260 \&\fIDSA_set_method()\fR and \fIDSA_new_method()\fR were altered to use \fB\s-1ENGINE\s0\fRs rather than
 261 \&\fB\s-1DSA_METHOD\s0\fRs during development of the engine version of OpenSSL 0.9.6. For
 262 0.9.7, the handling of defaults in the \s-1ENGINE\s0 \s-1API\s0 was restructured so that this
 263 change was reversed, and behaviour of the other functions resembled more closely
 264 the previous behaviour. The behaviour of defaults in the \s-1ENGINE\s0 \s-1API\s0 now
 265 transparently overrides the behaviour of defaults in the \s-1DSA\s0 \s-1API\s0 without
 266 requiring changing these function prototypes.