1.\" $OpenBSD: SMIME_write_CMS.3,v 1.5 2019/11/02 15:39:46 schwarze Exp $ 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 3.\" 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" Copyright (c) 2008 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: November 2 2019 $ 52.Dt SMIME_WRITE_CMS 3 53.Os 54.Sh NAME 55.Nm SMIME_write_CMS 56.Nd convert CMS structure to S/MIME format 57.Sh SYNOPSIS 58.In openssl/cms.h 59.Ft int 60.Fo SMIME_write_CMS 61.Fa "BIO *out" 62.Fa "CMS_ContentInfo *cms" 63.Fa "BIO *data" 64.Fa "int flags" 65.Fc 66.Sh DESCRIPTION 67.Fn SMIME_write_CMS 68adds the appropriate MIME headers to the 69.Fa cms 70structure to produce an S/MIME message and writes it to 71.Fa out . 72If streaming is enabled, the content must be supplied in the 73.Fa data 74argument. 75.Pp 76The following 77.Fa flags 78can be passed: 79.Bl -tag -width Ds 80.It Dv CMS_DETACHED 81Use cleartext signing. 82This option only makes sense if 83.Fa cms 84is of the type 85.Vt SignedData 86and 87.Dv CMS_DETACHED 88was also set when it was created with 89.Xr CMS_sign 3 . 90.Pp 91If 92.Dv CMS_STREAM 93is not set, the data must be read twice: 94once to compute the signature in 95.Xr CMS_sign 3 96and once to output the S/MIME message. 97.It Dv CMS_TEXT 98Add MIME headers for type text/plain to the content. 99This only makes sense if 100.Dv CMS_DETACHED 101is also set. 102.It Dv CMS_STREAM 103Perform streaming. 104This flag should only be set if 105.Dv CMS_STREAM 106was also passed to the function that created 107.Fa cms . 108.Pp 109The content is output in BER format using indefinite length 110constructed encoding except in the case of 111.Vt SignedData 112with detached content where the content is absent and DER format is 113used. 114.El 115.Sh RETURN VALUES 116.Fn SMIME_write_CMS 117returns 1 for success or 0 for failure. 118.Sh SEE ALSO 119.Xr CMS_ContentInfo_new 3 , 120.Xr CMS_encrypt 3 , 121.Xr CMS_sign 3 , 122.Xr d2i_CMS_ContentInfo 3 , 123.Xr ERR_get_error 3 124.Sh HISTORY 125.Fn SMIME_write_CMS 126first appeared in OpenSSL 0.9.8h 127and has been available since 128.Ox 6.7 . 129.Sh BUGS 130.Fn SMIME_write_CMS 131always base64 encodes CMS structures. 132There should be an option to disable this. 133