Debian Codegraph @

upstream/debian-unstable/man3/CMS_sign_receipt.3ssl

raw
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 "CMS_SIGN_RECEIPT 3SSL"
58 .TH CMS_SIGN_RECEIPT 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 CMS_sign_receipt \- create a CMS signed receipt
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si, X509 *signcert,
71 \& EVP_PKEY *pkey, STACK_OF(X509) *certs,
72 \& unsigned int flags);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBCMS_sign_receipt()\fR creates and returns a CMS signed receipt structure. \fBsi\fR is
77 the \fBCMS_SignerInfo\fR structure containing the signed receipt request.
78 \&\fBsigncert\fR is the certificate to sign with, \fBpkey\fR is the corresponding
79 private key. \fBcerts\fR is an optional additional set of certificates to include
80 in the CMS structure (for example any intermediate CAs in the chain).
81 .PP
82 \&\fBflags\fR is an optional set of flags.
83 .SH NOTES
84 .IX Header "NOTES"
85 This functions behaves in a similar way to \fBCMS_sign()\fR except the flag values
86 \&\fBCMS_DETACHED\fR, \fBCMS_BINARY\fR, \fBCMS_NOATTR\fR, \fBCMS_TEXT\fR and \fBCMS_STREAM\fR
87 are not supported since they do not make sense in the context of signed
88 receipts.
89 .SH "RETURN VALUES"
90 .IX Header "RETURN VALUES"
91 \&\fBCMS_sign_receipt()\fR returns either a valid CMS_ContentInfo structure or NULL if
92 an error occurred. The error can be obtained from \fBERR_get_error\fR\|(3).
93 .SH "SEE ALSO"
94 .IX Header "SEE ALSO"
95 \&\fBERR_get_error\fR\|(3),
96 \&\fBCMS_verify_receipt\fR\|(3),
97 \&\fBCMS_sign\fR\|(3)
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.