diff options
author | schwarze <> | 2019-08-15 15:46:51 +0000 |
---|---|---|
committer | schwarze <> | 2019-08-15 15:46:51 +0000 |
commit | 2dbc937e4ecf6e43ef6bbdeadea1ff910a1cb5f9 (patch) | |
tree | 4d6dfdbc0272c3af427549cd5657a5d7b4c0413a /src | |
parent | 2aae7c8bfc5593665f39dabf982e6e684e7029f0 (diff) | |
download | openbsd-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.3 | 39 |
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 |
68 | extracts and uncompresses the content from a CMS CompressedData | 68 | extracts and uncompresses the content of a CMS |
69 | .Vt CompressedData | ||
69 | structure | 70 | structure |
70 | .Fa cms . | 71 | .Fa cms |
71 | .Fa out | 72 | and writes it to |
72 | is a | 73 | .Fa out . |
73 | .Vt BIO | ||
74 | to write the content to and | ||
75 | .Fa flags | ||
76 | is an optional set of flags. | ||
77 | .Pp | 74 | .Pp |
78 | The | 75 | In the rare case where the compressed content is detached, |
76 | pass it in via | ||
77 | .Fa dcont . | ||
78 | For normal use, set | ||
79 | .Fa dcont | 79 | .Fa dcont |
80 | parameter is used in the rare case where the compressed content is | 80 | to |
81 | detached. | ||
82 | It will normally be set to | ||
83 | .Dv NULL . | 81 | .Dv NULL . |
84 | .Pp | 82 | .Pp |
85 | The only currently supported compression algorithm is zlib: if the | 83 | The only currently supported compression algorithm is zlib: if the |
86 | structure indicates the use of any other algorithm, an error is returned. | 84 | structure indicates the use of any other algorithm, an error is returned. |
87 | .Pp | 85 | If zlib support is not compiled in, |
88 | If zlib support is not compiled in, then | ||
89 | .Fn CMS_uncompress | 86 | .Fn CMS_uncompress |
90 | will always return an error. | 87 | always returns an error. |
91 | .Pp | 88 | .Pp |
92 | If the | 89 | If the |
93 | .Dv CMS_TEXT | 90 | .Dv CMS_TEXT |
94 | flag is set, MIME headers for type text/plain are deleted from the content. | 91 | bit is set in |
92 | .Fa flags , | ||
93 | MIME headers for type text/plain are deleted from the content. | ||
95 | If the content is not of type text/plain, an error is returned. | 94 | If 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 |
98 | returns either 1 for success or 0 for failure. | 97 | returns 1 for success or 0 for failure. |
99 | The error can be obtained from | 98 | The 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 | ||
103 | RFC 3274: Compressed Data Content Type for Cryptographic Message Syntax (CMS) | ||
103 | .Sh HISTORY | 104 | .Sh HISTORY |
104 | .Fn CMS_uncompress | 105 | .Fn CMS_uncompress |
105 | first appeared in OpenSSL 0.9.8h | 106 | first appeared in OpenSSL 0.9.8h |