rack-proxy 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7613a66b731bfac2c3f24a961757f359894ebdce
-  data.tar.gz: f69050ff757d137cebc48c7afcf385661e703d33
+SHA256:
+  metadata.gz: 228f3bf6e52dcd2bdcebf9c52bf1db47dfdc7179ed52cd3664e14cfd8df80db9
+  data.tar.gz: 6613d7f13087046d9ad6ee22e5afa56db6910145df427e42101f5aa491d3fe26
 SHA512:
-  metadata.gz: 9085c724256f803ecd1d232c41ef1811c560b4600759af715e44bbd06ab343f239a5c4db7c3da6c2ede58f8089bfdd00f76cda3f509f7e65ba99e5f6d4450c68
-  data.tar.gz: e158ad03e8ff6f415d39f12759659f0148d2463d85f9734b73000401ac20b395ab7226f2cc49a5db0c69e8175f807823a9d1502a151b1aeddaaf970049190ba4
+  metadata.gz: 151b04e286d1305d116cf743f00c6b811ed10fad0f24cf806b685a4e038a4dcf5c3b8f7e0dd0cf1e8aa95dd8c46763b0f8b114d36c668fdaabda541d48d5722a
+  data.tar.gz: 234ec48678c973b203cf00f256039c6e88f63c67c5e279e6f0ec17fc51de07022f7a3099dfe0efdaacf46808a0512cd9e16444823b6d616fdee08ae5572efbb2

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem 'rake'
 

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    rack-proxy (0.6.5)
+    rack-proxy (0.7.0)
       rack
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     power_assert (0.2.6)
     rack (2.0.3)
     rack-test (0.5.6)
       rack (>= 1.0)
-    rake (0.9.2.2)
+    rake (13.0.1)
     test-unit (3.1.5)
       power_assert
 
@@ -25,4 +25,4 @@ DEPENDENCIES
   test-unit
 
 BUNDLED WITH
-   1.16.0
+   1.17.2

data/README.md

@@ -6,7 +6,7 @@ Installation
 Add the following to your `Gemfile`:
 
 ```
-gem 'rack-proxy', '~> 0.6.4'
+gem 'rack-proxy', '~> 0.7.0'
 ```
 
 Or install:
@@ -17,7 +17,8 @@ gem install rack-proxy
 
 Use Cases
 ----
-Below are some examples of real world use cases for Rack-Proxy, done something interesting add the list below and send a PR.
+
+Below are some examples of real world use cases for Rack-Proxy. If you have done something interesting, add it to the list below and send a PR.
 
 * Allowing one app to act as central trust authority
   * handle accepting self-sign certificates for internal apps
@@ -25,7 +26,7 @@ Below are some examples of real world use cases for Rack-Proxy, done something i
   * avoiding CORs complications by proxying from same domain to another backend
 * subdomain based pass-through to multiple apps
 * Complex redirect rules
-   * redirect pages with different extensions (ex: `.php`) to another app 
+   * redirect pages with different extensions (ex: `.php`) to another app
    * useful for handling awkward redirection rules for moved pages
 * fan Parallel Requests: turning a single API request to [multiple concurrent backend requests](https://github.com/typhoeus/typhoeus#making-parallel-requests) & merging results.
 * inserting or stripping headers required or problematic for certain clients
@@ -76,7 +77,7 @@ class ForwardHost < Rack::Proxy
 
     # example of inserting an additional header
     headers["X-Foo"] = "Bar"
-    
+
     # if you rewrite env, it appears that content-length isn't calculated correctly
     # resulting in only partial responses being sent to users
     # you can remove it or recalculate it here
@@ -98,14 +99,14 @@ class TrustingProxy < Rack::Proxy
   def rewrite_env(env)
     env["HTTP_HOST"] = "self-signed.badssl.com"
 
-    # We are going to trust the self-signed SSL 
+    # We are going to trust the self-signed SSL
     env["rack.ssl_verify_none"] = true
     env
   end
 
   def rewrite_response(triplet)
     status, headers, body = triplet
-    
+
     # if you rewrite env, it appears that content-length isn't calculated correctly
     # resulting in only partial responses being sent to users
     # you can remove it or recalculate it here
@@ -130,12 +131,12 @@ Test with `require 'rack_proxy_examples/example_service_proxy'`
 ```ruby
 ###
 # This is an example of how to use Rack-Proxy in a Rails application.
-#  
+#
 # Setup:
-# 1. rails new test_app 
+# 1. rails new test_app
 # 2. cd test_app
 # 3. install Rack-Proxy in `Gemfile`
-#    a. `gem 'rack-proxy', '~> 0.6.3'`
+#    a. `gem 'rack-proxy', '~> 0.7.0'`
 # 4. install gem: `bundle install`
 # 5. create `config/initializers/proxy.rb` adding this line `require 'rack_proxy_examples/example_service_proxy'`
 # 6. run: `SERVICE_URL=http://guides.rubyonrails.org rails server`
@@ -157,7 +158,7 @@ class ExampleServiceProxy < Rack::Proxy
 
         # This is the only path that needs to be set currently on Rails 5 & greater
         env['PATH_INFO'] = ENV['SERVICE_PATH'] || '/configuring.html'
-        
+
         # don't send your sites cookies to target service, unless it is a trusted internal service that can parse all your cookies
         env['HTTP_COOKIE'] = ''
         super(env)
@@ -185,14 +186,14 @@ class RackPhpProxy < Rack::Proxy
     if request.path =~ %r{\.php}
       env["HTTP_HOST"] = ENV["HTTP_HOST"] ? URI(ENV["HTTP_HOST"]).host : "localhost"
       ENV["PHP_PATH"] ||= '/manual/en/tutorial.firstpage.php'
-       
+
       # Rails 3 & 4
       env["REQUEST_PATH"] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
       # Rails 5 and above
       env['PATH_INFO'] = ENV["PHP_PATH"] || "/php/#{request.fullpath}"
 
       env['content-length'] = nil
-      
+
       super(env)
     else
       @app.call(env)
@@ -201,7 +202,7 @@ class RackPhpProxy < Rack::Proxy
 
   def rewrite_response(triplet)
     status, headers, body = triplet
-    
+
     # if you proxy depending on the backend, it appears that content-length isn't calculated correctly
     # resulting in only partial responses being sent to users
     # you can remove it or recalculate it here
@@ -232,6 +233,71 @@ This will allow to run the other requests through the application and only proxy
 
 See tests for more examples.
 
+### SSL proxy for SpringBoot applications debugging
+
+Whenever you need to debug communication with external services with HTTPS protocol (like OAuth based) you have to be able to access to your local web app through HTTPS protocol too. Typical way is to use nginx or Apache httpd as a reverse proxy but it might be inconvinuent for development environment. Simple proxy server is a better way in this case. The only what we need is to unpack incoming SSL queries and proxy them to a backend. We can prepare minimal set of files to create autonomous proxy server.
+
+Create `config.ru` file:
+```ruby
+#
+# config.ru
+#
+require 'rack'
+require 'rack-proxy'
+
+class ForwardHost < Rack::Proxy
+  def rewrite_env(env)
+    env['HTTP_X_FORWARDED_HOST'] = env['SERVER_NAME']
+    env['HTTP_X_FORWARDED_PROTO'] = env['rack.url_scheme']
+    env
+  end
+end
+
+run ForwardHost.new(backend: 'http://localhost:8080')
+```
+
+Create `Gemfile` file:
+```ruby
+source "https://rubygems.org"
+
+gem 'thin'
+gem 'rake'
+gem 'rack-proxy'
+```
+
+Create `config.yml` file with configuration of web server `thin`:
+```yml
+---
+ssl: true
+ssl-key-file: keys/domain.key
+ssl-cert-file: keys/domain.crt
+ssl-disable-verify: false
+```
+
+Create 'keys' directory and generate SSL key and certificates files `domain.key` and `domain.crt`
+
+Run `bundle exec thin start` for running it with `thin`'s default port.
+
+Or use `sudo -E thin start -C config.yml -p 443` for running with default for `https://` port.
+
+Don't forget to enable processing of `X-Forwarded-...` headers on your application side. Just add following strings to your `resources/application.yml` file.
+```yml
+---
+server:
+  tomcat:
+    remote-ip-header: x-forwarded-for
+    protocol-header:  x-forwarded-proto
+  use-forward-headers:  true
+```
+
+Add some domain name like `debug.your_app.com` into your local `/etc/hosts` file like
+```
+127.0.0.1	debug.your_app.com
+```
+
+Next start the proxy and your app. And now you can access to your Spring application through SSL connection via `https://debug.your_app.com` URI in a browser.
+
+
 WARNING
 ----
 
@@ -242,4 +308,4 @@ Todos
 
 * Make the docs up to date with the current use case for this code: everything except streaming which involved a rather ugly monkey patch and only worked in 1.8, but does not work now.
 * Improve and validate requirements for Host and Path rewrite rules
-* Ability to inject logger and set log level
+* Ability to inject logger and set log level

data/lib/net_http_hacked.rb

@@ -4,7 +4,7 @@
 #
 # [status, headers, streamable_body]
 #
-# See http://github.com/aniero/rack-streaming-proxy
+# See http://github.com/zerowidth/rack-streaming-proxy
 # for alternative that uses additional process.
 #
 # BTW I don't like monkey patching either

data/lib/rack/proxy.rb

@@ -5,12 +5,12 @@ module Rack
 
   # Subclass and bring your own #rewrite_request and #rewrite_response
   class Proxy
-    VERSION = "0.6.5"
+    VERSION = "0.7.0"
 
     class << self
       def extract_http_request_headers(env)
         headers = env.reject do |k, v|
-          !(/^HTTP_[A-Z0-9_]+$/ === k) || v.nil?
+          !(/^HTTP_[A-Z0-9_\.]+$/ === k) || v.nil?
         end.map do |k, v|
           [reconstruct_header_name(k), v]
         end.inject(Utils::HeaderHash.new) do |hash, k_v|
@@ -46,11 +46,17 @@ module Rack
       else
         @app = app
       end
+
       @streaming = opts.fetch(:streaming, true)
       @ssl_verify_none = opts.fetch(:ssl_verify_none, false)
       @backend = URI(opts[:backend]) if opts[:backend]
       @read_timeout = opts.fetch(:read_timeout, 60)
       @ssl_version = opts[:ssl_version] if opts[:ssl_version]
+
+      @username = opts[:username] if opts[:username]
+      @password = opts[:password] if opts[:password]
+
+      @opts = opts
     end
 
     def call(env)
@@ -92,6 +98,9 @@ module Rack
         target_request.body_stream.rewind
       end
 
+      # Use basic auth if we have to
+      target_request.basic_auth(@username, @password) if @username && @password
+
       backend = env.delete('rack.backend') || @backend || source_request
       use_ssl = backend.scheme == "https"
       ssl_verify_none = (env.delete('rack.ssl_verify_none') || @ssl_verify_none) == true

data/lib/rack_proxy_examples/example_service_proxy.rb

@@ -1,11 +1,11 @@
 ###
 # This is an example of how to use Rack-Proxy in a Rails application.
-#  
+#
 # Setup:
-# 1. rails new test_app 
+# 1. rails new test_app
 # 2. cd test_app
 # 3. install Rack-Proxy in `Gemfile`
-#    a. `gem 'rack-proxy', '~> 0.6.3'`
+#    a. `gem 'rack-proxy', '~> 0.7.0'`
 # 4. install gem: `bundle install`
 # 5. create `config/initializers/proxy.rb` adding this line `require 'rack_proxy_examples/example_service_proxy'`
 # 6. run: `SERVICE_URL=http://guides.rubyonrails.org rails server`
@@ -27,7 +27,7 @@ class ExampleServiceProxy < Rack::Proxy
 
         # This is the only path that needs to be set currently on Rails 5 & greater
         env['PATH_INFO'] = ENV['SERVICE_PATH'] || '/configuring.html'
-        
+
         # don't send your sites cookies to target service, unless it is a trusted internal service that can parse all your cookies
         env['HTTP_COOKIE'] = ''
         super(env)

data/rack-proxy.gemspec

@@ -6,14 +6,13 @@ Gem::Specification.new do |s|
   s.name        = "rack-proxy"
   s.version     = Rack::Proxy::VERSION
   s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
   s.authors     = ["Jacek Becela"]
   s.email       = ["jacek.becela@gmail.com"]
   s.homepage    = "https://github.com/ncr/rack-proxy"
   s.summary     = %q{A request/response rewriting HTTP proxy. A Rack app.}
   s.description = %q{A Rack app that provides request/response rewriting proxy capabilities with streaming.}
 
-  s.rubyforge_project = "rack-proxy"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/test/rack_proxy_test.rb

@@ -6,7 +6,7 @@ class RackProxyTest < Test::Unit::TestCase
     attr_accessor :host
 
     def rewrite_env(env)
-      env["HTTP_HOST"] = self.host || 'www.trix.pl'
+      env["HTTP_HOST"] = self.host || 'example.com'
       env
     end
   end
@@ -18,14 +18,15 @@ class RackProxyTest < Test::Unit::TestCase
   def test_http_streaming
     get "/"
     assert last_response.ok?
-    assert_match(/Jacek Becela/, last_response.body)
+
+    assert_match(/Example Domain/, last_response.body)
   end
 
   def test_http_full_request
     app(:streaming => false)
     get "/"
     assert last_response.ok?
-    assert_match(/Jacek Becela/, last_response.body)
+    assert_match(/Example Domain/, last_response.body)
   end
 
   def test_http_full_request_headers
@@ -89,12 +90,14 @@ class RackProxyTest < Test::Unit::TestCase
       'NOT-HTTP-HEADER' => 'test-value',
       'HTTP_ACCEPT' => 'text/html',
       'HTTP_CONNECTION' => nil,
-      'HTTP_CONTENT_MD5' => 'deadbeef'
+      'HTTP_CONTENT_MD5' => 'deadbeef',
+      'HTTP_HEADER.WITH.PERIODS' => 'stillmooing'
     }
 
     headers = proxy_class.extract_http_request_headers(env)
     assert headers.key?('ACCEPT')
     assert headers.key?('CONTENT-MD5')
+    assert headers.key?('HEADER.WITH.PERIODS')
     assert !headers.key?('CONNECTION')
     assert !headers.key?('NOT-HTTP-HEADER')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-proxy
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Jacek Becela
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -81,9 +81,10 @@ files:
 - test/rack_proxy_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ncr/rack-proxy
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rack-proxy
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A request/response rewriting HTTP proxy. A Rack app.
 test_files: