doc/man3/SSL_COMP_add_compression_method.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_COMP_add_compression_method, SSL_COMP_get_compression_methods,
   6 SSL_COMP_get0_name, SSL_COMP_get_id, SSL_COMP_free_compression_methods
   7 - handle SSL/TLS integrated compression methods
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
  14  STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
  15  const char *SSL_COMP_get0_name(const SSL_COMP *comp);
  16  int SSL_COMP_get_id(const SSL_COMP *comp);
  17
  18 Deprecated:
  19
  20  #if OPENSSL_API_COMPAT < 0x10100000L
  21  void SSL_COMP_free_compression_methods(void)
  22  #endif
  23
  24 =head1 DESCRIPTION
  25
  26 SSL_COMP_add_compression_method() adds the compression method B<cm> with
  27 the identifier B<id> to the list of available compression methods. This
  28 list is globally maintained for all SSL operations within this application.
  29 It cannot be set for specific SSL_CTX or SSL objects.
  30
  31 SSL_COMP_get_compression_methods() returns a stack of all of the available
  32 compression methods or NULL on error.
  33
  34 SSL_COMP_get0_name() returns the name of the compression method B<comp>.
  35
  36 SSL_COMP_get_id() returns the id of the compression method B<comp>.
  37
  38 In versions of OpenSSL prior to 1.1.0 SSL_COMP_free_compression_methods() freed
  39 the internal table of compression methods that were built internally, and
  40 possibly augmented by adding SSL_COMP_add_compression_method(). However this is
  41 now unnecessary from version 1.1.0.  No explicit initialisation or
  42 de-initialisation is necessary. See L<OPENSSL_init_crypto(3)> and
  43 L<OPENSSL_init_ssl(3)>. From OpenSSL 1.1.0 calling this function does nothing.
  44
  45 =head1 NOTES
  46
  47 The TLS standard (or SSLv3) allows the integration of compression methods
  48 into the communication. The TLS RFC does however not specify compression
  49 methods or their corresponding identifiers, so there is currently no compatible
  50 way to integrate compression with unknown peers. It is therefore currently not
  51 recommended to integrate compression into applications. Applications for
  52 non-public use may agree on certain compression methods. Using different
  53 compression methods with the same identifier will lead to connection failure.
  54
  55 An OpenSSL client speaking a protocol that allows compression (SSLv3, TLSv1)
  56 will unconditionally send the list of all compression methods enabled with
  57 SSL_COMP_add_compression_method() to the server during the handshake.
  58 Unlike the mechanisms to set a cipher list, there is no method available to
  59 restrict the list of compression method on a per connection basis.
  60
  61 An OpenSSL server will match the identifiers listed by a client against
  62 its own compression methods and will unconditionally activate compression
  63 when a matching identifier is found. There is no way to restrict the list
  64 of compression methods supported on a per connection basis.
  65
  66 If enabled during compilation, the OpenSSL library will have the
  67 COMP_zlib() compression method available.
  68
  69 =head1 WARNINGS
  70
  71 Once the identities of the compression methods for the TLS protocol have
  72 been standardized, the compression API will most likely be changed. Using
  73 it in the current state is not recommended.
  74
  75 =head1 RETURN VALUES
  76
  77 SSL_COMP_add_compression_method() may return the following values:
  78
  79 =over 4
  80
  81 =item Z<>0
  82
  83 The operation succeeded.
  84
  85 =item Z<>1
  86
  87 The operation failed. Check the error queue to find out the reason.
  88
  89 =back
  90
  91 SSL_COMP_get_compression_methods() returns the stack of compressions methods or
  92 NULL on error.
  93
  94 SSL_COMP_get0_name() returns the name of the compression method or NULL on error.
  95
  96 SSL_COMP_get_id() returns the name of the compression method or -1 on error.
  97
  98 =head1 SEE ALSO
  99
 100 L<ssl(7)>
 101
 102 =head1 HISTORY
 103
 104 SSL_COMP_free_compression_methods() was deprecated in OpenSSL 1.1.0.
 105 SSL_COMP_get0_name() and SSL_comp_get_id() were added in OpenSSL 1.1.0d.
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
 110
 111 Licensed under the OpenSSL license (the "License").  You may not use
 112 this file except in compliance with the License.  You can obtain a copy
 113 in the file LICENSE in the source distribution or at
 114 L<https://www.openssl.org/source/license.html>.
 115
 116 =cut