secure/lib/libcrypto/man/DH_set_method.3

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