summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/CMS_final.3
blob: 4e7912a4e0042e7bbe9c07b1a065a508493d8cec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.Dd $Mdocdate: November 11 2015 $
.Dt CMS_FINAL 3
.Os
.Sh NAME
.Nm CMS_final
.Nd finalise a CMS_ContentInfo structure
.Sh SYNOPSIS
.In openssl/cms.h
.Ft int
.Fo CMS_final
.Fa "CMS_ContentInfo *cms"
.Fa "BIO *data"
.Fa "BIO *dcont"
.Fa "unsigned int flags"
.Fc
.Sh DESCRIPTION
.Fn CMS_final
finalises the structure
.Fa cms .
Its purpose is to perform any operations necessary on
.Fa cms
(digest computation for example) and set the appropriate fields.
The parameter
.Fa data
contains the content to be processed.
The
.Fa dcont
parameter contains a
.Vt BIO
to write content to after processing: this is
only used with detached data and will usually be set to
.Dv NULL .
.Sh NOTES
This function will normally be called when the
.Dv CMS_PARTIAL
flag is used.
It should only be used when streaming is not performed because the
streaming I/O functions perform finalisation operations internally.
.Sh RETURN VALUES
.Fn CMS_final
returns 1 for success or 0 for failure.
.Sh SEE ALSO
.Xr CMS_encrypt 3 ,
.Xr CMS_sign 3 ,
.Xr ERR_get_error 3
.Sh HISTORY
.Fn CMS_final
was added to OpenSSL 0.9.8.