secure/lib/libcrypto/man/DSA_set_method.3

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