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

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