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

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
   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 "EVP_PKEY_KEYGEN 3"
 136 .TH EVP_PKEY_KEYGEN 3 "2021-02-16" "1.1.1j" "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 EVP_PKEY_keygen_init, EVP_PKEY_keygen, EVP_PKEY_paramgen_init, EVP_PKEY_paramgen, EVP_PKEY_CTX_set_cb, EVP_PKEY_CTX_get_cb, EVP_PKEY_CTX_get_keygen_info, EVP_PKEY_CTX_set_app_data, EVP_PKEY_CTX_get_app_data, EVP_PKEY_gen_cb, EVP_PKEY_check, EVP_PKEY_public_check, EVP_PKEY_param_check \&\- key and parameter generation and check functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx);
 149 \& int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
 150 \& int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx);
 151 \& int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
 152 \&
 153 \& typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx);
 154 \&
 155 \& void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX *ctx, EVP_PKEY_gen_cb *cb);
 156 \& EVP_PKEY_gen_cb *EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX *ctx);
 157 \&
 158 \& int EVP_PKEY_CTX_get_keygen_info(EVP_PKEY_CTX *ctx, int idx);
 159 \&
 160 \& void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data);
 161 \& void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx);
 162 \&
 163 \& int EVP_PKEY_check(EVP_PKEY_CTX *ctx);
 164 \& int EVP_PKEY_public_check(EVP_PKEY_CTX *ctx);
 165 \& int EVP_PKEY_param_check(EVP_PKEY_CTX *ctx);
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 The \fBEVP_PKEY_keygen_init()\fR function initializes a public key algorithm
 170 context using key \fBpkey\fR for a key generation operation.
 171 .PP
 172 The \fBEVP_PKEY_keygen()\fR function performs a key generation operation, the
 173 generated key is written to \fBppkey\fR.
 174 .PP
 175 The functions \fBEVP_PKEY_paramgen_init()\fR and \fBEVP_PKEY_paramgen()\fR are similar
 176 except parameters are generated.
 177 .PP
 178 The function \fBEVP_PKEY_set_cb()\fR sets the key or parameter generation callback
 179 to \fBcb\fR. The function \fBEVP_PKEY_CTX_get_cb()\fR returns the key or parameter
 180 generation callback.
 181 .PP
 182 The function \fBEVP_PKEY_CTX_get_keygen_info()\fR returns parameters associated
 183 with the generation operation. If \fBidx\fR is \-1 the total number of
 184 parameters available is returned. Any non negative value returns the value of
 185 that parameter. \fBEVP_PKEY_CTX_gen_keygen_info()\fR with a nonnegative value for
 186 \&\fBidx\fR should only be called within the generation callback.
 187 .PP
 188 If the callback returns 0 then the key generation operation is aborted and an
 189 error occurs. This might occur during a time consuming operation where
 190 a user clicks on a \*(L"cancel\*(R" button.
 191 .PP
 192 The functions \fBEVP_PKEY_CTX_set_app_data()\fR and \fBEVP_PKEY_CTX_get_app_data()\fR set
 193 and retrieve an opaque pointer. This can be used to set some application
 194 defined value which can be retrieved in the callback: for example a handle
 195 which is used to update a \*(L"progress dialog\*(R".
 196 .PP
 197 \&\fBEVP_PKEY_check()\fR validates the key-pair given by \fBctx\fR. This function first tries
 198 to use customized key check method in \fB\s-1EVP_PKEY_METHOD\s0\fR if it's present; otherwise
 199 it calls a default one defined in \fB\s-1EVP_PKEY_ASN1_METHOD\s0\fR.
 200 .PP
 201 \&\fBEVP_PKEY_public_check()\fR validates the public component of the key-pair given by \fBctx\fR.
 202 This function first tries to use customized key check method in \fB\s-1EVP_PKEY_METHOD\s0\fR
 203 if it's present; otherwise it calls a default one defined in \fB\s-1EVP_PKEY_ASN1_METHOD\s0\fR.
 204 .PP
 205 \&\fBEVP_PKEY_param_check()\fR validates the algorithm parameters of the key-pair given by \fBctx\fR.
 206 This function first tries to use customized key check method in \fB\s-1EVP_PKEY_METHOD\s0\fR
 207 if it's present; otherwise it calls a default one defined in \fB\s-1EVP_PKEY_ASN1_METHOD\s0\fR.
 208 .SH "NOTES"
 209 .IX Header "NOTES"
 210 After the call to \fBEVP_PKEY_keygen_init()\fR or \fBEVP_PKEY_paramgen_init()\fR algorithm
 211 specific control operations can be performed to set any appropriate parameters
 212 for the operation.
 213 .PP
 214 The functions \fBEVP_PKEY_keygen()\fR and \fBEVP_PKEY_paramgen()\fR can be called more than
 215 once on the same context if several operations are performed using the same
 216 parameters.
 217 .PP
 218 The meaning of the parameters passed to the callback will depend on the
 219 algorithm and the specific implementation of the algorithm. Some might not
 220 give any useful information at all during key or parameter generation. Others
 221 might not even call the callback.
 222 .PP
 223 The operation performed by key or parameter generation depends on the algorithm
 224 used. In some cases (e.g. \s-1EC\s0 with a supplied named curve) the \*(L"generation\*(R"
 225 option merely sets the appropriate fields in an \s-1EVP_PKEY\s0 structure.
 226 .PP
 227 In OpenSSL an \s-1EVP_PKEY\s0 structure containing a private key also contains the
 228 public key components and parameters (if any). An OpenSSL private key is
 229 equivalent to what some libraries call a \*(L"key pair\*(R". A private key can be used
 230 in functions which require the use of a public key or parameters.
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fBEVP_PKEY_keygen_init()\fR, \fBEVP_PKEY_paramgen_init()\fR, \fBEVP_PKEY_keygen()\fR and
 234 \&\fBEVP_PKEY_paramgen()\fR return 1 for success and 0 or a negative value for failure.
 235 In particular a return value of \-2 indicates the operation is not supported by
 236 the public key algorithm.
 237 .PP
 238 \&\fBEVP_PKEY_check()\fR, \fBEVP_PKEY_public_check()\fR and \fBEVP_PKEY_param_check()\fR return 1
 239 for success or others for failure. They return \-2 if the operation is not supported
 240 for the specific algorithm.
 241 .SH "EXAMPLES"
 242 .IX Header "EXAMPLES"
 243 Generate a 2048 bit \s-1RSA\s0 key:
 244 .PP
 245 .Vb 2
 246 \& #include <openssl/evp.h>
 247 \& #include <openssl/rsa.h>
 248 \&
 249 \& EVP_PKEY_CTX *ctx;
 250 \& EVP_PKEY *pkey = NULL;
 251 \&
 252 \& ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_RSA, NULL);
 253 \& if (!ctx)
 254 \&     /* Error occurred */
 255 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
 256 \&     /* Error */
 257 \& if (EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, 2048) <= 0)
 258 \&     /* Error */
 259 \&
 260 \& /* Generate key */
 261 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
 262 \&     /* Error */
 263 .Ve
 264 .PP
 265 Generate a key from a set of parameters:
 266 .PP
 267 .Vb 2
 268 \& #include <openssl/evp.h>
 269 \& #include <openssl/rsa.h>
 270 \&
 271 \& EVP_PKEY_CTX *ctx;
 272 \& ENGINE *eng;
 273 \& EVP_PKEY *pkey = NULL, *param;
 274 \&
 275 \& /* Assumed param, eng are set up already */
 276 \& ctx = EVP_PKEY_CTX_new(param, eng);
 277 \& if (!ctx)
 278 \&     /* Error occurred */
 279 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
 280 \&     /* Error */
 281 \&
 282 \& /* Generate key */
 283 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
 284 \&     /* Error */
 285 .Ve
 286 .PP
 287 Example of generation callback for OpenSSL public key implementations:
 288 .PP
 289 .Vb 1
 290 \& /* Application data is a BIO to output status to */
 291 \&
 292 \& EVP_PKEY_CTX_set_app_data(ctx, status_bio);
 293 \&
 294 \& static int genpkey_cb(EVP_PKEY_CTX *ctx)
 295 \& {
 296 \&     char c = \*(Aq*\*(Aq;
 297 \&     BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
 298 \&     int p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
 299 \&
 300 \&     if (p == 0)
 301 \&         c = \*(Aq.\*(Aq;
 302 \&     if (p == 1)
 303 \&         c = \*(Aq+\*(Aq;
 304 \&     if (p == 2)
 305 \&         c = \*(Aq*\*(Aq;
 306 \&     if (p == 3)
 307 \&         c = \*(Aq\en\*(Aq;
 308 \&     BIO_write(b, &c, 1);
 309 \&     (void)BIO_flush(b);
 310 \&     return 1;
 311 \& }
 312 .Ve
 313 .SH "SEE ALSO"
 314 .IX Header "SEE ALSO"
 315 \&\fBEVP_PKEY_CTX_new\fR\|(3),
 316 \&\fBEVP_PKEY_encrypt\fR\|(3),
 317 \&\fBEVP_PKEY_decrypt\fR\|(3),
 318 \&\fBEVP_PKEY_sign\fR\|(3),
 319 \&\fBEVP_PKEY_verify\fR\|(3),
 320 \&\fBEVP_PKEY_verify_recover\fR\|(3),
 321 \&\fBEVP_PKEY_derive\fR\|(3)
 322 .SH "HISTORY"
 323 .IX Header "HISTORY"
 324 These functions were added in OpenSSL 1.0.0.
 325 .PP
 326 \&\fBEVP_PKEY_check()\fR, \fBEVP_PKEY_public_check()\fR and \fBEVP_PKEY_param_check()\fR were added
 327 in OpenSSL 1.1.1.
 328 .SH "COPYRIGHT"
 329 .IX Header "COPYRIGHT"
 330 Copyright 2006\-2020 The OpenSSL Project Authors. All Rights Reserved.
 331 .PP
 332 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 333 this file except in compliance with the License.  You can obtain a copy
 334 in the file \s-1LICENSE\s0 in the source distribution or at
 335 <https://www.openssl.org/source/license.html>.