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_compress.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_compress.3 | 110 |
1 files changed, 0 insertions, 110 deletions
diff --git a/src/lib/libcrypto/man/CMS_compress.3 b/src/lib/libcrypto/man/CMS_compress.3 deleted file mode 100644 index 1330464441..0000000000 --- a/src/lib/libcrypto/man/CMS_compress.3 +++ /dev/null | |||
@@ -1,110 +0,0 @@ | |||
1 | .Dd $Mdocdate: November 11 2015 $ | ||
2 | .Dt CMS_COMPRESS 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm CMS_compress | ||
6 | .Nd create a CMS CompressedData structure | ||
7 | .Sh SYNOPSIS | ||
8 | .In openssl/cms.h | ||
9 | .Ft CMS_ContentInfo * | ||
10 | .Fo CMS_compress | ||
11 | .Fa "BIO *in" | ||
12 | .Fa "int comp_nid" | ||
13 | .Fa "unsigned int flags" | ||
14 | .Fc | ||
15 | .Sh DESCRIPTION | ||
16 | .Fn CMS_compress | ||
17 | creates and returns a CMS CompressedData structure. | ||
18 | .Fa comp_nid | ||
19 | is the compression algorithm to use or | ||
20 | .Dv NID_undef | ||
21 | to use the default algorithm (zlib compression). | ||
22 | .Fa in | ||
23 | is the content to be compressed. | ||
24 | .Fa flags | ||
25 | is an optional set of flags. | ||
26 | .Sh NOTES | ||
27 | The only currently supported compression algorithm is zlib using the NID | ||
28 | .Dv NID_zlib_compression . | ||
29 | .Pp | ||
30 | If zlib support is not compiled into OpenSSL then | ||
31 | .Fn CMS_compress | ||
32 | will return an error. | ||
33 | .Pp | ||
34 | If the | ||
35 | .Dv CMS_TEXT | ||
36 | flag is set, MIME headers for type | ||
37 | .Sy text/plain | ||
38 | are prepended to the data. | ||
39 | .Pp | ||
40 | Normally the supplied content is translated into MIME canonical format | ||
41 | (as required by the S/MIME specifications); if | ||
42 | .Dv CMS_BINARY | ||
43 | is set, no translation occurs. | ||
44 | This option should be used if the supplied data is in binary format; | ||
45 | otherwise the translation will corrupt it. | ||
46 | If | ||
47 | .Dv CMS_BINARY | ||
48 | is set then | ||
49 | .Dv CMS_TEXT | ||
50 | is ignored. | ||
51 | .Pp | ||
52 | If the | ||
53 | .Dv CMS_STREAM | ||
54 | flag is set a partial | ||
55 | .Vt CMS_ContentInfo | ||
56 | structure is returned suitable for streaming I/O: no data is read from | ||
57 | the | ||
58 | .Vt BIO | ||
59 | .Fa in . | ||
60 | .Pp | ||
61 | The compressed data is included in the | ||
62 | .Vt CMS_ContentInfo | ||
63 | structure, unless | ||
64 | .Dv CMS_DETACHED | ||
65 | is set, in which case it is omitted. | ||
66 | This is rarely used in practice and is not supported by | ||
67 | .Xr SMIME_write_CMS 3 . | ||
68 | .Sh NOTES | ||
69 | If the flag | ||
70 | .Dv CMS_STREAM | ||
71 | is set, the returned | ||
72 | .Vt CMS_ContentInfo | ||
73 | structure is | ||
74 | .Em not | ||
75 | complete and outputting its contents via a function that does not | ||
76 | properly finalize the | ||
77 | .Vt CMS_ContentInfo | ||
78 | structure will give unpredictable results. | ||
79 | .Pp | ||
80 | Several functions including | ||
81 | .Xr SMIME_write_CMS 3 , | ||
82 | .Xr i2d_CMS_bio_stream 3 , | ||
83 | .Xr PEM_write_bio_CMS_stream 3 | ||
84 | finalize the structure. | ||
85 | Alternatively finalization can be performed by obtaining the streaming | ||
86 | ASN1 | ||
87 | .Vt BIO | ||
88 | directly using | ||
89 | .Xr BIO_new_CMS 3 . | ||
90 | .Pp | ||
91 | Additional compression parameters such as the zlib compression level | ||
92 | cannot currently be set. | ||
93 | .Sh RETURN VALUES | ||
94 | .Fn CMS_compress | ||
95 | returns either a | ||
96 | .Vt CMS_ContentInfo | ||
97 | structure or | ||
98 | .Dv NULL | ||
99 | if an error occurred. | ||
100 | The error can be obtained from | ||
101 | .Xr ERR_get_error 3 . | ||
102 | .Sh SEE ALSO | ||
103 | .Xr CMS_uncompress 3 , | ||
104 | .Xr ERR_get_error 3 | ||
105 | .Sh HISTORY | ||
106 | .Fn CMS_compress | ||
107 | was added to OpenSSL 0.9.8. | ||
108 | The | ||
109 | .Dv CMS_STREAM | ||
110 | flag was first supported in OpenSSL 1.0.0. | ||