11#include <botan/tls_policy.h>
13#include <botan/pk_keys.h>
14#include <botan/tls_algos.h>
15#include <botan/tls_ciphersuite.h>
16#include <botan/tls_exceptn.h>
17#include <botan/tls_signature_scheme.h>
18#include <botan/internal/stl_util.h>
30 std::vector<Signature_Scheme> schemes;
36 if(sig_allowed && hash_allowed) {
37 schemes.push_back(scheme);
125 const std::vector<Group_Params>& offered_by_peer)
const {
126 if(supported_by_peer.empty()) {
127 return Group_Params::NONE;
133 for(
auto share : offered_by_peer) {
134 if(share.is_post_quantum() &&
value_exists(our_groups, share)) {
140 for(
auto share : supported_by_peer) {
141 if(share.is_post_quantum() &&
value_exists(our_groups, share)) {
148 for(
auto g : offered_by_peer) {
156 for(
auto g : our_groups) {
162 return Group_Params::NONE;
170 if(g.is_dh_named_group()) {
175 return Group_Params::FFDHE_2048;
179 std::vector<Group_Params> groups = {
180 Group_Params::X25519,
181 Group_Params::SECP256R1,
188 Group_Params::SECP384R1,
189 Group_Params::SECP521R1,
191 Group_Params::BRAINPOOL256R1,
192 Group_Params::BRAINPOOL256R1TLS13,
193 Group_Params::BRAINPOOL384R1,
194 Group_Params::BRAINPOOL384R1TLS13,
195 Group_Params::BRAINPOOL512R1,
196 Group_Params::BRAINPOOL512R1TLS13,
206 std::vector<Group_Params> groups_to_offer;
209 BOTAN_ASSERT(!supported_groups.empty(),
"Policy allows at least one key exchange group");
217 if(group.is_pure_ecc_group()) {
218 groups_to_offer.push_back(group);
227 if(groups_to_offer.empty()) {
228 groups_to_offer.push_back(supported_groups.front());
231 return groups_to_offer;
272 const std::string algo_name = public_key.
algo_name();
274 const size_t keylength = public_key.
key_length();
275 size_t expected_keylength = 0;
277 if(algo_name ==
"RSA") {
279 }
else if(algo_name ==
"DH") {
281 }
else if(algo_name ==
"ECDH" || algo_name ==
"X25519" || algo_name ==
"X448") {
283 }
else if(algo_name ==
"ECDSA") {
288 if(keylength < expected_keylength) {
290 "Peer sent " + std::to_string(keylength) +
" bit " + algo_name +
292 ", policy requires at least " +
293 std::to_string(expected_keylength));
302 return std::chrono::days(1);
314#if defined(BOTAN_HAS_TLS_13)
315 if(version == Protocol_Version::TLS_V13 &&
allow_tls13()) {
320#if defined(BOTAN_HAS_TLS_12)
321 if(version == Protocol_Version::TLS_V12 &&
allow_tls12()) {
325 if(version == Protocol_Version::DTLS_V12 &&
allow_dtls12()) {
337 return Protocol_Version::DTLS_V12;
341 return Protocol_Version::TLS_V13;
344 return Protocol_Version::TLS_V12;
348 throw Invalid_State(
"Policy forbids all available TLS version");
369#if defined(BOTAN_HAS_TLS_12)
377#if defined(BOTAN_HAS_TLS_13)
385#if defined(BOTAN_HAS_TLS_12)
504 return uint64_t(1) << 23;
543 return 1280 - 40 - 8;
547 return std::vector<uint16_t>();
552class Ciphersuite_Preference_Ordering final {
554 Ciphersuite_Preference_Ordering(
const std::vector<std::string>& ciphers,
555 const std::vector<std::string>& macs,
556 const std::vector<std::string>& kex,
557 const std::vector<std::string>& sigs) :
558 m_ciphers(ciphers), m_macs(macs), m_kex(kex), m_sigs(sigs) {}
560 bool operator()(
const Ciphersuite& a,
const Ciphersuite& b)
const {
561 if(a.kex_method() != b.kex_method()) {
562 for(
const auto& i : m_kex) {
563 if(a.kex_algo() == i) {
566 if(b.kex_algo() == i) {
572 if(a.cipher_algo() != b.cipher_algo()) {
573 for(
const auto& m_cipher : m_ciphers) {
574 if(a.cipher_algo() == m_cipher) {
577 if(b.cipher_algo() == m_cipher) {
583 if(a.cipher_keylen() != b.cipher_keylen()) {
584 if(a.cipher_keylen() < b.cipher_keylen()) {
587 if(a.cipher_keylen() > b.cipher_keylen()) {
592 if(a.auth_method() != b.auth_method()) {
593 for(
const auto& m_sig : m_sigs) {
594 if(a.sig_algo() == m_sig) {
597 if(b.sig_algo() == m_sig) {
603 if(a.mac_algo() != b.mac_algo()) {
604 for(
const auto& m_mac : m_macs) {
605 if(a.mac_algo() == m_mac) {
608 if(b.mac_algo() == m_mac) {
618 std::vector<std::string> m_ciphers, m_macs, m_kex, m_sigs;
629 std::vector<Ciphersuite> ciphersuites;
638 if(!suite.usable_in_version(version)) {
688 ciphersuites.push_back(suite);
691 if(ciphersuites.empty()) {
692 throw Invalid_State(
"Policy does not allow any available cipher suite");
695 const Ciphersuite_Preference_Ordering order(ciphers, macs, kex, sigs);
696 std::sort(ciphersuites.begin(), ciphersuites.end(), order);
698 std::vector<uint16_t> ciphersuite_codes;
699 ciphersuite_codes.reserve(ciphersuites.size());
700 for(
const auto& i : ciphersuites) {
701 ciphersuite_codes.push_back(i.ciphersuite_code());
703 return ciphersuite_codes;
708void print_vec(std::ostream& o,
const char* key,
const std::vector<std::string>& v) {
710 for(
size_t i = 0; i != v.size(); ++i) {
712 if(i != v.size() - 1) {
719void print_vec(std::ostream& o,
const char* key,
const std::vector<Group_Params>& params) {
721 std::vector<std::string> names;
722 for(
const auto p : params) {
723 if(
auto name = p.to_string()) {
724 names.push_back(
name.value());
730 for(
size_t i = 0; i != names.size(); ++i) {
732 if(i != names.size() - 1) {
739void print_vec(std::ostream& o,
const char* key,
const std::vector<Certificate_Type>& types) {
741 for(
size_t i = 0; i != types.size(); ++i) {
743 if(i != types.size() - 1) {
750void print_vec(std::ostream& o,
const char* key,
const std::vector<Signature_Scheme>& schemes) {
752 for(
size_t i = 0; i != schemes.size(); ++i) {
753 o << schemes[i].to_string();
754 if(i != schemes.size() - 1) {
761void print_bool(std::ostream& o,
const char* key,
bool b) {
762 o << key <<
" = " << (b ?
"true" :
"false") <<
'\n';
781 if(groups_to_offer.empty()) {
782 print_vec(o,
"key_exchange_groups_to_offer", {std::string(
"none")});
784 print_vec(o,
"key_exchange_groups_to_offer", groups_to_offer);
812 std::ostringstream oss;
818 return {
"AES-256/GCM",
"AES-128/GCM",
"ChaCha20Poly1305"};
822 return {
"SHA-512",
"SHA-384"};
#define BOTAN_ASSERT(expr, assertion_made)
virtual std::string algo_name() const =0
virtual size_t key_length() const =0
static const std::vector< Ciphersuite > & all_known_ciphersuites()
std::string mac_algo() const
std::string cipher_algo() const
bool is_available() const
virtual bool include_time_in_hello_random() const
virtual void check_peer_key_acceptable(const Public_Key &public_key) const
virtual bool abort_connection_on_undesired_renegotiation() const
virtual size_t maximum_dh_group_size() const
virtual size_t dtls_maximum_timeout() const
virtual size_t minimum_ecdh_group_size() const
virtual size_t maximum_handshake_message_size() const
virtual size_t record_padding_bytes(size_t plaintext_bytes) const
virtual size_t dtls_default_mtu() const
virtual std::optional< size_t > max_useless_records() const
virtual bool allow_tls12() const
virtual std::vector< Signature_Scheme > allowed_signature_schemes() const
std::string to_string() const
virtual bool reuse_session_tickets() const
virtual std::vector< uint16_t > ciphersuite_list(Protocol_Version version) const
virtual std::vector< Certificate_Type > accepted_server_certificate_types() const
virtual std::vector< Certificate_Type > accepted_client_certificate_types() const
bool allowed_signature_method(std::string_view sig_method) const
virtual bool require_client_certificate_authentication() const
virtual std::vector< Group_Params > key_exchange_groups() const
virtual size_t new_session_tickets_upon_handshake_success() const
virtual uint64_t records_per_traffic_key() const
virtual std::vector< Group_Params > key_exchange_groups_to_offer() const
bool allowed_signature_hash(std::string_view hash) const
virtual size_t minimum_rsa_bits() const
virtual std::optional< size_t > dtls_maximum_hello_verify_requests() const
virtual bool tls_13_middlebox_compatibility_mode() const
virtual bool only_resume_with_exact_version() const
virtual bool allow_client_initiated_renegotiation() const
virtual std::optional< size_t > dtls_maximum_retransmissions() const
virtual bool allow_ssl_key_log_file() const
virtual bool allow_dtls_epoch0_restart() const
virtual bool request_client_certificate_authentication() const
virtual bool require_cert_revocation_info() const
virtual bool negotiate_encrypt_then_mac() const
virtual bool require_extended_master_secret() const
virtual bool server_uses_own_ciphersuite_preferences() const
virtual Protocol_Version latest_supported_version(bool datagram) const
virtual bool acceptable_protocol_version(Protocol_Version version) const
virtual std::vector< uint16_t > srtp_profiles() const
virtual bool support_cert_status_message() const
virtual bool acceptable_ciphersuite(const Ciphersuite &suite) const
virtual std::vector< std::string > allowed_macs() const
virtual bool hide_unknown_users() const
virtual std::optional< std::vector< Signature_Scheme > > acceptable_certificate_signature_schemes() const
virtual bool hash_hello_random() const
virtual bool allow_tls13() const
virtual std::vector< std::string > allowed_key_exchange_methods() const
virtual size_t dtls_initial_timeout() const
virtual size_t maximum_session_tickets_per_connection() const
virtual size_t maximum_session_tickets_per_client_hello() const
virtual std::vector< Signature_Scheme > acceptable_signature_schemes() const
virtual bool use_ecc_point_compression() const
virtual bool allow_dtls12() const
virtual size_t minimum_dh_group_size() const
virtual bool allow_insecure_renegotiation() const
virtual std::optional< uint16_t > record_size_limit() const
virtual std::vector< std::string > allowed_ciphers() const
virtual std::chrono::seconds session_ticket_lifetime() const
virtual size_t minimum_signature_strength() const
virtual uint64_t minimum_key_update_interval_ms() const
virtual Group_Params default_dh_group() const
virtual bool dtls_server_require_cookie_exchange() const
virtual size_t maximum_certificate_chain_size() const
virtual std::vector< std::string > allowed_signature_methods() const
virtual size_t minimum_ecdsa_group_size() 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 bool allow_resumption_for_renegotiation() const
virtual std::vector< std::string > allowed_signature_hashes() const
virtual bool allow_server_initiated_renegotiation() const
virtual void print(std::ostream &o) const
bool is_datagram_protocol() const
bool is_pre_tls_13() const
static const std::vector< Signature_Scheme > & all_available_schemes()
std::vector< std::string > allowed_macs() 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_signature_hashes() const override
std::string certificate_type_to_string(Certificate_Type type)
@ HYBRID_X25519_ML_KEM_768
@ HYBRID_SECP256R1_ML_KEM_768
@ HYBRID_SECP384R1_ML_KEM_1024
bool value_exists(const std::vector< T > &vec, const V &val)