Botan 3.8.1
Crypto and TLS for C&
Botan::TLS::Text_Policy Class Reference

#include <tls_policy.h>

Inheritance diagram for Botan::TLS::Text_Policy:
Botan::TLS::Policy

Public Member Functions

virtual bool abort_connection_on_undesired_renegotiation () const
 
virtual std::optional< std::vector< Signature_Scheme > > acceptable_certificate_signature_schemes () const
 
virtual bool acceptable_ciphersuite (const Ciphersuite &suite) const
 
virtual bool acceptable_protocol_version (Protocol_Version version) const
 
virtual std::vector< Signature_Schemeacceptable_signature_schemes () const
 
std::vector< Certificate_Typeaccepted_client_certificate_types () const override
 
std::vector< Certificate_Typeaccepted_server_certificate_types () const override
 
bool allow_client_initiated_renegotiation () const override
 
bool allow_dtls12 () const override
 
virtual bool allow_dtls_epoch0_restart () const
 
bool allow_insecure_renegotiation () const override
 
virtual bool allow_resumption_for_renegotiation () const
 
bool allow_server_initiated_renegotiation () const override
 
bool allow_ssl_key_log_file () const override
 
bool allow_tls12 () const override
 
bool allow_tls13 () const override
 
std::vector< std::string > allowed_ciphers () const override
 
std::vector< std::string > allowed_key_exchange_methods () const override
 
std::vector< std::string > allowed_macs () const override
 
bool allowed_signature_hash (std::string_view hash) const
 
std::vector< std::string > allowed_signature_hashes () const override
 
bool allowed_signature_method (std::string_view sig_method) const
 
std::vector< std::string > allowed_signature_methods () const override
 
virtual std::vector< Signature_Schemeallowed_signature_schemes () const
 
virtual void check_peer_key_acceptable (const Public_Key &public_key) const
 
virtual Group_Params choose_key_exchange_group (const std::vector< Group_Params > &supported_by_peer, const std::vector< Group_Params > &offered_by_peer) const
 
virtual std::vector< uint16_t > ciphersuite_list (Protocol_Version version) const
 
virtual Group_Params default_dh_group () const
 
size_t dtls_default_mtu () const override
 
size_t dtls_initial_timeout () const override
 
size_t dtls_maximum_timeout () const override
 
bool hash_hello_random () const override
 
bool hide_unknown_users () const override
 
bool include_time_in_hello_random () const override
 
std::vector< Group_Paramskey_exchange_groups () const override
 
std::vector< Group_Paramskey_exchange_groups_to_offer () const override
 
virtual Protocol_Version latest_supported_version (bool datagram) const
 
virtual size_t maximum_certificate_chain_size () const
 
size_t maximum_session_tickets_per_client_hello () const override
 
size_t minimum_dh_group_size () const override
 
size_t minimum_ecdh_group_size () const override
 
size_t minimum_ecdsa_group_size () const override
 
size_t minimum_rsa_bits () const override
 
size_t minimum_signature_strength () const override
 
bool negotiate_encrypt_then_mac () const override
 
size_t new_session_tickets_upon_handshake_success () const override
 
virtual bool only_resume_with_exact_version () const
 
virtual void print (std::ostream &o) const
 
std::optional< uint16_t > record_size_limit () const override
 
virtual bool request_client_certificate_authentication () const
 
bool require_cert_revocation_info () const override
 
bool require_client_certificate_authentication () const override
 
bool reuse_session_tickets () const override
 
bool server_uses_own_ciphersuite_preferences () const override
 
std::chrono::seconds session_ticket_lifetime () const override
 
void set (const std::string &key, const std::string &value)
 
std::vector< uint16_t > srtp_profiles () const override
 
bool support_cert_status_message () const override
 
 Text_Policy (std::istream &in)
 
 Text_Policy (std::string_view s)
 
bool tls_13_middlebox_compatibility_mode () const override
 
std::string to_string () const
 
bool use_ecc_point_compression () const override
 

Protected Member Functions

bool get_bool (const std::string &key, bool def) const
 
std::chrono::seconds get_duration (const std::string &key, std::chrono::seconds def) const
 
size_t get_len (const std::string &key, size_t def) const
 
std::vector< std::string > get_list (const std::string &key, const std::vector< std::string > &def) const
 
std::string get_str (const std::string &key, const std::string &def="") const
 
std::vector< Certificate_Typeread_cert_type_list (const std::string &cert_type_str) const
 
std::vector< Group_Paramsread_group_list (std::string_view group_str) const
 
bool set_value (const std::string &key, std::string_view val, bool overwrite)
 

Detailed Description

Definition at line 732 of file tls_policy.h.

Constructor & Destructor Documentation

◆ Text_Policy() [1/2]

Botan::TLS::Text_Policy::Text_Policy ( std::string_view s)
explicit

Definition at line 215 of file tls_text_policy.cpp.

215 {
216 std::istringstream iss{std::string(s)}; // FIXME C++23 avoid copy
217 m_kv = read_cfg(iss);
218}
std::map< std::string, std::string > read_cfg(std::istream &is)
Definition read_cfg.cpp:34

References Botan::read_cfg().

◆ Text_Policy() [2/2]

Botan::TLS::Text_Policy::Text_Policy ( std::istream & in)
explicit

Definition at line 220 of file tls_text_policy.cpp.

220: m_kv(read_cfg(in)) {}

References Botan::read_cfg().

Member Function Documentation

◆ abort_connection_on_undesired_renegotiation()

bool Botan::TLS::Policy::abort_connection_on_undesired_renegotiation ( ) const
virtualinherited

If true, a request to renegotiate will close the connection with a fatal alert. Otherwise, a warning alert is sent.

See also
allow_client_initiated_renegotiation
allow_server_initiated_renegotiation

Default: false

Note
Has no effect for TLS 1.3 connections.

Definition at line 445 of file tls_policy.cpp.

445 {
446 return false;
447}

◆ acceptable_certificate_signature_schemes()

std::optional< std::vector< Signature_Scheme > > Botan::TLS::Policy::acceptable_certificate_signature_schemes ( ) const
virtualinherited

Return a list of schemes we are willing to accept for signatures in certificates.

By default, the same restrictions as in acceptable_signature_schemes() apply.

Returns
std::nullopt if the same restrictions as defined in acceptable_signature_schemes() should apply

Definition at line 46 of file tls_policy.cpp.

46 {
47 // the restrictions of ::acceptable_signature_schemes() shall apply
48 return std::nullopt;
49}

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), and Botan::TLS::Client_Hello_13::Client_Hello_13().

◆ acceptable_ciphersuite()

bool Botan::TLS::Policy::acceptable_ciphersuite ( const Ciphersuite & suite) const
virtualinherited

Allows policy to reject any ciphersuites which are undesirable for whatever reason without having to reimplement ciphersuite_list

Definition at line 356 of file tls_policy.cpp.

356 {
357 return value_exists(allowed_ciphers(), ciphersuite.cipher_algo()) &&
358 value_exists(allowed_macs(), ciphersuite.mac_algo());
359}
virtual std::vector< std::string > allowed_macs() const
virtual std::vector< std::string > allowed_ciphers() const
bool value_exists(const std::vector< T > &vec, const OT &val)
Definition stl_util.h:61

References allowed_ciphers(), allowed_macs(), Botan::TLS::Ciphersuite::cipher_algo(), Botan::TLS::Ciphersuite::mac_algo(), and Botan::value_exists().

Referenced by ciphersuite_list().

◆ acceptable_protocol_version()

bool Botan::TLS::Policy::acceptable_protocol_version ( Protocol_Version version) const
virtualinherited
Returns
true if and only if we are willing to accept this version Default accepts TLS v1.2 and later or DTLS v1.2 or later.

Definition at line 317 of file tls_policy.cpp.

317 {
318#if defined(BOTAN_HAS_TLS_13)
319 if(version == Protocol_Version::TLS_V13 && allow_tls13()) {
320 return true;
321 }
322#endif
323
324#if defined(BOTAN_HAS_TLS_12)
325 if(version == Protocol_Version::TLS_V12 && allow_tls12()) {
326 return true;
327 }
328
329 if(version == Protocol_Version::DTLS_V12 && allow_dtls12()) {
330 return true;
331 }
332#endif
333
334 return false;
335}
virtual bool allow_tls12() const
virtual bool allow_tls13() const
virtual bool allow_dtls12() const

References allow_dtls12(), allow_tls12(), and allow_tls13().

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_13::highest_supported_version(), and latest_supported_version().

◆ acceptable_signature_schemes()

std::vector< Signature_Scheme > Botan::TLS::Policy::acceptable_signature_schemes ( ) const
virtualinherited

Return a list of schemes we are willing to accept

Definition at line 42 of file tls_policy.cpp.

42 {
43 return this->allowed_signature_schemes();
44}
virtual std::vector< Signature_Scheme > allowed_signature_schemes() const

References allowed_signature_schemes().

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), and Botan::TLS::Client_Hello_13::Client_Hello_13().

◆ accepted_client_certificate_types()

std::vector< Certificate_Type > Botan::TLS::Text_Policy::accepted_client_certificate_types ( ) const
overridevirtual

Returns a list of accepted certificate types for client authentication in order of preference. See RFC 7250 and RFC 8446 4.4.2 for details. Defaults to X509 only.

Note that it is the application's responsibility to provide public keys and/or certificates according to the specification in this list via the Credentials_Manager.

Reimplemented from Botan::TLS::Policy.

Definition at line 75 of file tls_text_policy.cpp.

75 {
76 const auto cert_types = get_str("accepted_client_certificate_types");
77 return (cert_types.empty()) ? Policy::accepted_client_certificate_types() : read_cert_type_list(cert_types);
78}
virtual std::vector< Certificate_Type > accepted_client_certificate_types() const
std::string get_str(const std::string &key, const std::string &def="") const
std::vector< Certificate_Type > read_cert_type_list(const std::string &cert_type_str) const

References Botan::TLS::Policy::accepted_client_certificate_types(), get_str(), and read_cert_type_list().

◆ accepted_server_certificate_types()

std::vector< Certificate_Type > Botan::TLS::Text_Policy::accepted_server_certificate_types ( ) const
overridevirtual

Returns a list of accepted certificate types for server authentication in order of preference. See RFC 7250 and RFC 8446 4.4.2 for details. Defaults to X509 only.

Note that it is the application's responsibility to provide public keys and/or certificates according to the specification in this list via the Credentials_Manager.

Reimplemented from Botan::TLS::Policy.

Definition at line 80 of file tls_text_policy.cpp.

80 {
81 const auto cert_types = get_str("accepted_server_certificate_types");
82 return (cert_types.empty()) ? Policy::accepted_server_certificate_types() : read_cert_type_list(cert_types);
83}
virtual std::vector< Certificate_Type > accepted_server_certificate_types() const

References Botan::TLS::Policy::accepted_server_certificate_types(), get_str(), and read_cert_type_list().

◆ allow_client_initiated_renegotiation()

bool Botan::TLS::Text_Policy::allow_client_initiated_renegotiation ( ) const
overridevirtual

Consulted by server side. If true, allows clients to initiate a new handshake

If this function returns true, a server will accept a client-initiated renegotiation attempt. Otherwise it will send the client a non-fatal TLS::AlertType::NoRenegotiation alert.

Default: false

Note
Has no effect for TLS 1.3 connections.

Reimplemented from Botan::TLS::Policy.

Definition at line 71 of file tls_text_policy.cpp.

71 {
72 return get_bool("allow_client_initiated_renegotiation", Policy::allow_client_initiated_renegotiation());
73}
virtual bool allow_client_initiated_renegotiation() const
bool get_bool(const std::string &key, bool def) const

References Botan::TLS::Policy::allow_client_initiated_renegotiation(), and get_bool().

◆ allow_dtls12()

bool Botan::TLS::Text_Policy::allow_dtls12 ( ) const
overridevirtual

Allow DTLS v1.2

Reimplemented from Botan::TLS::Policy.

Definition at line 55 of file tls_text_policy.cpp.

55 {
56 return get_bool("allow_dtls12", Policy::allow_dtls12());
57}

References Botan::TLS::Policy::allow_dtls12(), and get_bool().

◆ allow_dtls_epoch0_restart()

bool Botan::TLS::Policy::allow_dtls_epoch0_restart ( ) const
virtualinherited

If true, then allow a DTLS client to restart a connection to the same server association as described in section 4.2.8 of the DTLS RFC

Definition at line 457 of file tls_policy.cpp.

457 {
458 return false;
459}

Referenced by Botan::TLS::Channel_Impl_12::from_peer().

◆ allow_insecure_renegotiation()

bool Botan::TLS::Text_Policy::allow_insecure_renegotiation ( ) const
overridevirtual

Allow renegotiation even if the counterparty doesn't support the secure renegotiation extension.

Default: false

Warning
Changing this to true exposes you to injected plaintext attacks. Read RFC 5746 for background.
Note
Has no effect for TLS 1.3 connections.

Reimplemented from Botan::TLS::Policy.

Definition at line 59 of file tls_text_policy.cpp.

59 {
60 return get_bool("allow_insecure_renegotiation", Policy::allow_insecure_renegotiation());
61}
virtual bool allow_insecure_renegotiation() const

References Botan::TLS::Policy::allow_insecure_renegotiation(), and get_bool().

◆ allow_resumption_for_renegotiation()

bool Botan::TLS::Policy::allow_resumption_for_renegotiation ( ) const
virtualinherited
Note
Has no effect for TLS 1.3 connections.

Definition at line 421 of file tls_policy.cpp.

421 {
422 return true;
423}

Referenced by Botan::TLS::Channel_Impl_12::renegotiate().

◆ allow_server_initiated_renegotiation()

bool Botan::TLS::Text_Policy::allow_server_initiated_renegotiation ( ) const
overridevirtual

Consulted by client side. If true, allows servers to initiate a new handshake

If this function returns true, a client will accept a server-initiated renegotiation attempt. Otherwise it will send the server a non-fatal TLS::AlertType::NoRenegotiation alert.

Default: false

Note
Has no effect for TLS 1.3 connections.

Reimplemented from Botan::TLS::Policy.

Definition at line 85 of file tls_text_policy.cpp.

85 {
86 return get_bool("allow_server_initiated_renegotiation", Policy::allow_server_initiated_renegotiation());
87}
virtual bool allow_server_initiated_renegotiation() const

References Botan::TLS::Policy::allow_server_initiated_renegotiation(), and get_bool().

◆ allow_ssl_key_log_file()

bool Botan::TLS::Text_Policy::allow_ssl_key_log_file ( ) const
overridevirtual

Allow ssl key log file

Note
If function returns true, then Callbacks::tls_ssl_key_log_data will be invoked containing secret information for logging purposes

Reimplemented from Botan::TLS::Policy.

Definition at line 19 of file tls_text_policy.cpp.

19 {
20 return get_bool("allow_ssl_key_log_file", Policy::allow_ssl_key_log_file());
21}
virtual bool allow_ssl_key_log_file() const

References Botan::TLS::Policy::allow_ssl_key_log_file(), and get_bool().

◆ allow_tls12()

bool Botan::TLS::Text_Policy::allow_tls12 ( ) const
overridevirtual

Allow TLS v1.2

Reimplemented from Botan::TLS::Policy.

Definition at line 47 of file tls_text_policy.cpp.

47 {
48 return get_bool("allow_tls12", Policy::allow_tls12());
49}

References Botan::TLS::Policy::allow_tls12(), and get_bool().

◆ allow_tls13()

bool Botan::TLS::Text_Policy::allow_tls13 ( ) const
overridevirtual

Allow TLS v1.3

Reimplemented from Botan::TLS::Policy.

Definition at line 51 of file tls_text_policy.cpp.

51 {
52 return get_bool("allow_tls13", Policy::allow_tls13());
53}

References Botan::TLS::Policy::allow_tls13(), and get_bool().

◆ allowed_ciphers()

std::vector< std::string > Botan::TLS::Text_Policy::allowed_ciphers ( ) const
overridevirtual

Returns a list of ciphers we are willing to negotiate, in order of preference.

Reimplemented from Botan::TLS::Policy.

Definition at line 23 of file tls_text_policy.cpp.

23 {
24 return get_list("ciphers", Policy::allowed_ciphers());
25}
std::vector< std::string > get_list(const std::string &key, const std::vector< std::string > &def) const

References Botan::TLS::Policy::allowed_ciphers(), and get_list().

◆ allowed_key_exchange_methods()

std::vector< std::string > Botan::TLS::Text_Policy::allowed_key_exchange_methods ( ) const
overridevirtual

Returns a list of key exchange algorithms we are willing to use, in order of preference. Allowed values: DH, empty string (representing RSA using server certificate key)

Reimplemented from Botan::TLS::Policy.

Definition at line 35 of file tls_text_policy.cpp.

35 {
36 return get_list("key_exchange_methods", Policy::allowed_key_exchange_methods());
37}
virtual std::vector< std::string > allowed_key_exchange_methods() const

References Botan::TLS::Policy::allowed_key_exchange_methods(), and get_list().

◆ allowed_macs()

std::vector< std::string > Botan::TLS::Text_Policy::allowed_macs ( ) const
overridevirtual

Returns a list of MAC algorithms we are willing to use.

Reimplemented from Botan::TLS::Policy.

Definition at line 31 of file tls_text_policy.cpp.

31 {
32 return get_list("macs", Policy::allowed_macs());
33}

References Botan::TLS::Policy::allowed_macs(), and get_list().

◆ allowed_signature_hash()

bool Botan::TLS::Policy::allowed_signature_hash ( std::string_view hash) const
inherited

Definition at line 114 of file tls_policy.cpp.

114 {
115 return value_exists(allowed_signature_hashes(), sig_hash);
116}
virtual std::vector< std::string > allowed_signature_hashes() const

References allowed_signature_hashes(), and Botan::value_exists().

Referenced by allowed_signature_schemes(), and Botan::TLS::Handshake_State::choose_sig_format().

◆ allowed_signature_hashes()

std::vector< std::string > Botan::TLS::Text_Policy::allowed_signature_hashes ( ) const
overridevirtual

Returns a list of hash algorithms we are willing to use for signatures, in order of preference.

Reimplemented from Botan::TLS::Policy.

Definition at line 27 of file tls_text_policy.cpp.

27 {
28 return get_list("signature_hashes", Policy::allowed_signature_hashes());
29}

References Botan::TLS::Policy::allowed_signature_hashes(), and get_list().

◆ allowed_signature_method()

bool Botan::TLS::Policy::allowed_signature_method ( std::string_view sig_method) const
inherited

Definition at line 110 of file tls_policy.cpp.

110 {
111 return value_exists(allowed_signature_methods(), sig_method);
112}
virtual std::vector< std::string > allowed_signature_methods() const

References allowed_signature_methods(), and Botan::value_exists().

Referenced by allowed_signature_schemes(), Botan::TLS::Certificate_13::Certificate_13(), and Botan::TLS::Handshake_State::parse_sig_format().

◆ allowed_signature_methods()

std::vector< std::string > Botan::TLS::Text_Policy::allowed_signature_methods ( ) const
overridevirtual

Returns a list of signature algorithms we are willing to use, in order of preference.

Reimplemented from Botan::TLS::Policy.

Definition at line 39 of file tls_text_policy.cpp.

39 {
40 return get_list("signature_methods", Policy::allowed_signature_methods());
41}

References Botan::TLS::Policy::allowed_signature_methods(), and get_list().

◆ allowed_signature_schemes()

std::vector< Signature_Scheme > Botan::TLS::Policy::allowed_signature_schemes ( ) const
virtualinherited

Definition at line 27 of file tls_policy.cpp.

27 {
28 std::vector<Signature_Scheme> schemes;
29
30 for(Signature_Scheme scheme : Signature_Scheme::all_available_schemes()) {
31 const bool sig_allowed = allowed_signature_method(scheme.algorithm_name());
32 const bool hash_allowed = allowed_signature_hash(scheme.hash_function_name());
33
34 if(sig_allowed && hash_allowed) {
35 schemes.push_back(scheme);
36 }
37 }
38
39 return schemes;
40}
bool allowed_signature_method(std::string_view sig_method) const
bool allowed_signature_hash(std::string_view hash) const
static const std::vector< Signature_Scheme > & all_available_schemes()

References Botan::TLS::Signature_Scheme::all_available_schemes(), allowed_signature_hash(), and allowed_signature_method().

Referenced by acceptable_signature_schemes(), Botan::TLS::Certificate_Verify_13::Certificate_Verify_13(), and Botan::TLS::Handshake_State::choose_sig_format().

◆ check_peer_key_acceptable()

void Botan::TLS::Policy::check_peer_key_acceptable ( const Public_Key & public_key) const
virtualinherited

Allows the policy to examine peer public keys. Throw an exception if the key should be rejected. Default implementation checks against policy values minimum_dh_group_size(), minimum_rsa_bits(), minimum_ecdsa_group_size(), and minimum_ecdh_group_size().

Override if you'd like to perform some other kind of test on (or logging of) the peer's keys.

Definition at line 275 of file tls_policy.cpp.

275 {
276 const std::string algo_name = public_key.algo_name();
277
278 const size_t keylength = public_key.key_length();
279 size_t expected_keylength = 0;
280
281 if(algo_name == "RSA") {
282 expected_keylength = minimum_rsa_bits();
283 } else if(algo_name == "DH") {
284 expected_keylength = minimum_dh_group_size();
285 } else if(algo_name == "ECDH" || algo_name == "X25519" || algo_name == "X448") {
286 expected_keylength = minimum_ecdh_group_size();
287 } else if(algo_name == "ECDSA") {
288 expected_keylength = minimum_ecdsa_group_size();
289 }
290 // else some other algo, so leave expected_keylength as zero and the check is a no-op
291
292 if(keylength < expected_keylength) {
293 throw TLS_Exception(Alert::InsufficientSecurity,
294 "Peer sent " + std::to_string(keylength) + " bit " + algo_name +
295 " key"
296 ", policy requires at least " +
297 std::to_string(expected_keylength));
298 }
299}
virtual size_t minimum_ecdh_group_size() const
virtual size_t minimum_rsa_bits() const
virtual size_t minimum_dh_group_size() const
virtual size_t minimum_ecdsa_group_size() const

References Botan::Asymmetric_Key::algo_name(), Botan::Public_Key::key_length(), minimum_dh_group_size(), minimum_ecdh_group_size(), minimum_ecdsa_group_size(), and minimum_rsa_bits().

Referenced by Botan::TLS::Certificate_13::Certificate_13(), Botan::TLS::Callbacks::tls_ephemeral_key_agreement(), Botan::TLS::Callbacks::tls_kem_encapsulate(), Botan::TLS::Certificate_Verify_12::verify(), and Botan::TLS::Server_Key_Exchange::verify().

◆ choose_key_exchange_group()

Group_Params Botan::TLS::Policy::choose_key_exchange_group ( const std::vector< Group_Params > & supported_by_peer,
const std::vector< Group_Params > & offered_by_peer ) const
virtualinherited

Select a key exchange group to use, from the list of groups sent by the peer. In TLS 1.3 handshakes the peer might have provided cryptographic material for a subset of its available groups. Choosing a group for which no share was provided will result in an additional round trip. If none are acceptable, return Group_Params::NONE.

By default this will try to optimize for less round trips even if this results in the usage of a less preferred group.

Definition at line 122 of file tls_policy.cpp.

123 {
124 if(supported_by_peer.empty()) {
125 return Group_Params::NONE;
126 }
127
128 const auto our_groups = key_exchange_groups();
129
130 // First check if the peer sent a PQ share of a group we also support
131 for(auto share : offered_by_peer) {
132 if(share.is_post_quantum() && value_exists(our_groups, share)) {
133 return share;
134 }
135 }
136
137 // Then check if the peer offered a PQ algo we also support
138 for(auto share : supported_by_peer) {
139 if(share.is_post_quantum() && value_exists(our_groups, share)) {
140 return share;
141 }
142 }
143
144 // Prefer groups that were offered by the peer for the sake of saving
145 // an additional round trip. For TLS 1.2, this won't be used.
146 for(auto g : offered_by_peer) {
147 if(value_exists(our_groups, g)) {
148 return g;
149 }
150 }
151
152 // If no pre-offered groups fit our supported set, we prioritize our
153 // own preference.
154 for(auto g : our_groups) {
155 if(value_exists(supported_by_peer, g)) {
156 return g;
157 }
158 }
159
160 return Group_Params::NONE;
161}
virtual std::vector< Group_Params > key_exchange_groups() const

References key_exchange_groups(), and Botan::value_exists().

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Server_Hello_13::create(), and Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

◆ ciphersuite_list()

std::vector< uint16_t > Botan::TLS::Policy::ciphersuite_list ( Protocol_Version version) const
virtualinherited

Return allowed ciphersuites, in order of preference for the provided protocol version.

Parameters
versionthe exact protocol version to select supported and allowed ciphersuites for

Definition at line 556 of file tls_policy.cpp.

556 {
557 const std::vector<std::string> ciphers = allowed_ciphers();
558 const std::vector<std::string> macs = allowed_macs();
559 const std::vector<std::string> kex = allowed_key_exchange_methods();
560 const std::vector<std::string> sigs = allowed_signature_methods();
561
562 std::vector<Ciphersuite> ciphersuites;
563
564 for(auto&& suite : Ciphersuite::all_known_ciphersuites()) {
565 // Can we use it?
566 if(!suite.valid()) {
567 continue;
568 }
569
570 // Can we use it in this version?
571 if(!suite.usable_in_version(version)) {
572 continue;
573 }
574
575 // Is it acceptable to the policy?
576 if(!this->acceptable_ciphersuite(suite)) {
577 continue;
578 }
579
580 if(!value_exists(ciphers, suite.cipher_algo())) {
581 continue; // unsupported cipher
582 }
583
584 // these checks are irrelevant for TLS 1.3
585 // TODO: consider making a method for this logic
586 if(version.is_pre_tls_13()) {
587 if(!value_exists(kex, suite.kex_algo())) {
588 continue; // unsupported key exchange
589 }
590
591 if(!value_exists(macs, suite.mac_algo())) {
592 continue; // unsupported MAC algo
593 }
594
595 if(!value_exists(sigs, suite.sig_algo())) {
596 // allow if it's an empty sig algo and we want to use PSK
597 if(suite.auth_method() != Auth_Method::IMPLICIT || !suite.psk_ciphersuite()) {
598 continue;
599 }
600 }
601 }
602
603 // OK, consider it
604 ciphersuites.push_back(suite);
605 }
606
607 if(ciphersuites.empty()) {
608 throw Invalid_State("Policy does not allow any available cipher suite");
609 }
610
611 Ciphersuite_Preference_Ordering order(ciphers, macs, kex, sigs);
612 std::sort(ciphersuites.begin(), ciphersuites.end(), order);
613
614 std::vector<uint16_t> ciphersuite_codes;
615 ciphersuite_codes.reserve(ciphersuites.size());
616 for(auto i : ciphersuites) {
617 ciphersuite_codes.push_back(i.ciphersuite_code());
618 }
619 return ciphersuite_codes;
620}
static const std::vector< Ciphersuite > & all_known_ciphersuites()
virtual bool acceptable_ciphersuite(const Ciphersuite &suite) const

References acceptable_ciphersuite(), Botan::TLS::Ciphersuite::all_known_ciphersuites(), allowed_ciphers(), allowed_key_exchange_methods(), allowed_macs(), allowed_signature_methods(), Botan::TLS::IMPLICIT, Botan::TLS::Protocol_Version::is_pre_tls_13(), and Botan::value_exists().

Referenced by Botan::TLS::Client_Hello_12::Client_Hello_12(), Botan::TLS::Client_Hello_12::Client_Hello_12(), and Botan::TLS::Client_Hello_13::Client_Hello_13().

◆ default_dh_group()

Group_Params Botan::TLS::Policy::default_dh_group ( ) const
virtualinherited

For ephemeral Diffie-Hellman key exchange, the server sends a group parameter. Return the 2 Byte TLS group identifier specifying the group parameter a server should use.

Default: 2048 bit IETF IPsec group ("modp/ietf/2048")

Note
Has no effect for TLS 1.3 connections.

Definition at line 163 of file tls_policy.cpp.

163 {
164 /*
165 * Return the first listed or just default to 2048
166 */
167 for(auto g : key_exchange_groups()) {
168 if(g.is_dh_named_group()) {
169 return g;
170 }
171 }
172
173 return Group_Params::FFDHE_2048;
174}

References key_exchange_groups().

Referenced by Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

◆ dtls_default_mtu()

size_t Botan::TLS::Text_Policy::dtls_default_mtu ( ) const
overridevirtual
Returns
the default MTU for DTLS

Reimplemented from Botan::TLS::Policy.

Definition at line 159 of file tls_text_policy.cpp.

159 {
160 return get_len("dtls_default_mtu", Policy::dtls_default_mtu());
161}
virtual size_t dtls_default_mtu() const
size_t get_len(const std::string &key, size_t def) const

References Botan::TLS::Policy::dtls_default_mtu(), and get_len().

◆ dtls_initial_timeout()

size_t Botan::TLS::Text_Policy::dtls_initial_timeout ( ) const
overridevirtual
Returns
the initial timeout for DTLS

Reimplemented from Botan::TLS::Policy.

Definition at line 163 of file tls_text_policy.cpp.

163 {
164 return get_len("dtls_initial_timeout", Policy::dtls_initial_timeout());
165}
virtual size_t dtls_initial_timeout() const

References Botan::TLS::Policy::dtls_initial_timeout(), and get_len().

◆ dtls_maximum_timeout()

size_t Botan::TLS::Text_Policy::dtls_maximum_timeout ( ) const
overridevirtual
Returns
the maximum timeout for DTLS

Reimplemented from Botan::TLS::Policy.

Definition at line 167 of file tls_text_policy.cpp.

167 {
168 return get_len("dtls_maximum_timeout", Policy::dtls_maximum_timeout());
169}
virtual size_t dtls_maximum_timeout() const

References Botan::TLS::Policy::dtls_maximum_timeout(), and get_len().

◆ get_bool()

bool Botan::TLS::Text_Policy::get_bool ( const std::string & key,
bool def ) const
protected

Definition at line 307 of file tls_text_policy.cpp.

307 {
308 const std::string v = get_str(key);
309
310 if(v.empty()) {
311 return def;
312 }
313
314 if(v == "true" || v == "True") {
315 return true;
316 } else if(v == "false" || v == "False") {
317 return false;
318 } else {
319 throw Decoding_Error("Invalid boolean '" + v + "'");
320 }
321}

References get_str().

Referenced by allow_client_initiated_renegotiation(), allow_dtls12(), allow_insecure_renegotiation(), allow_server_initiated_renegotiation(), allow_ssl_key_log_file(), allow_tls12(), allow_tls13(), hash_hello_random(), hide_unknown_users(), include_time_in_hello_random(), negotiate_encrypt_then_mac(), require_cert_revocation_info(), require_client_certificate_authentication(), reuse_session_tickets(), server_uses_own_ciphersuite_preferences(), support_cert_status_message(), tls_13_middlebox_compatibility_mode(), and use_ecc_point_compression().

◆ get_duration()

std::chrono::seconds Botan::TLS::Text_Policy::get_duration ( const std::string & key,
std::chrono::seconds def ) const
protected

Definition at line 288 of file tls_text_policy.cpp.

288 {
289 using rep_t = std::chrono::seconds::rep;
290 constexpr rep_t max_seconds = std::chrono::seconds::max().count();
291 constexpr auto max_sizet = std::numeric_limits<size_t>::max();
292 using ull = unsigned long long;
293
294 // The concrete type of `rep` is not specified exactly. Let's play it extra safe...
295 // e.g. on 32-bit platforms size_t is 32 bits but rep_t is "at least 35 bits"
296
297 // at least zero and certainly fitting into rep_t
298 const rep_t positive_default = std::max(def.count(), rep_t(0));
299 // at least zero but capped to whatever size_t can handle
300 const size_t positive_capped_default = static_cast<size_t>(std::min<ull>(positive_default, max_sizet));
301 // at least zero but capped to whatever rep_t can handle
302 const rep_t result = static_cast<rep_t>(std::min<ull>(get_len(key, positive_capped_default), max_seconds));
303
304 return std::chrono::seconds(result);
305}

References get_len().

Referenced by session_ticket_lifetime().

◆ get_len()

size_t Botan::TLS::Text_Policy::get_len ( const std::string & key,
size_t def ) const
protected

◆ get_list()

std::vector< std::string > Botan::TLS::Text_Policy::get_list ( const std::string & key,
const std::vector< std::string > & def ) const
protected

Definition at line 222 of file tls_text_policy.cpp.

222 {
223 const std::string v = get_str(key);
224
225 if(v.empty()) {
226 return def;
227 }
228
229 return split_on(v, ' ');
230}
std::vector< std::string > split_on(std::string_view str, char delim)
Definition parsing.cpp:111

References get_str(), and Botan::split_on().

Referenced by allowed_ciphers(), allowed_key_exchange_methods(), allowed_macs(), allowed_signature_hashes(), allowed_signature_methods(), and srtp_profiles().

◆ get_str()

std::string Botan::TLS::Text_Policy::get_str ( const std::string & key,
const std::string & def = "" ) const
protected

Definition at line 323 of file tls_text_policy.cpp.

323 {
324 auto i = m_kv.find(key);
325 if(i == m_kv.end()) {
326 return def;
327 }
328
329 return i->second;
330}

Referenced by accepted_client_certificate_types(), accepted_server_certificate_types(), get_bool(), get_len(), get_list(), key_exchange_groups(), and key_exchange_groups_to_offer().

◆ hash_hello_random()

bool Botan::TLS::Text_Policy::hash_hello_random ( ) const
overridevirtual

Hash the RNG output for the client/server hello random. This is a pre-caution to avoid writing "raw" RNG output to the wire.

There's not normally a reason to disable this, except when deterministic output is required for testing.

Default: true

Reimplemented from Botan::TLS::Policy.

Definition at line 207 of file tls_text_policy.cpp.

207 {
208 return get_bool("hash_hello_random", Policy::hash_hello_random());
209}
virtual bool hash_hello_random() const

References get_bool(), and Botan::TLS::Policy::hash_hello_random().

◆ hide_unknown_users()

bool Botan::TLS::Text_Policy::hide_unknown_users ( ) const
overridevirtual

The PSK suites work using an identifier along with a shared secret. If this function returns true, when an identifier that the server does not recognize is provided by a client, a random shared secret will be generated in such a way that a client should not be able to tell the difference between the identifier not being known and the secret being wrong. This can help protect against some username probing attacks. If it returns false, the server will instead send an TLS::AlertType::UnknownPSKIdentity alert when an unknown identifier is used.

Default: false

Reimplemented from Botan::TLS::Policy.

Definition at line 175 of file tls_text_policy.cpp.

175 {
176 return get_bool("hide_unknown_users", Policy::hide_unknown_users());
177}
virtual bool hide_unknown_users() const

References get_bool(), and Botan::TLS::Policy::hide_unknown_users().

◆ include_time_in_hello_random()

bool Botan::TLS::Text_Policy::include_time_in_hello_random ( ) const
overridevirtual

The protocol dictates that the first 32 bits of the random field are the current time in seconds. However this allows client fingerprinting attacks. Set to false to disable, in which case random bytes will be used instead.

Default: true

Reimplemented from Botan::TLS::Policy.

Definition at line 63 of file tls_text_policy.cpp.

63 {
64 return get_bool("include_time_in_hello_random", Policy::include_time_in_hello_random());
65}
virtual bool include_time_in_hello_random() const

References get_bool(), and Botan::TLS::Policy::include_time_in_hello_random().

◆ key_exchange_groups()

std::vector< Group_Params > Botan::TLS::Text_Policy::key_exchange_groups ( ) const
overridevirtual

Return a list of ECC curve and DH group TLS identifiers we are willing to use, in order of preference. The default ordering puts the best performing ECC first.

Default: Group_Params::X25519, Group_Params::SECP256R1, Group_Params::BRAINPOOL256R1, Group_Params::SECP384R1, Group_Params::BRAINPOOL384R1, Group_Params::SECP521R1, Group_Params::BRAINPOOL512R1, Group_Params::FFDHE_2048, Group_Params::FFDHE_3072, Group_Params::FFDHE_4096, Group_Params::FFDHE_6144, Group_Params::FFDHE_8192

No other values are currently defined.

Reimplemented from Botan::TLS::Policy.

Definition at line 109 of file tls_text_policy.cpp.

109 {
110 std::string group_str = get_str("key_exchange_groups");
111
112 if(group_str.empty()) {
113 // fall back to previously used name
114 group_str = get_str("groups");
115 }
116
117 if(group_str.empty()) {
119 }
120
121 return read_group_list(group_str);
122}
std::vector< Group_Params > read_group_list(std::string_view group_str) const

References get_str(), Botan::TLS::Policy::key_exchange_groups(), and read_group_list().

◆ key_exchange_groups_to_offer()

std::vector< Group_Params > Botan::TLS::Text_Policy::key_exchange_groups_to_offer ( ) const
overridevirtual

Return a list of groups to provide prepared key share offers in the initial client hello for. Groups in this list must be reflected in key_exchange_groups() and in the same order. If an empty list is returned, no prepared key share offers are sent and the decision of the group to use is left to the server.

Default: the most preferred group from key_exchange_groups().

Note
Has an effect on TLS 1.3 clients, only.

Reimplemented from Botan::TLS::Policy.

Definition at line 124 of file tls_text_policy.cpp.

124 {
125 std::string group_str = get_str("key_exchange_groups_to_offer", "notset");
126
127 if(group_str.empty() || group_str == "notset") {
128 // policy was not set, fall back to default behaviour
130 }
131
132 if(group_str == "none") {
133 return {};
134 }
135
136 return read_group_list(group_str);
137}
virtual std::vector< Group_Params > key_exchange_groups_to_offer() const

References get_str(), Botan::TLS::Policy::key_exchange_groups_to_offer(), and read_group_list().

◆ latest_supported_version()

Protocol_Version Botan::TLS::Policy::latest_supported_version ( bool datagram) const
virtualinherited

Returns the most recent protocol version we are willing to use, for either TLS or DTLS depending on datagram param. Shouldn't ever need to override this unless you want to allow a user to disable specific TLS versions.

Definition at line 337 of file tls_policy.cpp.

337 {
338 if(datagram) {
339 if(acceptable_protocol_version(Protocol_Version::DTLS_V12)) {
340 return Protocol_Version::DTLS_V12;
341 }
342 throw Invalid_State("Policy forbids all available DTLS version");
343 } else {
344#if defined(BOTAN_HAS_TLS_13)
345 if(acceptable_protocol_version(Protocol_Version::TLS_V13)) {
346 return Protocol_Version::TLS_V13;
347 }
348#endif
349 if(acceptable_protocol_version(Protocol_Version::TLS_V12)) {
350 return Protocol_Version::TLS_V12;
351 }
352 throw Invalid_State("Policy forbids all available TLS version");
353 }
354}
virtual bool acceptable_protocol_version(Protocol_Version version) const

References acceptable_protocol_version().

◆ maximum_certificate_chain_size()

size_t Botan::TLS::Policy::maximum_certificate_chain_size ( ) const
virtualinherited
Returns
the maximum size of the certificate chain, in bytes. Return 0 to disable this and accept any size.

Definition at line 461 of file tls_policy.cpp.

461 {
462 return 0;
463}

Referenced by Botan::TLS::Certificate_12::Certificate_12(), and Botan::TLS::Certificate_13::Certificate_13().

◆ maximum_session_tickets_per_client_hello()

size_t Botan::TLS::Text_Policy::maximum_session_tickets_per_client_hello ( ) const
overridevirtual

Defines the maximum number of session tickets a client might offer in a single resumption attempt. Must be greater than 0.

TODO: Currently, the TLS 1.3 client implementation supports exactly one ticket per handshake. RFC 8446 allows for an arbitrary amount, though.

Default: 1

Note
Has an effect on TLS 1.3 connections, only.

Reimplemented from Botan::TLS::Policy.

Definition at line 179 of file tls_text_policy.cpp.

179 {
180 return get_len("maximum_session_tickets_per_client_hello", Policy::maximum_session_tickets_per_client_hello());
181}
virtual size_t maximum_session_tickets_per_client_hello() const

References get_len(), and Botan::TLS::Policy::maximum_session_tickets_per_client_hello().

◆ minimum_dh_group_size()

size_t Botan::TLS::Text_Policy::minimum_dh_group_size ( ) const
overridevirtual

Return the minimum DH group size we're willing to use

Return the minimum size in bits for a Diffie-Hellman group that a client will accept. Due to the design of the protocol the client has only two options - accept the group, or reject it with a fatal alert then attempt to reconnect after disabling ephemeral Diffie-Hellman.

Default: 2048 bits

Reimplemented from Botan::TLS::Policy.

Definition at line 147 of file tls_text_policy.cpp.

147 {
148 return get_len("minimum_dh_group_size", Policy::minimum_dh_group_size());
149}

References get_len(), and Botan::TLS::Policy::minimum_dh_group_size().

◆ minimum_ecdh_group_size()

size_t Botan::TLS::Text_Policy::minimum_ecdh_group_size ( ) const
overridevirtual

Return the minimum ECDH group size we're willing to use for key exchange

Default 255, allowing x25519 and larger x25519 is the smallest curve we will negotiate P-521 is the largest

Reimplemented from Botan::TLS::Policy.

Definition at line 139 of file tls_text_policy.cpp.

139 {
140 return get_len("minimum_ecdh_group_size", Policy::minimum_ecdh_group_size());
141}

References get_len(), and Botan::TLS::Policy::minimum_ecdh_group_size().

◆ minimum_ecdsa_group_size()

size_t Botan::TLS::Text_Policy::minimum_ecdsa_group_size ( ) const
overridevirtual

For ECDSA authenticated ciphersuites, the smallest key size the client will accept. This policy is currently only enforced on the server by the client.

Default: 256

Reimplemented from Botan::TLS::Policy.

Definition at line 143 of file tls_text_policy.cpp.

143 {
144 return get_len("minimum_ecdsa_group_size", Policy::minimum_ecdsa_group_size());
145}

References get_len(), and Botan::TLS::Policy::minimum_ecdsa_group_size().

◆ minimum_rsa_bits()

size_t Botan::TLS::Text_Policy::minimum_rsa_bits ( ) const
overridevirtual

Return the minimum bit size we're willing to accept for RSA key exchange or server signatures.

It does not place any requirements on the size of any RSA signature(s) which were used to check the server certificate. This is only concerned with the server's public key.

Default is 2048 which is smallest RSA key size still secure for medium term security.

Reimplemented from Botan::TLS::Policy.

Definition at line 151 of file tls_text_policy.cpp.

151 {
152 return get_len("minimum_rsa_bits", Policy::minimum_rsa_bits());
153}

References get_len(), and Botan::TLS::Policy::minimum_rsa_bits().

◆ minimum_signature_strength()

size_t Botan::TLS::Text_Policy::minimum_signature_strength ( ) const
overridevirtual

The minimum signature strength we will accept

Returning 80 allows RSA 1024 and SHA-1. Values larger than 80 disable SHA-1 support. Returning 110 allows RSA 2048. Return 128 to force ECC (P-256) or large (~3000 bit) RSA keys.

Default is 110

Reimplemented from Botan::TLS::Policy.

Definition at line 155 of file tls_text_policy.cpp.

155 {
156 return get_len("minimum_signature_strength", Policy::minimum_signature_strength());
157}
virtual size_t minimum_signature_strength() const

References get_len(), and Botan::TLS::Policy::minimum_signature_strength().

◆ negotiate_encrypt_then_mac()

bool Botan::TLS::Text_Policy::negotiate_encrypt_then_mac ( ) const
overridevirtual

Indicates whether the encrypt-then-MAC extension should be negotiated (RFC 7366)

Note
Has no effect for TLS 1.3 connections.

Reimplemented from Botan::TLS::Policy.

Definition at line 93 of file tls_text_policy.cpp.

93 {
94 return get_bool("negotiate_encrypt_then_mac", Policy::negotiate_encrypt_then_mac());
95}
virtual bool negotiate_encrypt_then_mac() const

References get_bool(), and Botan::TLS::Policy::negotiate_encrypt_then_mac().

◆ new_session_tickets_upon_handshake_success()

size_t Botan::TLS::Text_Policy::new_session_tickets_upon_handshake_success ( ) const
overridevirtual

Return the number of new session tickets a TLS 1.3 server should issue automatically upon a successful handshake. Note that applications can use TLS::Server::send_new_session_tickets() regardless of this policy.

For convenience (and compatibility with the TLS 1.2 behaviour), this returns '1' by default.

Note
Has an effect on TLS 1.3 connections, only.

Reimplemented from Botan::TLS::Policy.

Definition at line 191 of file tls_text_policy.cpp.

191 {
192 return get_len("new_session_tickets_upon_handshake_success", Policy::new_session_tickets_upon_handshake_success());
193}
virtual size_t new_session_tickets_upon_handshake_success() const

References get_len(), and Botan::TLS::Policy::new_session_tickets_upon_handshake_success().

◆ only_resume_with_exact_version()

bool Botan::TLS::Policy::only_resume_with_exact_version ( ) const
virtualinherited

Only resume sessions when their original protocol version matches the current version exactly.

Default: true

Definition at line 433 of file tls_policy.cpp.

433 {
434 return true;
435}

◆ print()

void Botan::TLS::Policy::print ( std::ostream & o) const
virtualinherited

Convert this policy to a printable format.

Parameters
ostream to be printed to

Definition at line 672 of file tls_policy.cpp.

672 {
673 print_bool(o, "allow_tls12", allow_tls12());
674 print_bool(o, "allow_tls13", allow_tls13());
675 print_bool(o, "allow_dtls12", allow_dtls12());
676 print_bool(o, "allow_ssl_key_log_file", allow_ssl_key_log_file());
677 print_vec(o, "ciphers", allowed_ciphers());
678 print_vec(o, "macs", allowed_macs());
679 print_vec(o, "signature_hashes", allowed_signature_hashes());
680 print_vec(o, "signature_methods", allowed_signature_methods());
681 print_vec(o, "key_exchange_methods", allowed_key_exchange_methods());
682 print_vec(o, "key_exchange_groups", key_exchange_groups());
683 const auto groups_to_offer = key_exchange_groups_to_offer();
684 if(groups_to_offer.empty()) {
685 print_vec(o, "key_exchange_groups_to_offer", {std::string("none")});
686 } else {
687 print_vec(o, "key_exchange_groups_to_offer", groups_to_offer);
688 }
689 print_bool(o, "allow_insecure_renegotiation", allow_insecure_renegotiation());
690 print_bool(o, "include_time_in_hello_random", include_time_in_hello_random());
691 print_bool(o, "allow_server_initiated_renegotiation", allow_server_initiated_renegotiation());
692 print_bool(o, "hide_unknown_users", hide_unknown_users());
693 print_bool(o, "server_uses_own_ciphersuite_preferences", server_uses_own_ciphersuite_preferences());
694 print_bool(o, "negotiate_encrypt_then_mac", negotiate_encrypt_then_mac());
695 print_bool(o, "support_cert_status_message", support_cert_status_message());
696 print_bool(o, "tls_13_middlebox_compatibility_mode", tls_13_middlebox_compatibility_mode());
697 print_vec(o, "accepted_client_certificate_types", accepted_client_certificate_types());
698 print_vec(o, "accepted_server_certificate_types", accepted_server_certificate_types());
699 print_bool(o, "hash_hello_random", hash_hello_random());
700 if(record_size_limit().has_value()) {
701 o << "record_size_limit = " << record_size_limit().value() << '\n';
702 }
703 o << "maximum_session_tickets_per_client_hello = " << maximum_session_tickets_per_client_hello() << '\n';
704 o << "session_ticket_lifetime = " << session_ticket_lifetime().count() << '\n';
705 print_bool(o, "reuse_session_tickets", reuse_session_tickets());
706 o << "new_session_tickets_upon_handshake_success = " << new_session_tickets_upon_handshake_success() << '\n';
707 o << "minimum_dh_group_size = " << minimum_dh_group_size() << '\n';
708 o << "minimum_ecdh_group_size = " << minimum_ecdh_group_size() << '\n';
709 o << "minimum_rsa_bits = " << minimum_rsa_bits() << '\n';
710 o << "minimum_signature_strength = " << minimum_signature_strength() << '\n';
711}
virtual bool reuse_session_tickets() const
virtual bool tls_13_middlebox_compatibility_mode() const
virtual bool server_uses_own_ciphersuite_preferences() const
virtual bool support_cert_status_message() const
virtual std::optional< uint16_t > record_size_limit() const
virtual std::chrono::seconds session_ticket_lifetime() const

References accepted_client_certificate_types(), accepted_server_certificate_types(), allow_dtls12(), allow_insecure_renegotiation(), allow_server_initiated_renegotiation(), allow_ssl_key_log_file(), allow_tls12(), allow_tls13(), allowed_ciphers(), allowed_key_exchange_methods(), allowed_macs(), allowed_signature_hashes(), allowed_signature_methods(), hash_hello_random(), hide_unknown_users(), include_time_in_hello_random(), key_exchange_groups(), key_exchange_groups_to_offer(), maximum_session_tickets_per_client_hello(), minimum_dh_group_size(), minimum_ecdh_group_size(), minimum_rsa_bits(), minimum_signature_strength(), negotiate_encrypt_then_mac(), new_session_tickets_upon_handshake_success(), record_size_limit(), reuse_session_tickets(), server_uses_own_ciphersuite_preferences(), session_ticket_lifetime(), support_cert_status_message(), and tls_13_middlebox_compatibility_mode().

Referenced by to_string().

◆ read_cert_type_list()

std::vector< Certificate_Type > Botan::TLS::Text_Policy::read_cert_type_list ( const std::string & cert_type_str) const
protected

Definition at line 269 of file tls_text_policy.cpp.

269 {
270 std::vector<Certificate_Type> cert_types;
271 for(const std::string& cert_type_name : split_on(cert_type_names, ' ')) {
272 cert_types.push_back(certificate_type_from_string(cert_type_name));
273 }
274
275 return cert_types;
276}
Certificate_Type certificate_type_from_string(const std::string &type_str)

References Botan::TLS::certificate_type_from_string(), and Botan::split_on().

Referenced by accepted_client_certificate_types(), and accepted_server_certificate_types().

◆ read_group_list()

std::vector< Group_Params > Botan::TLS::Text_Policy::read_group_list ( std::string_view group_str) const
protected

Definition at line 232 of file tls_text_policy.cpp.

232 {
233 std::vector<Group_Params> groups;
234 for(const auto& group_name : split_on(group_str, ' ')) {
235 Group_Params group_id = Group_Params::from_string(group_name).value_or(Group_Params::NONE);
236
237 if(!group_id.is_available()) {
238 continue;
239 }
240
241 if(group_id == Group_Params::NONE) {
242 try {
243 size_t consumed = 0;
244 unsigned long ll_id = std::stoul(group_name, &consumed, 0);
245 if(consumed != group_name.size()) {
246 continue; // some other cruft
247 }
248
249 const uint16_t id = static_cast<uint16_t>(ll_id);
250
251 if(id != ll_id) {
252 continue; // integer too large
253 }
254
255 group_id = static_cast<Group_Params>(id);
256 } catch(...) {
257 continue;
258 }
259 }
260
261 if(group_id != Group_Params::NONE) {
262 groups.push_back(group_id);
263 }
264 }
265
266 return groups;
267}
static std::optional< Group_Params > from_string(std::string_view group_name)

References Botan::TLS::Group_Params::from_string(), Botan::TLS::Group_Params::is_available(), and Botan::split_on().

Referenced by key_exchange_groups(), and key_exchange_groups_to_offer().

◆ record_size_limit()

std::optional< uint16_t > Botan::TLS::Text_Policy::record_size_limit ( ) const
overridevirtual

Defines the maximum TLS record length for TLS connections. This is based on the Record Size Limit extension described in RFC 8449. By default (i.e. if std::nullopt is returned), TLS clients will omit this extension altogether.

This value may be between 64 and 16385 (TLS 1.3) or 16384 (TLS 1.2).

Note
This is currently not implemented for TLS 1.2, hence the limit won't be negotiated by TLS 1.3 clients that support downgrading to TLS 1.2 (i.e. allow_tls12() returning true).

Reimplemented from Botan::TLS::Policy.

Definition at line 97 of file tls_text_policy.cpp.

97 {
98 const auto limit = get_len("record_size_limit", 0);
99 // RFC 8449 4.
100 // TLS 1.3 uses a limit of 2^14+1 octets.
101 BOTAN_ARG_CHECK(limit <= 16385, "record size limit too large");
102 return (limit > 0) ? std::make_optional(static_cast<uint16_t>(limit)) : std::nullopt;
103}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:31

References BOTAN_ARG_CHECK, and get_len().

◆ request_client_certificate_authentication()

bool Botan::TLS::Policy::request_client_certificate_authentication ( ) const
virtualinherited

Indicate if client certificate authentication is requested. If true, then a cert will be requested.

Definition at line 441 of file tls_policy.cpp.

441 {
443}
virtual bool require_client_certificate_authentication() const

References require_client_certificate_authentication().

Referenced by Botan::TLS::Encrypted_Extensions::Encrypted_Extensions(), and Botan::TLS::Certificate_Request_13::maybe_create().

◆ require_cert_revocation_info()

bool Botan::TLS::Text_Policy::require_cert_revocation_info ( ) const
overridevirtual

Return if certificate revocation info (CRL/OCSP) is required

If true, certificates won't be trusted unless a valid CRL or OCSP response was examined.

Default: true

Reimplemented from Botan::TLS::Policy.

Definition at line 171 of file tls_text_policy.cpp.

171 {
172 return get_bool("require_cert_revocation_info", Policy::require_cert_revocation_info());
173}
virtual bool require_cert_revocation_info() const

References get_bool(), and Botan::TLS::Policy::require_cert_revocation_info().

◆ require_client_certificate_authentication()

bool Botan::TLS::Text_Policy::require_client_certificate_authentication ( ) const
overridevirtual

Indicate if client certificate authentication is required. If true, then a cert will be requested and if the client does not send a certificate the connection will be closed.

Reimplemented from Botan::TLS::Policy.

Definition at line 67 of file tls_text_policy.cpp.

67 {
68 return get_bool("require_client_certificate_authentication", Policy::require_client_certificate_authentication());
69}

References get_bool(), and Botan::TLS::Policy::require_client_certificate_authentication().

◆ reuse_session_tickets()

bool Botan::TLS::Text_Policy::reuse_session_tickets ( ) const
overridevirtual

Decides whether stored session tickets should be used multiple times (until their lifetime runs out). This might allow passive observers to correlate connections (RFC 8446 Appendix C.4). This has no effect on TLS 1.2 resumptions based on session IDs as those are negotiated in the clear anyway.

Default: false

Reimplemented from Botan::TLS::Policy.

Definition at line 187 of file tls_text_policy.cpp.

187 {
188 return get_bool("reuse_session_tickets", Policy::reuse_session_tickets());
189}

References get_bool(), and Botan::TLS::Policy::reuse_session_tickets().

◆ server_uses_own_ciphersuite_preferences()

bool Botan::TLS::Text_Policy::server_uses_own_ciphersuite_preferences ( ) const
overridevirtual

Default: true

Returns
true if servers should choose the ciphersuite matching their highest preference, rather than the clients. Has no effect on client side.

Reimplemented from Botan::TLS::Policy.

Definition at line 89 of file tls_text_policy.cpp.

89 {
90 return get_bool("server_uses_own_ciphersuite_preferences", Policy::server_uses_own_ciphersuite_preferences());
91}

References get_bool(), and Botan::TLS::Policy::server_uses_own_ciphersuite_preferences().

◆ session_ticket_lifetime()

std::chrono::seconds Botan::TLS::Text_Policy::session_ticket_lifetime ( ) const
overridevirtual

Return the allowed lifetime of a session ticket. If 0, session tickets do not expire until the session ticket key rolls over. For TLS 1.3 session tickets the lifetime must not be longer than seven days. Expired session tickets cannot be used to resume a session.

Default: 1 day

Reimplemented from Botan::TLS::Policy.

Definition at line 183 of file tls_text_policy.cpp.

183 {
184 return get_duration("session_ticket_lifetime", Policy::session_ticket_lifetime());
185}
std::chrono::seconds get_duration(const std::string &key, std::chrono::seconds def) const

References get_duration(), and Botan::TLS::Policy::session_ticket_lifetime().

◆ set()

void Botan::TLS::Text_Policy::set ( const std::string & key,
const std::string & value )

Definition at line 211 of file tls_text_policy.cpp.

211 {
212 m_kv[key] = value;
213}

◆ set_value()

bool Botan::TLS::Text_Policy::set_value ( const std::string & key,
std::string_view val,
bool overwrite )
protected

Definition at line 332 of file tls_text_policy.cpp.

332 {
333 auto i = m_kv.find(key);
334
335 if(overwrite == false && i != m_kv.end()) {
336 return false;
337 }
338
339 m_kv.insert(i, std::make_pair(key, val));
340 return true;
341}

◆ srtp_profiles()

std::vector< uint16_t > Botan::TLS::Text_Policy::srtp_profiles ( ) const
overridevirtual

If this returns a non-empty vector, and DTLS is negotiated, then we will also attempt to negotiate the SRTP extension from RFC 5764 using the returned values as the profile ids.

Reimplemented from Botan::TLS::Policy.

Definition at line 195 of file tls_text_policy.cpp.

195 {
196 std::vector<uint16_t> r;
197 for(const auto& p : get_list("srtp_profiles", std::vector<std::string>())) {
198 r.push_back(to_uint16(p));
199 }
200 return r;
201}
uint16_t to_uint16(std::string_view str)
Definition parsing.cpp:22

References get_list(), and Botan::to_uint16().

◆ support_cert_status_message()

bool Botan::TLS::Text_Policy::support_cert_status_message ( ) const
overridevirtual

Indicates whether certificate status messages should be supported

Reimplemented from Botan::TLS::Policy.

Definition at line 105 of file tls_text_policy.cpp.

105 {
106 return get_bool("support_cert_status_message", Policy::support_cert_status_message());
107}

References get_bool(), and Botan::TLS::Policy::support_cert_status_message().

◆ tls_13_middlebox_compatibility_mode()

bool Botan::TLS::Text_Policy::tls_13_middlebox_compatibility_mode ( ) const
overridevirtual

Defines whether or not the middlebox compatibility mode should be used. Enabled by default.

RFC 8446 Appendix D.4 [This makes] the TLS 1.3 handshake resemble TLS 1.2 session resumption, which improves the chance of successfully connecting through middleboxes.

Default: true

Note
Has an effect on TLS 1.3 connections, only.

Reimplemented from Botan::TLS::Policy.

Definition at line 203 of file tls_text_policy.cpp.

203 {
204 return get_bool("tls_13_middlebox_compatibility_mode", Policy::tls_13_middlebox_compatibility_mode());
205}

References get_bool(), and Botan::TLS::Policy::tls_13_middlebox_compatibility_mode().

◆ to_string()

std::string Botan::TLS::Policy::to_string ( ) const
inherited

Convert this policy to a printable format. Same as calling print on a ostringstream and reading o.str()

Definition at line 713 of file tls_policy.cpp.

713 {
714 std::ostringstream oss;
715 this->print(oss);
716 return oss.str();
717}
virtual void print(std::ostream &o) const

References print().

◆ use_ecc_point_compression()

bool Botan::TLS::Text_Policy::use_ecc_point_compression ( ) const
overridevirtual

Request that ECC curve points are sent compressed

Signals that we prefer ECC points to be compressed when transmitted to us. The other party may not support ECC point compression and therefore may still send points uncompressed.

Note that the certificate used during authentication must also follow the other party's preference.

Note
Support for EC point compression is deprecated and will be removed in a future major release. TLS 1.3 does not support point compression at all (see RFC 8446 4.2.8.2)

Reimplemented from Botan::TLS::Policy.

Definition at line 43 of file tls_text_policy.cpp.

43 {
44 return get_bool("use_ecc_point_compression", Policy::use_ecc_point_compression());
45}
virtual bool use_ecc_point_compression() const

References get_bool(), and Botan::TLS::Policy::use_ecc_point_compression().


The documentation for this class was generated from the following files: