Skip to content

adds tls sni support to mysql2 #1405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

adds tls sni support to mysql2 #1405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions ext/mysql2/client.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,26 +504,34 @@ static int opt_connect_attr_add_i(VALUE key, VALUE value, VALUE arg)
}
#endif

static VALUE rb_mysql_connect(VALUE self, VALUE user, VALUE pass, VALUE host, VALUE port, VALUE database, VALUE socket, VALUE flags, VALUE conn_attrs) {
static VALUE rb_mysql_connect(VALUE self, VALUE user, VALUE pass, VALUE host, VALUE port, VALUE database, VALUE socket, VALUE flags, VALUE conn_attrs, VALUE tls_sni_name) {
struct nogvl_connect_args args;
time_t start_time, end_time, elapsed_time, connect_timeout;
const char *sni_hostname;
VALUE rv;
GET_CLIENT(self);

args.host = NIL_P(host) ? NULL : StringValueCStr(host);
args.unix_socket = NIL_P(socket) ? NULL : StringValueCStr(socket);
args.port = NIL_P(port) ? 0 : NUM2INT(port);
args.user = NIL_P(user) ? NULL : StringValueCStr(user);
args.passwd = NIL_P(pass) ? NULL : StringValueCStr(pass);
args.db = NIL_P(database) ? NULL : StringValueCStr(database);
args.mysql = wrapper->client;
args.client_flag = NUM2ULONG(flags);
args.host = NIL_P(host) ? NULL : StringValueCStr(host);
args.unix_socket = NIL_P(socket) ? NULL : StringValueCStr(socket);
args.port = NIL_P(port) ? 0 : NUM2INT(port);
args.user = NIL_P(user) ? NULL : StringValueCStr(user);
args.passwd = NIL_P(pass) ? NULL : StringValueCStr(pass);
args.db = NIL_P(database) ? NULL : StringValueCStr(database);
args.mysql = wrapper->client;
args.client_flag = NUM2ULONG(flags);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this spacing off by one or is that a GitHub display bug? (I'm reviewing on web)


sni_hostname = NIL_P(tls_sni_name) ? NULL : StringValueCStr(tls_sni_name);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to refresh myself on this code to remember if this ought to go into the args structure. It is used to stash arguments that are passed by pointer-to-structure to nogvl_connect -- but I don't remember if the args structure is also used for subsequent reconnects or looking up connection parameters later on.


#ifdef CLIENT_CONNECT_ATTRS
mysql_options(wrapper->client, MYSQL_OPT_CONNECT_ATTR_RESET, 0);
rb_hash_foreach(conn_attrs, opt_connect_attr_add_i, (VALUE)wrapper);
#endif

if(sni_hostname != NULL) {
Copy link
Collaborator

@sodabrew sodabrew Jul 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:

Suggested change
if(sni_hostname != NULL) {
if (sni_hostname != NULL) {

/* Set the TLS SNI name if provided */
mysql_options(wrapper->client, MYSQL_OPT_TLS_SNI_SERVERNAME, sni_hostname);
Copy link
Collaborator

@sodabrew sodabrew Jul 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that this wasn't added until MySQL 8.1:
https://dev.mysql.com/doc/relnotes/mysql/8.1/en/news-8-1-0.html

However MySQL 8.0 is still in support window, so #ifdef protection is required.

}

if (wrapper->connect_timeout)
time(&start_time);
rv = (VALUE) rb_thread_call_without_gvl(nogvl_connect, &args, RUBY_UBF_IO, 0);
Expand Down Expand Up @@ -1619,7 +1627,7 @@ void init_mysql2_client() {
rb_define_private_method(cMysql2Client, "ssl_mode=", rb_set_ssl_mode_option, 1);
rb_define_private_method(cMysql2Client, "enable_cleartext_plugin=", set_enable_cleartext_plugin, 1);
rb_define_private_method(cMysql2Client, "initialize_ext", initialize_ext, 0);
rb_define_private_method(cMysql2Client, "connect", rb_mysql_connect, 8);
rb_define_private_method(cMysql2Client, "connect", rb_mysql_connect, 9);
rb_define_private_method(cMysql2Client, "_query", rb_mysql_query, 2);

sym_id = ID2SYM(rb_intern("id"));
Expand Down
16 changes: 9 additions & 7 deletions lib/mysql2/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,25 @@ def initialize(opts = {})

check_and_clean_query_options

user = opts[:username] || opts[:user]
pass = opts[:password] || opts[:pass]
host = opts[:host] || opts[:hostname]
port = opts[:port]
database = opts[:database] || opts[:dbname] || opts[:db]
socket = opts[:socket] || opts[:sock]
user = opts[:username] || opts[:user]
pass = opts[:password] || opts[:pass]
host = opts[:host] || opts[:hostname]
tls_sni_name = opts[:tls_sni_name]
port = opts[:port]
database = opts[:database] || opts[:dbname] || opts[:db]
socket = opts[:socket] || opts[:sock]

# Correct the data types before passing these values down to the C level
user = user.to_s unless user.nil?
pass = pass.to_s unless pass.nil?
host = host.to_s unless host.nil?
port = port.to_i unless port.nil?
database = database.to_s unless database.nil?
tls_sni_name = tls_sni_name.to_s unless tls_sni_name.nil?
socket = socket.to_s unless socket.nil?
conn_attrs = parse_connect_attrs(opts[:connect_attrs])

connect user, pass, host, port, database, socket, flags, conn_attrs
connect user, pass, host, port, database, socket, flags, conn_attrs, tls_sni_name
end

def parse_ssl_mode(mode)
Expand Down
Loading