diff options
Diffstat (limited to 'src/lib/libcrypto/man/CMS_sign_receipt.3')
| -rw-r--r-- | src/lib/libcrypto/man/CMS_sign_receipt.3 | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/CMS_sign_receipt.3 b/src/lib/libcrypto/man/CMS_sign_receipt.3 new file mode 100644 index 0000000000..7ddff976cc --- /dev/null +++ b/src/lib/libcrypto/man/CMS_sign_receipt.3 | |||
| @@ -0,0 +1,110 @@ | |||
| 1 | .\" $OpenBSD: CMS_sign_receipt.3,v 1.3 2019/08/10 23:41:22 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: August 10 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 | ||
| 69 | creates and returns a CMS signed receipt structure. | ||
| 70 | .Fa si | ||
| 71 | is the | ||
| 72 | .Vt CMS_SignerInfo | ||
| 73 | structure containing the signed receipt request. | ||
| 74 | .Fa signcert | ||
| 75 | is the certificate to sign with, | ||
| 76 | .Fa pkey | ||
| 77 | is the corresponding private key. | ||
| 78 | .Fa certs | ||
| 79 | is an optional additional set of certificates to include in the CMS | ||
| 80 | structure (for example any intermediate CAs in the chain). | ||
| 81 | .Pp | ||
| 82 | .Fa flags | ||
| 83 | is an optional set of flags. | ||
| 84 | .Pp | ||
| 85 | This functions behaves in a similar way to | ||
| 86 | .Xr CMS_sign 3 | ||
| 87 | except the flag values | ||
| 88 | .Dv CMS_DETACHED , | ||
| 89 | .Dv CMS_BINARY , | ||
| 90 | .Dv CMS_NOATTR , | ||
| 91 | .Dv CMS_TEXT , | ||
| 92 | and | ||
| 93 | .Dv CMS_STREAM | ||
| 94 | are not supported since they do not make sense in the context of | ||
| 95 | signed receipts. | ||
| 96 | .Sh RETURN VALUES | ||
| 97 | .Fn CMS_sign_receipt | ||
| 98 | returns either a valid | ||
| 99 | .Vt CMS_ContentInfo | ||
| 100 | structure or | ||
| 101 | .Dv NULL | ||
| 102 | if an error occurred. | ||
| 103 | The error can be obtained from | ||
| 104 | .Xr ERR_get_error 3 . | ||
| 105 | .Sh SEE ALSO | ||
| 106 | .Xr CMS_sign 3 , | ||
| 107 | .Xr CMS_verify_receipt 3 | ||
| 108 | .Sh HISTORY | ||
| 109 | .Fn CMS_sign_receipt | ||
| 110 | was added to OpenSSL 0.9.8. | ||