crypto/external/bsd/openssl/lib/libcrypto/man/DSA_set_method.3

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