Skip to content

Commit

Permalink
fix sporadic failure in specs with OpenSSL 1.1+. (#8582)
Browse files Browse the repository at this point in the history
* fix sporadic failure in specs with OpenSSL 1.1+. See openssl/openssl#6904

* don't use a keyword for a variable
  • Loading branch information
rdp authored and Brian J. Cardiff committed Dec 16, 2019
1 parent b91c698 commit fe94936
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
23 changes: 23 additions & 0 deletions spec/std/openssl/ssl/socket_spec.cr
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,32 @@ describe OpenSSL::SSL::Socket do
end
end

it "accepts clients that only write then close the connection" do
tcp_server = TCPServer.new(0)
server_context, client_context = ssl_context_pair
# in tls 1.3, if clients don't read anything and close the connection
# the server still try and write to it a ticket, resulting in a "pipe failure"
# this context method disables the tickets which allows the behavior:
server_context.disable_session_resume_tickets

OpenSSL::SSL::Server.open(tcp_server, server_context) do |server|
spawn do
# the :sync_close aspect, as implemented in crystal, effects a unidirectional socket close from the client
OpenSSL::SSL::Socket::Client.open(TCPSocket.new(tcp_server.local_address.address, tcp_server.local_address.port), client_context, hostname: "example.com", sync_close: true) do |socket|
# doesn't read anything, just write and close connection immediately
socket.puts "hello"
end
end

client = server.accept # shouldn't raise "Broken pipe (Errno)"
client.close
end
end

it "closes connection to server that doesn't properly terminate SSL session" do
tcp_server = TCPServer.new(0)
server_context, client_context = ssl_context_pair
server_context.disable_session_resume_tickets # avoid Broken pipe

client_successfully_closed_socket = Channel(Nil).new
spawn do
Expand Down
6 changes: 6 additions & 0 deletions src/openssl/lib_ssl.cr
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,12 @@ lib LibSSL
# Hostname validation for OpenSSL <= 1.0.1
fun ssl_ctx_set_cert_verify_callback = SSL_CTX_set_cert_verify_callback(ctx : SSLContext, callback : CertVerifyCallback, arg : Void*)

# control TLS 1.3 session ticket generation
{% if compare_versions(OPENSSL_VERSION, "1.1.1") >= 0 %}
fun ssl_ctx_set_num_tickets = SSL_CTX_set_num_tickets(ctx : SSLContext, larg : LibC::SizeT) : Int
fun ssl_set_num_tickets = SSL_set_num_tickets(ctx : SSL, larg : LibC::SizeT) : Int
{% end %}

{% if compare_versions(OPENSSL_VERSION, "1.1.0") >= 0 %}
fun tls_method = TLS_method : SSLMethod
{% else %}
Expand Down
14 changes: 14 additions & 0 deletions src/openssl/ssl/context.cr
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,20 @@ abstract class OpenSSL::SSL::Context
def self.from_hash(params) : self
super(params)
end

# Disables all session ticket generation for this context.
# Tickets are used to resume earlier sessions more quickly,
# but in TLS 1.3 if the client connects, sends data, and closes the connection
# unidirectionally, the server connects, then sends a ticket
# after the connect handshake, the ticket send can fail with Broken Pipe.
# So if you have that kind of behavior (clients that never read) call this method.
def disable_session_resume_tickets
add_options(OpenSSL::SSL::Options::NO_TICKET) # TLS v1.2 and below
{% if compare_versions(LibSSL::OPENSSL_VERSION, "1.1.1") >= 0 %}
ret = LibSSL.ssl_ctx_set_num_tickets(self, 0) # TLS v1.3
raise OpenSSL::Error.new("SSL_CTX_set_num_tickets") if ret != 1
{% end %}
end
end

protected def initialize(method : LibSSL::SSLMethod)
Expand Down

0 comments on commit fe94936

Please sign in to comment.