secure/lib/libcrypto/man/DH_set_method.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:42:50 2003
   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 "DH_set_method 3"
 141 .TH DH_set_method 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 DH_set_default_method, DH_get_default_method,
 145 DH_set_method, DH_new_method, DH_OpenSSL \- select \s-1DH\s0 method
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 2
 149 \& #include <openssl/dh.h>
 150 \& #include <openssl/engine.h>
 151 .Ve
 152 .Vb 1
 153 \& void DH_set_default_method(const DH_METHOD *meth);
 154 .Ve
 155 .Vb 1
 156 \& const DH_METHOD *DH_get_default_method(void);
 157 .Ve
 158 .Vb 1
 159 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
 160 .Ve
 161 .Vb 1
 162 \& DH *DH_new_method(ENGINE *engine);
 163 .Ve
 164 .Vb 1
 165 \& const DH_METHOD *DH_OpenSSL(void);
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 A \fB\s-1DH_METHOD\s0\fR specifies the functions that OpenSSL uses for Diffie-Hellman
 170 operations. By modifying the method, alternative implementations
 171 such as hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
 172 important information about how these \s-1DH\s0 \s-1API\s0 functions are affected by the use
 173 of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
 174 .PP
 175 Initially, the default \s-1DH_METHOD\s0 is the OpenSSL internal implementation, as
 176 returned by \fIDH_OpenSSL()\fR.
 177 .PP
 178 \&\fIDH_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1DH\s0
 179 structures created later. \fB\s-1NB\s0\fR: This is true only whilst no \s-1ENGINE\s0 has been set
 180 as a default for \s-1DH\s0, so this function is no longer recommended.
 181 .PP
 182 \&\fIDH_get_default_method()\fR returns a pointer to the current default \s-1DH_METHOD\s0.
 183 However, the meaningfulness of this result is dependant on whether the \s-1ENGINE\s0
 184 \&\s-1API\s0 is being used, so this function is no longer recommended.
 185 .PP
 186 \&\fIDH_set_method()\fR selects \fBmeth\fR to perform all operations using the key \fBdh\fR.
 187 This will replace the \s-1DH_METHOD\s0 used by the \s-1DH\s0 key and if the previous method
 188 was supplied by an \s-1ENGINE\s0, the handle to that \s-1ENGINE\s0 will be released during the
 189 change. It is possible to have \s-1DH\s0 keys that only work with certain \s-1DH_METHOD\s0
 190 implementations (eg. from an \s-1ENGINE\s0 module that supports embedded
 191 hardware-protected keys), and in such cases attempting to change the \s-1DH_METHOD\s0
 192 for the key can have unexpected results.
 193 .PP
 194 \&\fIDH_new_method()\fR allocates and initializes a \s-1DH\s0 structure so that \fBengine\fR will
 195 be used for the \s-1DH\s0 operations. If \fBengine\fR is \s-1NULL\s0, the default \s-1ENGINE\s0 for \s-1DH\s0
 196 operations is used, and if no default \s-1ENGINE\s0 is set, the \s-1DH_METHOD\s0 controlled by
 197 \&\fIDH_set_default_method()\fR is used.
 198 .SH "THE DH_METHOD STRUCTURE"
 199 .IX Header "THE DH_METHOD STRUCTURE"
 200 .Vb 4
 201 \& typedef struct dh_meth_st
 202 \& {
 203 \&     /* name of the implementation */
 204 \&        const char *name;
 205 .Ve
 206 .Vb 2
 207 \&     /* generate private and public DH values for key agreement */
 208 \&        int (*generate_key)(DH *dh);
 209 .Ve
 210 .Vb 2
 211 \&     /* compute shared secret */
 212 \&        int (*compute_key)(unsigned char *key, BIGNUM *pub_key, DH *dh);
 213 .Ve
 214 .Vb 4
 215 \&     /* compute r = a ^ p mod m (May be NULL for some implementations) */
 216 \&        int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 217 \&                                const BIGNUM *m, BN_CTX *ctx,
 218 \&                                BN_MONT_CTX *m_ctx);
 219 .Ve
 220 .Vb 2
 221 \&     /* called at DH_new */
 222 \&        int (*init)(DH *dh);
 223 .Ve
 224 .Vb 2
 225 \&     /* called at DH_free */
 226 \&        int (*finish)(DH *dh);
 227 .Ve
 228 .Vb 1
 229 \&        int flags;
 230 .Ve
 231 .Vb 1
 232 \&        char *app_data; /* ?? */
 233 .Ve
 234 .Vb 1
 235 \& } DH_METHOD;
 236 .Ve
 237 .SH "RETURN VALUES"
 238 .IX Header "RETURN VALUES"
 239 \&\fIDH_OpenSSL()\fR and \fIDH_get_default_method()\fR return pointers to the respective
 240 \&\fB\s-1DH_METHOD\s0\fRs.
 241 .PP
 242 \&\fIDH_set_default_method()\fR returns no value.
 243 .PP
 244 \&\fIDH_set_method()\fR returns non-zero if the provided \fBmeth\fR was successfully set as
 245 the method for \fBdh\fR (including unloading the \s-1ENGINE\s0 handle if the previous
 246 method was supplied by an \s-1ENGINE\s0).
 247 .PP
 248 \&\fIDH_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be obtained by
 249 ERR_get_error(3) if the allocation fails. Otherwise it
 250 returns a pointer to the newly allocated structure.
 251 .SH "NOTES"
 252 .IX Header "NOTES"
 253 As of version 0.9.7, \s-1DH_METHOD\s0 implementations are grouped together with other
 254 algorithmic APIs (eg. \s-1RSA_METHOD\s0, \s-1EVP_CIPHER\s0, etc) in \fB\s-1ENGINE\s0\fR modules. If a
 255 default \s-1ENGINE\s0 is specified for \s-1DH\s0 functionality using an \s-1ENGINE\s0 \s-1API\s0 function,
 256 that will override any \s-1DH\s0 defaults set using the \s-1DH\s0 \s-1API\s0 (ie.
 257 \&\fIDH_set_default_method()\fR). For this reason, the \s-1ENGINE\s0 \s-1API\s0 is the recommended way
 258 to control default implementations for use in \s-1DH\s0 and other cryptographic
 259 algorithms.
 260 .SH "SEE ALSO"
 261 .IX Header "SEE ALSO"
 262 dh(3), DH_new(3)
 263 .SH "HISTORY"
 264 .IX Header "HISTORY"
 265 \&\fIDH_set_default_method()\fR, \fIDH_get_default_method()\fR, \fIDH_set_method()\fR,
 266 \&\fIDH_new_method()\fR and \fIDH_OpenSSL()\fR were added in OpenSSL 0.9.4.
 267 .PP
 268 \&\fIDH_set_default_openssl_method()\fR and \fIDH_get_default_openssl_method()\fR replaced
 269 \&\fIDH_set_default_method()\fR and \fIDH_get_default_method()\fR respectively, and
 270 \&\fIDH_set_method()\fR and \fIDH_new_method()\fR were altered to use \fB\s-1ENGINE\s0\fRs rather than
 271 \&\fB\s-1DH_METHOD\s0\fRs during development of the engine version of OpenSSL 0.9.6. For
 272 0.9.7, the handling of defaults in the \s-1ENGINE\s0 \s-1API\s0 was restructured so that this
 273 change was reversed, and behaviour of the other functions resembled more closely
 274 the previous behaviour. The behaviour of defaults in the \s-1ENGINE\s0 \s-1API\s0 now
 275 transparently overrides the behaviour of defaults in the \s-1DH\s0 \s-1API\s0 without
 276 requiring changing these function prototypes.