Handle URI Query Parameters #534

Tensho · 2017-12-20T10:09:39Z

Related Issues and PRs:

Tensho · 2017-12-20T10:11:12Z

spec/spec_helper.rb


-require "amq/protocol/version"
 puts "Using Ruby #{RUBY_VERSION}, amq-protocol #{AMQ::Protocol::VERSION}"


Maybe it's more relevant to show SHA of the amq-protocol master branch here instead of version.

What is there is no "SHA" because we don't run with a local clone?

As far as CI grabs amq-protocol master branch before tests run, it'd be nice to see exact commit SHA. Probably it'd bring a little benefit locally, but I'd prefer to control deps with bundle config --local local.amq-protocol ../amq-protocol. In this case I'm free to specify any path and don't create symlinks and use #custom_gem extension to #gem.

We can do that in .travis.yml.

Tensho · 2017-12-20T10:12:07Z

spec/higher_level_api/integration/connection_spec.rb

@@ -319,9 +343,9 @@
          password: "bunny_password",
          vhost: "bunny_testbed",
          ssl:                 true,
-          ssl_cert:            "spec/tls/client_cert.pem",


:ssl context test data setup is outdated, so I normalized it with :tls context.

Tensho · 2017-12-20T10:12:44Z

spec/higher_level_api/integration/connection_spec.rb

+      end
+
+      it "parses extra connection parameters" do
+        # session.start # raises "OpenSSL::SSL::SSLError: hostname "127.0.0.1" does not match the server certificate"


https://groups.google.com/d/msg/rabbitmq-users/V4fCdASYT1I/75TG_VhVCwAJ

I responded there.

Inspecting the transport suggests that it has :ssl=>0.

Tensho · 2017-12-20T10:13:33Z

lib/bunny/session.rb

@@ -464,7 +464,7 @@ def blocked?
    # @param [String] uri amqp or amqps URI to parse
    # @return [Hash] Parsed URI as a hash
    def self.parse_uri(uri)
-      AMQ::Settings.parse_amqp_url(uri)
+      AMQ::Settings.configure(uri)


❗️ Very important change that enables defaults merge for the parsed parameters.

Tensho · 2017-12-20T12:55:59Z

Strange things happen at CI, I can't understand how Bunny::Session#ssl? may return 0?
https://travis-ci.org/ruby-amqp/bunny/builds/319109274

Failures:

  1) Bunny::Session initialized via connection URI when URI contains query parameters parses extra connection parameters

     Failure/Error: expect(session.ssl?).to eq(true)

       expected: true
            got: 0

       (compared using ==)
     # ./spec/higher_level_api/integration/connection_spec.rb:66:in `block (4 levels) in <top (required)>'

Finished in 3 minutes 0 seconds (files took 0.2697 seconds to load)

198 examples, 1 failure

Failed examples:

rspec ./spec/higher_level_api/integration/connection_spec.rb:55 # Bunny::Session initialized via connection URI when URI contains query parameters parses extra connection parameters

michaelklishin · 2017-12-20T16:01:08Z

I get several TLS connection test suite failures in my standard testing environment, will take a look later in the week.

michaelklishin · 2017-12-20T16:05:31Z

lib/bunny/session.rb

@@ -191,7 +191,7 @@ def initialize(connection_string_or_opts = ENV['RABBITMQ_URL'], optz = Hash.new)

      client_props         = opts[:properties] || opts[:client_properties] || {}
      @client_properties   = DEFAULT_CLIENT_PROPERTIES.merge(client_props)
-      @mechanism           = normalize_auth_mechanism(opts.fetch(:auth_mechanism, "PLAIN"))
+      @mechanism           = (opts[:auth_mechanism] || []).first || "PLAIN"


If we modify this at all (not sure why it's a part of this PR but OK), normalize_auth_mechanism should then be deleted.

Yeah, nice spot, I forgot to remove the method. Basically auth_mechanism confused me too. According to specification client may specify several auth mechanism, so I decided to adheer in amq-protocol. But when I proceed with bunny, I realised that session initialization expects a single string value, not array. TBH, I didn't have time to analyze, how several auth mechanisms should be handled properly, so i decided to adheer bunny fallback to "PLAIN" for array case.

Let me recheck, maybe normalize_auth_mechanism is OK for array default value, I don't remember exact reason, why I replaced it...

michaelklishin · 2017-12-20T16:40:37Z

So far everything points at the fact that @opts in Bunny::Session in your test have :ssl => 0. I pushed Tensho-init-params with my changes that were necessary to make the tests except for one (the same as yours) pass for me.

Please open a new PR based on that branch once you figure out what's going on in the newly added test example. Thanks.

michaelklishin · 2017-12-20T16:47:33Z

So the issue comes from AMQ::Settings.configure:

require "pp"

pp AMQ::Settings.configure("amqps://bunny_gem:bunny_password@/bunny_testbed?heartbeat=10&connection_timeout=100&channel_max=1000&verify=false&cacertfile=spec/tls/ca_certificate.pem&certfile=spec/tls/client_certificate.pem&keyfile=spec/tls/client_key.pem")

produces

{:host=>"127.0.0.1",
 :port=>5671,
 :user=>"bunny_gem",
 :pass=>"bunny_password",
 :vhost=>"bunny_testbed",
 :ssl=>0,
 :frame_max=>131072,
 :heartbeat=>10,
 :connection_timeout=>100,
 :channel_max=>1000,
 :auth_mechanism=>nil,
 :verify=>"false",
 :fail_if_no_peer_cert=>nil,
 :cacertfile=>"spec/tls/ca_certificate.pem",
 :certfile=>"spec/tls/client_certificate.pem",
 :keyfile=>"spec/tls/client_key.pem",
 :scheme=>"amqps"}

References #534.

carlhoerberg · 2018-01-10T14:23:50Z

lib/bunny/transport.rb

@@ -349,8 +353,8 @@ def prepare_tls_context(opts)
      @tls_key               = tls_key_from(opts)
      @tls_certificate_store = opts[:tls_certificate_store]

-      @tls_ca_certificates   = opts.fetch(:tls_ca_certificates, default_tls_certificates)
-      @verify_peer           = (opts[:verify_ssl] || opts[:verify_peer])
+      @tls_ca_certificates   = tls_ca_certificates_paths_from(opts) || default_tls_certificates


I susptect that tls_ca_certificates_paths_from will never evaluate to nil, so the default_tls_certificates will never be used

You are totally right, what do you think if we call Array() out of #tls_ca_certificates_paths_from method?

@tls_ca_certificates = Array(tls_ca_certificates_paths_from(opts) || default_tls_certificates)

Should I create a PR with fix?

Tensho added 2 commits December 20, 2017 12:08

Handle URI query parameters

3914c06

Increase time interval for rabbitmq server start in container

7ddca23

Tensho commented Dec 20, 2017

View reviewed changes

Spec helper cleanup

61ffc6f

Tensho force-pushed the init-params branch from 1b454e1 to 61ffc6f Compare December 20, 2017 10:51

Tensho mentioned this pull request Dec 20, 2017

URI Query Parameters ruby-amqp/rubybunny.info#46

Merged

michaelklishin reviewed Dec 20, 2017

View reviewed changes

michaelklishin closed this Dec 20, 2017

michaelklishin reopened this Dec 20, 2017

michaelklishin added a commit that referenced this pull request Dec 20, 2017

Enforce these values to be boolean

ce31d22

References #534.

michaelklishin merged commit 61ffc6f into ruby-amqp:master Dec 20, 2017

michaelklishin mentioned this pull request Dec 20, 2017

AMQ::Protocol.configure can return a bogus ssl key value that's not a boolean ruby-amqp/amq-protocol#71

Closed

Tensho deleted the init-params branch December 20, 2017 20:33

This was referenced Dec 21, 2017

Extend URI Parsing Specs #535

Merged

AMQP doesn't share AMQ::Settings ruby-amqp/amqp#236

Closed

michaelklishin mentioned this pull request Jan 10, 2018

Default CA store doesn't work #539

Closed

carlhoerberg reviewed Jan 10, 2018

View reviewed changes

michaelklishin mentioned this pull request Jan 24, 2018

Problem with verify_peer: false #541

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle URI Query Parameters #534

Handle URI Query Parameters #534

Tensho commented Dec 20, 2017

Tensho Dec 20, 2017

michaelklishin Dec 20, 2017

Tensho Dec 20, 2017

michaelklishin Dec 20, 2017

Tensho Dec 20, 2017 •

edited

Loading

Tensho Dec 20, 2017

michaelklishin Dec 20, 2017

michaelklishin Dec 20, 2017

Tensho Dec 20, 2017

Tensho commented Dec 20, 2017 •

edited

Loading

michaelklishin commented Dec 20, 2017

michaelklishin Dec 20, 2017

Tensho Dec 20, 2017

michaelklishin commented Dec 20, 2017

michaelklishin commented Dec 20, 2017 •

edited

Loading

carlhoerberg Jan 10, 2018

Tensho Jan 10, 2018 •

edited

Loading

carlhoerberg Jan 10, 2018


		require "amq/protocol/version"
		puts "Using Ruby #{RUBY_VERSION}, amq-protocol #{AMQ::Protocol::VERSION}"

Handle URI Query Parameters #534

Handle URI Query Parameters #534

Conversation

Tensho commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho commented Dec 20, 2017 • edited Loading

michaelklishin commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelklishin commented Dec 20, 2017

michaelklishin commented Dec 20, 2017 • edited Loading

Choose a reason for hiding this comment

Tensho Jan 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho Dec 20, 2017 •

edited

Loading

Tensho commented Dec 20, 2017 •

edited

Loading

michaelklishin commented Dec 20, 2017 •

edited

Loading

Tensho Jan 10, 2018 •

edited

Loading