Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CMS_final (3openssl)

Name

CMS_final - finalise a CMS_ContentInfo structure

Synopsis

#include <openssl/cms.h>

int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);

Description

CMS_final(3openssl)                 OpenSSL                CMS_final(3openssl)



NAME
        CMS_final - finalise a CMS_ContentInfo structure

SYNOPSIS
        #include <openssl/cms.h>

        int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags);

DESCRIPTION
       CMS_final() finalises the structure cms. It's purpose is to perform any
       operations necessary on cms (digest computation for example) and set
       the appropriate fields. The parameter data contains the content to be
       processed. The dcont parameter contains a BIO to write content to after
       processing: this is only used with detached data and will usually be
       set to NULL.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       This function will normally be called when the 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.

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       CMS_final() returns 1 for success or 0 for failure.

SEE ALSO
       ERR_get_error(3), CMS_sign(3), CMS_encrypt(3)

HISTORY
       CMS_final() was added to OpenSSL 0.9.8




1.0.2ze                           2022-05-03               CMS_final(3openssl)