Debian Codegraph @

upstream/debian-unstable/man3/CMS_compress.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CMS_COMPRESS 3SSL"
58 .TH CMS_COMPRESS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CMS_compress \- create a CMS CompressedData structure
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/cms.h>
69 \&
70 \& CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBCMS_compress()\fR creates and returns a CMS CompressedData structure. \fBcomp_nid\fR
75 is the compression algorithm to use or \fBNID_undef\fR to use the default
76 algorithm (zlib compression). \fBin\fR is the content to be compressed.
77 \&\fBflags\fR is an optional set of flags.
78 .PP
79 The only currently supported compression algorithm is zlib using the NID
80 NID_zlib_compression.
81 .PP
82 If zlib support is not compiled into OpenSSL then \fBCMS_compress()\fR will return
83 an error.
84 .PP
85 If the \fBCMS_TEXT\fR flag is set MIME headers for type \fBtext/plain\fR are
86 prepended to the data.
87 .PP
88 Normally the supplied content is translated into MIME canonical format (as
89 required by the S/MIME specifications) if \fBCMS_BINARY\fR is set no translation
90 occurs. This option should be used if the supplied data is in binary format
91 otherwise the translation will corrupt it. If \fBCMS_BINARY\fR is set then
92 \&\fBCMS_TEXT\fR is ignored.
93 .PP
94 If the \fBCMS_STREAM\fR flag is set a partial \fBCMS_ContentInfo\fR structure is
95 returned suitable for streaming I/O: no data is read from the BIO \fBin\fR.
96 .PP
97 The compressed data is included in the CMS_ContentInfo structure, unless
98 \&\fBCMS_DETACHED\fR is set in which case it is omitted. This is rarely used in
99 practice and is not supported by \fBSMIME_write_CMS()\fR.
100 .PP
101 If the flag \fBCMS_STREAM\fR is set the returned \fBCMS_ContentInfo\fR structure is
102 \&\fBnot\fR complete and outputting its contents via a function that does not
103 properly finalize the \fBCMS_ContentInfo\fR structure will give unpredictable
104 results.
105 .PP
106 Several functions including \fBSMIME_write_CMS()\fR, \fBi2d_CMS_bio_stream()\fR,
107 \&\fBPEM_write_bio_CMS_stream()\fR finalize the structure. Alternatively finalization
108 can be performed by obtaining the streaming ASN1 \fBBIO\fR directly using
109 \&\fBBIO_new_CMS()\fR.
110 .PP
111 Additional compression parameters such as the zlib compression level cannot
112 currently be set.
113 .SH "RETURN VALUES"
114 .IX Header "RETURN VALUES"
115 \&\fBCMS_compress()\fR returns either a CMS_ContentInfo structure or NULL if an error
116 occurred. The error can be obtained from \fBERR_get_error\fR\|(3).
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBERR_get_error\fR\|(3), \fBCMS_uncompress\fR\|(3)
120 .SH HISTORY
121 .IX Header "HISTORY"
122 The \fBCMS_STREAM\fR flag was added in OpenSSL 1.0.0.
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved.
126 .PP
127 Licensed under the Apache License 2.0 (the "License"). You may not use
128 this file except in compliance with the License. You can obtain a copy
129 in the file LICENSE in the source distribution or at
130 <https://www.openssl.org/source/license.html>.