summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorschwarze <>2019-08-15 15:46:51 +0000
committerschwarze <>2019-08-15 15:46:51 +0000
commit2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9 (patch)
tree4d6dfdbc0272c3af427549cd5657a5d7b4c0413a /src
parent2aae7c8bfc5593665f39dabf982e6e684e7029f0 (diff)
downloadopenbsd-2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9.tar.gz
openbsd-2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9.tar.bz2
openbsd-2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9.zip
minor cleanup:
* add the missing STANDARDS section * mark up ASN.1 type names * and minor wording improvements
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/CMS_uncompress.339
1 files changed, 20 insertions, 19 deletions
diff --git a/src/lib/libcrypto/man/CMS_uncompress.3 b/src/lib/libcrypto/man/CMS_uncompress.3
index 1b99e72d28..786828b1c5 100644
--- a/src/lib/libcrypto/man/CMS_uncompress.3
+++ b/src/lib/libcrypto/man/CMS_uncompress.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: CMS_uncompress.3,v 1.4 2019/08/11 12:46:38 schwarze Exp $ 1.\" $OpenBSD: CMS_uncompress.3,v 1.5 2019/08/15 15:46:51 schwarze Exp $
2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
3.\" 3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,7 +48,7 @@
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\" 50.\"
51.Dd $Mdocdate: August 11 2019 $ 51.Dd $Mdocdate: August 15 2019 $
52.Dt CMS_UNCOMPRESS 3 52.Dt CMS_UNCOMPRESS 3
53.Os 53.Os
54.Sh NAME 54.Sh NAME
@@ -65,41 +65,42 @@
65.Fc 65.Fc
66.Sh DESCRIPTION 66.Sh DESCRIPTION
67.Fn CMS_uncompress 67.Fn CMS_uncompress
68extracts and uncompresses the content from a CMS CompressedData 68extracts and uncompresses the content of a CMS
69.Vt CompressedData
69structure 70structure
70.Fa cms . 71.Fa cms
71.Fa out 72and writes it to
72is a 73.Fa out .
73.Vt BIO
74to write the content to and
75.Fa flags
76is an optional set of flags.
77.Pp 74.Pp
78The 75In the rare case where the compressed content is detached,
76pass it in via
77.Fa dcont .
78For normal use, set
79.Fa dcont 79.Fa dcont
80parameter is used in the rare case where the compressed content is 80to
81detached.
82It will normally be set to
83.Dv NULL . 81.Dv NULL .
84.Pp 82.Pp
85The only currently supported compression algorithm is zlib: if the 83The only currently supported compression algorithm is zlib: if the
86structure indicates the use of any other algorithm, an error is returned. 84structure indicates the use of any other algorithm, an error is returned.
87.Pp 85If zlib support is not compiled in,
88If zlib support is not compiled in, then
89.Fn CMS_uncompress 86.Fn CMS_uncompress
90will always return an error. 87always returns an error.
91.Pp 88.Pp
92If the 89If the
93.Dv CMS_TEXT 90.Dv CMS_TEXT
94flag is set, MIME headers for type text/plain are deleted from the content. 91bit is set in
92.Fa flags ,
93MIME headers for type text/plain are deleted from the content.
95If the content is not of type text/plain, an error is returned. 94If the content is not of type text/plain, an error is returned.
96.Sh RETURN VALUES 95.Sh RETURN VALUES
97.Fn CMS_uncompress 96.Fn CMS_uncompress
98returns either 1 for success or 0 for failure. 97returns 1 for success or 0 for failure.
99The error can be obtained from 98The error can be obtained from
100.Xr ERR_get_error 3 . 99.Xr ERR_get_error 3 .
101.Sh SEE ALSO 100.Sh SEE ALSO
102.Xr CMS_compress 3 101.Xr CMS_compress 3
102.Sh STANDARDS
103RFC 3274: Compressed Data Content Type for Cryptographic Message Syntax (CMS)
103.Sh HISTORY 104.Sh HISTORY
104.Fn CMS_uncompress 105.Fn CMS_uncompress
105first appeared in OpenSSL 0.9.8h 106first appeared in OpenSSL 0.9.8h