secure/lib/libcrypto/man/man3/SSL_COMP_add_compression_method.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_COMP_ADD_COMPRESSION_METHOD 3"
 136 .TH SSL_COMP_ADD_COMPRESSION_METHOD 3 "2020-04-21" "1.1.1g" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_COMP_add_compression_method, SSL_COMP_get_compression_methods, SSL_COMP_get0_name, SSL_COMP_get_id, SSL_COMP_free_compression_methods \&\- handle SSL/TLS integrated compression methods
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
 149 \& STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
 150 \& const char *SSL_COMP_get0_name(const SSL_COMP *comp);
 151 \& int SSL_COMP_get_id(const SSL_COMP *comp);
 152 .Ve
 153 .PP
 154 Deprecated:
 155 .PP
 156 .Vb 3
 157 \& #if OPENSSL_API_COMPAT < 0x10100000L
 158 \& void SSL_COMP_free_compression_methods(void)
 159 \& #endif
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 \&\fBSSL_COMP_add_compression_method()\fR adds the compression method \fBcm\fR with
 164 the identifier \fBid\fR to the list of available compression methods. This
 165 list is globally maintained for all \s-1SSL\s0 operations within this application.
 166 It cannot be set for specific \s-1SSL_CTX\s0 or \s-1SSL\s0 objects.
 167 .PP
 168 \&\fBSSL_COMP_get_compression_methods()\fR returns a stack of all of the available
 169 compression methods or \s-1NULL\s0 on error.
 170 .PP
 171 \&\fBSSL_COMP_get0_name()\fR returns the name of the compression method \fBcomp\fR.
 172 .PP
 173 \&\fBSSL_COMP_get_id()\fR returns the id of the compression method \fBcomp\fR.
 174 .PP
 175 \&\fBSSL_COMP_free_compression_methods()\fR releases any resources acquired to
 176 maintain the internal table of compression methods.
 177 .SH "NOTES"
 178 .IX Header "NOTES"
 179 The \s-1TLS\s0 standard (or SSLv3) allows the integration of compression methods
 180 into the communication. The \s-1TLS RFC\s0 does however not specify compression
 181 methods or their corresponding identifiers, so there is currently no compatible
 182 way to integrate compression with unknown peers. It is therefore currently not
 183 recommended to integrate compression into applications. Applications for
 184 non-public use may agree on certain compression methods. Using different
 185 compression methods with the same identifier will lead to connection failure.
 186 .PP
 187 An OpenSSL client speaking a protocol that allows compression (SSLv3, TLSv1)
 188 will unconditionally send the list of all compression methods enabled with
 189 \&\fBSSL_COMP_add_compression_method()\fR to the server during the handshake.
 190 Unlike the mechanisms to set a cipher list, there is no method available to
 191 restrict the list of compression method on a per connection basis.
 192 .PP
 193 An OpenSSL server will match the identifiers listed by a client against
 194 its own compression methods and will unconditionally activate compression
 195 when a matching identifier is found. There is no way to restrict the list
 196 of compression methods supported on a per connection basis.
 197 .PP
 198 If enabled during compilation, the OpenSSL library will have the
 199 \&\fBCOMP_zlib()\fR compression method available.
 200 .SH "RETURN VALUES"
 201 .IX Header "RETURN VALUES"
 202 \&\fBSSL_COMP_add_compression_method()\fR may return the following values:
 203 .IP "0" 4
 204 The operation succeeded.
 205 .IP "1" 4
 206 .IX Item "1"
 207 The operation failed. Check the error queue to find out the reason.
 208 .PP
 209 \&\fBSSL_COMP_get_compression_methods()\fR returns the stack of compressions methods or
 210 \&\s-1NULL\s0 on error.
 211 .PP
 212 \&\fBSSL_COMP_get0_name()\fR returns the name of the compression method or \s-1NULL\s0 on error.
 213 .PP
 214 \&\fBSSL_COMP_get_id()\fR returns the name of the compression method or \-1 on error.
 215 .SH "SEE ALSO"
 216 .IX Header "SEE ALSO"
 217 \&\fBssl\fR\|(7)
 218 .SH "HISTORY"
 219 .IX Header "HISTORY"
 220 The \fBSSL_COMP_free_compression_methods()\fR function was deprecated in OpenSSL 1.1.0.
 221 The \fBSSL_COMP_get0_name()\fR and \fBSSL_comp_get_id()\fR functions were added in OpenSSL 1.1.0d.
 222 .SH "COPYRIGHT"
 223 .IX Header "COPYRIGHT"
 224 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 225 .PP
 226 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 227 this file except in compliance with the License.  You can obtain a copy
 228 in the file \s-1LICENSE\s0 in the source distribution or at
 229 <https://www.openssl.org/source/license.html>.