sql_connect.cc

/*
   Copyright (c) 2007, 2024, Oracle and/or its affiliates.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.

   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

/*
  Functions to authenticate and handle requests for a connection
*/

#include "sql/sql_connect.h"

#include "my_config.h"

#include "my_loglevel.h"
#include "my_psi_config.h"
#include "mysql/components/services/log_builtins.h"
#include "mysql/components/services/log_shared.h"
#include "pfs_thread_provider.h"
#include "sql/table.h"

#ifndef _WIN32
#include <netdb.h>
#endif
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
#include <stdint.h>
#include <string.h>
#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif
#include <algorithm>
#include <atomic>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>

#include "lex_string.h"
#include "m_ctype.h"
#include "m_string.h"  // my_stpcpy
#include "map_helpers.h"
#include "my_command.h"
#include "my_dbug.h"
#include "my_sqlcommand.h"
#include "my_sys.h"
#include "mysql/plugin_audit.h"
#include "mysql/psi/mysql_mutex.h"
#include "mysql/psi/mysql_thread.h"
#include "mysql/service_mysql_alloc.h"
#include "mysql_com.h"
#include "mysqld_error.h"
#include "sql-common/net_ns.h"  // set_network_namespace
#include "sql/auth/auth_acls.h"
#include "sql/auth/auth_common.h"  // SUPER_ACL
#include "sql/auth/sql_security_ctx.h"
#include "sql/debug_sync.h"      // DEBUG_SYNC
#include "sql/derror.h"          // ER_THD
#include "sql/hostname_cache.h"  // Host_errors
#include "sql/item_func.h"       // mqh_used
#include "sql/log.h"
#include "sql/mysqld.h"  // LOCK_user_conn
#include "sql/protocol.h"
#include "sql/protocol_classic.h"
#include "sql/psi_memory_key.h"
#include "sql/sql_audit.h"  // MYSQL_AUDIT_NOTIFY_CONNECTION_CONNECT
#include "sql/sql_class.h"  // THD
#include "sql/sql_error.h"
#include "sql/sql_lex.h"
#include "sql/sql_parse.h"   // sql_command_flags
#include "sql/sql_plugin.h"  // plugin_thdvar_cleanup
#include "sql/system_variables.h"
#include "sql_string.h"
#include "violite.h"

#ifdef HAVE_ARPA_INET_H
#include <arpa/inet.h>
#endif

using std::max;
using std::min;

/*
  With SSL the handshake might consist of two packets. If the first
  packet (client capabilities) has CLIENT_SSL flag set, we have to
  switch to SSL and read the second packet. The scrambled password
  is in the second packet and client_capabilites field will be ignored.
  Maybe it is better to accept flags other than CLIENT_SSL from the
  second packet?
*/
#define SSL_HANDSHAKE_SIZE 2
#define NORMAL_HANDSHAKE_SIZE 6
#define MIN_HANDSHAKE_SIZE 2

user_stats_t *global_user_stats;
user_stats_t *global_client_stats;
thread_stats_t *global_thread_stats;
table_stats_t *global_table_stats;
index_stats_t *global_index_stats;

/*
  Get structure for logging connection data for the current user
*/

static collation_unordered_map<std::string, unique_ptr_my_free<user_conn>>
    *hash_user_connections;

int get_or_create_user_conn(THD *thd, const char *user, const char *host,
                            const USER_RESOURCES *mqh) {
  int return_val = 0;
  size_t temp_len, user_len;
  char temp_user[USER_HOST_BUFF_SIZE];
  struct user_conn *uc = nullptr;

  assert(user != nullptr);
  assert(host != nullptr);

  user_len = strlen(user);
  temp_len = (my_stpcpy(my_stpcpy(temp_user, user) + 1, host) - temp_user) + 1;
  mysql_mutex_lock(&LOCK_user_conn);
  const auto it = hash_user_connections->find(std::string(temp_user, temp_len));
  if (it == hash_user_connections->end()) {
    /* First connection for user; Create a user connection object */
    if (!(uc = ((struct user_conn *)my_malloc(
              key_memory_user_conn, sizeof(struct user_conn) + temp_len + 1,
              MYF(MY_WME))))) {
      /* MY_WME ensures an error is set in THD. */
      return_val = 1;
      goto end;
    }
    uc->user = (char *)(uc + 1);
    memcpy(uc->user, temp_user, temp_len + 1);
    uc->host = uc->user + user_len + 1;
    uc->len = temp_len;
    uc->connections = uc->questions = uc->updates = uc->conn_per_hour = 0;
    uc->user_resources = *mqh;
    uc->reset_utime = thd->start_utime;
    hash_user_connections->emplace(std::string(temp_user, temp_len),
                                   unique_ptr_my_free<user_conn>(uc));
  } else {
    uc = it->second.get();
  }
  thd->set_user_connect(uc);
  thd->increment_user_connections_counter();
end:
  mysql_mutex_unlock(&LOCK_user_conn);
  return return_val;
}

/* Intialize an instance of USER_STATS */
USER_STATS::USER_STATS(const char *priv_user_, uint total_ssl_connections_,
                       ulonglong denied_connections_) noexcept
    : total_ssl_connections(total_ssl_connections_),
      priv_user_len(strlen(priv_user_)),
      denied_connections(denied_connections_) {
  strncpy(priv_user, priv_user_, sizeof(priv_user) - 1);
  priv_user[sizeof(priv_user) - 1] = '\0';
}

void init_global_user_stats(void) {
  global_user_stats = new (std::nothrow)
      user_stats_t(system_charset_info, key_memory_userstat_user_stats);
  if (unlikely(!global_user_stats)) {
    sql_print_error("Initializing global_user_stats failed.");
    exit(1);
  }
}

void init_global_client_stats(void) {
  global_client_stats = new (std::nothrow)
      user_stats_t(system_charset_info, key_memory_userstat_client_stats);
  if (unlikely(!global_client_stats)) {
    sql_print_error("Initializing global_client_stats failed.");
    exit(1);
  }
}

void init_global_thread_stats(void) {
  global_thread_stats =
      new (std::nothrow) thread_stats_t(key_memory_userstat_thread_stats);
  if (unlikely(!global_thread_stats)) {
    sql_print_error("Initializing global_thread_stats failed.");
    exit(1);
  }
}

void init_global_table_stats(void) {
  global_table_stats = new (std::nothrow)
      table_stats_t(system_charset_info, key_memory_userstat_table_stats);
  if (unlikely(!global_table_stats)) {
    sql_print_error("Initializing global_table_stats failed.");
    exit(1);
  }
}

void init_global_index_stats(void) {
  global_index_stats = new (std::nothrow)
      index_stats_t(system_charset_info, key_memory_userstat_index_stats);
  if (unlikely(!global_index_stats)) {
    sql_print_error("Initializing global_index_stats failed.");
    exit(1);
  }
}

void free_global_user_stats(void) noexcept { delete global_user_stats; }

void free_global_thread_stats(void) noexcept { delete global_thread_stats; }

void free_global_table_stats(void) noexcept { delete global_table_stats; }

void free_global_index_stats(void) noexcept { delete global_index_stats; }

void free_global_client_stats(void) noexcept { delete global_client_stats; }

// 'mysql_system_user' is used for when the user is not defined for a THD.
static constexpr char mysql_system_user[] = "#mysql_system#";

// Returns 'user' if it's not NULL.  Returns 'mysql_system_user' otherwise.
static const char *get_valid_user_string(const char *user) {
  return user ? user : mysql_system_user;
}

// Increments the global stats connection count for an entry from
// global_client_stats or global_user_stats. Returns false on success
// and true on error.
static void increment_count_by_name(const std::string &name,
                                    const char *role_name,
                                    user_stats_t *users_or_clients,
                                    const THD &thd) {
  if (acl_is_utility_user(thd.security_context()->user().str,
                          thd.security_context()->host().str,
                          thd.security_context()->ip().str))
    return;

  const auto ssl_connections = thd.is_ssl() ? 1 : 0;
  const auto &it = users_or_clients->find(name);
  if (it == users_or_clients->cend()) {
    // First connection for this user or client
    users_or_clients->emplace(
        std::piecewise_construct, std::forward_as_tuple(name),
        std::forward_as_tuple(role_name, ssl_connections,
                              thd.diff_denied_connections));
  } else {
    it->second.total_connections++;
    it->second.total_ssl_connections += ssl_connections;
  }
}

static void increment_count_by_id(my_thread_id id, thread_stats_t *thread_stats,
                                  const THD &thd) {
  if (acl_is_utility_user(thd.security_context()->user().str,
                          thd.security_context()->host().str,
                          thd.security_context()->ip().str))
    return;

  const auto ssl_connections = thd.is_ssl() ? 1 : 0;
  const auto &it = thread_stats->find(id);
  if (it == thread_stats->cend()) {
    // First connection for this user or client
    thread_stats->emplace(std::piecewise_construct, std::forward_as_tuple(id),
                          std::forward_as_tuple(id, ssl_connections,
                                                thd.diff_denied_connections));
  } else {
    it->second.total_connections++;
    it->second.total_ssl_connections += ssl_connections;
  }
}

/* Increments the global user and client stats connection count.  If 'use_lock'
   is true, LOCK_global_user_client_stats will be locked/unlocked.  Returns
   0 on success, 1 on error.
*/
static void increment_connection_count(const THD &thd, bool use_lock) {
  const char *user_string =
      get_valid_user_string(thd.m_main_security_ctx.user().str);
  const char *client_string = get_client_host(thd);

  if (acl_is_utility_user(thd.security_context()->user().str,
                          thd.security_context()->host().str,
                          thd.security_context()->ip().str))
    return;

  if (use_lock) mysql_mutex_lock(&LOCK_global_user_client_stats);

  increment_count_by_name(user_string, user_string, global_user_stats, thd);
  increment_count_by_name(client_string, user_string, global_client_stats, thd);
  if (opt_thread_statistics)
    increment_count_by_id(thd.thread_id(), global_thread_stats, thd);

  if (use_lock) mysql_mutex_unlock(&LOCK_global_user_client_stats);
}

// Used to update the global user and client stats.
static void update_global_user_stats_with_user(const THD &thd,
                                               USER_STATS *user_stats,
                                               ulonglong now) noexcept {
  user_stats->connected_time +=
      (now - thd.last_global_update_time) / 10000000.0;
  user_stats->busy_time += thd.diff_total_busy_time;
  user_stats->cpu_time += thd.diff_total_cpu_time;
  user_stats->bytes_received += thd.diff_total_bytes_received;
  user_stats->bytes_sent += thd.diff_total_bytes_sent;
  user_stats->binlog_bytes_written += thd.diff_total_binlog_bytes_written;
  user_stats->rows_fetched += thd.diff_total_sent_rows;
  user_stats->rows_updated += thd.diff_total_updated_rows;
  user_stats->rows_read += thd.diff_total_read_rows;
  user_stats->select_commands += thd.diff_select_commands;
  user_stats->update_commands += thd.diff_update_commands;
  user_stats->other_commands += thd.diff_other_commands;
  user_stats->commit_trans += thd.diff_commit_trans;
  user_stats->rollback_trans += thd.diff_rollback_trans;
  user_stats->denied_connections += thd.diff_denied_connections;
  user_stats->lost_connections += thd.diff_lost_connections;
  user_stats->access_denied_errors += thd.diff_access_denied_errors;
  user_stats->empty_queries += thd.diff_empty_queries;
}

static void update_global_thread_stats_with_thread(const THD &thd,
                                                   THREAD_STATS *thread_stats,
                                                   ulonglong now) noexcept {
  thread_stats->connected_time +=
      (now - thd.last_global_update_time) / 10000000.0;
  thread_stats->busy_time += thd.diff_total_busy_time;
  thread_stats->cpu_time += thd.diff_total_cpu_time;
  thread_stats->bytes_received += thd.diff_total_bytes_received;
  thread_stats->bytes_sent += thd.diff_total_bytes_sent;
  thread_stats->binlog_bytes_written += thd.diff_total_binlog_bytes_written;
  thread_stats->rows_fetched += thd.diff_total_sent_rows;
  thread_stats->rows_updated += thd.diff_total_updated_rows;
  thread_stats->rows_read += thd.diff_total_read_rows;
  thread_stats->select_commands += thd.diff_select_commands;
  thread_stats->update_commands += thd.diff_update_commands;
  thread_stats->other_commands += thd.diff_other_commands;
  thread_stats->commit_trans += thd.diff_commit_trans;
  thread_stats->rollback_trans += thd.diff_rollback_trans;
  thread_stats->denied_connections += thd.diff_denied_connections;
  thread_stats->lost_connections += thd.diff_lost_connections;
  thread_stats->access_denied_errors += thd.diff_access_denied_errors;
  thread_stats->empty_queries += thd.diff_empty_queries;
}

void update_global_user_stats(THD *thd, bool create_user, ulonglong now) {
  update_global_user_stats(
      thd, create_user, now,
      get_valid_user_string(thd->security_context()->user().str),
      get_client_host(*thd));
}

// Updates the global stats of a user or client
void update_global_user_stats(THD *thd, bool create_user, ulonglong now,
                              const char *user_string,
                              const char *client_string) {
  mysql_mutex_lock(&LOCK_global_user_client_stats);

  // Update by user name
  if (user_string) {
    const auto &user_it = global_user_stats->find(user_string);
    if (user_it != global_user_stats->cend())
      update_global_user_stats_with_user(*thd, &user_it->second, now);
    else if (create_user)
      increment_count_by_name(user_string, user_string, global_user_stats,
                              *thd);
  }

  // Update by client IP
  if (client_string) {
    const auto &client_it = global_client_stats->find(client_string);
    if (client_it != global_client_stats->cend())
      update_global_user_stats_with_user(*thd, &client_it->second, now);
    else if (create_user)
      increment_count_by_name(client_string, user_string, global_client_stats,
                              *thd);
  }

  if (opt_thread_statistics) {
    // Update by thread ID
    const my_thread_id thread_id = thd->thread_id();
    const auto &thread_it = global_thread_stats->find(thread_id);
    if (thread_it != global_thread_stats->cend())
      update_global_thread_stats_with_thread(*thd, &thread_it->second, now);
    else if (create_user)
      increment_count_by_id(thread_id, global_thread_stats, *thd);
  }

  thd->last_global_update_time = now;
  thd->reset_diff_stats();

  mysql_mutex_unlock(&LOCK_global_user_client_stats);
}

static void clear_stats_concurrent_connections(user_stats_t *stats) noexcept {
  for (auto &it : *stats) it.second.concurrent_connections = 0;
}

static void inc_stats_concurrent_conn(user_stats_t *stats,
                                      const std::string &user_string,
                                      int cnt) noexcept {
  auto it = stats->find(user_string);
  if (it != stats->end()) it->second.concurrent_connections += cnt;
}

/**
  Update number of concurrent connections for user_stats and client_stats
  based on account resource limits
*/
void refresh_concurrent_conn_stats() noexcept {
  mysql_mutex_lock(&LOCK_user_conn);

  mysql_mutex_lock(&LOCK_global_user_client_stats);
  clear_stats_concurrent_connections(global_user_stats);
  clear_stats_concurrent_connections(global_client_stats);
  mysql_mutex_unlock(&LOCK_global_user_client_stats);

  for (const auto &it : *hash_user_connections) {
    mysql_mutex_lock(&LOCK_global_user_client_stats);
    inc_stats_concurrent_conn(global_user_stats, it.second->user,
                              it.second->connections);
    inc_stats_concurrent_conn(global_client_stats, it.second->host,
                              it.second->connections);
    mysql_mutex_unlock(&LOCK_global_user_client_stats);
  }
  mysql_mutex_unlock(&LOCK_user_conn);
}

/*
  check if user has already too many connections

  SYNOPSIS
  check_for_max_user_connections()
  thd     Thread handle
  uc      User connect object

  NOTES
    If check fails, we decrease user connection count, which means one
    shouldn't call decrease_user_connections() after this function.

  RETURN
    0 ok
    1 error
*/

int check_for_max_user_connections(THD *thd, const USER_CONN *uc) {
  int error = 0;
  Host_errors errors;
  DBUG_TRACE;

  mysql_mutex_lock(&LOCK_user_conn);
  if (global_system_variables.max_user_connections &&
      !uc->user_resources.user_conn &&
      global_system_variables.max_user_connections < (uint)uc->connections &&
      !thd->is_admin_connection()) {
    my_error(ER_TOO_MANY_USER_CONNECTIONS, MYF(0), uc->user);
    error = 1;
    errors.m_max_user_connection = 1;
    goto end;
  }
  thd->time_out_user_resource_limits();
  if (uc->user_resources.user_conn &&
      uc->user_resources.user_conn < uc->connections) {
    my_error(ER_USER_LIMIT_REACHED, MYF(0), uc->user, "max_user_connections",
             (long)uc->user_resources.user_conn);
    error = 1;
    errors.m_max_user_connection = 1;
    goto end;
  }
  if (uc->user_resources.conn_per_hour &&
      uc->user_resources.conn_per_hour <= uc->conn_per_hour) {
    my_error(ER_USER_LIMIT_REACHED, MYF(0), uc->user,
             "max_connections_per_hour",
             (long)uc->user_resources.conn_per_hour);
    error = 1;
    errors.m_max_user_connection_per_hour = 1;
    goto end;
  }
  thd->increment_con_per_hour_counter();

end:
  if (error) {
    ++denied_connections;
    thd->decrement_user_connections_counter();
    /*
      The thread may returned back to the pool and assigned to a user
      that doesn't have a limit. Ensure the user is not using resources
      of someone else.
    */
    thd->set_user_connect(nullptr);
  }
  mysql_mutex_unlock(&LOCK_user_conn);
  if (error) {
    inc_host_errors(thd->m_main_security_ctx.ip().str, &errors);
  }
  return error;
}

/*
  Decrease user connection count

  SYNOPSIS
    decrease_user_connections()
    uc      User connection object

  NOTES
    If there is a n user connection object for a connection
    (which only happens if 'max_user_connections' is defined or
    if someone has created a resource grant for a user), then
    the connection count is always incremented on connect.

    The user connect object is not freed if some users has
    'max connections per hour' defined as we need to be able to hold
    count over the lifetime of the connection.
*/

void decrease_user_connections(USER_CONN *uc) {
  DBUG_TRACE;
  mysql_mutex_lock(&LOCK_user_conn);
  assert(uc->connections);
  if (!--uc->connections && !mqh_used) {
    /* Last connection for user; Delete it */
    hash_user_connections->erase(std::string(uc->user, uc->len));
  }
  mysql_mutex_unlock(&LOCK_user_conn);
}

/*
   Decrements user connections count from the USER_CONN held by THD
   And removes USER_CONN from the hash if no body else is using it.

   SYNOPSIS
     release_user_connection()
     THD  Thread context object.
 */
void release_user_connection(THD *thd) {
  const USER_CONN *uc = thd->get_user_connect();
  DBUG_TRACE;

  if (uc) {
    mysql_mutex_lock(&LOCK_user_conn);
    assert(uc->connections > 0);
    thd->decrement_user_connections_counter();
    if (!uc->connections && !mqh_used) {
      /* Last connection for user; Delete it */
      hash_user_connections->erase(std::string(uc->user, uc->len));
    }
    mysql_mutex_unlock(&LOCK_user_conn);
    thd->set_user_connect(nullptr);
  }
}

/*
  Check if maximum queries per hour limit has been reached
  returns 0 if OK.
*/

bool check_mqh(THD *thd, uint check_command) {
  bool error = false;
  const USER_CONN *uc = thd->get_user_connect();
  DBUG_TRACE;
  assert(uc != nullptr);

  mysql_mutex_lock(&LOCK_user_conn);

  thd->time_out_user_resource_limits();

  /* Check that we have not done too many questions / hour */
  if (uc->user_resources.questions) {
    thd->increment_questions_counter();
    if ((uc->questions - 1) >= uc->user_resources.questions) {
      my_error(ER_USER_LIMIT_REACHED, MYF(0), uc->user, "max_questions",
               (long)uc->user_resources.questions);
      error = true;
      goto end;
    }
  }
  if (check_command < (uint)SQLCOM_END) {
    /* Check that we have not done too many updates / hour */
    if (uc->user_resources.updates &&
        (sql_command_flags[check_command] & CF_CHANGES_DATA)) {
      thd->increment_updates_counter();
      if ((uc->updates - 1) >= uc->user_resources.updates) {
        my_error(ER_USER_LIMIT_REACHED, MYF(0), uc->user, "max_updates",
                 (long)uc->user_resources.updates);
        error = true;
        goto end;
      }
    }
  }
end:
  mysql_mutex_unlock(&LOCK_user_conn);
  return error;
}

void init_max_user_conn(void) {
  hash_user_connections =
      new collation_unordered_map<std::string, unique_ptr_my_free<user_conn>>(
          system_charset_info, key_memory_user_conn);
}

void free_max_user_conn(void) {
  delete hash_user_connections;
  hash_user_connections = nullptr;
}

void reset_mqh(THD *thd, LEX_USER *lu, bool get_them = false) {
  mysql_mutex_lock(&LOCK_user_conn);
  DEBUG_SYNC(thd, "in_reset_mqh_flush_privileges");
  if (lu)  // for GRANT
  {
    size_t temp_len = lu->user.length + lu->host.length + 2;
    char temp_user[USER_HOST_BUFF_SIZE];

    memcpy(temp_user, lu->user.str, lu->user.length);
    memcpy(temp_user + lu->user.length + 1, lu->host.str, lu->host.length);
    temp_user[lu->user.length] = '\0';
    temp_user[temp_len - 1] = 0;
    const auto it =
        hash_user_connections->find(std::string(temp_user, temp_len));
    if (it != hash_user_connections->end()) {
      USER_CONN *uc = it->second.get();
      uc->questions = 0;
      get_mqh(thd, temp_user, &temp_user[lu->user.length + 1], uc);
      uc->updates = 0;
      uc->conn_per_hour = 0;
    }
  } else {
    /* for FLUSH PRIVILEGES and FLUSH USER_RESOURCES */
    for (const auto &key_and_value : *hash_user_connections) {
      USER_CONN *uc = key_and_value.second.get();
      if (get_them) get_mqh(thd, uc->user, uc->host, uc);
      uc->questions = 0;
      uc->updates = 0;
      uc->conn_per_hour = 0;
    }
  }
  mysql_mutex_unlock(&LOCK_user_conn);
}

/**
  Set thread character set variables from the given ID

  @param  thd         thread handle
  @param  cs_number   character set and collation ID

  @retval  0  OK; character_set_client, collation_connection and
              character_set_results are set to the new value,
              or to the default global values.

  @retval  1  error, e.g. the given ID is not supported by parser.
              Corresponding SQL error is sent.
*/

bool thd_init_client_charset(THD *thd, uint cs_number) {
  CHARSET_INFO *cs;
  /*
   Use server character set and collation if
   - opt_character_set_client_handshake is not set
   - client has not specified a character set
   - client character set is the same as the servers
   - client character set doesn't exists in server
  */
  if (!opt_character_set_client_handshake ||
      !(cs = get_charset(cs_number, MYF(0))) ||
      !my_strcasecmp(&my_charset_latin1,
                     global_system_variables.character_set_client->m_coll_name,
                     cs->m_coll_name)) {
    if (!is_supported_parser_charset(
            global_system_variables.character_set_client)) {
      /* Disallow non-supported parser character sets: UCS2, UTF16, UTF32 */
      my_error(ER_WRONG_VALUE_FOR_VAR, MYF(0), "character_set_client",
               global_system_variables.character_set_client->csname);
      return true;
    }
    thd->variables.character_set_client =
        global_system_variables.character_set_client;
    thd->variables.collation_connection =
        global_system_variables.collation_connection;
    thd->variables.character_set_results =
        global_system_variables.character_set_results;
  } else {
    if (!is_supported_parser_charset(cs)) {
      /* Disallow non-supported parser character sets: UCS2, UTF16, UTF32 */
      my_error(ER_WRONG_VALUE_FOR_VAR, MYF(0), "character_set_client",
               cs->csname);
      return true;
    }
    thd->variables.character_set_results = thd->variables.collation_connection =
        thd->variables.character_set_client = cs;
  }
  return false;
}

/*
  Perform handshake, authorize client and update thd ACL variables.

  SYNOPSIS
    check_connection()
    thd  thread handle

  RETURN
     0  success, thd is updated.
     1  error
*/

static int check_connection(THD *thd) {
  uint connect_errors = 0;
  int auth_rc;
  NET *net = thd->get_protocol_classic()->get_net();
#ifndef NDEBUG
  char desc[VIO_DESCRIPTION_SIZE];
  vio_description(net->vio, desc);
  DBUG_PRINT("info", ("New connection received on %s", desc));
#endif  // NDEBUG

  thd->set_active_vio(net->vio);

  if (!thd->m_main_security_ctx.host().length)  // If TCP/IP connection
  {
    bool peer_rc;
    char ip[NI_MAXHOST];
    LEX_CSTRING main_sctx_ip;

    if (thd->is_admin_connection()) {
      vio_force_skip_proxy(net->vio);
    }

    /* Set the remote (peer) port for this THD. */
    peer_rc = vio_peer_addr(net->vio, ip, &thd->peer_port, NI_MAXHOST);
    mysql_thread_set_peer_port(thd->peer_port);

    /*
    ===========================================================================
    DEBUG code only (begin)
    Simulate various output from vio_peer_addr().
    ===========================================================================
    */

    DBUG_EXECUTE_IF("vio_peer_addr_error", { peer_rc = 1; });
    DBUG_EXECUTE_IF("vio_peer_addr_fake_ipv4", {
      struct sockaddr *sa = (sockaddr *)&net->vio->remote;
      sa->sa_family = AF_INET;
      struct in_addr *ip4 = &((struct sockaddr_in *)sa)->sin_addr;
      /* See RFC 5737, 192.0.2.0/24 is reserved. */
      const char *fake = "192.0.2.4";
      ip4->s_addr = inet_addr(fake);
      strcpy(ip, fake);
      peer_rc = 0;
    });

    DBUG_EXECUTE_IF("vio_peer_addr_fake_ipv6", {
      struct sockaddr_in6 *sa = (sockaddr_in6 *)&net->vio->remote;
      sa->sin6_family = AF_INET6;
      struct in6_addr *ip6 = &sa->sin6_addr;
      /* See RFC 3849, ipv6 2001:DB8::/32 is reserved. */
      const char *fake = "2001:db8::6:6";
      /* inet_pton(AF_INET6, fake, ip6); not available on Windows XP. */
      ip6->s6_addr[0] = 0x20;
      ip6->s6_addr[1] = 0x01;
      ip6->s6_addr[2] = 0x0d;
      ip6->s6_addr[3] = 0xb8;
      ip6->s6_addr[4] = 0x00;
      ip6->s6_addr[5] = 0x00;
      ip6->s6_addr[6] = 0x00;
      ip6->s6_addr[7] = 0x00;
      ip6->s6_addr[8] = 0x00;
      ip6->s6_addr[9] = 0x00;
      ip6->s6_addr[10] = 0x00;
      ip6->s6_addr[11] = 0x00;
      ip6->s6_addr[12] = 0x00;
      ip6->s6_addr[13] = 0x06;
      ip6->s6_addr[14] = 0x00;
      ip6->s6_addr[15] = 0x06;
      strcpy(ip, fake);
      peer_rc = 0;
    });

    /*
    ===========================================================================
    DEBUG code only (end)
    ===========================================================================
    */

    if (peer_rc) {
      /*
        Since we can not even get the peer IP address,
        there is nothing to show in the host_cache,
        so increment the global status variable for peer address errors.
      */
      connection_errors_peer_addr++;
      my_error(ER_BAD_HOST_ERROR, MYF(0));
      return 1;
    }
    thd->m_main_security_ctx.assign_ip(ip, strlen(ip));
    main_sctx_ip = thd->m_main_security_ctx.ip();
    if (!(main_sctx_ip.length)) {
      /*
        No error accounting per IP in host_cache,
        this is treated as a global server OOM error.
        TODO: remove the need for my_strdup.
      */
      connection_errors_internal++;
      return 1; /* The error is set by my_strdup(). */
    }
    thd->m_main_security_ctx.set_host_or_ip_ptr(main_sctx_ip.str,
                                                main_sctx_ip.length);
    if (!(specialflag & SPECIAL_NO_RESOLVE)) {
      int rc;
      char *host = nullptr;
      LEX_CSTRING main_sctx_host;

#ifdef HAVE_SETNS
      /*
        Check whether namespace is specified for a socket being handled.
        If it is specified then set the namespace as active before resolving
        ip address to host name. Restore original network namespace after
        address resolution finished.
      */

      std::string network_namespace(net->vio->network_namespace);
      if (!network_namespace.empty() &&
          set_network_namespace(network_namespace)) {
        return 1;
      }
#endif
      rc = ip_to_hostname(&net->vio->remote, main_sctx_ip.str, &host,
                          &connect_errors);
#ifdef HAVE_SETNS
      if (!network_namespace.empty() && restore_original_network_namespace()) {
        if (host && host != my_localhost) {
          my_free(host);
        }
        return 1;
      }
#endif
      thd->m_main_security_ctx.assign_host(host, host ? strlen(host) : 0);
      DBUG_EXECUTE_IF("vio_peer_addr_fake_hostname1", {
        thd->m_main_security_ctx.assign_host(
            "host_"
            "1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij123456"
            "7890abcdefghij1234567890abcdefghij1234567890abcdefghij1234567890ab"
            "cdefghij1234567890abcdefghij1234567890abcdefghij1234567890abcdefgh"
            "ij1234567890abcdefghij1234567890abcdefghij1234567890",
            255);
      });

      main_sctx_host = thd->m_main_security_ctx.host();
      if (host && host != my_localhost) {
        my_free(host);
      }

      /* Cut very long hostnames to avoid possible overflows */
      if (main_sctx_host.length) {
        if (main_sctx_host.str != my_localhost)
          thd->m_main_security_ctx.set_host_ptr(
              main_sctx_host.str,
              min<size_t>(main_sctx_host.length, HOSTNAME_LENGTH));
        thd->m_main_security_ctx.set_host_or_ip_ptr(main_sctx_host.str,
                                                    main_sctx_host.length);
      }

      if (rc == RC_LONG_HOSTNAME) {
        my_error(ER_HOSTNAME_TOO_LONG, MYF(0), HOSTNAME_LENGTH);
        return 1;
      }

      if (rc == RC_BLOCKED_HOST) {
        /* HOST_CACHE stats updated by ip_to_hostname(). */
        my_error(ER_HOST_IS_BLOCKED, MYF(0),
                 thd->m_main_security_ctx.host_or_ip().str);
        return 1;
      }
    }
    DBUG_PRINT("info",
               ("Host: %s  ip: %s",
                (thd->m_main_security_ctx.host().length
                     ? thd->m_main_security_ctx.host().str
                     : "unknown host"),
                (main_sctx_ip.length ? main_sctx_ip.str : "unknown ip")));
    if (acl_check_host(thd, thd->m_main_security_ctx.host().str,
                       main_sctx_ip.str)) {
      /* HOST_CACHE stats updated by acl_check_host(). */
      my_error(ER_HOST_NOT_PRIVILEGED, MYF(0),
               thd->m_main_security_ctx.host_or_ip().str);
      return 1;
    }
  } else /* Hostname given means that the connection was on a socket */
  {
    LEX_CSTRING main_sctx_host = thd->m_main_security_ctx.host();
    DBUG_PRINT("info", ("Host: %s", main_sctx_host.str));
    thd->m_main_security_ctx.set_host_or_ip_ptr(main_sctx_host.str,
                                                main_sctx_host.length);
    thd->m_main_security_ctx.set_ip_ptr(STRING_WITH_LEN(""));
    /* Reset sin_addr */
    memset(&net->vio->remote, 0, sizeof(net->vio->remote));
  }
  vio_keepalive(net->vio, true);

  if (thd->get_protocol_classic()->get_output_packet()->alloc(
          thd->variables.net_buffer_length)) {
    /*
      Important note:
      net_buffer_length is a SESSION variable,
      so it may be tempting to account OOM conditions per IP in the HOST_CACHE,
      in case some clients are more demanding than others ...
      However, this session variable is *not* initialized with a per client
      value during the initial connection, it is initialized from the
      GLOBAL net_buffer_length variable from the server.
      Hence, there is no reason to account on OOM conditions per client IP,
      we count failures in the global server status instead.
    */
    connection_errors_internal++;
    return 1; /* The error is set by alloc(). */
  }

  if (mysql_audit_notify(
          thd, AUDIT_EVENT(MYSQL_AUDIT_CONNECTION_PRE_AUTHENTICATE))) {
    return 1;
  }

  auth_rc = acl_authenticate(thd, COM_CONNECT);

  if (mysql_audit_notify(thd, AUDIT_EVENT(MYSQL_AUDIT_CONNECTION_CONNECT))) {
    return 1;
  }

#ifdef HAVE_PSI_THREAD_INTERFACE
  PSI_THREAD_CALL(notify_session_connect)(thd->get_psi());
#endif /* HAVE_PSI_THREAD_INTERFACE */

  if (auth_rc == 0 && connect_errors != 0) {
    /*
      A client connection from this IP was successful,
      after some previous failures.
      Reset the connection error counter.
    */
    reset_host_connect_errors(thd->m_main_security_ctx.ip().str);
  }

  /*
    Now that acl_authenticate() is executed,
    the SSL info is available.
    Advertise it to THD, so SSL status variables
    can be inspected.
  */
  thd->set_ssl(net->vio);
  return auth_rc;
}

/*
  Authenticate user, with error reporting

  SYNOPSIS
   login_connection()
   thd        Thread handler

  NOTES
    Connection is not closed in case of errors

  RETURN
    0    ok
    1    error
*/

static bool login_connection(THD *thd) {
  int error;
  DBUG_TRACE;
  DBUG_PRINT("info",
             ("login_connection called by thread %u", thd->thread_id()));

  /* Use "connect_timeout" value during connection phase */
  thd->get_protocol_classic()->set_read_timeout(connect_timeout, true);
  thd->get_protocol_classic()->set_write_timeout(connect_timeout);

  error = check_connection(thd);
  thd->send_statement_status();

  if (error) {  // Wrong permissions
#ifdef _WIN32
    if (vio_type(thd->get_protocol_classic()->get_vio()) == VIO_TYPE_NAMEDPIPE)
      my_sleep(1000); /* must wait after eof() */
#endif
    return true;
  }
  /* Connect completed, set read/write timeouts back to default */
  thd->get_protocol_classic()->set_read_timeout(
      thd->variables.net_read_timeout);
  thd->get_protocol_classic()->set_write_timeout(
      thd->variables.net_write_timeout);

  if (unlikely(opt_userstat)) {
    thd->reset_stats();

    // Updates global user connection stats.
    increment_connection_count(*thd, true);
  }

  return false;
}

/*
  Close an established connection

  NOTES
    This mainly updates status variables
*/

void end_connection(THD *thd) {
  NET *net = thd->get_protocol_classic()->get_net();

  mysql_audit_notify(thd, AUDIT_EVENT(MYSQL_AUDIT_CONNECTION_DISCONNECT), 0);

#ifdef HAVE_PSI_THREAD_INTERFACE
  PSI_THREAD_CALL(notify_session_disconnect)(thd->get_psi());
#endif /* HAVE_PSI_THREAD_INTERFACE */

  plugin_thdvar_cleanup(thd, thd->m_enable_plugins);

  /*
    The thread may returned back to the pool and assigned to a user
    that doesn't have a limit. Ensure the user is not using resources
    of someone else.
  */
  release_user_connection(thd);

  if (thd->killed || (net->error && net->vio != nullptr)) {
    aborted_threads++;
    thd->diff_lost_connections++;
  }

  if (net->error && net->vio != nullptr) {
    if (!thd->killed) {
      Security_context *sctx = thd->security_context();
      LEX_CSTRING sctx_user = sctx->user();
      LogErr(
          INFORMATION_LEVEL, ER_ABORTING_USER_CONNECTION, thd->thread_id(),
          (thd->db().str ? thd->db().str : "unconnected"),
          sctx_user.str ? sctx_user.str : "unauthenticated",
          sctx->host_or_ip().str,
          (thd->get_stmt_da()->is_error() ? thd->get_stmt_da()->message_text()
                                          : ER_DEFAULT(ER_UNKNOWN_ERROR)));
    }
  }
}

/*
  Initialize THD to handle queries
*/

static void prepare_new_connection_state(THD *thd) {
  NET *net = thd->get_protocol_classic()->get_net();
  Security_context *sctx = thd->security_context();

  if (thd->get_protocol()->has_client_capability(CLIENT_COMPRESS) ||
      thd->get_protocol()->has_client_capability(
          CLIENT_ZSTD_COMPRESSION_ALGORITHM)) {
    net->compress = true;  // Use compression
    enum enum_compression_algorithm algorithm = get_compression_algorithm(
        thd->get_protocol()->get_compression_algorithm());
    NET_SERVER *server_extn = static_cast<NET_SERVER *>(net->extension);
    if (server_extn != nullptr)
      mysql_compress_context_init(&server_extn->compress_ctx, algorithm,
                                  thd->get_protocol()->get_compression_level());
    if (net->extension == nullptr) {
      LEX_CSTRING sctx_user = sctx->user();
      Host_errors errors;
      my_error(ER_NEW_ABORTING_CONNECTION, MYF(0), thd->thread_id(),
               thd->db().str ? thd->db().str : "unconnected",
               sctx_user.str ? sctx_user.str : "unauthenticated",
               sctx->host_or_ip().str,
               "Unable to allocate memory for compression context: Aborting "
               "connection.");
      thd->server_status &= ~SERVER_STATUS_CLEAR_SET;
      thd->send_statement_status();
      thd->killed = THD::KILL_CONNECTION;
      errors.m_init_connect = 1;
      inc_host_errors(thd->m_main_security_ctx.ip().str, &errors);
      return;
    }
  }

  // Initializing session system variables.
  alloc_and_copy_thd_dynamic_variables(thd, true);

  thd->set_proc_info(nullptr);
  thd->set_command(COM_SLEEP);
  thd->init_query_mem_roots();
  const bool is_admin_conn =
      (sctx->check_access(SUPER_ACL) ||
       sctx->has_global_grant(STRING_WITH_LEN("CONNECTION_ADMIN")).first);
  thd->m_mem_cnt.set_orig_mode(is_admin_conn ? MEM_CNT_UPDATE_GLOBAL_COUNTER
                                             : (MEM_CNT_UPDATE_GLOBAL_COUNTER |
                                                MEM_CNT_GENERATE_ERROR |
                                                MEM_CNT_GENERATE_LOG_ERROR));
  if (opt_init_connect.length && !is_admin_conn) {
    if (sctx->password_expired()) {
      LogErr(WARNING_LEVEL, ER_CONN_INIT_CONNECT_IGNORED, sctx->priv_user().str,
             sctx->priv_host().str);
      return;
    }
    if (sctx->is_in_registration_sandbox_mode()) {
      LogErr(WARNING_LEVEL, ER_CONN_INIT_CONNECT_IGNORED_MFA,
             sctx->priv_user().str, sctx->priv_host().str);
      return;
    }
    // Do not print OOM error to error log.
    thd->m_mem_cnt.set_curr_mode(
        (MEM_CNT_UPDATE_GLOBAL_COUNTER | MEM_CNT_GENERATE_ERROR));
    execute_init_command(thd, &opt_init_connect, &LOCK_sys_init_connect);
    thd->m_mem_cnt.set_curr_mode(MEM_CNT_DEFAULT);
    if (thd->is_error()) {
      Host_errors errors;
      ulong packet_length;
      LEX_CSTRING sctx_user = sctx->user();
      Diagnostics_area *da = thd->get_stmt_da();
      const char *user = sctx_user.str ? sctx_user.str : "unauthenticated";
      const char *what = "init_connect command failed";

      LogEvent()
          .prio(WARNING_LEVEL)
          .subsys(LOG_SUBSYSTEM_TAG)
          .thread_id(thd->thread_id())
          .user(sctx_user)
          .host(sctx->host_or_ip())
          .source_file(MY_BASENAME)
          .errcode(ER_SERVER_NEW_ABORTING_CONNECTION)
          .sqlstate(da->returned_sqlstate())
          .string_value(LOG_TAG_DIAG, da->message_text())
          .string_value(LOG_TAG_AUX, what)
          .lookup(ER_SERVER_NEW_ABORTING_CONNECTION, thd->thread_id(),
                  thd->db().str ? thd->db().str : "unconnected", user,
                  sctx->host_or_ip().str, what, da->mysql_errno(),
                  da->message_text());

      thd->lex->set_current_query_block(nullptr);
      my_net_set_read_timeout(net, thd->variables.net_wait_timeout);
      thd->clear_error();
      net_new_transaction(net);
      packet_length = my_net_read(net);
      /*
        If my_net_read() failed, my_error() has been already called,
        and the main Diagnostics Area contains an error condition.
      */
      if (packet_length != packet_error)
        my_error(ER_NEW_ABORTING_CONNECTION, MYF(0), thd->thread_id(),
                 thd->db().str ? thd->db().str : "unconnected",
                 sctx_user.str ? sctx_user.str : "unauthenticated",
                 sctx->host_or_ip().str, "init_connect command failed");

      thd->server_status &= ~SERVER_STATUS_CLEAR_SET;
      thd->send_statement_status();
      thd->killed = THD::KILL_CONNECTION;
      errors.m_init_connect = 1;
      inc_host_errors(thd->m_main_security_ctx.ip().str, &errors);
      NET_SERVER *server_extn = static_cast<NET_SERVER *>(net->extension);
      if (server_extn != nullptr)
        mysql_compress_context_deinit(&server_extn->compress_ctx);
      return;
    }

    thd->set_proc_info(nullptr);
    thd->init_query_mem_roots();
  }
}

bool thd_prepare_connection(THD *thd) {
  thd->enable_mem_cnt();

  bool rc;
  lex_start(thd);
  rc = login_connection(thd);

  if (rc) return rc;

  prepare_new_connection_state(thd);
  return false;
}

/**
  Close a connection.

  @param thd        Thread handle.
  @param sql_errno  The error code to send before disconnect.
  @param server_shutdown True for a server shutdown
  @param generate_event  Generate Audit API disconnect event.

  @note
    For the connection that is doing shutdown, this is called twice
*/

void close_connection(THD *thd, uint sql_errno, bool server_shutdown,
                      bool generate_event) {
  DBUG_TRACE;

  if (sql_errno) net_send_error(thd, sql_errno, ER_DEFAULT_NONCONST(sql_errno));
  thd->disconnect(server_shutdown);

  if (generate_event) {
    mysql_audit_notify(thd, AUDIT_EVENT(MYSQL_AUDIT_CONNECTION_DISCONNECT),
                       sql_errno);
#ifdef HAVE_PSI_THREAD_INTERFACE
    PSI_THREAD_CALL(notify_session_disconnect)(thd->get_psi());
#endif /* HAVE_PSI_THREAD_INTERFACE */
  }

  thd->security_context()->logout();
}

bool thd_connection_alive(THD *thd) {
  NET *net = thd->get_protocol_classic()->get_net();
  if (!net->error && net->vio != nullptr &&
      !(thd->killed == THD::KILL_CONNECTION))
    return true;
  return false;
}