destination_ssl_context.h

Go to the documentation of this file.

/*
  Copyright (c) 2018, 2026, 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 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
*/
 
#ifndef MYSQL_ROUTING_DESTINATION_TLS_CONTEXT_INCLUDED
#define MYSQL_ROUTING_DESTINATION_TLS_CONTEXT_INCLUDED
 
#include "mysqlrouter/routing_export.h"
 
#include <chrono>
#include <map>
#include <mutex>
#include <string>
 
#include "mysql/harness/tls_client_context.h"
#include "mysqlrouter/ssl_mode.h"  // SslVerify
 
/**
 * TlsClientContext per destination.
 */
class ROUTING_EXPORT DestinationTlsContext {
 public:
  DestinationTlsContext(bool session_cache_mode, size_t ssl_session_cache_size,
                        unsigned int ssl_session_cache_timeout)
      : session_cache_mode_(session_cache_mode),
        ssl_session_cache_size_(ssl_session_cache_size),
        ssl_session_cache_timeout_(ssl_session_cache_timeout) {}
 
  /**
   * set SslVerify.
   */
  void verify(SslVerify ssl_verify);
 
  /**
   * set CA file.
   */
  void ca_file(const std::string &file);
 
  /**
   * set CA path.
   */
  void ca_path(const std::string &path);
 
  /**
   * set CRL file.
   */
  void crl_file(const std::string &file);
 
  /**
   * set CRL path.
   */
  void crl_path(const std::string &path);
 
  /**
   * set allowed EC curves.
   */
  void curves(const std::string &curves);
 
  /**
   * set allowed ciphers.
   */
  void ciphers(const std::string &ciphers);
 
  SslVerify get_verify();
  const std::string &get_ca_file();
  const std::string &get_ca_path();
  const std::string &get_crl_file();
  const std::string &get_crl_path();
  const std::string &get_curves();
  const std::string &get_ciphers();
 
  /**
   * set client-key and its cert.
   */
  void client_key_and_cert_file(std::string key, std::string cert);
 
  /**
   * get a TlsClientContent for a destination.
   *
   * If no TlsClientContext exists for the destination, creates a
   * TlsClientContent based on:
   *
   * - verify()
   * - ca_file()
   * - ca_path()
   * - crl_file()
   * - crl_path()
   * - curves()
   * - ciphers()
   *
   * If that succeeds, the resulting TlsClientContext is cached and a shared
   * reference to it is returned.
   *
   * If a TlsClientContext for the destination exists, a shared reference to it
   * is returned.
   *
   * @param dest_id  unique identifier of a destination
   * @param hostname name of the destination host
   */
  std::shared_ptr<TlsClientContext> get(const std::string &dest_id,
                                        const std::string &hostname);
 
  /**
   * Validate the configured TLS material before invalidating the cache.
   *
   * On success, discards the cached client contexts. The next get() lazily
   * creates a context for its destination from the configured paths. On
   * failure, existing cache entries remain available, while a cache miss still
   * initializes a new context from the configured paths.
   *
   * @param out_error receives the validation error when false is returned.
   */
  bool reload(std::string &out_error);
 
 private:
  SslVerify ssl_verify_{SslVerify::kDisabled};
  std::string ca_file_;
  std::string ca_path_;
  std::string crl_file_;
  std::string crl_path_;
  std::string curves_;
  std::string ciphers_;
 
  std::string cert_file_;
  std::string key_file_;
 
  std::map<std::string, std::shared_ptr<TlsClientContext>> tls_contexts_;
 
  std::mutex mtx_;
 
  bool session_cache_mode_{true};
  size_t ssl_session_cache_size_{};
  std::chrono::seconds ssl_session_cache_timeout_{std::chrono::seconds(0)};
};
 
#endif