1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
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.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
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
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
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'
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 \
133 .\" ========================================================================
135 .IX Title "PKCS7_ENCRYPT 3"
136 .TH PKCS7_ENCRYPT 3 "2021-08-24" "1.1.1l" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 PKCS7_encrypt \- create a PKCS#7 envelopedData structure
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/pkcs7.h>
148 \& PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher,
152 .IX Header "DESCRIPTION"
153 \&\fBPKCS7_encrypt()\fR creates and returns a PKCS#7 envelopedData structure. \fBcerts\fR
154 is a list of recipient certificates. \fBin\fR is the content to be encrypted.
155 \&\fBcipher\fR is the symmetric cipher to use. \fBflags\fR is an optional set of flags.
158 Only \s-1RSA\s0 keys are supported in PKCS#7 and envelopedData so the recipient
159 certificates supplied to this function must all contain \s-1RSA\s0 public keys, though
160 they do not have to be signed using the \s-1RSA\s0 algorithm.
162 \&\fBEVP_des_ede3_cbc()\fR (triple \s-1DES\s0) is the algorithm of choice for S/MIME use
163 because most clients will support it.
165 Some old \*(L"export grade\*(R" clients may only support weak encryption using 40 or 64
166 bit \s-1RC2.\s0 These can be used by passing \fBEVP_rc2_40_cbc()\fR and \fBEVP_rc2_64_cbc()\fR
169 The algorithm passed in the \fBcipher\fR parameter must support \s-1ASN1\s0 encoding of
172 Many browsers implement a \*(L"sign and encrypt\*(R" option which is simply an S/MIME
173 envelopedData containing an S/MIME signed message. This can be readily produced
174 by storing the S/MIME signed message in a memory \s-1BIO\s0 and passing it to
175 \&\fBPKCS7_encrypt()\fR.
177 The following flags can be passed in the \fBflags\fR parameter.
179 If the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are
180 prepended to the data.
182 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
183 required by the S/MIME specifications) if \fB\s-1PKCS7_BINARY\s0\fR is set no translation
184 occurs. This option should be used if the supplied data is in binary format
185 otherwise the translation will corrupt it. If \fB\s-1PKCS7_BINARY\s0\fR is set then
186 \&\fB\s-1PKCS7_TEXT\s0\fR is ignored.
188 If the \fB\s-1PKCS7_STREAM\s0\fR flag is set a partial \fB\s-1PKCS7\s0\fR structure is output
189 suitable for streaming I/O: no data is read from the \s-1BIO\s0 \fBin\fR.
192 If the flag \fB\s-1PKCS7_STREAM\s0\fR is set the returned \fB\s-1PKCS7\s0\fR structure is \fBnot\fR
193 complete and outputting its contents via a function that does not
194 properly finalize the \fB\s-1PKCS7\s0\fR structure will give unpredictable
197 Several functions including \fBSMIME_write_PKCS7()\fR, \fBi2d_PKCS7_bio_stream()\fR,
198 \&\fBPEM_write_bio_PKCS7_stream()\fR finalize the structure. Alternatively finalization
199 can be performed by obtaining the streaming \s-1ASN1\s0 \fB\s-1BIO\s0\fR directly using
200 \&\fBBIO_new_PKCS7()\fR.
202 .IX Header "RETURN VALUES"
203 \&\fBPKCS7_encrypt()\fR returns either a \s-1PKCS7\s0 structure or \s-1NULL\s0 if an error occurred.
204 The error can be obtained from \fBERR_get_error\fR\|(3).
206 .IX Header "SEE ALSO"
207 \&\fBERR_get_error\fR\|(3), \fBPKCS7_decrypt\fR\|(3)
210 The \fB\s-1PKCS7_STREAM\s0\fR flag was added in OpenSSL 1.0.0.
212 .IX Header "COPYRIGHT"
213 Copyright 2002\-2016 The OpenSSL Project Authors. All Rights Reserved.
215 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
216 this file except in compliance with the License. You can obtain a copy
217 in the file \s-1LICENSE\s0 in the source distribution or at
218 <https://www.openssl.org/source/license.html>.