xref: /openbsd-src/lib/libssl/man/SSL_COMP_add_compression_method.3 (revision d4c5fc9dc00f5a9cadd8c2de4e52d85d3c1c6003)
1.\"	$OpenBSD: SSL_COMP_add_compression_method.3,v 1.4 2018/03/23 00:10:28 schwarze Exp $
2.\"
3.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 23 2018 $
18.Dt SSL_COMP_ADD_COMPRESSION_METHOD 3
19.Os
20.Sh NAME
21.Nm SSL_COMP_add_compression_method ,
22.Nm SSL_COMP_get_compression_methods
23.Nd handle SSL/TLS integrated compression methods
24.Sh SYNOPSIS
25.In openssl/ssl.h
26.Ft int
27.Fn SSL_COMP_add_compression_method "int id" "COMP_METHOD *cm"
28.Ft STACK_OF(SSL_COMP) *
29.Fn SSL_COMP_get_compression_methods void
30.Sh DESCRIPTION
31These functions are deprecated and have no effect.
32They are provided purely for compatibility with legacy application code.
33.Pp
34.Fn SSL_COMP_add_compression_method
35used to add the compression method
36.Fa cm
37with the identifier
38.Fa id
39to the list of available compression methods.
40.Pp
41.Fn SSL_COMP_get_compression_methods
42used to return a stack of available compression methods.
43.Sh RETURN VALUES
44.Fn SSL_COMP_add_compression_method
45always returns 1.
46.Fn SSL_COMP_get_compression_methods
47always returns
48.Dv NULL .
49.Sh HISTORY
50.Fn SSL_COMP_add_compression_method
51first appeared in OpenSSL 0.9.2b and has been available since
52.Ox 2.6 .
53.Pp
54.Fn SSL_COMP_get_compression_methods
55first appeared in OpenSSL 0.9.8 and has been available since
56.Ox 4.5 .
57