secure/lib/libcrypto/man/SSL_COMP_add_compression_method.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_COMP_ADD_COMPRESSION_METHOD 3"
 132 .TH SSL_COMP_ADD_COMPRESSION_METHOD 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
 145 \& STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
 146 \& const char *SSL_COMP_get0_name(const SSL_COMP *comp);
 147 \& int SSL_COMP_get_id(const SSL_COMP *comp);
 148 .Ve
 149 .PP
 150 Deprecated:
 151 .PP
 152 .Vb 3
 153 \& #if OPENSSL_API_COMPAT < 0x10100000L
 154 \& void SSL_COMP_free_compression_methods(void)
 155 \& #endif
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fISSL_COMP_add_compression_method()\fR adds the compression method \fBcm\fR with
 160 the identifier \fBid\fR to the list of available compression methods. This
 161 list is globally maintained for all \s-1SSL\s0 operations within this application.
 162 It cannot be set for specific \s-1SSL_CTX\s0 or \s-1SSL\s0 objects.
 163 .PP
 164 \&\fISSL_COMP_get_compression_methods()\fR returns a stack of all of the available
 165 compression methods or \s-1NULL\s0 on error.
 166 .PP
 167 \&\fISSL_COMP_get0_name()\fR returns the name of the compression method \fBcomp\fR.
 168 .PP
 169 \&\fISSL_COMP_get_id()\fR returns the id of the compression method \fBcomp\fR.
 170 .PP
 171 \&\fISSL_COMP_free_compression_methods()\fR releases any resources acquired to
 172 maintain the internal table of compression methods.
 173 .SH "NOTES"
 174 .IX Header "NOTES"
 175 The \s-1TLS\s0 standard (or SSLv3) allows the integration of compression methods
 176 into the communication. The \s-1TLS RFC\s0 does however not specify compression
 177 methods or their corresponding identifiers, so there is currently no compatible
 178 way to integrate compression with unknown peers. It is therefore currently not
 179 recommended to integrate compression into applications. Applications for
 180 non-public use may agree on certain compression methods. Using different
 181 compression methods with the same identifier will lead to connection failure.
 182 .PP
 183 An OpenSSL client speaking a protocol that allows compression (SSLv3, TLSv1)
 184 will unconditionally send the list of all compression methods enabled with
 185 \&\fISSL_COMP_add_compression_method()\fR to the server during the handshake.
 186 Unlike the mechanisms to set a cipher list, there is no method available to
 187 restrict the list of compression method on a per connection basis.
 188 .PP
 189 An OpenSSL server will match the identifiers listed by a client against
 190 its own compression methods and will unconditionally activate compression
 191 when a matching identifier is found. There is no way to restrict the list
 192 of compression methods supported on a per connection basis.
 193 .PP
 194 If enabled during compilation, the OpenSSL library will have the
 195 \&\fICOMP_zlib()\fR compression method available.
 196 .SH "RETURN VALUES"
 197 .IX Header "RETURN VALUES"
 198 \&\fISSL_COMP_add_compression_method()\fR may return the following values:
 199 .IP "0" 4
 200 The operation succeeded.
 201 .IP "1" 4
 202 .IX Item "1"
 203 The operation failed. Check the error queue to find out the reason.
 204 .PP
 205 \&\fISSL_COMP_get_compression_methods()\fR returns the stack of compressions methods or
 206 \&\s-1NULL\s0 on error.
 207 .PP
 208 \&\fISSL_COMP_get0_name()\fR returns the name of the compression method or \s-1NULL\s0 on error.
 209 .PP
 210 \&\fISSL_COMP_get_id()\fR returns the name of the compression method or \-1 on error.
 211 .SH "SEE ALSO"
 212 .IX Header "SEE ALSO"
 213 \&\fIssl\fR\|(7)
 214 .SH "HISTORY"
 215 .IX Header "HISTORY"
 216 \&\fISSL_COMP_free_compression_methods()\fR was deprecated in OpenSSL 1.1.0;
 217 do not use it.
 218 \&\fISSL_COMP_get0_name()\fR and \fISSL_comp_get_id()\fR were added in OpenSSL 1.1.0d.
 219 .SH "COPYRIGHT"
 220 .IX Header "COPYRIGHT"
 221 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 222 .PP
 223 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 224 this file except in compliance with the License.  You can obtain a copy
 225 in the file \s-1LICENSE\s0 in the source distribution or at
 226 <https://www.openssl.org/source/license.html>.