Debian Codegraph @

upstream/debian-unstable/man3/CMS_final.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_FINAL 3SSL"
58 .TH CMS_FINAL 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_final, CMS_final_digest \- finalise a CMS_ContentInfo structure
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);
71 \& int CMS_final_digest(CMS_ContentInfo *cms, const unsigned char *md,
72 \& unsigned int mdlen, BIO *dcont, unsigned int flags);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBCMS_final()\fR finalises the structure \fBcms\fR. Its purpose is to perform any
77 operations necessary on \fBcms\fR (digest computation for example) and set the
78 appropriate fields. The parameter \fBdata\fR contains the content to be
79 processed. The \fBdcont\fR parameter contains a BIO to write content to after
80 processing: this is only used with detached data and will usually be set to
81 NULL.
82 .PP
83 \&\fBCMS_final_digest()\fR finalises the structure \fBcms\fR using a pre-computed digest,
84 rather than computing the digest from the original data.
85 .SH NOTES
86 .IX Header "NOTES"
87 These functions will normally be called when the \fBCMS_PARTIAL\fR flag is used. It
88 should only be used when streaming is not performed because the streaming
89 I/O functions perform finalisation operations internally.
90 .PP
91 To sign a pre-computed digest, \fBCMS_sign\fR\|(3) or \fBCMS_sign_ex()\fR is called
92 with the \fBdata\fR parameter set to NULL before the CMS structure is finalised
93 with the digest provided to \fBCMS_final_digest()\fR in binary form.
94 When signing a pre-computed digest, the security relies on the digest and its
95 computation from the original message being trusted.
96 .SH "RETURN VALUES"
97 .IX Header "RETURN VALUES"
98 \&\fBCMS_final()\fR and \fBCMS_final_digest()\fR return 1 for success or 0 for failure.
99 .SH "SEE ALSO"
100 .IX Header "SEE ALSO"
101 \&\fBERR_get_error\fR\|(3), \fBCMS_sign\fR\|(3),
102 \&\fBCMS_encrypt\fR\|(3)
103 .SH HISTORY
104 .IX Header "HISTORY"
105 \&\fBCMS_final_digest()\fR was added in OpenSSL 3.2.
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2008\-2022 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.