| 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_WRITE_ASN1 3SSL" |
| 58 |
.TH SMIME_WRITE_ASN1 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_write_ASN1_ex, SMIME_write_ASN1 |
| 65 |
\&\- convert structure to S/MIME format |
| 66 |
.SH SYNOPSIS |
| 67 |
.IX Header "SYNOPSIS" |
| 68 |
.Vb 1 |
| 69 |
\& #include <openssl/asn1.h> |
| 70 |
\& |
| 71 |
\& int SMIME_write_ASN1_ex(BIO *out, ASN1_VALUE *val, BIO *data, int flags, |
| 72 |
\& int ctype_nid, int econt_nid, |
| 73 |
\& STACK_OF(X509_ALGOR) *mdalgs, const ASN1_ITEM *it, |
| 74 |
\& OSSL_LIB_CTX *libctx, const char *propq); |
| 75 |
\& |
| 76 |
\& int SMIME_write_ASN1(BIO *out, |
| 77 |
\& ASN1_VALUE *val, BIO *data, int flags, int ctype_nid, int econt_nid, |
| 78 |
\& STACK_OF(X509_ALGOR) *mdalgs, const ASN1_ITEM *it); |
| 79 |
.Ve |
| 80 |
.SH DESCRIPTION |
| 81 |
.IX Header "DESCRIPTION" |
| 82 |
\&\fBSMIME_write_ASN1_ex()\fR adds the appropriate MIME headers to an object |
| 83 |
structure to produce an S/MIME message. |
| 84 |
.PP |
| 85 |
\&\fIout\fR is the BIO to write the data to. \fIvalue\fR is the appropriate ASN1_VALUE |
| 86 |
structure (either CMS_ContentInfo or PKCS7). If streaming is enabled then the |
| 87 |
content must be supplied via \fIdata\fR. |
| 88 |
\&\fIflags\fR is an optional set of flags. \fIctype_nid\fR is the NID of the content |
| 89 |
type, \fIecont_nid\fR is the NID of the embedded content type and \fImdalgs\fR is a |
| 90 |
list of signed data digestAlgorithms. Valid values that can be used by the |
| 91 |
ASN.1 structure \fIit\fR are ASN1_ITEM_rptr(PKCS7) or ASN1_ITEM_rptr(CMS_ContentInfo). |
| 92 |
The library context \fIlibctx\fR and the property query \fIpropq\fR are used when |
| 93 |
retrieving algorithms from providers. |
| 94 |
.SH NOTES |
| 95 |
.IX Header "NOTES" |
| 96 |
The higher level functions \fBSMIME_write_CMS\fR\|(3) and |
| 97 |
\&\fBSMIME_write_PKCS7\fR\|(3) should be used instead of \fBSMIME_write_ASN1()\fR. |
| 98 |
.PP |
| 99 |
The following flags can be passed in the \fBflags\fR parameter. |
| 100 |
.PP |
| 101 |
If \fBCMS_DETACHED\fR is set then cleartext signing will be used, this option only |
| 102 |
makes sense for SignedData where \fBCMS_DETACHED\fR is also set when the \fBsign()\fR |
| 103 |
method is called. |
| 104 |
.PP |
| 105 |
If the \fBCMS_TEXT\fR flag is set MIME headers for type \fBtext/plain\fR are added to |
| 106 |
the content, this only makes sense if \fBCMS_DETACHED\fR is also set. |
| 107 |
.PP |
| 108 |
If the \fBCMS_STREAM\fR flag is set streaming is performed. This flag should only |
| 109 |
be set if \fBCMS_STREAM\fR was also set in the previous call to a CMS_ContentInfo |
| 110 |
or PKCS7 creation function. |
| 111 |
.PP |
| 112 |
If cleartext signing is being used and \fBCMS_STREAM\fR not set then the data must |
| 113 |
be read twice: once to compute the signature in sign method and once to output |
| 114 |
the S/MIME message. |
| 115 |
.PP |
| 116 |
If streaming is performed the content is output in BER format using indefinite |
| 117 |
length constructed encoding except in the case of signed data with detached |
| 118 |
content where the content is absent and DER format is used. |
| 119 |
.SH "RETURN VALUES" |
| 120 |
.IX Header "RETURN VALUES" |
| 121 |
\&\fBSMIME_write_ASN1_ex()\fR and \fBSMIME_write_ASN1()\fR return 1 for success or |
| 122 |
0 for failure. |
| 123 |
.SH "SEE ALSO" |
| 124 |
.IX Header "SEE ALSO" |
| 125 |
\&\fBERR_get_error\fR\|(3), |
| 126 |
\&\fBSMIME_write_CMS\fR\|(3), |
| 127 |
\&\fBSMIME_write_PKCS7\fR\|(3) |
| 128 |
.SH COPYRIGHT |
| 129 |
.IX Header "COPYRIGHT" |
| 130 |
Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. |
| 131 |
.PP |
| 132 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 133 |
this file except in compliance with the License. You can obtain a copy |
| 134 |
in the file LICENSE in the source distribution or at |
| 135 |
<https://www.openssl.org/source/license.html>. |