Skip to content

ssl: add SSLSocket#add_certificate #1149

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
kou wants to merge 1 commit into
base: master
Choose a base branch
from
Open

ssl: add SSLSocket#add_certificate #1149

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
75 changes: 61 additions & 14 deletions ext/openssl/ossl_ssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1379,6 +1379,26 @@ ossl_sslctx_enable_fallback_scsv(VALUE self)
}
#endif

static void
get_cert_and_key(VALUE cert, VALUE key, X509 **x509, EVP_PKEY **pkey)
{
EVP_PKEY *pub_pkey;

*x509 = GetX509CertPtr(cert);
*pkey = GetPrivPKeyPtr(key);

/*
* The reference counter is bumped, and decremented immediately.
* X509_get0_pubkey() is only available in OpenSSL >= 1.1.0.
*/
pub_pkey = X509_get_pubkey(*x509);
EVP_PKEY_free(pub_pkey);
if (!pub_pkey)
rb_raise(rb_eArgError, "certificate does not contain public key");
if (EVP_PKEY_eq(pub_pkey, *pkey) != 1)
rb_raise(rb_eArgError, "public key mismatch");
}

/*
* call-seq:
* ctx.add_certificate(certificate, pkey [, extra_certs]) -> self
Expand Down Expand Up @@ -1421,24 +1441,12 @@ ossl_sslctx_add_certificate(int argc, VALUE *argv, VALUE self)
SSL_CTX *ctx;
X509 *x509;
STACK_OF(X509) *extra_chain = NULL;
EVP_PKEY *pkey, *pub_pkey;
EVP_PKEY *pkey;

GetSSLCTX(self, ctx);
rb_scan_args(argc, argv, "21", &cert, &key, &extra_chain_ary);
rb_check_frozen(self);
x509 = GetX509CertPtr(cert);
pkey = GetPrivPKeyPtr(key);

/*
* The reference counter is bumped, and decremented immediately.
* X509_get0_pubkey() is only available in OpenSSL >= 1.1.0.
*/
pub_pkey = X509_get_pubkey(x509);
EVP_PKEY_free(pub_pkey);
if (!pub_pkey)
rb_raise(rb_eArgError, "certificate does not contain public key");
if (EVP_PKEY_eq(pub_pkey, pkey) != 1)
rb_raise(rb_eArgError, "public key mismatch");
get_cert_and_key(cert, key, &x509, &pkey);

if (argc >= 3)
extra_chain = ossl_x509_ary2sk(extra_chain_ary);
Expand All @@ -1458,6 +1466,44 @@ ossl_sslctx_add_certificate(int argc, VALUE *argv, VALUE self)
return self;
}

/*
* call-seq:
* ssl.add_certificate(certificate, pkey [, extra_certs]) -> self
*
* Adds a certificate to this connection only. See
* SSLContext#add_certificate for details.
*/
static VALUE
ossl_ssl_add_certificate(int argc, VALUE *argv, VALUE self)
{
VALUE cert, key, extra_chain_ary;
SSL *ssl;
X509 *x509;
STACK_OF(X509) *extra_chain = NULL;
EVP_PKEY *pkey;

GetSSL(self, ssl);
rb_scan_args(argc, argv, "21", &cert, &key, &extra_chain_ary);
get_cert_and_key(cert, key, &x509, &pkey);

if (argc >= 3)
extra_chain = ossl_x509_ary2sk(extra_chain_ary);

if (!SSL_use_certificate(ssl, x509)) {
sk_X509_pop_free(extra_chain, X509_free);
ossl_raise(eSSLError, "SSL_use_certificate");
}
if (!SSL_use_PrivateKey(ssl, pkey)) {
sk_X509_pop_free(extra_chain, X509_free);
ossl_raise(eSSLError, "SSL_use_PrivateKey");
}
if (extra_chain && !SSL_set0_chain(ssl, extra_chain)) {
sk_X509_pop_free(extra_chain, X509_free);
ossl_raise(eSSLError, "SSL_set0_chain");
}
return self;
}

/*
* call-seq:
* ctx.session_add(session) -> true | false
Expand Down Expand Up @@ -3026,6 +3072,7 @@ Init_ossl_ssl(void)
rb_define_method(cSSLSocket, "hostname=", ossl_ssl_set_hostname, 1);
rb_define_method(cSSLSocket, "min_version=", ossl_ssl_set_min_version, 1);
rb_define_method(cSSLSocket, "max_version=", ossl_ssl_set_max_version, 1);
rb_define_method(cSSLSocket, "add_certificate", ossl_ssl_add_certificate, -1);
rb_define_method(cSSLSocket, "finished_message", ossl_ssl_get_finished, 0);
rb_define_method(cSSLSocket, "peer_finished_message", ossl_ssl_get_peer_finished, 0);
rb_define_method(cSSLSocket, "tmp_key", ossl_ssl_tmp_key, 0);
Expand Down
23 changes: 23 additions & 0 deletions test/openssl/test_ssl.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,29 @@ def test_add_certificate
end
end

def test_socket_add_certificate
server_proc = -> sock {
ssl = OpenSSL::SSL::SSLSocket.new(sock, OpenSSL::SSL::SSLContext.new)
ssl.add_certificate(@svr_cert, @svr_key, [@ca_cert])
ssl.accept
readwrite_loop(ssl)
}
start_server_proc(server_proc) { |port|
server_connect(port) { |ssl|
assert_equal [@svr_cert.subject, @ca_cert.subject],
ssl.peer_cert_chain.map(&:subject)

ssl.puts "abc"; assert_equal "abc\n", ssl.gets
}

@rhenium rhenium Nov 11, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The test failures are relevant. In TLS 1.3, SSL_connect() may return before SSL_accept() finishes writing NewSessionTicket. The usual workaround is to complete an application data round trip (ssl.puts("abc"); ssl.gets) to avoid the RST.

Maybe it's time to clean this up, since the same workaround is repeated in quite a few tests. But it would not belong to this PR.

@kou kou Nov 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Oh, sorry. You're right. I've added one round trip and CI is green now.

Let's discuss how to clean this up as a separated task.

}

# Invalid
IO.pipe { |r, _w|
ssl = OpenSSL::SSL::SSLSocket.new(r)
assert_raise(ArgumentError) { ssl.add_certificate(@svr_cert, @cli_key) }
}
end

def test_add_certificate_multiple_certs
ca2_key = Fixtures.pkey("rsa-3")
ca2_exts = [
Expand Down
Loading