diff options
author | schwarze <> | 2016-09-05 10:43:42 +0000 |
---|---|---|
committer | schwarze <> | 2016-09-05 10:43:42 +0000 |
commit | 8bc3352bee3f743c2b8f9fd9c743fca60706336c (patch) | |
tree | 8ddbb216e39c4571145c2d202a95596f977cdfe0 /src/lib/libcrypto/man/CMS_uncompress.3 | |
parent | de12fbc1ebd942810e5ca1e55d7a6e213023f318 (diff) | |
download | openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.gz openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.bz2 openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.zip |
remove CMS manuals; beck@ agress with the general idea
Diffstat (limited to '')
-rw-r--r-- | src/lib/libcrypto/man/CMS_uncompress.3 | 70 |
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 | ||
18 | extracts and uncompresses the content from a CMS CompressedData | ||
19 | structure | ||
20 | .Fa cms . | ||
21 | .Fa data | ||
22 | is a | ||
23 | .Vt BIO | ||
24 | to write the content to and | ||
25 | .Fa flags | ||
26 | is an optional set of flags. | ||
27 | .Pp | ||
28 | The | ||
29 | .Fa dcont | ||
30 | parameter is used in the rare case where the compressed content is | ||
31 | detached. | ||
32 | It will normally be set to | ||
33 | .Dv NULL . | ||
34 | .Sh NOTES | ||
35 | The only currently supported compression algorithm is zlib: if the | ||
36 | structure indicates the use of any other algorithm, an error is returned. | ||
37 | .Pp | ||
38 | If zlib support is not compiled into OpenSSL, then | ||
39 | .Fn CMS_uncompress | ||
40 | will always return an error. | ||
41 | .Pp | ||
42 | The following flags can be passed in the | ||
43 | .Fa flags | ||
44 | parameter: | ||
45 | .Pp | ||
46 | If the | ||
47 | .Dv CMS_TEXT | ||
48 | flag is set, MIME headers for type | ||
49 | .Sy text/plain | ||
50 | are deleted from the content. | ||
51 | If the content is not of type | ||
52 | .Sy text/plain , | ||
53 | then an error is returned. | ||
54 | .Sh RETURN VALUES | ||
55 | .Fn CMS_uncompress | ||
56 | returns either 1 for success or 0 for failure. | ||
57 | The 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 | ||
64 | was added to OpenSSL 0.9.8. | ||
65 | .Sh BUGS | ||
66 | The lack of single pass processing and the need to hold all data in | ||
67 | memory as mentioned in | ||
68 | .Xr CMS_verify 3 | ||
69 | also applies to | ||
70 | .Xr CMS_decompress 3 . | ||