secure/lib/libcrypto/man/DH_set_method.3

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