1.\" $OpenBSD: CMS_sign_receipt.3,v 1.7 2019/11/02 15:39:46 schwarze Exp $ 2.\" full merge up to: OpenSSL e9b77246 Jan 20 19:58:49 2017 +0100 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 CMS_SIGN_RECEIPT 3 53.Os 54.Sh NAME 55.Nm CMS_sign_receipt 56.Nd create a CMS signed receipt 57.Sh SYNOPSIS 58.In openssl/cms.h 59.Ft CMS_ContentInfo * 60.Fo CMS_sign_receipt 61.Fa "CMS_SignerInfo *si" 62.Fa "X509 *signcert" 63.Fa "EVP_PKEY *pkey" 64.Fa "STACK_OF(X509) *certs" 65.Fa "unsigned int flags" 66.Fc 67.Sh DESCRIPTION 68.Fn CMS_sign_receipt 69creates a new CMS 70.Vt SignedData 71structure containing a signed 72.Vt Receipt 73as its embedded content. 74.Fa si 75is the 76.Vt SignerInfo 77structure containing the signed receipt request. 78.Fa signcert 79is the certificate to sign with, 80.Fa pkey 81is the corresponding private key. 82.Fa certs 83is an optional additional set of certificates to include in the CMS 84structure (for example any intermediate CAs in the chain). 85.Pp 86This functions behaves in a similar way to 87.Xr CMS_sign 3 88except that the 89.Fa flags 90values 91.Dv CMS_DETACHED , 92.Dv CMS_BINARY , 93.Dv CMS_NOATTR , 94.Dv CMS_TEXT , 95and 96.Dv CMS_STREAM 97are not supported since they do not make sense in the context of 98signed receipts. 99.Sh RETURN VALUES 100.Fn CMS_sign_receipt 101returns either a valid 102.Vt CMS_ContentInfo 103structure or 104.Dv NULL 105if an error occurred. 106The error can be obtained from 107.Xr ERR_get_error 3 . 108.Sh SEE ALSO 109.Xr CMS_ContentInfo_new 3 , 110.Xr CMS_get1_ReceiptRequest 3 , 111.Xr CMS_sign 3 , 112.Xr CMS_verify_receipt 3 113.Sh STANDARDS 114RFC 2634: Enhanced Security Services for S/MIME, section 2.8: Receipt Syntax 115.Sh HISTORY 116.Fn CMS_sign_receipt 117first appeared in OpenSSL 0.9.8h 118and has been available since 119.Ox 6.7 . 120