secure/lib/libcrypto/man/DH_set_method.3

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