$NetBSD: SMIME_read_PKCS7.3,v 1.1.1.2 2023/04/18 14:19:14 christos Exp $ Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) Standard preamble: ========================================================================..
..
..
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 -- \(*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\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, 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. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
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
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. 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
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. 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
.\}
======================================================================== Title "SMIME_read_PKCS7 3" SMIME_read_PKCS7 3 "2018-09-23" "1.1.1i" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
"NAME"
SMIME_read_PKCS7 - parse
S/
MIME message
"LIBRARY"
libcrypto, -lcrypto
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1
#include <
openssl/
pkcs7.h>
\&
PKCS7 *SMIME_read_PKCS7(BIO *in, BIO **bcont);
.Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBSMIME_read_PKCS7() parses a message in
S/
MIME format.
\fBin is a \s-1BIO\s0 to read the message from.
If cleartext signing is used then the content is saved in
a memory bio which is written to *bcont, otherwise
\fB*bcont is set to \s-1NULL\s0.
The parsed PKCS#7 structure is returned or \s-1NULL\s0 if an
error occurred.
"NOTES"
Header "NOTES" If
*bcont is not
\s-1NULL\s0 then the message is clear text
signed.
*bcont can then be passed to
PKCS7_verify() with
the
\s-1PKCS7_DETACHED\s0 flag set.
Otherwise the type of the returned structure can be determined
using PKCS7_type_is_enveloped(), etc.
To support future functionality if bcont is not \s-1NULL\s0
\fB*bcont should be initialized to \s-1NULL\s0. For example:
.Vb 2
BIO *cont = NULL;
PKCS7 *p7;
\&
p7 = SMIME_read_PKCS7(in, &cont);
.Ve
"BUGS"
Header "BUGS" The \s-1MIME\s0 parser used by
SMIME_read_PKCS7() is somewhat primitive.
While it will handle most
S/
MIME messages more complex compound
formats may not work.
The parser assumes that the \s-1PKCS7\s0 structure is always base64
encoded and will not handle the case where it is in binary format
or uses quoted printable format.
The use of a memory \s-1BIO\s0 to hold the signed content limits the size
of message which can be processed due to memory restraints: a
streaming single pass option should be available.
"RETURN VALUES"
Header "RETURN VALUES" \fBSMIME_read_PKCS7() returns a valid
\s-1PKCS7\s0 structure or
\s-1NULL\s0
if an error occurred. The error can be obtained from
ERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3),
\fBSMIME_read_PKCS7\|(3),
PKCS7_sign\|(3),
\fBPKCS7_verify\|(3),
PKCS7_encrypt\|(3)
\fBPKCS7_decrypt\|(3)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.