309 lines
9.9 KiB
Groff
Executable File
309 lines
9.9 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "EVP_PKEY_KEYGEN 3"
|
|
.TH EVP_PKEY_KEYGEN 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
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
|
|
\&\- key and parameter generation and check functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/evp.h>
|
|
\&
|
|
\& int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx);
|
|
\& int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
|
|
\& int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx);
|
|
\& int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
|
|
\&
|
|
\& typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx);
|
|
\&
|
|
\& void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX *ctx, EVP_PKEY_gen_cb *cb);
|
|
\& EVP_PKEY_gen_cb *EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX *ctx);
|
|
\&
|
|
\& int EVP_PKEY_CTX_get_keygen_info(EVP_PKEY_CTX *ctx, int idx);
|
|
\&
|
|
\& void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data);
|
|
\& void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fIEVP_PKEY_keygen_init()\fR function initializes a public key algorithm
|
|
context using key \fBpkey\fR for a key generation operation.
|
|
.PP
|
|
The \fIEVP_PKEY_keygen()\fR function performs a key generation operation, the
|
|
generated key is written to \fBppkey\fR.
|
|
.PP
|
|
The functions \fIEVP_PKEY_paramgen_init()\fR and \fIEVP_PKEY_paramgen()\fR are similar
|
|
except parameters are generated.
|
|
.PP
|
|
The function \fIEVP_PKEY_set_cb()\fR sets the key or parameter generation callback
|
|
to \fBcb\fR. The function \fIEVP_PKEY_CTX_get_cb()\fR returns the key or parameter
|
|
generation callback.
|
|
.PP
|
|
The function \fIEVP_PKEY_CTX_get_keygen_info()\fR returns parameters associated
|
|
with the generation operation. If \fBidx\fR is \-1 the total number of
|
|
parameters available is returned. Any non negative value returns the value of
|
|
that parameter. \fIEVP_PKEY_CTX_gen_keygen_info()\fR with a non-negative value for
|
|
\&\fBidx\fR should only be called within the generation callback.
|
|
.PP
|
|
If the callback returns 0 then the key generation operation is aborted and an
|
|
error occurs. This might occur during a time consuming operation where
|
|
a user clicks on a \*(L"cancel\*(R" button.
|
|
.PP
|
|
The functions \fIEVP_PKEY_CTX_set_app_data()\fR and \fIEVP_PKEY_CTX_get_app_data()\fR set
|
|
and retrieve an opaque pointer. This can be used to set some application
|
|
defined value which can be retrieved in the callback: for example a handle
|
|
which is used to update a \*(L"progress dialog\*(R".
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
After the call to \fIEVP_PKEY_keygen_init()\fR or \fIEVP_PKEY_paramgen_init()\fR algorithm
|
|
specific control operations can be performed to set any appropriate parameters
|
|
for the operation.
|
|
.PP
|
|
The functions \fIEVP_PKEY_keygen()\fR and \fIEVP_PKEY_paramgen()\fR can be called more than
|
|
once on the same context if several operations are performed using the same
|
|
parameters.
|
|
.PP
|
|
The meaning of the parameters passed to the callback will depend on the
|
|
algorithm and the specific implementation of the algorithm. Some might not
|
|
give any useful information at all during key or parameter generation. Others
|
|
might not even call the callback.
|
|
.PP
|
|
The operation performed by key or parameter generation depends on the algorithm
|
|
used. In some cases (e.g. \s-1EC\s0 with a supplied named curve) the \*(L"generation\*(R"
|
|
option merely sets the appropriate fields in an \s-1EVP_PKEY\s0 structure.
|
|
.PP
|
|
In OpenSSL an \s-1EVP_PKEY\s0 structure containing a private key also contains the
|
|
public key components and parameters (if any). An OpenSSL private key is
|
|
equivalent to what some libraries call a \*(L"key pair\*(R". A private key can be used
|
|
in functions which require the use of a public key or parameters.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIEVP_PKEY_keygen_init()\fR, \fIEVP_PKEY_paramgen_init()\fR, \fIEVP_PKEY_keygen()\fR and
|
|
\&\fIEVP_PKEY_paramgen()\fR return 1 for success and 0 or a negative value for failure.
|
|
In particular a return value of \-2 indicates the operation is not supported by
|
|
the public key algorithm.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Generate a 2048 bit \s-1RSA\s0 key:
|
|
.PP
|
|
.Vb 2
|
|
\& #include <openssl/evp.h>
|
|
\& #include <openssl/rsa.h>
|
|
\&
|
|
\& EVP_PKEY_CTX *ctx;
|
|
\& EVP_PKEY *pkey = NULL;
|
|
\&
|
|
\& ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_RSA, NULL);
|
|
\& if (!ctx)
|
|
\& /* Error occurred */
|
|
\& if (EVP_PKEY_keygen_init(ctx) <= 0)
|
|
\& /* Error */
|
|
\& if (EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, 2048) <= 0)
|
|
\& /* Error */
|
|
\&
|
|
\& /* Generate key */
|
|
\& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
|
|
\& /* Error */
|
|
.Ve
|
|
.PP
|
|
Generate a key from a set of parameters:
|
|
.PP
|
|
.Vb 2
|
|
\& #include <openssl/evp.h>
|
|
\& #include <openssl/rsa.h>
|
|
\&
|
|
\& EVP_PKEY_CTX *ctx;
|
|
\& ENGINE *eng;
|
|
\& EVP_PKEY *pkey = NULL, *param;
|
|
\&
|
|
\& /* Assumed param, eng are set up already */
|
|
\& ctx = EVP_PKEY_CTX_new(param, eng);
|
|
\& if (!ctx)
|
|
\& /* Error occurred */
|
|
\& if (EVP_PKEY_keygen_init(ctx) <= 0)
|
|
\& /* Error */
|
|
\&
|
|
\& /* Generate key */
|
|
\& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
|
|
\& /* Error */
|
|
.Ve
|
|
.PP
|
|
Example of generation callback for OpenSSL public key implementations:
|
|
.PP
|
|
.Vb 1
|
|
\& /* Application data is a BIO to output status to */
|
|
\&
|
|
\& EVP_PKEY_CTX_set_app_data(ctx, status_bio);
|
|
\&
|
|
\& static int genpkey_cb(EVP_PKEY_CTX *ctx)
|
|
\& {
|
|
\& char c = \*(Aq*\*(Aq;
|
|
\& BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
|
|
\& int p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
|
|
\&
|
|
\& if (p == 0)
|
|
\& c = \*(Aq.\*(Aq;
|
|
\& if (p == 1)
|
|
\& c = \*(Aq+\*(Aq;
|
|
\& if (p == 2)
|
|
\& c = \*(Aq*\*(Aq;
|
|
\& if (p == 3)
|
|
\& c = \*(Aq\en\*(Aq;
|
|
\& BIO_write(b, &c, 1);
|
|
\& (void)BIO_flush(b);
|
|
\& return 1;
|
|
\& }
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIEVP_PKEY_CTX_new\fR\|(3),
|
|
\&\fIEVP_PKEY_encrypt\fR\|(3),
|
|
\&\fIEVP_PKEY_decrypt\fR\|(3),
|
|
\&\fIEVP_PKEY_sign\fR\|(3),
|
|
\&\fIEVP_PKEY_verify\fR\|(3),
|
|
\&\fIEVP_PKEY_verify_recover\fR\|(3),
|
|
\&\fIEVP_PKEY_derive\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
These functions were added in OpenSSL 1.0.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2006\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|