secure/lib/libcrypto/man/DSA_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 "DSA_GET0_PQG 3"
 132 .TH DSA_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 DSA_get0_pqg, DSA_set0_pqg, DSA_get0_key, DSA_set0_key, DSA_get0_p, DSA_get0_q, DSA_get0_g, DSA_get0_pub_key, DSA_get0_priv_key, DSA_clear_flags, DSA_test_flags, DSA_set_flags, DSA_get0_engine \- Routines for getting and setting data in a DSA object
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/dsa.h>
 143 \&
 144 \& void DSA_get0_pqg(const DSA *d,
 145 \&                   const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
 146 \& int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
 147 \& void DSA_get0_key(const DSA *d,
 148 \&                   const BIGNUM **pub_key, const BIGNUM **priv_key);
 149 \& int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
 150 \& const BIGNUM *DSA_get0_p(const DSA *d);
 151 \& const BIGNUM *DSA_get0_q(const DSA *d);
 152 \& const BIGNUM *DSA_get0_g(const DSA *d);
 153 \& const BIGNUM *DSA_get0_pub_key(const DSA *d);
 154 \& const BIGNUM *DSA_get0_priv_key(const DSA *d);
 155 \& void DSA_clear_flags(DSA *d, int flags);
 156 \& int DSA_test_flags(const DSA *d, int flags);
 157 \& void DSA_set_flags(DSA *d, int flags);
 158 \& ENGINE *DSA_get0_engine(DSA *d);
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 A \s-1DSA\s0 object contains the parameters \fBp\fR, \fBq\fR and \fBg\fR. It also contains a
 163 public key (\fBpub_key\fR) and (optionally) a private key (\fBpriv_key\fR).
 164 .PP
 165 The \fBp\fR, \fBq\fR and \fBg\fR parameters can be obtained by calling \fIDSA_get0_pqg()\fR.
 166 If the parameters have not yet been set then \fB*p\fR, \fB*q\fR and \fB*g\fR will be set
 167 to \s-1NULL.\s0 Otherwise they are set to pointers to their respective values. These
 168 point directly to the internal representations of the values and therefore
 169 should not be freed directly.
 170 .PP
 171 The \fBp\fR, \fBq\fR and \fBg\fR values can be set by calling \fIDSA_set0_pqg()\fR and passing
 172 the new values for \fBp\fR, \fBq\fR and \fBg\fR as parameters to the function. Calling
 173 this function transfers the memory management of the values to the \s-1DSA\s0 object,
 174 and therefore the values that have been passed in should not be freed directly
 175 after this function has been called.
 176 .PP
 177 To get the public and private key values use the \fIDSA_get0_key()\fR function. A
 178 pointer to the public key will be stored in \fB*pub_key\fR, and a pointer to the
 179 private key will be stored in \fB*priv_key\fR. Either may be \s-1NULL\s0 if they have not
 180 been set yet, although if the private key has been set then the public key must
 181 be. The values point to the internal representation of the public key and
 182 private key values. This memory should not be freed directly.
 183 .PP
 184 The public and private key values can be set using \fIDSA_set0_key()\fR. The public
 185 key must be non-NULL the first time this function is called on a given \s-1DSA\s0
 186 object. The private key may be \s-1NULL.\s0  On subsequent calls, either may be \s-1NULL,\s0
 187 which means the corresponding \s-1DSA\s0 field is left untouched. As for \fIDSA_set0_pqg()\fR
 188 this function transfers the memory management of the key values to the \s-1DSA\s0
 189 object, and therefore they should not be freed directly after this function has
 190 been called.
 191 .PP
 192 Any of the values \fBp\fR, \fBq\fR, \fBg\fR, \fBpriv_key\fR, and \fBpub_key\fR can also be
 193 retrieved separately by the corresponding function \fIDSA_get0_p()\fR, \fIDSA_get0_q()\fR,
 194 \&\fIDSA_get0_g()\fR, \fIDSA_get0_priv_key()\fR, and \fIDSA_get0_pub_key()\fR, respectively.
 195 .PP
 196 \&\fIDSA_set_flags()\fR sets the flags in the \fBflags\fR parameter on the \s-1DSA\s0 object.
 197 Multiple flags can be passed in one go (bitwise ORed together). Any flags that
 198 are already set are left set. \fIDSA_test_flags()\fR tests to see whether the flags
 199 passed in the \fBflags\fR parameter are currently set in the \s-1DSA\s0 object. Multiple
 200 flags can be tested in one go. All flags that are currently set are returned, or
 201 zero if none of the flags are set. \fIDSA_clear_flags()\fR clears the specified flags
 202 within the \s-1DSA\s0 object.
 203 .PP
 204 \&\fIDSA_get0_engine()\fR returns a handle to the \s-1ENGINE\s0 that has been set for this \s-1DSA\s0
 205 object, or \s-1NULL\s0 if no such \s-1ENGINE\s0 has been set.
 206 .SH "NOTES"
 207 .IX Header "NOTES"
 208 Values retrieved with \fIDSA_get0_key()\fR are owned by the \s-1DSA\s0 object used
 209 in the call and may therefore \fInot\fR be passed to \fIDSA_set0_key()\fR.  If
 210 needed, duplicate the received value using \fIBN_dup()\fR and pass the
 211 duplicate.  The same applies to \fIDSA_get0_pqg()\fR and \fIDSA_set0_pqg()\fR.
 212 .SH "RETURN VALUES"
 213 .IX Header "RETURN VALUES"
 214 \&\fIDSA_set0_pqg()\fR and \fIDSA_set0_key()\fR return 1 on success or 0 on failure.
 215 .PP
 216 \&\fIDSA_test_flags()\fR returns the current state of the flags in the \s-1DSA\s0 object.
 217 .PP
 218 \&\fIDSA_get0_engine()\fR returns the \s-1ENGINE\s0 set for the \s-1DSA\s0 object or \s-1NULL\s0 if no \s-1ENGINE\s0
 219 has been set.
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 \&\fIDSA_new\fR\|(3), \fIDSA_new\fR\|(3), \fIDSA_generate_parameters\fR\|(3), \fIDSA_generate_key\fR\|(3),
 223 \&\fIDSA_dup_DH\fR\|(3), \fIDSA_do_sign\fR\|(3), \fIDSA_set_method\fR\|(3), \fIDSA_SIG_new\fR\|(3),
 224 \&\fIDSA_sign\fR\|(3), \fIDSA_size\fR\|(3), \fIDSA_meth_new\fR\|(3)
 225 .SH "HISTORY"
 226 .IX Header "HISTORY"
 227 The functions described here were added in OpenSSL 1.1.0.
 228 .SH "COPYRIGHT"
 229 .IX Header "COPYRIGHT"
 230 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
 231 .PP
 232 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 233 this file except in compliance with the License.  You can obtain a copy
 234 in the file \s-1LICENSE\s0 in the source distribution or at
 235 <https://www.openssl.org/source/license.html>.