summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/CMS_uncompress.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/CMS_uncompress.370
1 files changed, 0 insertions, 70 deletions
diff --git a/src/lib/libcrypto/man/CMS_uncompress.3 b/src/lib/libcrypto/man/CMS_uncompress.3
deleted file mode 100644
index c651f24de2..0000000000
--- a/src/lib/libcrypto/man/CMS_uncompress.3
+++ /dev/null
@@ -1,70 +0,0 @@
1.Dd $Mdocdate: November 11 2015 $
2.Dt CMS_UNCOMPRESS 3
3.Os
4.Sh NAME
5.Nm CMS_uncompress
6.Nd uncompress a CMS CompressedData structure
7.Sh SYNOPSIS
8.In openssl/cms.h
9.Ft int
10.Fo CMS_uncompress
11.Fa "CMS_ContentInfo *cms"
12.Fa "BIO *dcont"
13.Fa "BIO *out"
14.Fa "unsigned int flags"
15.Fc
16.Sh DESCRIPTION
17.Fn CMS_uncompress
18extracts and uncompresses the content from a CMS CompressedData
19structure
20.Fa cms .
21.Fa data
22is a
23.Vt BIO
24to write the content to and
25.Fa flags
26is an optional set of flags.
27.Pp
28The
29.Fa dcont
30parameter is used in the rare case where the compressed content is
31detached.
32It will normally be set to
33.Dv NULL .
34.Sh NOTES
35The only currently supported compression algorithm is zlib: if the
36structure indicates the use of any other algorithm, an error is returned.
37.Pp
38If zlib support is not compiled into OpenSSL, then
39.Fn CMS_uncompress
40will always return an error.
41.Pp
42The following flags can be passed in the
43.Fa flags
44parameter:
45.Pp
46If the
47.Dv CMS_TEXT
48flag is set, MIME headers for type
49.Sy text/plain
50are deleted from the content.
51If the content is not of type
52.Sy text/plain ,
53then an error is returned.
54.Sh RETURN VALUES
55.Fn CMS_uncompress
56returns either 1 for success or 0 for failure.
57The error can be obtained from
58.Xr ERR_get_error 3 .
59.Sh SEE ALSO
60.Xr CMS_compress 3 ,
61.Xr ERR_get_error 3
62.Sh HISTORY
63.Fn CMS_uncompress
64was added to OpenSSL 0.9.8.
65.Sh BUGS
66The lack of single pass processing and the need to hold all data in
67memory as mentioned in
68.Xr CMS_verify 3
69also applies to
70.Xr CMS_decompress 3 .