Merge branch 'vendor/BINUTILS220' into bu220
[dragonfly.git] / secure / lib / libcrypto / man / EVP_SealInit.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "EVP_SealInit 3"
135 .TH EVP_SealInit 3 "2009-04-11" "0.9.8k" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 EVP_SealInit, EVP_SealUpdate, EVP_SealFinal \- EVP envelope encryption
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/evp.h>
146 \&
147 \& int EVP_SealInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
148 \&                  unsigned char **ek, int *ekl, unsigned char *iv,
149 \&                  EVP_PKEY **pubk, int npubk);
150 \& int EVP_SealUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
151 \&         int *outl, unsigned char *in, int inl);
152 \& int EVP_SealFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
153 \&         int *outl);
154 .Ve
155 .SH "DESCRIPTION"
156 .IX Header "DESCRIPTION"
157 The \s-1EVP\s0 envelope routines are a high level interface to envelope
158 encryption. They generate a random key and \s-1IV\s0 (if required) then
159 \&\*(L"envelope\*(R" it by using public key encryption. Data can then be
160 encrypted using this key.
161 .PP
162 \&\fIEVP_SealInit()\fR initializes a cipher context \fBctx\fR for encryption
163 with cipher \fBtype\fR using a random secret key and \s-1IV\s0. \fBtype\fR is normally
164 supplied by a function such as \fIEVP_des_cbc()\fR. The secret key is encrypted
165 using one or more public keys, this allows the same encrypted data to be
166 decrypted using any of the corresponding private keys. \fBek\fR is an array of
167 buffers where the public key encrypted secret key will be written, each buffer
168 must contain enough room for the corresponding encrypted key: that is
169 \&\fBek[i]\fR must have room for \fBEVP_PKEY_size(pubk[i])\fR bytes. The actual
170 size of each encrypted secret key is written to the array \fBekl\fR. \fBpubk\fR is
171 an array of \fBnpubk\fR public keys.
172 .PP
173 The \fBiv\fR parameter is a buffer where the generated \s-1IV\s0 is written to. It must
174 contain enough room for the corresponding cipher's \s-1IV\s0, as determined by (for
175 example) EVP_CIPHER_iv_length(type).
176 .PP
177 If the cipher does not require an \s-1IV\s0 then the \fBiv\fR parameter is ignored
178 and can be \fB\s-1NULL\s0\fR.
179 .PP
180 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR have exactly the same properties
181 as the \fIEVP_EncryptUpdate()\fR and \fIEVP_EncryptFinal()\fR routines, as 
182 documented on the \fIEVP_EncryptInit\fR\|(3) manual
183 page.
184 .SH "RETURN VALUES"
185 .IX Header "RETURN VALUES"
186 \&\fIEVP_SealInit()\fR returns 0 on error or \fBnpubk\fR if successful.
187 .PP
188 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR return 1 for success and 0 for
189 failure.
190 .SH "NOTES"
191 .IX Header "NOTES"
192 Because a random secret key is generated the random number generator
193 must be seeded before calling \fIEVP_SealInit()\fR.
194 .PP
195 The public key must be \s-1RSA\s0 because it is the only OpenSSL public key
196 algorithm that supports key transport.
197 .PP
198 Envelope encryption is the usual method of using public key encryption
199 on large amounts of data, this is because public key encryption is slow
200 but symmetric encryption is fast. So symmetric encryption is used for
201 bulk encryption and the small random symmetric key used is transferred
202 using public key encryption.
203 .PP
204 It is possible to call \fIEVP_SealInit()\fR twice in the same way as
205 \&\fIEVP_EncryptInit()\fR. The first call should have \fBnpubk\fR set to 0
206 and (after setting any cipher parameters) it should be called again
207 with \fBtype\fR set to \s-1NULL\s0.
208 .SH "SEE ALSO"
209 .IX Header "SEE ALSO"
210 \&\fIevp\fR\|(3), \fIrand\fR\|(3),
211 \&\fIEVP_EncryptInit\fR\|(3),
212 \&\fIEVP_OpenInit\fR\|(3)
213 .SH "HISTORY"
214 .IX Header "HISTORY"
215 \&\fIEVP_SealFinal()\fR did not return a value before OpenSSL 0.9.7.