secure/lib/libcrypto/man/DH_get0_pqg.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_GET0_PQG 3"
 132 .TH DH_GET0_PQG 3 "2018-09-11" "1.1.1" "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_get0_pqg, DH_set0_pqg, DH_get0_key, DH_set0_key, DH_get0_p, DH_get0_q, DH_get0_g, DH_get0_priv_key, DH_get0_pub_key, DH_clear_flags, DH_test_flags, DH_set_flags, DH_get0_engine, DH_get_length, DH_set_length \- Routines for getting and setting data in a DH object
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/dh.h>
 143 \&
 144 \& void DH_get0_pqg(const DH *dh,
 145 \&                  const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
 146 \& int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
 147 \& void DH_get0_key(const DH *dh,
 148 \&                  const BIGNUM **pub_key, const BIGNUM **priv_key);
 149 \& int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
 150 \& const BIGNUM *DH_get0_p(const DH *dh);
 151 \& const BIGNUM *DH_get0_q(const DH *dh);
 152 \& const BIGNUM *DH_get0_g(const DH *dh);
 153 \& const BIGNUM *DH_get0_priv_key(const DH *dh);
 154 \& const BIGNUM *DH_get0_pub_key(const DH *dh);
 155 \& void DH_clear_flags(DH *dh, int flags);
 156 \& int DH_test_flags(const DH *dh, int flags);
 157 \& void DH_set_flags(DH *dh, int flags);
 158 \& ENGINE *DH_get0_engine(DH *d);
 159 \& long DH_get_length(const DH *dh);
 160 \& int DH_set_length(DH *dh, long length);
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 A \s-1DH\s0 object contains the parameters \fBp\fR, \fBq\fR and \fBg\fR. Note that the \fBq\fR
 165 parameter is optional. It also contains a public key (\fBpub_key\fR) and
 166 (optionally) a private key (\fBpriv_key\fR).
 167 .PP
 168 The \fBp\fR, \fBq\fR and \fBg\fR parameters can be obtained by calling \fIDH_get0_pqg()\fR.
 169 If the parameters have not yet been set then \fB*p\fR, \fB*q\fR and \fB*g\fR will be set
 170 to \s-1NULL.\s0 Otherwise they are set to pointers to their respective values. These
 171 point directly to the internal representations of the values and therefore
 172 should not be freed directly.
 173 Any of the out parameters \fBp\fR, \fBq\fR, and \fBg\fR can be \s-1NULL,\s0 in which case no
 174 value will be returned for that parameter.
 175 .PP
 176 The \fBp\fR, \fBq\fR and \fBg\fR values can be set by calling \fIDH_set0_pqg()\fR and passing
 177 the new values for \fBp\fR, \fBq\fR and \fBg\fR as parameters to the function. Calling
 178 this function transfers the memory management of the values to the \s-1DH\s0 object,
 179 and therefore the values that have been passed in should not be freed directly
 180 after this function has been called. The \fBq\fR parameter may be \s-1NULL.\s0
 181 .PP
 182 To get the public and private key values use the \fIDH_get0_key()\fR function. A
 183 pointer to the public key will be stored in \fB*pub_key\fR, and a pointer to the
 184 private key will be stored in \fB*priv_key\fR. Either may be \s-1NULL\s0 if they have not
 185 been set yet, although if the private key has been set then the public key must
 186 be. The values point to the internal representation of the public key and
 187 private key values. This memory should not be freed directly.
 188 Any of the out parameters \fBpub_key\fR and \fBpriv_key\fR can be \s-1NULL,\s0 in which case
 189 no value will be returned for that parameter.
 190 .PP
 191 The public and private key values can be set using \fIDH_set0_key()\fR. Either
 192 parameter may be \s-1NULL,\s0 which means the corresponding \s-1DH\s0 field is left
 193 untouched. As with \fIDH_set0_pqg()\fR this function transfers the memory management
 194 of the key values to the \s-1DH\s0 object, and therefore they should not be freed
 195 directly after this function has been called.
 196 .PP
 197 Any of the values \fBp\fR, \fBq\fR, \fBg\fR, \fBpriv_key\fR, and \fBpub_key\fR can also be
 198 retrieved separately by the corresponding function \fIDH_get0_p()\fR, \fIDH_get0_q()\fR,
 199 \&\fIDH_get0_g()\fR, \fIDH_get0_priv_key()\fR, and \fIDH_get0_pub_key()\fR, respectively.
 200 .PP
 201 \&\fIDH_set_flags()\fR sets the flags in the \fBflags\fR parameter on the \s-1DH\s0 object.
 202 Multiple flags can be passed in one go (bitwise ORed together). Any flags that
 203 are already set are left set. \fIDH_test_flags()\fR tests to see whether the flags
 204 passed in the \fBflags\fR parameter are currently set in the \s-1DH\s0 object. Multiple
 205 flags can be tested in one go. All flags that are currently set are returned, or
 206 zero if none of the flags are set. \fIDH_clear_flags()\fR clears the specified flags
 207 within the \s-1DH\s0 object.
 208 .PP
 209 \&\fIDH_get0_engine()\fR returns a handle to the \s-1ENGINE\s0 that has been set for this \s-1DH\s0
 210 object, or \s-1NULL\s0 if no such \s-1ENGINE\s0 has been set.
 211 .PP
 212 The \fIDH_get_length()\fR and \fIDH_set_length()\fR functions get and set the optional
 213 length parameter associated with this \s-1DH\s0 object. If the length is non-zero then
 214 it is used, otherwise it is ignored. The \fBlength\fR parameter indicates the
 215 length of the secret exponent (private key) in bits.
 216 .SH "NOTES"
 217 .IX Header "NOTES"
 218 Values retrieved with \fIDH_get0_key()\fR are owned by the \s-1DH\s0 object used
 219 in the call and may therefore \fInot\fR be passed to \fIDH_set0_key()\fR.  If
 220 needed, duplicate the received value using \fIBN_dup()\fR and pass the
 221 duplicate.  The same applies to \fIDH_get0_pqg()\fR and \fIDH_set0_pqg()\fR.
 222 .SH "RETURN VALUES"
 223 .IX Header "RETURN VALUES"
 224 \&\fIDH_set0_pqg()\fR and \fIDH_set0_key()\fR return 1 on success or 0 on failure.
 225 .PP
 226 \&\fIDH_get0_p()\fR, \fIDH_get0_q()\fR, \fIDH_get0_g()\fR, \fIDH_get0_priv_key()\fR, and \fIDH_get0_pub_key()\fR
 227 return the respective value, or \s-1NULL\s0 if it is unset.
 228 .PP
 229 \&\fIDH_test_flags()\fR returns the current state of the flags in the \s-1DH\s0 object.
 230 .PP
 231 \&\fIDH_get0_engine()\fR returns the \s-1ENGINE\s0 set for the \s-1DH\s0 object or \s-1NULL\s0 if no \s-1ENGINE\s0
 232 has been set.
 233 .PP
 234 \&\fIDH_get_length()\fR returns the length of the secret exponent (private key) in bits,
 235 or zero if no such length has been explicitly set.
 236 .SH "SEE ALSO"
 237 .IX Header "SEE ALSO"
 238 \&\fIDH_new\fR\|(3), \fIDH_new\fR\|(3), \fIDH_generate_parameters\fR\|(3), \fIDH_generate_key\fR\|(3),
 239 \&\fIDH_set_method\fR\|(3), \fIDH_size\fR\|(3), \fIDH_meth_new\fR\|(3)
 240 .SH "HISTORY"
 241 .IX Header "HISTORY"
 242 The functions described here were added in OpenSSL 1.1.0.
 243 .SH "COPYRIGHT"
 244 .IX Header "COPYRIGHT"
 245 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 246 .PP
 247 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 248 this file except in compliance with the License.  You can obtain a copy
 249 in the file \s-1LICENSE\s0 in the source distribution or at
 250 <https://www.openssl.org/source/license.html>.