ritm 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f1109dfaeac6ea30bcc246368fbfa4588fd2dd2
-  data.tar.gz: 22cabc4371ed6a45093b03e094bc2aa433a4362c
+  metadata.gz: e057b05ae3168ee5ff218a8c6ce01c46184e523c
+  data.tar.gz: 91438a6194dce60e5dc4827d76c5a5056e8db1c5
 SHA512:
-  metadata.gz: a898d03940990af84ec7cab9cb172ebc28580179e86965f7be9b0ba806f9a5e51e6ded0e2c6863b91c678907403f00fd4ec442e6bce97faaded946b0a5b888e4
-  data.tar.gz: d4b1462c4e80f8e8d14acc30e0452bbbf446d43df1899e6f9e1a61cb9dc607132717240abad80ddbd4b82ff19bcf566fd720d807cf70ff1a866d180d4dd337e7
+  metadata.gz: 71cc70b613e2d72c8914d8ce896f7baea3f11c85623490a915a7c88160303572df4a4a429b2651ec803c8138c2b586ac0cf998a71c0ce4bddd659c0d5b56e749
+  data.tar.gz: b2bcb23777a6c8cbaab3672c2f2954818d4d602cdfc6e08f45c289a118832ae735a6743727e9eba3e79d4240e249d6a89ba4d0abff8aa585dff20d3d62a5eb8f

data/lib/ritm/configuration.rb

@@ -2,7 +2,6 @@ require 'dot_hash'
 require 'set'
 
 module Ritm
-  # Global Ritm settings
   class Configuration
     def default_settings # rubocop:disable Metrics/MethodLength
       {
@@ -60,12 +59,10 @@ module Ritm
       end
     end
 
-    # Re-enable interception
     def enable
       @settings.intercept[:enabled] = true
     end
 
-    # Disable interception
     def disable
       @settings.intercept[:enabled] = false
     end

data/lib/ritm/helpers/encodings.rb

@@ -1,7 +1,6 @@
 require 'zlib'
 
 module Ritm
-  # ENCODER/DECODER of HTTP content
   module Encodings
     ENCODINGS = %i[identity gzip deflate].freeze
 
@@ -34,7 +33,6 @@ module Ritm
     class << self
       private
 
-      # Returns data unchanged. Identity is the default value of Accept-Encoding headers.
       def identity(data)
         data
       end

data/lib/ritm/interception/http_forwarder.rb

@@ -1,6 +1,6 @@
 require 'faraday'
-
 require 'ritm/interception/intercept_utils'
+require 'webrick/cookie'
 
 module Ritm
   # Forwarder that acts as a WEBrick <-> Faraday adaptor: Works this way:
@@ -13,6 +13,21 @@ module Ritm
   #
   # Besides the possible modifications to be done by interceptors there might be automated globally configured
   # transformations like header stripping/adding.
+
+  class ParamEncoder
+    def encode(params)
+      pairs = params.map { |k, v| "#{k}=#{v}" }
+      pairs.join('&')
+    end
+
+    def decode(query)
+      query.split('&').each_with_object({}) do |param, params|
+        k, v = param.split('=')
+        params[k] = v
+      end
+    end
+  end
+
   class HTTPForwarder
     include InterceptUtils
 
@@ -21,9 +36,11 @@ module Ritm
       @response_interceptor = response_interceptor
       @config = context_config
       # TODO: make SSL verification a configuration setting
-      @client = Faraday.new(ssl: { verify: false }) do |conn|
+      @client = Faraday.new(
+        ssl: { verify: false },
+        request: { params_encoder: ParamEncoder.new }
+      ) do |conn|
         conn.adapter :net_http
-        conn.proxy = @config.misc.upstream_proxy unless @config.misc.upstream_proxy.nil?
       end
     end
 
@@ -39,11 +56,10 @@ module Ritm
     def faraday_forward(request)
       req_method = request.request_method.downcase
       @client.send req_method do |req|
+        req.options[:proxy] = @config.misc.upstream_proxy
         req.url request.request_uri
         req.body = request.body
-        request.header.each do |name, value|
-          req.headers[name] = value
-        end
+        request.header.each { |name, value| req.headers[name] = value }
       end
     end
 
@@ -51,7 +67,12 @@ module Ritm
       webrick_response.status = faraday_response.status
       webrick_response.body = faraday_response.body
       faraday_response.headers.each do |name, value|
-        webrick_response[name] = value
+        case name
+        when 'set-cookie'
+          WEBrick::Cookie.parse_set_cookies(value).each { |cookie| webrick_response.cookies << cookie }
+        else
+          webrick_response[name] = value
+        end
       end
       webrick_response
     end

data/lib/ritm/interception/request_interceptor_servlet.rb

@@ -1,12 +1,11 @@
 require 'webrick'
-require 'ritm/interception/http_forwarder'
 
 module Ritm
   # Actual implementation of the SSL Reverse Proxy service (decoupled from the certificate handling)
   class RequestInterceptorServlet < WEBrick::HTTPServlet::AbstractServlet
-    def initialize(server, request_interceptor, response_interceptor, conf)
+    def initialize(server, forwarder)
       super server
-      @forwarder = HTTPForwarder.new(request_interceptor, response_interceptor, conf)
+      @forwarder = forwarder
     end
 
     def service(request, response)

data/lib/ritm/main.rb

@@ -1,6 +1,5 @@
 require 'ritm/session'
 
-# Main module
 module Ritm
   GLOBAL_SESSION = Session.new
 

data/lib/ritm/proxy/cert_signing_https_server.rb

@@ -9,7 +9,7 @@ module Ritm
   module Proxy
     # Patches WEBrick::HTTPServer SSL context creation to get
     # a callback on the 'Client Helo' step of the SSL-Handshake if SNI is specified
-    # So we can create self-signed certificates on the fly
+    # So RitM can create self-signed certificates on the fly
     class CertSigningHTTPSServer < WEBrick::HTTPServer
       # Override
       def setup_ssl_context(config)

data/lib/ritm/proxy/launcher.rb

@@ -2,6 +2,7 @@ require 'ritm/proxy/ssl_reverse_proxy'
 require 'ritm/proxy/proxy_server'
 require 'ritm/certs/ca'
 require 'ritm/interception/handlers'
+require 'ritm/interception/http_forwarder'
 
 module Ritm
   module Proxy
@@ -13,13 +14,11 @@ module Ritm
         build_proxy
       end
 
-      # Starts the service (non blocking)
       def start
         @https.start_async
         @http.start_async
       end
 
-      # Stops the service
       def shutdown
         @https.shutdown
         @http.shutdown
@@ -32,8 +31,10 @@ module Ritm
         ssl_proxy_host = @conf.ssl_reverse_proxy.bind_address
         ssl_proxy_port = @conf.ssl_reverse_proxy.bind_port
         @https_forward = "#{ssl_proxy_host}:#{ssl_proxy_port}"
-        @request_interceptor = default_request_handler(session)
-        @response_interceptor = default_response_handler(session)
+
+        request_interceptor = default_request_handler(session)
+        response_interceptor = default_response_handler(session)
+        @forwarder = HTTPForwarder.new(request_interceptor, response_interceptor, @conf)
 
         crt_path = @conf.ssl_reverse_proxy.ca.pem
         key_path = @conf.ssl_reverse_proxy.ca.key
@@ -47,17 +48,14 @@ module Ritm
                                              Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
                                              https_forward: @https_forward,
                                              ProxyVia: nil,
-                                             request_interceptor: @request_interceptor,
-                                             response_interceptor: @response_interceptor,
+                                             forwarder: @forwarder,
                                              ritm_conf: @conf)
       end
 
       def build_reverse_proxy
         @https = Ritm::Proxy::SSLReverseProxy.new(@conf.ssl_reverse_proxy.bind_port,
                                                   @certificate,
-                                                  @conf,
-                                                  request_interceptor: @request_interceptor,
-                                                  response_interceptor: @response_interceptor)
+                                                  @forwarder)
       end
 
       def ca_certificate(pem, key)

data/lib/ritm/proxy/proxy_server.rb

@@ -1,15 +1,12 @@
 require 'webrick'
 require 'webrick/httpproxy'
 require 'ritm/helpers/patches'
-require 'ritm/interception/intercept_utils'
 
 module Ritm
   module Proxy
     # Proxy server that accepts request and response intercept handlers for HTTP traffic
     # HTTPS traffic is redirected to the SSLReverseProxy for interception
     class ProxyServer < WEBrick::HTTPProxyServer
-      include InterceptUtils
-
       def start_async
         trap(:TERM) { shutdown }
         trap(:INT) { shutdown }
@@ -28,20 +25,7 @@ module Ritm
       def proxy_service(req, res)
         # Proxy Authentication
         proxy_auth(req, res)
-
-        # Request modifier handler
-        intercept_request(@config[:request_interceptor], req, @config[:ritm_conf].intercept.request)
-
-        begin
-          send("do_#{req.request_method}", req, res)
-        rescue NoMethodError
-          raise WEBrick::HTTPStatus::MethodNotAllowed, "unsupported method `#{req.request_method}'."
-        rescue StandardError => err
-          raise WEBrick::HTTPStatus::ServiceUnavailable, err.message
-        end
-
-        # Response modifier handler
-        intercept_response(@config[:response_interceptor], req, res, @config[:ritm_conf].intercept.response)
+        @config[:forwarder].forward(req, res)
       end
 
       # Override

data/lib/ritm/proxy/ssl_reverse_proxy.rb

@@ -11,9 +11,8 @@ module Ritm
       # Creates a HTTPS server with the given settings
       # @param port [Fixnum]: TCP port to bind the service
       # @param ca [Ritm::CA]: The certificate authority used to sign fake server certificates
-      # @param request_interceptor [Proc]: If given, it will be invoked before proxying the request
-      # @param response_interceptor [Proc]: If give, it will be invoked before sending back the response
-      def initialize(port, ca, conf, request_interceptor: nil, response_interceptor: nil)
+      # @param forwarder [Ritm::HTTPForwarder]: Forwards http traffic with interception
+      def initialize(port, ca, forwarder)
         @ca = ca
         default_vhost = 'localhost'
         @server = CertSigningHTTPSServer.new(Port: port,
@@ -21,8 +20,7 @@ module Ritm
                                              Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
                                              ca: ca,
                                              **vhost_settings(default_vhost))
-
-        @server.mount '/', RequestInterceptorServlet, request_interceptor, response_interceptor, conf
+        @server.mount '/', RequestInterceptorServlet, forwarder
       end
 
       def start_async

data/lib/ritm/version.rb

@@ -1,4 +1,3 @@
-# Ritm version
 module Ritm
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ritm
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Sebastián Tello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: certificate_authority
@@ -142,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement