[dragonfly.git] / secure / lib / libcrypto / man / EVP_PKEY_encrypt.3

.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
.\"
.\" 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_encrypt 3"
.TH EVP_PKEY_encrypt 3 "2014-06-05" "1.0.1h" "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_encrypt_init, EVP_PKEY_encrypt \- encrypt using a public key algorithm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/evp.h>
\&
\& int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
\& int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
\&                        unsigned char *out, size_t *outlen,
\&                        const unsigned char *in, size_t inlen);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fIEVP_PKEY_encrypt_init()\fR function initializes a public key algorithm
context using key \fBpkey\fR for an encryption operation.
.PP
The \fIEVP_PKEY_encrypt()\fR function performs a public key encryption operation
using \fBctx\fR. The data to be encrypted is specified using the \fBin\fR and
\&\fBinlen\fR parameters. If \fBout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
buffer is written to the \fBoutlen\fR parameter. If \fBout\fR is not \fB\s-1NULL\s0\fR then
before the call the \fBoutlen\fR parameter should contain the length of the
\&\fBout\fR buffer, if the call is successful the encrypted data is written to
\&\fBout\fR and the amount of data written to \fBoutlen\fR.
.SH "NOTES"
.IX Header "NOTES"
After the call to \fIEVP_PKEY_encrypt_init()\fR algorithm specific control
operations can be performed to set any appropriate parameters for the
operation.
.PP
The function \fIEVP_PKEY_encrypt()\fR can be called more than once on the same
context if several operations are performed using the same parameters.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fIEVP_PKEY_encrypt_init()\fR and \fIEVP_PKEY_encrypt()\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 "EXAMPLE"
.IX Header "EXAMPLE"
Encrypt data using \s-1OAEP\s0 (for \s-1RSA\s0 keys):
.PP
.Vb 2
\& #include <openssl/evp.h>
\& #include <openssl/rsa.h>
\&
\& EVP_PKEY_CTX *ctx;
\& unsigned char *out, *in;
\& size_t outlen, inlen; 
\& EVP_PKEY *key;
\& /* NB: assumes key in, inlen are already set up
\&  * and that key is an RSA public key
\&  */
\& ctx = EVP_PKEY_CTX_new(key);
\& if (!ctx)
\&        /* Error occurred */
\& if (EVP_PKEY_encrypt_init(ctx) <= 0)
\&        /* Error */
\& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
\&        /* Error */
\&
\& /* Determine buffer length */
\& if (EVP_PKEY_encrypt(ctx, NULL, &outlen, in, inlen) <= 0)
\&        /* Error */
\&
\& out = OPENSSL_malloc(outlen);
\&
\& if (!out)
\&        /* malloc failure */
\& 
\& if (EVP_PKEY_encrypt(ctx, out, &outlen, in, inlen) <= 0)
\&        /* Error */
\&
\& /* Encrypted data is outlen bytes written to buffer out */
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIEVP_PKEY_CTX_new\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 first added to OpenSSL 1.0.0.
Commit	Line	Data
11c7e1cd	1	.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
01185282 PA	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	'br\}
	42	.\"
	43	.\" Escape single quotes in literal strings from groff's Unicode transform.
	44	.ie \n(.g .ds Aq \(aq
	45	.el .ds Aq '
	46	.\"
	47	.\" If the F register is turned on, we'll generate index entries on stderr for
	48	.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
	49	.\" entries marked with X<> in POD. Of course, you'll have to process the
	50	.\" output yourself in some meaningful fashion.
	51	.ie \nF \{\
	52	. de IX
	53	. tm Index:\\$1\t\\n%\t"\\$2"
	54	..
	55	. nr % 0
	56	. rr F
	57	.\}
	58	.el \{\
	59	. de IX
	60	..
	61	.\}
	62	.\"
	63	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
	64	.\" Fear. Run. Save yourself. No user-serviceable parts.
	65	. \" fudge factors for nroff and troff
66	.if n \{\
67	. ds #H 0
68	. ds #V .8m
69	. ds #F .3m
70	. ds #[ \f1
71	. ds #] \fP
72	.\}
73	.if t \{\
74	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75	. ds #V .6m
76	. ds #F 0
77	. ds #[ \&
78	. ds #] \&
79	.\}
80	. \" simple accents for nroff and troff
81	.if n \{\
82	. ds ' \&
83	. ds ` \&
84	. ds ^ \&
85	. ds , \&
86	. ds ~ ~
87	. ds /
88	.\}
89	.if t \{\
90	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
91	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
92	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
93	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
94	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
95	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
96	.\}
97	. \" troff and (daisy-wheel) nroff accents
98	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
99	.ds 8 \h'\(#H'\(b\h'-\*(#H'
100	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
101	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
102	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
103	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
104	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
105	.ds ae a\h'-(\w'a'u*4/10)'e
106	.ds Ae A\h'-(\w'A'u*4/10)'E
107	. \" corrections for vroff
108	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
109	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
110	. \" for low resolution devices (crt and lpr)
111	.if \n(.H>23 .if \n(.V>19 \
112	\{\
113	. ds : e
114	. ds 8 ss
115	. ds o a
116	. ds d- d\h'-1'\(ga
117	. ds D- D\h'-1'\(hy
118	. ds th \o'bp'
119	. ds Th \o'LP'
120	. ds ae ae
121	. ds Ae AE
122	.\}
123	.rm #[ #] #H #V #F C
124	.\" ========================================================================
125	.\"
126	.IX Title "EVP_PKEY_encrypt 3"
34240b21	127	.TH EVP_PKEY_encrypt 3 "2014-06-05" "1.0.1h" "OpenSSL"
01185282 PA	128	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	129	.\" way too many mistakes in technical documents.
	130	.if n .ad l
	131	.nh
	132	.SH "NAME"
	133	EVP_PKEY_encrypt_init, EVP_PKEY_encrypt \- encrypt using a public key algorithm
	134	.SH "SYNOPSIS"
	135	.IX Header "SYNOPSIS"
	136	.Vb 1
	137	\& #include <openssl/evp.h>
	138	\&
	139	\& int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
	140	\& int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
	141	\& unsigned char out, size_t outlen,
	142	\& const unsigned char *in, size_t inlen);
	143	.Ve
	144	.SH "DESCRIPTION"
	145	.IX Header "DESCRIPTION"
	146	The \fIEVP_PKEY_encrypt_init()\fR function initializes a public key algorithm
	147	context using key \fBpkey\fR for an encryption operation.
	148	.PP
	149	The \fIEVP_PKEY_encrypt()\fR function performs a public key encryption operation
	150	using \fBctx\fR. The data to be encrypted is specified using the \fBin\fR and
	151	\&\fBinlen\fR parameters. If \fBout\fR is \fB\s-1NULL\s0\fR then the maximum size of the output
	152	buffer is written to the \fBoutlen\fR parameter. If \fBout\fR is not \fB\s-1NULL\s0\fR then
	153	before the call the \fBoutlen\fR parameter should contain the length of the
	154	\&\fBout\fR buffer, if the call is successful the encrypted data is written to
	155	\&\fBout\fR and the amount of data written to \fBoutlen\fR.
	156	.SH "NOTES"
	157	.IX Header "NOTES"
	158	After the call to \fIEVP_PKEY_encrypt_init()\fR algorithm specific control
	159	operations can be performed to set any appropriate parameters for the
	160	operation.
	161	.PP
	162	The function \fIEVP_PKEY_encrypt()\fR can be called more than once on the same
	163	context if several operations are performed using the same parameters.
	164	.SH "RETURN VALUES"
	165	.IX Header "RETURN VALUES"
	166	\&\fIEVP_PKEY_encrypt_init()\fR and \fIEVP_PKEY_encrypt()\fR return 1 for success and 0
	167	or a negative value for failure. In particular a return value of \-2
	168	indicates the operation is not supported by the public key algorithm.
	169	.SH "EXAMPLE"
	170	.IX Header "EXAMPLE"
	171	Encrypt data using \s-1OAEP\s0 (for \s-1RSA\s0 keys):
	172	.PP
	173	.Vb 2
	174	\& #include <openssl/evp.h>
	175	\& #include <openssl/rsa.h>
	176	\&
	177	\& EVP_PKEY_CTX *ctx;
	178	\& unsigned char out, in;
	179	\& size_t outlen, inlen;
	180	\& EVP_PKEY *key;
	181	\& /* NB: assumes key in, inlen are already set up
	182	\& * and that key is an RSA public key
	183	\& */
	184	\& ctx = EVP_PKEY_CTX_new(key);
	185	\& if (!ctx)
	186	\& /* Error occurred */
	187	\& if (EVP_PKEY_encrypt_init(ctx) <= 0)
	188	\& /* Error */
	189	\& if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_OAEP_PADDING) <= 0)
	190	\& /* Error */
	191	\&
192	\& /* Determine buffer length */
193	\& if (EVP_PKEY_encrypt(ctx, NULL, &outlen, in, inlen) <= 0)
194	\& /* Error */
195	\&
196	\& out = OPENSSL_malloc(outlen);
197	\&
198	\& if (!out)
199	\& /* malloc failure */
200	\&
201	\& if (EVP_PKEY_encrypt(ctx, out, &outlen, in, inlen) <= 0)
202	\& /* Error */
203	\&
204	\& /* Encrypted data is outlen bytes written to buffer out */
205	.Ve
206	.SH "SEE ALSO"
207	.IX Header "SEE ALSO"
208	\&\fIEVP_PKEY_CTX_new\fR\\|(3),
209	\&\fIEVP_PKEY_decrypt\fR\\|(3),
210	\&\fIEVP_PKEY_sign\fR\\|(3),
211	\&\fIEVP_PKEY_verify\fR\\|(3),
58e4c0cf	212	\&\fIEVP_PKEY_verify_recover\fR\\|(3),
01185282 PA	213	\&\fIEVP_PKEY_derive\fR\\|(3)
	214	.SH "HISTORY"
	215	.IX Header "HISTORY"
	216	These functions were first added to OpenSSL 1.0.0.