Add HTTP::Server#bind(URI) by straight-shoota · Pull Request #6500 · crystal-lang/crystal

straight-shoota · 2018-08-07T12:11:15Z

This PR was originally included in #5776 but it had been removed as a separate feature. Now that #5959 and #5960 are merged, it is ready to be reviewed. The original description can be found in #2735 (comment)

The URI can be parsed from a string and contains the protocol and address to bind to (plus optional additional configuration for SSL context). This allows for a uniform and easily exchangeable specification in config files.

server.bind "tcp://127.0.0.1:80"
server.bind "unix:///tmp/server.sock"
server.bind "ssl://127.0.0.1:443?key=private.key&cert=certificate.cert&ca=ca.crt"

Along the way this also adds Socket::{IP,UNIX,}Address.parse and OpenSSL::SSL::Context::{Client,Server}.parse to implement the individual component parsers.

ghost · 2018-08-07T12:32:54Z

src/socket/address.cr

+    # It expects the URI to include `<scheme>://<path>` where `scheme` as well
+    # as any additional URI components (such as `fragment` or `query`) are ignored.
+    #
+    # If `host` is not empty, it will be prepended to `path` to form a relatve


Typo: "relatve"

ghost · 2018-08-07T12:34:52Z

src/socket/address.cr

+    # Parses a `Socket::IPAddress` from an URI.
+    #
+    # It expects the URI to include `<scheme>://<host>:<port>` where `scheme` as
+    # well asa ny additional URI components (such as `path` or `query`) are ignored.


Typo: "asa ny"

bcardiff · 2018-08-07T13:27:50Z

src/http/server.cr

+      address = Socket::IPAddress.parse(uri)
+      context = OpenSSL::SSL::Context::Server.parse(HTTP::Params.parse(uri.query || ""))
+
+      bind_ssl(address, context)


Checking for flag?(:without_openssl) is missing here. At least with a duplication of the Unsupported socket type message or something more specific.

bcardiff · 2018-08-07T13:29:43Z

src/openssl/ssl/context.cr

+    #
+    # context = OpenSSL::SSL::Context::Client.parse({"key" => "private.key", "cert" => "certificate.crt", "ca" => "ca.pem"})
+    # ```
+    def self.parse(params) : self


I would expect T.parse to be from String -> T. I would suggest T.from_hash for this method.

bcardiff · 2018-08-07T13:30:55Z

src/http/server.cr

+    bind(URI.parse(uri))
+  end
+
+  # ditto


Warn: mixed ditto and :ditto: in the PR

bcardiff · 2018-08-07T13:32:27Z

src/socket/address.cr

+    # Socket::IPAddress.parse("tcp://127.0.0.1:8080") # => Socket::IPAddress.new("127.0.0.1", 8080)
+    # Socket::IPAddress.parse("udp://[::1]:8080")     # => Socket::IPAddress.new("::1", 8080)
+    # ```
+    def self.parse(uri : URI) : IPAddress


Somehow I'm ok with T.parse: URI -> T 😹 , but not with Hash.

URI is essentially a structured string...

Sija · 2018-08-07T17:55:06Z

src/openssl/ssl/context.cr

+    #
+    # Params:
+    #
+    # * `key` *(required*): Path to private key file. See `#private_key=`.


*(required*) -> (*required*)
ditto below

The URI can be parsed from a string and contains the protocol and address to bind to (plus optional additional configuration for SSL context). This allows for a uniform and easily exchangable specificitation in config files.

sdogruyol

Thank you @straight-shoota 👍

bcardiff · 2018-08-10T13:32:19Z

@straight-shoota

The sample in the PR description mention ssh:// as a protocol, but it should be ssl:// probably.
The port used is not the default 443, although any port is supported using defaults seems better for lazy copy/pasting.

server.bind "ssl://127.0.0.1:443?key=private.key&cert=certificate.cert&ca=ca.crt

Or am I missing something?

straight-shoota · 2018-08-10T13:34:45Z

You're absolute right.

jhass · 2018-08-10T13:47:32Z

Bold proposal: Lets ditch ssl:// and only support tls://

straight-shoota · 2018-08-10T13:54:09Z

All the classes in Crystal are called SSL... so I'd at least keep support for ssl://. But adding tls:// and using it as default (in examples) sounds good.

jhass · 2018-08-10T14:01:28Z

No, they're called OpenSSL, because they follow the name of the library they wrap. On the other hand we already renamed Http's ssl flags to tls at some point.

straight-shoota · 2018-08-10T14:31:01Z

No, I mean inside the OpenSSL namespace (which is obviously named after the library), there is OpenSSL::SSL.

But I'd suggest to discuss this further in a new dedicated issue...

jhass · 2018-08-10T14:46:58Z

I wouldn't be too opposed to renaming that to TLS too :P

RX14 · 2018-08-11T22:20:08Z

OpenSSL namespace will eventually go and be replaced with a TLS namespace with a much better API - which can be supported by libraries which aren't openssl. So +1 to supporting tls but supporting ssl too is fine.

straight-shoota · 2018-08-12T19:02:36Z

I'll work on that. Waiting for #6530 to be merged.

crisward · 2018-08-14T07:24:33Z

I realise this has already been merged, but FWIW I would have expected to be able to bind to do server.bind "http://... and server.bind "https://... (as aliases for tcp and ssl). Apologies if this has already been discussed somewhere else. Just saw this in the 0.26 release post. Congrats BTW on the new release!

straight-shoota · 2018-08-14T07:51:57Z

No, this wasn't discussed before explicitly. And I admit that this might look a bit surprising at first.

The reason is that HTTP and HTTPS are application protocols - and HTTP::Server naturally speaks HTTP(S) on all connections. server.bind "http://[...]" would only tell to use the HTTP protocol (which is obvious since this is an HTTP server).

The URIs used by bind are meant to specify the transport protocol (TCP, TCP+TLS or UNIX socket).
This is probably most clear when looking at tls://127.0.0.1:443?key=private.key&cert=certificate.cert&ca=ca.crt. This URI configures a TCP+TLS server and is not an HTTP resource.

The same transport protocol schemes are also used by similar applications such as Puma or Nginx.

crisward · 2018-08-14T07:54:45Z

Wasn't aware of other servers using these protocols, makes sense. Thanks for the clarification.

Extract socket/address_spec.cr

8fcc652

straight-shoota mentioned this pull request Aug 7, 2018

Refactor HTTP::Server to bind to multiple addresses #5776

Merged

ghost reviewed Aug 7, 2018

View reviewed changes

Add Socket::Address.parse

3f4b185

straight-shoota force-pushed the jm/feature/http-server-parse-address branch from 8ce0453 to 9e23371 Compare August 7, 2018 12:56

bcardiff requested changes Aug 7, 2018

View reviewed changes

straight-shoota force-pushed the jm/feature/http-server-parse-address branch from 9e23371 to d517ed6 Compare August 7, 2018 14:10

Sija reviewed Aug 7, 2018

View reviewed changes

straight-shoota added 2 commits August 7, 2018 23:16

Add OpenSSL::SSL::Context::Client.from_hash

a500478

Add HTTP::Server#bind(URI)

0620467

The URI can be parsed from a string and contains the protocol and address to bind to (plus optional additional configuration for SSL context). This allows for a uniform and easily exchangable specificitation in config files.

straight-shoota force-pushed the jm/feature/http-server-parse-address branch from d517ed6 to 0620467 Compare August 7, 2018 21:24

bcardiff approved these changes Aug 7, 2018

View reviewed changes

bcardiff mentioned this pull request Aug 7, 2018

Update to crystal 0.26.0 kemalcr/kemal#479

Closed

sdogruyol approved these changes Aug 8, 2018

View reviewed changes

sdogruyol added kind:feature topic:stdlib labels Aug 8, 2018

sdogruyol merged commit 928a738 into crystal-lang:master Aug 8, 2018

sdogruyol added this to the 0.26.0 milestone Aug 8, 2018

straight-shoota deleted the jm/feature/http-server-parse-address branch August 8, 2018 08:28

bcardiff mentioned this pull request Aug 8, 2018

Update to crystal 0.26 amberframework/amber#922

Closed

vladfaust mentioned this pull request Aug 9, 2018

Update to new Crystal onyxframework/http#31

Closed

3 tasks

straight-shoota mentioned this pull request Aug 13, 2018

Add tls scheme to HTTP::Server#bind and rename HTTP::Server#bind_ssl #6533

Merged

Uh oh!

Conversation

straight-shoota commented Aug 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sdogruyol left a comment

Choose a reason for hiding this comment

Uh oh!

bcardiff commented Aug 10, 2018

Uh oh!

straight-shoota commented Aug 10, 2018

Uh oh!

jhass commented Aug 10, 2018

Uh oh!

straight-shoota commented Aug 10, 2018

Uh oh!

jhass commented Aug 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

straight-shoota commented Aug 10, 2018

Uh oh!

jhass commented Aug 10, 2018

Uh oh!

RX14 commented Aug 11, 2018

Uh oh!

straight-shoota commented Aug 12, 2018

Uh oh!

crisward commented Aug 14, 2018

Uh oh!

straight-shoota commented Aug 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

crisward commented Aug 14, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

straight-shoota commented Aug 7, 2018 •

edited

Loading

jhass commented Aug 10, 2018 •

edited

Loading

straight-shoota commented Aug 14, 2018 •

edited

Loading