secure/lib/libcrypto/man/man3/DH_set_method.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .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 "DH_SET_METHOD 3"
 136 .TH DH_SET_METHOD 3 "2020-04-21" "1.1.1g" "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 DH_set_default_method, DH_get_default_method, DH_set_method, DH_new_method, DH_OpenSSL \- select DH method
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/dh.h>
 147 \&
 148 \& void DH_set_default_method(const DH_METHOD *meth);
 149 \&
 150 \& const DH_METHOD *DH_get_default_method(void);
 151 \&
 152 \& int DH_set_method(DH *dh, const DH_METHOD *meth);
 153 \&
 154 \& DH *DH_new_method(ENGINE *engine);
 155 \&
 156 \& const DH_METHOD *DH_OpenSSL(void);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 A \fB\s-1DH_METHOD\s0\fR specifies the functions that OpenSSL uses for Diffie-Hellman
 161 operations. By modifying the method, alternative implementations
 162 such as hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
 163 important information about how these \s-1DH API\s0 functions are affected by the use
 164 of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
 165 .PP
 166 Initially, the default \s-1DH_METHOD\s0 is the OpenSSL internal implementation, as
 167 returned by \fBDH_OpenSSL()\fR.
 168 .PP
 169 \&\fBDH_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1DH\s0
 170 structures created later.
 171 \&\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 This function is not thread-safe and should not be called at the same time
 174 as other OpenSSL functions.
 175 .PP
 176 \&\fBDH_get_default_method()\fR returns a pointer to the current default \s-1DH_METHOD.\s0
 177 However, the meaningfulness of this result is dependent on whether the \s-1ENGINE
 178 API\s0 is being used, so this function is no longer recommended.
 179 .PP
 180 \&\fBDH_set_method()\fR selects \fBmeth\fR to perform all operations using the key \fBdh\fR.
 181 This will replace the \s-1DH_METHOD\s0 used by the \s-1DH\s0 key and if the previous method
 182 was supplied by an \s-1ENGINE,\s0 the handle to that \s-1ENGINE\s0 will be released during the
 183 change. It is possible to have \s-1DH\s0 keys that only work with certain \s-1DH_METHOD\s0
 184 implementations (eg. from an \s-1ENGINE\s0 module that supports embedded
 185 hardware-protected keys), and in such cases attempting to change the \s-1DH_METHOD\s0
 186 for the key can have unexpected results.
 187 .PP
 188 \&\fBDH_new_method()\fR allocates and initializes a \s-1DH\s0 structure so that \fBengine\fR will
 189 be used for the \s-1DH\s0 operations. If \fBengine\fR is \s-1NULL,\s0 the default \s-1ENGINE\s0 for \s-1DH\s0
 190 operations is used, and if no default \s-1ENGINE\s0 is set, the \s-1DH_METHOD\s0 controlled by
 191 \&\fBDH_set_default_method()\fR is used.
 192 .PP
 193 A new \s-1DH_METHOD\s0 object may be constructed using \fBDH_meth_new()\fR (see
 194 \&\fBDH_meth_new\fR\|(3)).
 195 .SH "RETURN VALUES"
 196 .IX Header "RETURN VALUES"
 197 \&\fBDH_OpenSSL()\fR and \fBDH_get_default_method()\fR return pointers to the respective
 198 \&\fB\s-1DH_METHOD\s0\fRs.
 199 .PP
 200 \&\fBDH_set_default_method()\fR returns no value.
 201 .PP
 202 \&\fBDH_set_method()\fR returns non-zero if the provided \fBmeth\fR was successfully set as
 203 the method for \fBdh\fR (including unloading the \s-1ENGINE\s0 handle if the previous
 204 method was supplied by an \s-1ENGINE\s0).
 205 .PP
 206 \&\fBDH_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be obtained by
 207 \&\fBERR_get_error\fR\|(3) if the allocation fails. Otherwise it
 208 returns a pointer to the newly allocated structure.
 209 .SH "SEE ALSO"
 210 .IX Header "SEE ALSO"
 211 \&\fBDH_new\fR\|(3), \fBDH_new\fR\|(3), \fBDH_meth_new\fR\|(3)
 212 .SH "COPYRIGHT"
 213 .IX Header "COPYRIGHT"
 214 Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
 215 .PP
 216 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 217 this file except in compliance with the License.  You can obtain a copy
 218 in the file \s-1LICENSE\s0 in the source distribution or at
 219 <https://www.openssl.org/source/license.html>.