aboutsummaryrefslogtreecommitdiffstats
path: root/doc/deprecated.rst
blob: 57fa9957c80357ef11af219054d21d56e7e76136 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
Deprecated Features
========================

The following functionality is currently deprecated, and will likely
be removed in a future release. If you think you have a good reason to
be using one of the following, contact the developers to explain your
use case if you want to make sure your code continues to work.

This is in addition to specific API calls marked with BOTAN_DEPRECATED
in the source.

- Configuring a build (with ``configure.py``) using Python2. In a future
  major release, Python3 will be required.

- Using the Python wrapper with Python2.

- Directly using an algorithm class like ``AES_128`` or ``SHA_256``. Instead
  create the objects via a ``T::create`` call. A future major release may
  make such declarations private.

- Directly accessing the member variables of types calendar_point, ASN1_Attribute,
  AlgorithmIdentifier, and BER_Object

- The following headers are currently public, but will be completely
  removed in a future major release: ``botan.h``, ``init.h``,
  ``lookup.h``, ``threefish.h``, ``sm2_enc.h``, ``datastor.h``,
  ``basefilt.h``, ``hex_filt.h``, ``b64_filt.h``, ``comp_filter.h``,
  ``key_filt.h``, ``buf_filt.h``, ``cipher_filter.h``,
  ``tls_blocking.h``, ``pbkdf1.h``, ``xmss_key_pair.h``,

- The following headers are currently public, but will be made
  internal in a future major release, and no longer usable by
  applications: ``rotate.h``, ``loadstor.h``, ``mul128.h``,
  ``dyn_load.h``, ``atomic.h``, ``blinding.h``, ``gf2m_small_m.h``,
  ``locking_allocator.h``, ``polyn_gf2m.h`,, ``parsing.h``,
  ``rfc6979.h``, ``divide.h``, ``charset.h``, ``secqueue.h``,
  ``keypair.h``, ``http_util.h``, ``scan_name.h``, ``ghash.h``,
  ``tls_extensions.h``, ``tls_messages.h``, ``tls_algos.h``,
  ``tls_magic.h``, ``oids.h``, ``stl_compatability.h``, ``bswap.h``,
  ``calendar.h``, ``curve_nistp.h``, ``curve_gfp.h``, ``eme.h``,
  ``eme_pkcs.h``, ``eme_raw.h``, ``oaep.h``, ``emsa1.h``, ``emsa.h``,
  ``emsa_pkcs1.h``, ``emsa_raw.h``, ``emsa_x931.h``, ``hash_id.h``,
  ``iso9796.h``, ``pssr.h``, ``kdf1.h``, ``kdf1_iso18033.h``,
  ``kdf2.h``, ``sp800_108.h``, ``sp800_56a.h``, ``sp800_56c.h``,
  ``prf_tls.h``, ``prf_x942.h``, ``mode_pad.h``, ``monty.h``,
  ``mul128.h``, ``pbes2.h``, ``pbkdf2.h``, ``pk_ops.h``,
  ``pow_mod.h``, ``reducer.h``, ``stream_mode.h``, ``workfactor.h``,
  ``xmss_common_ops.h``, ``xmss_tools.h``, ``xmss_hash.h``,
  ``xmss_tools.h``,

- Using a default output length for "SHAKE-128" and "SHAKE-256". Instead,
  always specify the desired output length.

- All or nothing package transform (``package.h``)

- The TLS constructors taking `std::function` for callbacks. Instead
  use the TLS::Callbacks interface.

- Using ``X509_Certificate::subject_info`` and ``issuer_info`` to access any
  information that is not included in the DN or subject alternative name. Prefer
  using the specific assessor functions for other data, eg instead of
  ``cert.subject_info("X509.Certificate.serial")`` use ``cert.serial_number()``.

- The Buffered_Computation base class. In a future release the class will be
  removed, and all of member functions instead declared directly on
  MessageAuthenticationCode and HashFunction. So this only affects you if you
  are directly referencing `Botan::Buffered_Computation` in some way.

- Platform support for Google Native Client

- Support for PathScale and HP compilers

- Block ciphers CAST-256, Kasumi, MISTY1, and DESX.

- GOST 34.11-94 hash

- CBC-MAC

- PBKDF1 key derivation

- GCM support for 64-bit tags

- Weak or rarely used ECC builtin groups including "secp160k1", "secp160r1",
  "secp160r2", "secp192k1", "secp224k1",
  "brainpool160r1", "brainpool192r1", "brainpool224r1", "brainpool320r1",
  "x962_p192v2", "x962_p192v3", "x962_p239v1", "x962_p239v2", "x962_p239v3".

- All built in MODP groups < 2048 bits

- All pre-created DSA groups

TLS Protocol Deprecations
---------------------------

The following TLS protocol features are deprecated and will be removed
in a future major release:

- Support for TLSv1.0/v1.1 and DTLS v1.0

- All support for DSA ciphersuites/certificates

- Support for point compression in TLS. This is supported in v1.2 but
  removed in v1.3. For simplicity it will be removed in v1.2 also.

- Support for using SHA-1 to sign TLS v1.2 ServerKeyExchange.

- All CBC mode ciphersuites. This includes all available 3DES and SEED
  ciphersuites. This implies also removing Encrypt-then-MAC extension.

- All ciphersuites using DH key exchange (DHE-DSS, DHE-RSA, DHE-PSK, anon DH)

- All ciphersuites using static RSA key exchange

- All anonymous (DH/ECDH) ciphersuites. This does not include PSK and
  ECDHE-PSK, which will be retained.

- SRP ciphersuites. This is implied by the removal of CBC mode, since
  all available SRP ciphersuites use CBC. To avoid use of obsolete
  ciphers, it would be better to instead perform a standard TLS
  negotiation, then a PAKE authentication within (and bound to) the
  TLS channel.

- OCB ciphersuites using 128-bit keys