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