246 lines
9.9 KiB
Groff
Executable File
246 lines
9.9 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "DH_GET0_PQG 3"
|
|
.TH DH_GET0_PQG 3 "2020-03-02" "1.1.1e-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
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
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/dh.h>
|
|
\&
|
|
\& void DH_get0_pqg(const DH *dh,
|
|
\& const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
|
|
\& int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
|
|
\& void DH_get0_key(const DH *dh,
|
|
\& const BIGNUM **pub_key, const BIGNUM **priv_key);
|
|
\& int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
|
|
\& const BIGNUM *DH_get0_p(const DH *dh);
|
|
\& const BIGNUM *DH_get0_q(const DH *dh);
|
|
\& const BIGNUM *DH_get0_g(const DH *dh);
|
|
\& const BIGNUM *DH_get0_priv_key(const DH *dh);
|
|
\& const BIGNUM *DH_get0_pub_key(const DH *dh);
|
|
\& void DH_clear_flags(DH *dh, int flags);
|
|
\& int DH_test_flags(const DH *dh, int flags);
|
|
\& void DH_set_flags(DH *dh, int flags);
|
|
\& ENGINE *DH_get0_engine(DH *d);
|
|
\& long DH_get_length(const DH *dh);
|
|
\& int DH_set_length(DH *dh, long length);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
A \s-1DH\s0 object contains the parameters \fBp\fR, \fBq\fR and \fBg\fR. Note that the \fBq\fR
|
|
parameter is optional. It also contains a public key (\fBpub_key\fR) and
|
|
(optionally) a private key (\fBpriv_key\fR).
|
|
.PP
|
|
The \fBp\fR, \fBq\fR and \fBg\fR parameters can be obtained by calling \fIDH_get0_pqg()\fR.
|
|
If the parameters have not yet been set then \fB*p\fR, \fB*q\fR and \fB*g\fR will be set
|
|
to \s-1NULL\s0. Otherwise they are set to pointers to their respective values. These
|
|
point directly to the internal representations of the values and therefore
|
|
should not be freed directly.
|
|
Any of the out parameters \fBp\fR, \fBq\fR, and \fBg\fR can be \s-1NULL\s0, in which case no
|
|
value will be returned for that parameter.
|
|
.PP
|
|
The \fBp\fR, \fBq\fR and \fBg\fR values can be set by calling \fIDH_set0_pqg()\fR and passing
|
|
the new values for \fBp\fR, \fBq\fR and \fBg\fR as parameters to the function. Calling
|
|
this function transfers the memory management of the values to the \s-1DH\s0 object,
|
|
and therefore the values that have been passed in should not be freed directly
|
|
after this function has been called. The \fBq\fR parameter may be \s-1NULL\s0.
|
|
.PP
|
|
To get the public and private key values use the \fIDH_get0_key()\fR function. A
|
|
pointer to the public key will be stored in \fB*pub_key\fR, and a pointer to the
|
|
private key will be stored in \fB*priv_key\fR. Either may be \s-1NULL\s0 if they have not
|
|
been set yet, although if the private key has been set then the public key must
|
|
be. The values point to the internal representation of the public key and
|
|
private key values. This memory should not be freed directly.
|
|
Any of the out parameters \fBpub_key\fR and \fBpriv_key\fR can be \s-1NULL\s0, in which case
|
|
no value will be returned for that parameter.
|
|
.PP
|
|
The public and private key values can be set using \fIDH_set0_key()\fR. Either
|
|
parameter may be \s-1NULL\s0, which means the corresponding \s-1DH\s0 field is left
|
|
untouched. As with \fIDH_set0_pqg()\fR this function transfers the memory management
|
|
of the key values to the \s-1DH\s0 object, and therefore they should not be freed
|
|
directly after this function has been called.
|
|
.PP
|
|
Any of the values \fBp\fR, \fBq\fR, \fBg\fR, \fBpriv_key\fR, and \fBpub_key\fR can also be
|
|
retrieved separately by the corresponding function \fIDH_get0_p()\fR, \fIDH_get0_q()\fR,
|
|
\&\fIDH_get0_g()\fR, \fIDH_get0_priv_key()\fR, and \fIDH_get0_pub_key()\fR, respectively.
|
|
.PP
|
|
\&\fIDH_set_flags()\fR sets the flags in the \fBflags\fR parameter on the \s-1DH\s0 object.
|
|
Multiple flags can be passed in one go (bitwise ORed together). Any flags that
|
|
are already set are left set. \fIDH_test_flags()\fR tests to see whether the flags
|
|
passed in the \fBflags\fR parameter are currently set in the \s-1DH\s0 object. Multiple
|
|
flags can be tested in one go. All flags that are currently set are returned, or
|
|
zero if none of the flags are set. \fIDH_clear_flags()\fR clears the specified flags
|
|
within the \s-1DH\s0 object.
|
|
.PP
|
|
\&\fIDH_get0_engine()\fR returns a handle to the \s-1ENGINE\s0 that has been set for this \s-1DH\s0
|
|
object, or \s-1NULL\s0 if no such \s-1ENGINE\s0 has been set.
|
|
.PP
|
|
The \fIDH_get_length()\fR and \fIDH_set_length()\fR functions get and set the optional
|
|
length parameter associated with this \s-1DH\s0 object. If the length is non-zero then
|
|
it is used, otherwise it is ignored. The \fBlength\fR parameter indicates the
|
|
length of the secret exponent (private key) in bits.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
Values retrieved with \fIDH_get0_key()\fR are owned by the \s-1DH\s0 object used
|
|
in the call and may therefore \fInot\fR be passed to \fIDH_set0_key()\fR. If
|
|
needed, duplicate the received value using \fIBN_dup()\fR and pass the
|
|
duplicate. The same applies to \fIDH_get0_pqg()\fR and \fIDH_set0_pqg()\fR.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIDH_set0_pqg()\fR and \fIDH_set0_key()\fR return 1 on success or 0 on failure.
|
|
.PP
|
|
\&\fIDH_get0_p()\fR, \fIDH_get0_q()\fR, \fIDH_get0_g()\fR, \fIDH_get0_priv_key()\fR, and \fIDH_get0_pub_key()\fR
|
|
return the respective value, or \s-1NULL\s0 if it is unset.
|
|
.PP
|
|
\&\fIDH_test_flags()\fR returns the current state of the flags in the \s-1DH\s0 object.
|
|
.PP
|
|
\&\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
|
|
has been set.
|
|
.PP
|
|
\&\fIDH_get_length()\fR returns the length of the secret exponent (private key) in bits,
|
|
or zero if no such length has been explicitly set.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIDH_new\fR\|(3), \fIDH_new\fR\|(3), \fIDH_generate_parameters\fR\|(3), \fIDH_generate_key\fR\|(3),
|
|
\&\fIDH_set_method\fR\|(3), \fIDH_size\fR\|(3), \fIDH_meth_new\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The functions described here were added in OpenSSL 1.1.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|