Debian Codegraph @

upstream/debian-unstable/man3/CMS_uncompress.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CMS_UNCOMPRESS 3SSL"
58 .TH CMS_UNCOMPRESS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CMS_uncompress \- uncompress a CMS CompressedData structure
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out, unsigned int flags);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBCMS_uncompress()\fR extracts and uncompresses the content from a CMS
75 CompressedData structure \fBcms\fR. \fBdata\fR is a BIO to write the content to and
76 \&\fBflags\fR is an optional set of flags.
77 .PP
78 The \fBdcont\fR parameter is used in the rare case where the compressed content
79 is detached. It will normally be set to NULL.
80 .SH NOTES
81 .IX Header "NOTES"
82 The only currently supported compression algorithm is zlib: if the structure
83 indicates the use of any other algorithm an error is returned.
84 .PP
85 If zlib support is not compiled into OpenSSL then \fBCMS_uncompress()\fR will always
86 return an error.
87 .PP
88 The following flags can be passed in the \fBflags\fR parameter.
89 .PP
90 If the \fBCMS_TEXT\fR flag is set MIME headers for type \fBtext/plain\fR are deleted
91 from the content. If the content is not of type \fBtext/plain\fR then an error is
92 returned.
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 \&\fBCMS_uncompress()\fR returns either 1 for success or 0 for failure. The error can
96 be obtained from \fBERR_get_error\fR\|(3)
97 .SH BUGS
98 .IX Header "BUGS"
99 The lack of single pass processing and the need to hold all data in memory as
100 mentioned in \fBCMS_verify()\fR also applies to \fBCMS_decompress()\fR.
101 .SH "SEE ALSO"
102 .IX Header "SEE ALSO"
103 \&\fBERR_get_error\fR\|(3), \fBCMS_compress\fR\|(3)
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.