Debian Codegraph @

upstream/debian-unstable/man3/SMIME_read_PKCS7.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SMIME_READ_PKCS7 3SSL"
58 .TH SMIME_READ_PKCS7 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SMIME_read_PKCS7_ex, SMIME_read_PKCS7 \- parse S/MIME message
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/pkcs7.h>
69 \&
70 \& PKCS7 *SMIME_read_PKCS7_ex(BIO *bio, BIO **bcont, PKCS7 **p7);
71 \& PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBSMIME_read_PKCS7()\fR parses a message in S/MIME format.
76 .PP
77 \&\fBin\fR is a BIO to read the message from.
78 .PP
79 If cleartext signing is used then the content is saved in
80 a memory bio which is written to \fB*bcont\fR, otherwise
81 \&\fB*bcont\fR is set to \fBNULL\fR.
82 .PP
83 The parsed PKCS#7 structure is returned or \fBNULL\fR if an
84 error occurred.
85 .PP
86 \&\fBSMIME_read_PKCS7_ex()\fR is similar to \fBSMIME_read_PKCS7()\fR but can optionally supply
87 a previously created \fIp7\fR PKCS#7 object. If \fIp7\fR is NULL then it is identical
88 to \fBSMIME_read_PKCS7()\fR.
89 To create a \fIp7\fR object use \fBPKCS7_new_ex\fR\|(3).
90 .SH NOTES
91 .IX Header "NOTES"
92 If \fB*bcont\fR is not \fBNULL\fR then the message is clear text
93 signed. \fB*bcont\fR can then be passed to \fBPKCS7_verify()\fR with
94 the \fBPKCS7_DETACHED\fR flag set.
95 .PP
96 Otherwise the type of the returned structure can be determined
97 using \fBPKCS7_type_is_enveloped()\fR, etc.
98 .PP
99 To support future functionality if \fBbcont\fR is not \fBNULL\fR
100 \&\fB*bcont\fR should be initialized to \fBNULL\fR. For example:
101 .PP
102 .Vb 2
103 \& BIO *cont = NULL;
104 \& PKCS7 *p7;
105 \&
106 \& p7 = SMIME_read_PKCS7(in, &cont);
107 .Ve
108 .SH BUGS
109 .IX Header "BUGS"
110 The MIME parser used by \fBSMIME_read_PKCS7()\fR is somewhat primitive.
111 While it will handle most S/MIME messages more complex compound
112 formats may not work.
113 .PP
114 The parser assumes that the PKCS7 structure is always base64
115 encoded and will not handle the case where it is in binary format
116 or uses quoted printable format.
117 .PP
118 The use of a memory BIO to hold the signed content limits the size
119 of message which can be processed due to memory restraints: a
120 streaming single pass option should be available.
121 .SH "RETURN VALUES"
122 .IX Header "RETURN VALUES"
123 \&\fBSMIME_read_PKCS7_ex()\fR and \fBSMIME_read_PKCS7()\fR return a valid \fBPKCS7\fR structure
124 or \fBNULL\fR if an error occurred. The error can be obtained from \fBERR_get_error\fR\|(3).
125 .SH "SEE ALSO"
126 .IX Header "SEE ALSO"
127 \&\fBERR_get_error\fR\|(3),
128 \&\fBSMIME_read_PKCS7\fR\|(3), \fBPKCS7_sign\fR\|(3),
129 \&\fBPKCS7_verify\fR\|(3), \fBPKCS7_encrypt\fR\|(3)
130 \&\fBPKCS7_decrypt\fR\|(3)
131 .SH HISTORY
132 .IX Header "HISTORY"
133 The function \fBSMIME_read_PKCS7_ex()\fR was added in OpenSSL 3.0.
134 .SH COPYRIGHT
135 .IX Header "COPYRIGHT"
136 Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved.
137 .PP
138 Licensed under the Apache License 2.0 (the "License"). You may not use
139 this file except in compliance with the License. You can obtain a copy
140 in the file LICENSE in the source distribution or at
141 <https://www.openssl.org/source/license.html>.