Skip to content

Restore #bind_ssl as deprecated api #6551

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

Merged
RX14 merged 2 commits into from
Aug 19, 2018
Merged

Restore #bind_ssl as deprecated api #6551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
691c2da
Restore #bind_ssl as deprecated api
bcardiff Aug 16, 2018
2abbf55
Add TODO remove note
bcardiff Aug 17, 2018
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
24 changes: 24 additions & 0 deletions spec/std/http/server/server_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,30 @@ module HTTP
end
end

describe "#bind_ssl" do
it "binds SSL server context" do
server = Server.new do |context|
context.response.puts "Test Server (#{context.request.headers["Host"]?})"
context.response.close
end

server_context, client_context = ssl_context_pair

socket = OpenSSL::SSL::Server.new(TCPServer.new("127.0.0.1", 0), server_context)
server.bind socket
ip_address1 = server.bind_ssl "127.0.0.1", 0, server_context
ip_address2 = socket.local_address

spawn server.listen
Fiber.yield

HTTP::Client.get("https://#{ip_address1}", tls: client_context).body.should eq "Test Server (#{ip_address1})\n"
HTTP::Client.get("https://#{ip_address2}", tls: client_context).body.should eq "Test Server (#{ip_address2})\n"

server.close
end
end

describe "#listen" do
it "fails after listen" do
server = Server.new { }
Expand Down
8 changes: 7 additions & 1 deletion src/http/server.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,12 @@ class HTTP::Server
def bind_tls(address : Socket::IPAddress, context : OpenSSL::SSL::Context::Server) : Socket::IPAddress
bind_tls(address.address, address.port, context)
end

# DEPRECATED: Use `#bind_tls`.
Copy link
Copy Markdown
Member

@RX14 RX14 Aug 17, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Please add an explicit TODO: remove in 0.27.0 or similar

we should probably eventually settle on a TODO(0.27.0) style with a grep -R "TODO($(crystal -v))" src spec to fail the build. when you upgrade the compiler.

Which also reminds me that there should be a crystal -v which is machine-readable not human-readable....

Copy link
Copy Markdown
Member Author

@bcardiff bcardiff Aug 17, 2018

Choose a reason for hiding this comment

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

done.

# TODO: remove in 0.27.0
def bind_ssl(*args)
bind_tls(*args)
end
{% end %}

# Parses a socket configuration from *uri* and adds it to this server.
Expand Down Expand Up @@ -287,7 +293,7 @@ class HTTP::Server

bind_tls(address, context)
{% else %}
raise ArgumentError.new "Unsupported socket type: ssl (program was compiled without openssl support)"
raise ArgumentError.new "Unsupported socket type: #{uri.scheme} (program was compiled without openssl support)"
{% end %}
else
raise ArgumentError.new "Unsupported socket type: #{uri.scheme}"
Expand Down