xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man3/CMS_final.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosCMS_final - finalise a CMS_ContentInfo structure
6*4724848cSchristos
7*4724848cSchristos=head1 SYNOPSIS
8*4724848cSchristos
9*4724848cSchristos #include <openssl/cms.h>
10*4724848cSchristos
11*4724848cSchristos int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);
12*4724848cSchristos
13*4724848cSchristos=head1 DESCRIPTION
14*4724848cSchristos
15*4724848cSchristosCMS_final() finalises the structure B<cms>. Its purpose is to perform any
16*4724848cSchristosoperations necessary on B<cms> (digest computation for example) and set the
17*4724848cSchristosappropriate fields. The parameter B<data> contains the content to be
18*4724848cSchristosprocessed. The B<dcont> parameter contains a BIO to write content to after
19*4724848cSchristosprocessing: this is only used with detached data and will usually be set to
20*4724848cSchristosNULL.
21*4724848cSchristos
22*4724848cSchristos=head1 NOTES
23*4724848cSchristos
24*4724848cSchristosThis function will normally be called when the B<CMS_PARTIAL> flag is used. It
25*4724848cSchristosshould only be used when streaming is not performed because the streaming
26*4724848cSchristosI/O functions perform finalisation operations internally.
27*4724848cSchristos
28*4724848cSchristos=head1 RETURN VALUES
29*4724848cSchristos
30*4724848cSchristosCMS_final() returns 1 for success or 0 for failure.
31*4724848cSchristos
32*4724848cSchristos=head1 SEE ALSO
33*4724848cSchristos
34*4724848cSchristosL<ERR_get_error(3)>, L<CMS_sign(3)>,
35*4724848cSchristosL<CMS_encrypt(3)>
36*4724848cSchristos
37*4724848cSchristos=head1 COPYRIGHT
38*4724848cSchristos
39*4724848cSchristosCopyright 2008-2019 The OpenSSL Project Authors. All Rights Reserved.
40*4724848cSchristos
41*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
42*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
43*4724848cSchristosin the file LICENSE in the source distribution or at
44*4724848cSchristosL<https://www.openssl.org/source/license.html>.
45*4724848cSchristos
46*4724848cSchristos=cut
47