$NetBSD: CMS_uncompress.3,v 1.25 2024/09/08 13:08:17 christos Exp $
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "CMS_uncompress 3"
way too many mistakes in technical documents.
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "CMS_uncompress 3"
CMS_uncompress 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makesway too many mistakes in technical documents.
NAME
CMS_uncompress - uncompress a CMS CompressedData structure
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <openssl/cms.h>
\&
int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out, unsigned int flags);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBCMS_uncompress() extracts and uncompresses the content from a CMS
CompressedData structure cms. data is a BIO to write the content to and
\fBflags is an optional set of flags.
The dcont parameter is used in the rare case where the compressed content is detached. It will normally be set to NULL.
NOTES
Header "NOTES" The only currently supported compression algorithm is zlib: if the structure
indicates the use of any other algorithm an error is returned.
If zlib support is not compiled into OpenSSL then CMS_uncompress() will always return an error.
The following flags can be passed in the flags parameter.
If the CMS_TEXT flag is set MIME headers for type text/plain are deleted from the content. If the content is not of type text/plain then an error is returned.
"RETURN VALUES"
Header "RETURN VALUES" \fBCMS_uncompress() returns either 1 for success or 0 for failure. The error can
be obtained from ERR_get_error\|(3)
BUGS
Header "BUGS" The lack of single pass processing and the need to hold all data in memory as
mentioned in CMS_verify() also applies to CMS_decompress().
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), CMS_compress\|(3)
COPYRIGHT
Header "COPYRIGHT" Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.