diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_COMP_add_compression_method.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_COMP_add_compression_method.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_COMP_add_compression_method.3 | 68 |
1 files changed, 0 insertions, 68 deletions
diff --git a/src/lib/libssl/doc/SSL_COMP_add_compression_method.3 b/src/lib/libssl/doc/SSL_COMP_add_compression_method.3 deleted file mode 100644 index d683574dd3..0000000000 --- a/src/lib/libssl/doc/SSL_COMP_add_compression_method.3 +++ /dev/null | |||
@@ -1,68 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_COMP_add_compression_method.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_COMP_ADD_COMPRESSION_METHOD 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_COMP_add_compression_method | ||
9 | .Nd handle SSL/TLS integrated compression methods | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft int | ||
13 | .Fn SSL_COMP_add_compression_method "int id" "COMP_METHOD *cm" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_COMP_add_compression_method | ||
16 | adds the compression method | ||
17 | .Fa cm | ||
18 | with the identifier | ||
19 | .Fa id | ||
20 | to the list of available compression methods. | ||
21 | This list is globally maintained for all SSL operations within this application. | ||
22 | It cannot be set for specific SSL_CTX or SSL objects. | ||
23 | .Sh NOTES | ||
24 | The TLS standard (or SSLv3) allows the integration of compression methods | ||
25 | into the communication. | ||
26 | The TLS RFC does however not specify compression methods or their corresponding | ||
27 | identifiers, so there is currently no compatible way to integrate compression | ||
28 | with unknown peers. | ||
29 | It is therefore currently not recommended to integrate compression into | ||
30 | applications. | ||
31 | Applications for non-public use may agree on certain compression methods. | ||
32 | Using different compression methods with the same identifier will lead to | ||
33 | connection failure. | ||
34 | .Pp | ||
35 | An OpenSSL client speaking a protocol that allows compression (SSLv3, TLSv1) | ||
36 | will unconditionally send the list of all compression methods enabled with | ||
37 | .Fn SSL_COMP_add_compression_method | ||
38 | to the server during the handshake. | ||
39 | Unlike the mechanisms to set a cipher list, there is no method available to | ||
40 | restrict the list of compression method on a per connection basis. | ||
41 | .Pp | ||
42 | An OpenSSL server will match the identifiers listed by a client against | ||
43 | its own compression methods and will unconditionally activate compression | ||
44 | when a matching identifier is found. | ||
45 | There is no way to restrict the list of compression methods supported on a per | ||
46 | connection basis. | ||
47 | .Pp | ||
48 | The OpenSSL library has the compression methods | ||
49 | .Fn COMP_rle | ||
50 | and (when especially enabled during compilation) | ||
51 | .Fn COMP_zlib | ||
52 | available. | ||
53 | .Sh WARNINGS | ||
54 | Once the identities of the compression methods for the TLS protocol have | ||
55 | been standardized, the compression API will most likely be changed. | ||
56 | Using it in the current state is not recommended. | ||
57 | .Sh RETURN VALUES | ||
58 | .Fn SSL_COMP_add_compression_method | ||
59 | may return the following values: | ||
60 | .Bl -tag -width Ds | ||
61 | .It 0 | ||
62 | The operation succeeded. | ||
63 | .It 1 | ||
64 | The operation failed. | ||
65 | Check the error queue to find out the reason. | ||
66 | .El | ||
67 | .Sh SEE ALSO | ||
68 | .Xr ssl 3 | ||