xref: /freebsd/secure/lib/libcrypto/man/man3/SMIME_read_ASN1.3 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

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_ASN1 3"
SMIME_READ_ASN1 3 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
SMIME_read_ASN1_ex, SMIME_read_ASN1 \- parse S/MIME message
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/asn1.h> \& ASN1_VALUE *SMIME_read_ASN1_ex(BIO *in, int flags, BIO **bcont, const ASN1_ITEM *it, ASN1_VALUE **x, OSSL_LIB_CTX *libctx, const char *propq); ASN1_VALUE *SMIME_read_ASN1(BIO *in, BIO **bcont, const ASN1_ITEM *it); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBSMIME_read_ASN1_ex() parses a message in S/MIME format.

\fIin is a \s-1BIO\s0 to read the message from. If the flags argument contains \s-1CMS_BINARY\s0 then the input is assumed to be in binary format and is not translated to canonical form. If in addition \s-1SMIME_ASCIICRLF\s0 is set then the binary input is assumed to be followed by \s-1CR\s0 and \s-1LF\s0 characters, else only by an \s-1LF\s0 character. \fIx can be used to optionally supply a previously created it \s-1ASN1_VALUE\s0 object (such as CMS_ContentInfo or \s-1PKCS7\s0), it can be set to \s-1NULL.\s0 Valid values that can be used by \s-1ASN.1\s0 structure it are ASN1_ITEM_rptr(\s-1PKCS7\s0) or ASN1_ITEM_rptr(CMS_ContentInfo). Any algorithm fetches that occur during the operation will use the \s-1OSSL_LIB_CTX\s0 supplied in the libctx parameter, and use the property query string propq See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in crypto\|(7) for further details about algorithm fetching.

If cleartext signing is used then the content is saved in a memory bio which is written to *bcont, otherwise *bcont is set to \s-1NULL.\s0

The parsed \s-1ASN1_VALUE\s0 structure is returned or \s-1NULL\s0 if an error occurred.

\fBSMIME_read_ASN1() is similar to SMIME_read_ASN1_ex() but sets the value of x to \s-1NULL\s0 and the value of flags to 0.

"NOTES"
Header "NOTES" The higher level functions SMIME_read_CMS_ex\|(3) and \fBSMIME_read_PKCS7_ex\|(3) should be used instead of SMIME_read_ASN1_ex().

To support future functionality if bcont is not \s-1NULL\s0 *bcont should be initialized to \s-1NULL.\s0

"BUGS"
Header "BUGS" The \s-1MIME\s0 parser used by SMIME_read_ASN1_ex() is somewhat primitive. While it will handle most S/MIME messages more complex compound formats may not work.

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_ASN1_ex() and SMIME_read_ASN1() return a valid \s-1ASN1_VALUE\s0 structure or \s-1NULL\s0 if an error occurred. The error can be obtained from \fBERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), \fBSMIME_read_CMS_ex\|(3), \fBSMIME_read_PKCS7_ex\|(3), \fBSMIME_write_ASN1\|(3), \fBSMIME_write_ASN1_ex\|(3)
"HISTORY"
Header "HISTORY" The function SMIME_read_ASN1_ex() was added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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>.