xref: /netbsd-src/crypto/external/bsd/openssl/dist/doc/man3/CMS_final.pod (revision b0d1725196a7921d003d2c66a14f186abda4176b)
113d40330Schristos=pod
213d40330Schristos
313d40330Schristos=head1 NAME
413d40330Schristos
513d40330SchristosCMS_final - finalise a CMS_ContentInfo structure
613d40330Schristos
713d40330Schristos=head1 SYNOPSIS
813d40330Schristos
913d40330Schristos #include <openssl/cms.h>
1013d40330Schristos
1113d40330Schristos int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);
1213d40330Schristos
1313d40330Schristos=head1 DESCRIPTION
1413d40330Schristos
154ce06407SchristosCMS_final() finalises the structure B<cms>. Its purpose is to perform any
1613d40330Schristosoperations necessary on B<cms> (digest computation for example) and set the
1713d40330Schristosappropriate fields. The parameter B<data> contains the content to be
1813d40330Schristosprocessed. The B<dcont> parameter contains a BIO to write content to after
1913d40330Schristosprocessing: this is only used with detached data and will usually be set to
2013d40330SchristosNULL.
2113d40330Schristos
2213d40330Schristos=head1 NOTES
2313d40330Schristos
2413d40330SchristosThis function will normally be called when the B<CMS_PARTIAL> flag is used. It
2513d40330Schristosshould only be used when streaming is not performed because the streaming
2613d40330SchristosI/O functions perform finalisation operations internally.
2713d40330Schristos
2813d40330Schristos=head1 RETURN VALUES
2913d40330Schristos
3013d40330SchristosCMS_final() returns 1 for success or 0 for failure.
3113d40330Schristos
3213d40330Schristos=head1 SEE ALSO
3313d40330Schristos
3413d40330SchristosL<ERR_get_error(3)>, L<CMS_sign(3)>,
3513d40330SchristosL<CMS_encrypt(3)>
3613d40330Schristos
3713d40330Schristos=head1 COPYRIGHT
3813d40330Schristos
39*b0d17251SchristosCopyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
4013d40330Schristos
41*b0d17251SchristosLicensed under the Apache License 2.0 (the "License").  You may not use
4213d40330Schristosthis file except in compliance with the License.  You can obtain a copy
4313d40330Schristosin the file LICENSE in the source distribution or at
4413d40330SchristosL<https://www.openssl.org/source/license.html>.
4513d40330Schristos
4613d40330Schristos=cut
47