secure/lib/libcrypto/man/EVP_PKEY_keygen.3

   1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-11-02" "1.0.2m" "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_PKEVP_PKEY_CTX_set_app_data, EVP_PKEY_CTX_get_app_data \- key and parameter generation 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 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 The \fIEVP_PKEY_keygen_init()\fR function initializes a public key algorithm
 162 context using key \fBpkey\fR for a key genration operation.
 163 .PP
 164 The \fIEVP_PKEY_keygen()\fR function performs a key generation operation, the
 165 generated key is written to \fBppkey\fR.
 166 .PP
 167 The functions \fIEVP_PKEY_paramgen_init()\fR and \fIEVP_PKEY_paramgen()\fR are similar
 168 except parameters are generated.
 169 .PP
 170 The function \fIEVP_PKEY_set_cb()\fR sets the key or parameter generation callback
 171 to \fBcb\fR. The function \fIEVP_PKEY_CTX_get_cb()\fR returns the key or parameter
 172 generation callback.
 173 .PP
 174 The function \fIEVP_PKEY_CTX_get_keygen_info()\fR returns parameters associated
 175 with the generation operation. If \fBidx\fR is \-1 the total number of
 176 parameters available is returned. Any non negative value returns the value of
 177 that parameter. \fIEVP_PKEY_CTX_gen_keygen_info()\fR with a non-negative value for
 178 \&\fBidx\fR should only be called within the generation callback.
 179 .PP
 180 If the callback returns 0 then the key genration operation is aborted and an
 181 error occurs. This might occur during a time consuming operation where
 182 a user clicks on a \*(L"cancel\*(R" button.
 183 .PP
 184 The functions \fIEVP_PKEY_CTX_set_app_data()\fR and \fIEVP_PKEY_CTX_get_app_data()\fR set
 185 and retrieve an opaque pointer. This can be used to set some application
 186 defined value which can be retrieved in the callback: for example a handle
 187 which is used to update a \*(L"progress dialog\*(R".
 188 .SH "NOTES"
 189 .IX Header "NOTES"
 190 After the call to \fIEVP_PKEY_keygen_init()\fR or \fIEVP_PKEY_paramgen_init()\fR algorithm
 191 specific control operations can be performed to set any appropriate parameters
 192 for the operation.
 193 .PP
 194 The functions \fIEVP_PKEY_keygen()\fR and \fIEVP_PKEY_paramgen()\fR can be called more than
 195 once on the same context if several operations are performed using the same
 196 parameters.
 197 .PP
 198 The meaning of the parameters passed to the callback will depend on the
 199 algorithm and the specifiic implementation of the algorithm. Some might not
 200 give any useful information at all during key or parameter generation. Others
 201 might not even call the callback.
 202 .PP
 203 The operation performed by key or parameter generation depends on the algorithm
 204 used. In some cases (e.g. \s-1EC\s0 with a supplied named curve) the \*(L"generation\*(R"
 205 option merely sets the appropriate fields in an \s-1EVP_PKEY\s0 structure.
 206 .PP
 207 In OpenSSL an \s-1EVP_PKEY\s0 structure containing a private key also contains the
 208 public key components and parameters (if any). An OpenSSL private key is
 209 equivalent to what some libraries call a \*(L"key pair\*(R". A private key can be used
 210 in functions which require the use of a public key or parameters.
 211 .SH "RETURN VALUES"
 212 .IX Header "RETURN VALUES"
 213 \&\fIEVP_PKEY_keygen_init()\fR, \fIEVP_PKEY_paramgen_init()\fR, \fIEVP_PKEY_keygen()\fR and
 214 \&\fIEVP_PKEY_paramgen()\fR return 1 for success and 0 or a negative value for failure.
 215 In particular a return value of \-2 indicates the operation is not supported by
 216 the public key algorithm.
 217 .SH "EXAMPLES"
 218 .IX Header "EXAMPLES"
 219 Generate a 2048 bit \s-1RSA\s0 key:
 220 .PP
 221 .Vb 2
 222 \& #include <openssl/evp.h>
 223 \& #include <openssl/rsa.h>
 224 \&
 225 \& EVP_PKEY_CTX *ctx;
 226 \& EVP_PKEY *pkey = NULL;
 227 \& ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_RSA, NULL);
 228 \& if (!ctx)
 229 \&        /* Error occurred */
 230 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
 231 \&        /* Error */
 232 \& if (EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, 2048) <= 0)
 233 \&        /* Error */
 234 \&
 235 \& /* Generate key */
 236 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
 237 \&        /* Error */
 238 .Ve
 239 .PP
 240 Generate a key from a set of parameters:
 241 .PP
 242 .Vb 2
 243 \& #include <openssl/evp.h>
 244 \& #include <openssl/rsa.h>
 245 \&
 246 \& EVP_PKEY_CTX *ctx;
 247 \& EVP_PKEY *pkey = NULL, *param;
 248 \& /* Assumed param is set up already */
 249 \& ctx = EVP_PKEY_CTX_new(param);
 250 \& if (!ctx)
 251 \&        /* Error occurred */
 252 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
 253 \&        /* Error */
 254 \&
 255 \& /* Generate key */
 256 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
 257 \&        /* Error */
 258 .Ve
 259 .PP
 260 Example of generation callback for OpenSSL public key implementations:
 261 .PP
 262 .Vb 1
 263 \& /* Application data is a BIO to output status to */
 264 \&
 265 \& EVP_PKEY_CTX_set_app_data(ctx, status_bio);
 266 \&
 267 \& static int genpkey_cb(EVP_PKEY_CTX *ctx)
 268 \&        {
 269 \&        char c=\*(Aq*\*(Aq;
 270 \&        BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
 271 \&        int p;
 272 \&        p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
 273 \&        if (p == 0) c=\*(Aq.\*(Aq;
 274 \&        if (p == 1) c=\*(Aq+\*(Aq;
 275 \&        if (p == 2) c=\*(Aq*\*(Aq;
 276 \&        if (p == 3) c=\*(Aq\en\*(Aq;
 277 \&        BIO_write(b,&c,1);
 278 \&        (void)BIO_flush(b);
 279 \&        return 1;
 280 \&        }
 281 .Ve
 282 .SH "SEE ALSO"
 283 .IX Header "SEE ALSO"
 284 \&\fIEVP_PKEY_CTX_new\fR\|(3),
 285 \&\fIEVP_PKEY_encrypt\fR\|(3),
 286 \&\fIEVP_PKEY_decrypt\fR\|(3),
 287 \&\fIEVP_PKEY_sign\fR\|(3),
 288 \&\fIEVP_PKEY_verify\fR\|(3),
 289 \&\fIEVP_PKEY_verify_recover\fR\|(3),
 290 \&\fIEVP_PKEY_derive\fR\|(3)
 291 .SH "HISTORY"
 292 .IX Header "HISTORY"
 293 These functions were first added to OpenSSL 1.0.0.