| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | CMS_final, CMS_final_digest - finalise a CMS_ContentInfo structure
|
|---|
| 6 |
|
|---|
| 7 | =head1 SYNOPSIS
|
|---|
| 8 |
|
|---|
| 9 | #include <openssl/cms.h>
|
|---|
| 10 |
|
|---|
| 11 | int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);
|
|---|
| 12 | int CMS_final_digest(CMS_ContentInfo *cms, const unsigned char *md,
|
|---|
| 13 | unsigned int mdlen, BIO *dcont, unsigned int flags);
|
|---|
| 14 |
|
|---|
| 15 | =head1 DESCRIPTION
|
|---|
| 16 |
|
|---|
| 17 | CMS_final() finalises the structure B<cms>. Its purpose is to perform any
|
|---|
| 18 | operations necessary on B<cms> (digest computation for example) and set the
|
|---|
| 19 | appropriate fields. The parameter B<data> contains the content to be
|
|---|
| 20 | processed. The B<dcont> parameter contains a BIO to write content to after
|
|---|
| 21 | processing: this is only used with detached data and will usually be set to
|
|---|
| 22 | NULL.
|
|---|
| 23 |
|
|---|
| 24 | CMS_final_digest() finalises the structure B<cms> using a pre-computed digest,
|
|---|
| 25 | rather than computing the digest from the original data.
|
|---|
| 26 |
|
|---|
| 27 | =head1 NOTES
|
|---|
| 28 |
|
|---|
| 29 | These functions will normally be called when the B<CMS_PARTIAL> flag is used. It
|
|---|
| 30 | should only be used when streaming is not performed because the streaming
|
|---|
| 31 | I/O functions perform finalisation operations internally.
|
|---|
| 32 |
|
|---|
| 33 | To sign a pre-computed digest, L<CMS_sign(3)> or CMS_sign_ex() is called
|
|---|
| 34 | with the B<data> parameter set to NULL before the CMS structure is finalised
|
|---|
| 35 | with the digest provided to CMS_final_digest() in binary form.
|
|---|
| 36 | When signing a pre-computed digest, the security relies on the digest and its
|
|---|
| 37 | computation from the original message being trusted.
|
|---|
| 38 |
|
|---|
| 39 | =head1 RETURN VALUES
|
|---|
| 40 |
|
|---|
| 41 | CMS_final() and CMS_final_digest() return 1 for success or 0 for failure.
|
|---|
| 42 |
|
|---|
| 43 | =head1 SEE ALSO
|
|---|
| 44 |
|
|---|
| 45 | L<ERR_get_error(3)>, L<CMS_sign(3)>,
|
|---|
| 46 | L<CMS_encrypt(3)>
|
|---|
| 47 |
|
|---|
| 48 | =head1 HISTORY
|
|---|
| 49 |
|
|---|
| 50 | CMS_final_digest() was added in OpenSSL 3.2.
|
|---|
| 51 |
|
|---|
| 52 | =head1 COPYRIGHT
|
|---|
| 53 |
|
|---|
| 54 | Copyright 2008-2022 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 55 |
|
|---|
| 56 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 57 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 58 | in the file LICENSE in the source distribution or at
|
|---|
| 59 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 60 |
|
|---|
| 61 | =cut
|
|---|
