d2333279e245be277a3f46b7c11556adab9937df
[dragonfly.git] / secure / lib / libcrypto / man / EVP_SealInit.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, 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 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "EVP_SealInit 3"
136 .TH EVP_SealInit 3 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 EVP_SealInit, EVP_SealUpdate, EVP_SealFinal \- EVP envelope encryption
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/evp.h>
147 \&
148 \& int EVP_SealInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
149 \&                  unsigned char **ek, int *ekl, unsigned char *iv,
150 \&                  EVP_PKEY **pubk, int npubk);
151 \& int EVP_SealUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
152 \&         int *outl, unsigned char *in, int inl);
153 \& int EVP_SealFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
154 \&         int *outl);
155 .Ve
156 .SH "DESCRIPTION"
157 .IX Header "DESCRIPTION"
158 The \s-1EVP\s0 envelope routines are a high level interface to envelope
159 encryption. They generate a random key and \s-1IV \s0(if required) then
160 \&\*(L"envelope\*(R" it by using public key encryption. Data can then be
161 encrypted using this key.
162 .PP
163 \&\fIEVP_SealInit()\fR initializes a cipher context \fBctx\fR for encryption
164 with cipher \fBtype\fR using a random secret key and \s-1IV. \s0\fBtype\fR is normally
165 supplied by a function such as \fIEVP_des_cbc()\fR. The secret key is encrypted
166 using one or more public keys, this allows the same encrypted data to be
167 decrypted using any of the corresponding private keys. \fBek\fR is an array of
168 buffers where the public key encrypted secret key will be written, each buffer
169 must contain enough room for the corresponding encrypted key: that is
170 \&\fBek[i]\fR must have room for \fBEVP_PKEY_size(pubk[i])\fR bytes. The actual
171 size of each encrypted secret key is written to the array \fBekl\fR. \fBpubk\fR is
172 an array of \fBnpubk\fR public keys.
173 .PP
174 The \fBiv\fR parameter is a buffer where the generated \s-1IV\s0 is written to. It must
175 contain enough room for the corresponding cipher's \s-1IV,\s0 as determined by (for
176 example) EVP_CIPHER_iv_length(type).
177 .PP
178 If the cipher does not require an \s-1IV\s0 then the \fBiv\fR parameter is ignored
179 and can be \fB\s-1NULL\s0\fR.
180 .PP
181 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR have exactly the same properties
182 as the \fIEVP_EncryptUpdate()\fR and \fIEVP_EncryptFinal()\fR routines, as 
183 documented on the \fIEVP_EncryptInit\fR\|(3) manual
184 page.
185 .SH "RETURN VALUES"
186 .IX Header "RETURN VALUES"
187 \&\fIEVP_SealInit()\fR returns 0 on error or \fBnpubk\fR if successful.
188 .PP
189 \&\fIEVP_SealUpdate()\fR and \fIEVP_SealFinal()\fR return 1 for success and 0 for
190 failure.
191 .SH "NOTES"
192 .IX Header "NOTES"
193 Because a random secret key is generated the random number generator
194 must be seeded before calling \fIEVP_SealInit()\fR.
195 .PP
196 The public key must be \s-1RSA\s0 because it is the only OpenSSL public key
197 algorithm that supports key transport.
198 .PP
199 Envelope encryption is the usual method of using public key encryption
200 on large amounts of data, this is because public key encryption is slow
201 but symmetric encryption is fast. So symmetric encryption is used for
202 bulk encryption and the small random symmetric key used is transferred
203 using public key encryption.
204 .PP
205 It is possible to call \fIEVP_SealInit()\fR twice in the same way as
206 \&\fIEVP_EncryptInit()\fR. The first call should have \fBnpubk\fR set to 0
207 and (after setting any cipher parameters) it should be called again
208 with \fBtype\fR set to \s-1NULL.\s0
209 .SH "SEE ALSO"
210 .IX Header "SEE ALSO"
211 \&\fIevp\fR\|(3), \fIrand\fR\|(3),
212 \&\fIEVP_EncryptInit\fR\|(3),
213 \&\fIEVP_OpenInit\fR\|(3)
214 .SH "HISTORY"
215 .IX Header "HISTORY"
216 \&\fIEVP_SealFinal()\fR did not return a value before OpenSSL 0.9.7.