static-rails 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3159e387c25a9742f063230f554490e70d41e4be4a318eed738e26480c048cb6
-  data.tar.gz: da86a266cb8bd5559e5ec71d90a84c0ca0539449d8f7259d1ed0654abe3a0c64
+  metadata.gz: 7c20abb5a4b37f323a10e55d18ad7a65d0cb4219bf77bf1a9869d2ed0ab8f446
+  data.tar.gz: 3ca5e505c0b05eb36846153d0cb6b05947f3359eb1a92c6cfb477d99fc368484
 SHA512:
-  metadata.gz: 4be0b00df5deaacc0c414bf743b78b5feff4f589e44b93378d5de40458e9f56733c83315f9e58cfa9d08c0627d26193994bbec01f86b18924e980e7dc8271f3b
-  data.tar.gz: 1c42430d7193cf13eb21579f5647ecd53f07e010092c2056bef17848aed64a588c8c5919241760fb867e67734d2878559f127c6347b082fe5ef4c77387cc6454
+  metadata.gz: eb489b95dfc77757c3e72e3612c7d5fa021393684b230de937355e230778d371468922e1d5277d3d0ef819b106d5ab07db09dc7284b9a6eefe1098baec9dc58e
+  data.tar.gz: cbba26724c30fcfec192893973d5ec83de0d50ab719b05c842e457d504319d4658b65688f154566091e8a3bd50c27e8cc7df5bd5ac1645e73b67a821e866150a

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 0.0.10
+
+* Change default `cache-control` header for static assets being served from disk
+  from `no-cache` to `"public; max-age=31536000"`
+
+## 0.0.9
+
+* When using CSRF protection, the artificial path info will now be
+  "__static_rails__" instead of a random string, to make logs appear cleaner
+* Attempt to guard against future internal changes to Rails' request forgery
+  protection by adding `method_missing` that calls through
+
+## 0.0.8
+
+* Add support for the [CSRF
+  changes](https://github.com/rails/rails/commit/358ff18975f26e820ea355ec113ffc5228e59af8) in Rails 6.0.3.1
+
+## 0.0.7
+
+* Ensure that CSRF tokens are valid, at the cost of some performance and
+  reliance on additional Rails internals. As a result CSRF cookie setting is now
+  disabled by default [#6](https://github.com/testdouble/static-rails/pull/6)
+
+## 0.0.6
+
+* Fix an issue where `ActionDispatch::FileHandler` won't be loaded in the event
+  that static-rails is serving compiled assets but Rails is not
+
 ## 0.0.5
 
 * Add a site option `compile_404_file_path` to specify a file to be used as a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    static-rails (0.0.5)
+    static-rails (0.0.10)
       rack-proxy (~> 0.6)
       railties (>= 5.0.0)
 
@@ -32,19 +32,18 @@ GEM
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     erubi (1.9.0)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
-    parser (2.7.1.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     rack (2.2.2)
     rack-proxy (0.6.5)
@@ -64,26 +63,30 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    standard (0.2.5)
-      rubocop (~> 0.80.1)
-      rubocop-performance (~> 1.5.2)
+    standard (0.4.7)
+      rubocop (~> 0.85.0)
+      rubocop-performance (~> 1.6.0)
     thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
     zeitwerk (2.3.0)
 
 PLATFORMS

data/README.md

@@ -84,13 +84,14 @@ overall behavior of the gem itself, across all your static sites:
   `proxy_requests` is true, that the gem will wait for a response from a static
   site's server on any given request before timing out and raising an error
 
-* **config.set_csrf_token_cookie** (Default: `true`) when true, the gem's
+* **config.set_csrf_token_cookie** (Default: `false`) when true, the gem's
   middleware will set a cookie named `_csrf_token` with each request of your
   static site. You can use this to set the `'x-csrf-token'` header on any
   requests from your site back to routes hosted by the Rails app that are
   [protected from CSRF
   forgery](https://guides.rubyonrails.org/security.html#cross-site-request-forgery-csrf)
-  (if you're not using Rails' cookie store for sessions, turn this off)
+  (if you're not using Rails' cookie store for sessions or you're okay with API
+  calls bypassing Rails CSRF, leave this off)
 
 ### Configuring your static sites themselves
 

data/lib/generators/templates/static.rb

@@ -12,7 +12,7 @@ StaticRails.config do |config|
   # When true, both the proxy & static asset middleware will set a cookie
   #   named "_csrf_token" to the Rails CSRF token, allowing any client-side
   #   API requests to take advantage of Rails' request forgery protection
-  # config.set_csrf_token_cookie = true
+  # config.set_csrf_token_cookie = false
 
   # The list of static sites you are hosting with static-rails.
   # Note that order matters! Request will be forwarded to the first site that

data/lib/static-rails/configuration.rb

@@ -30,7 +30,7 @@ module StaticRails
       @proxy_requests = !Rails.env.production?
       @serve_compiled_assets = Rails.env.production?
       @ping_server_timeout = 5
-      @set_csrf_token_cookie = true
+      @set_csrf_token_cookie = false
     end
 
     attr_reader :sites

data/lib/static-rails/gets_csrf_token.rb

@@ -1,15 +1,31 @@
+require_relative "request_forgery_protection_fallback"
+
 module StaticRails
   class GetsCsrfToken
+    include RequestForgeryProtectionFallback
+
     def call(req)
       masked_authenticity_token(req.session)
     end
 
     private
 
+    def csrf_token_hmac(session, identifier)
+      ActionController::RequestForgeryProtection.instance_method(:csrf_token_hmac).bind(self).call(session, identifier)
+    end
+
+    def mask_token(raw_token)
+      ActionController::RequestForgeryProtection.instance_method(:mask_token).bind(self).call(raw_token)
+    end
+
     def masked_authenticity_token(session, form_options: {})
       ActionController::RequestForgeryProtection.instance_method(:masked_authenticity_token).bind(self).call(session, form_options)
     end
 
+    def global_csrf_token(session)
+      ActionController::RequestForgeryProtection.instance_method(:global_csrf_token).bind(self).call(session)
+    end
+
     def real_csrf_token(session)
       ActionController::RequestForgeryProtection.instance_method(:real_csrf_token).bind(self).call(session)
     end

data/lib/static-rails/proxy_middleware.rb

@@ -17,7 +17,6 @@ module StaticRails
 
       server_store = ServerStore.instance
       server_store.ensure_all_servers_are_started
-      server_store.ensure_servers_are_up
 
       req = Rack::Request.new(env)
       if (req.get? || req.head?) && (site = @matches_request_to_static_site.call(req))

data/lib/static-rails/request_forgery_protection_fallback.rb

@@ -0,0 +1,19 @@
+module StaticRails
+  module RequestForgeryProtectionFallback
+    def method_missing(method_name, *args, **kwargs, &blk)
+      if respond_to?(method_name)
+        ActionController::RequestForgeryProtection.instance_method(method_name).bind(self).call(*args, **kwargs, &blk)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name, *args)
+      ActionController::RequestForgeryProtection.instance_method(method_name) || super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      ActionController::RequestForgeryProtection.instance_method(method_name) || super
+    end
+  end
+end

data/lib/static-rails/server_store.rb

@@ -16,10 +16,6 @@ module StaticRails
       @servers[site] ||= Server.new(site)
     end
 
-    def ensure_servers_are_up
-      @servers.values.each(&:start)
-    end
-
     private
 
     def initialize

data/lib/static-rails/site_middleware.rb

@@ -1,11 +1,10 @@
 require_relative "proxy_middleware"
 require_relative "static_middleware"
 require_relative "determines_whether_to_handle_request"
-require_relative "gets_csrf_token"
 
 module StaticRails
   class SiteMiddleware
-    PATH_INFO_OBFUSCATION = "JujJVj31M3SpzTjIGBJ2-3iE0lKXOIOlbLuk9Lxwe-Ll2uLuwH5KD8dmt1MqyZ"
+    PATH_INFO_OBFUSCATION = "__static-rails__"
 
     def initialize(app)
       @app = app
@@ -17,7 +16,7 @@ module StaticRails
     def call(env)
       return @app.call(env) unless @determines_whether_to_handle_request.call(env)
 
-      if require_csrf_before_processing_request? && !csrf_token_is_set?(env)
+      if require_csrf_before_processing_request?
         # You might be asking yourself what the hell is going on here. In short,
         # This middleware sits at the top of the stack, which is too early to
         # set a CSRF token in a cookie. Therefore, we've placed a subclass of
@@ -41,7 +40,7 @@ module StaticRails
         #
         # (By the way, this was all Matthew Draper's bright idea. You can
         # compliment him here: https://github.com/matthewd )
-        @app.call(env.merge("PATH_INFO" => env["PATH_INFO"] + PATH_INFO_OBFUSCATION))
+        @app.call(env.merge("PATH_INFO" => PATH_INFO_OBFUSCATION + env["PATH_INFO"]))
       elsif StaticRails.config.proxy_requests
         @proxy_middleware.call(env)
       elsif StaticRails.config.serve_compiled_assets
@@ -55,9 +54,5 @@ module StaticRails
     def require_csrf_before_processing_request?
       StaticRails.config.set_csrf_token_cookie
     end
-
-    def csrf_token_is_set?(env)
-      Rack::Request.new(env).cookies.has_key?("_csrf_token")
-    end
   end
 end

data/lib/static-rails/site_plus_csrf_middleware.rb

@@ -1,30 +1,34 @@
 require_relative "site_middleware"
 require_relative "determines_whether_to_handle_request"
+require_relative "validates_csrf_token"
 require_relative "gets_csrf_token"
 
 module StaticRails
   class SitePlusCsrfMiddleware < SiteMiddleware
     def initialize(app)
       @determines_whether_to_handle_request = DeterminesWhetherToHandleRequest.new
+      @validates_csrf_token = ValidatesCsrfToken.new
       @gets_csrf_token = GetsCsrfToken.new
       super
     end
 
     def call(env)
-      return @app.call(env) unless @determines_whether_to_handle_request.call(env)
+      return @app.call(env) unless env["PATH_INFO"]&.start_with?(PATH_INFO_OBFUSCATION) || @determines_whether_to_handle_request.call(env)
 
       env = env.merge(
-        "PATH_INFO" => env["PATH_INFO"].gsub(/#{PATH_INFO_OBFUSCATION}/, "")
+        "PATH_INFO" => env["PATH_INFO"].gsub(/^#{PATH_INFO_OBFUSCATION}/, "")
       )
       status, headers, body = super(env)
 
       if StaticRails.config.set_csrf_token_cookie
         req = Rack::Request.new(env)
         res = Rack::Response.new(body, status, headers)
-        res.set_cookie("_csrf_token", {
-          value: @gets_csrf_token.call(req),
-          path: "/"
-        })
+        if needs_new_csrf_token?(req)
+          res.set_cookie("_csrf_token", {
+            value: @gets_csrf_token.call(req),
+            path: "/"
+          })
+        end
         res.finish
       else
         [status, headers, body]
@@ -36,5 +40,11 @@ module StaticRails
     def require_csrf_before_processing_request?
       false
     end
+
+    private
+
+    def needs_new_csrf_token?(req)
+      !req.cookies.has_key?("_csrf_token") || !@validates_csrf_token.call(req)
+    end
   end
 end

data/lib/static-rails/static_middleware.rb

@@ -1,4 +1,5 @@
 require "rack-proxy"
+require "action_dispatch/middleware/static"
 
 require_relative "matches_request_to_static_site"
 
@@ -32,7 +33,10 @@ module StaticRails
     #   See: actionpack/lib/action_dispatch/middleware/static.rb
     def file_handler_for(site)
       @file_handlers[site] ||= ActionDispatch::FileHandler.new(
-        StaticRails.config.app.root.join(site.compile_dir).to_s
+        StaticRails.config.app.root.join(site.compile_dir).to_s,
+        headers: {
+          "cache-control" => "public; max-age=31536000"
+        }
       )
     end
 

data/lib/static-rails/validates_csrf_token.rb

@@ -0,0 +1,33 @@
+require_relative "request_forgery_protection_fallback"
+
+module StaticRails
+  class ValidatesCsrfToken
+    include RequestForgeryProtectionFallback
+
+    def call(req)
+      valid_authenticity_token?(req.session, req.cookies["_csrf_token"])
+    end
+
+    private
+
+    [
+      :compare_with_global_token,
+      :global_csrf_token,
+      :csrf_token_hmac,
+      :valid_authenticity_token?,
+      :unmask_token,
+      :compare_with_real_token,
+      :valid_per_form_csrf_token?,
+      :xor_byte_strings,
+      :real_csrf_token
+    ].each do |method|
+      define_method method do |*args, **kwargs, &blk|
+        ActionController::RequestForgeryProtection.instance_method(method).bind(self).call(*args, **kwargs, &blk)
+      end
+    end
+
+    def per_form_csrf_tokens
+      false
+    end
+  end
+end

data/lib/static-rails/version.rb

@@ -1,3 +1,3 @@
 module StaticRails
-  VERSION = "0.0.5"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.10
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -69,12 +69,14 @@ files:
 - lib/static-rails/proxy_middleware.rb
 - lib/static-rails/rack_server_check.rb
 - lib/static-rails/railtie.rb
+- lib/static-rails/request_forgery_protection_fallback.rb
 - lib/static-rails/server.rb
 - lib/static-rails/server_store.rb
 - lib/static-rails/site.rb
 - lib/static-rails/site_middleware.rb
 - lib/static-rails/site_plus_csrf_middleware.rb
 - lib/static-rails/static_middleware.rb
+- lib/static-rails/validates_csrf_token.rb
 - lib/static-rails/version.rb
 - lib/static-rails/waits_for_connection.rb
 - lib/tasks/static-rails.rake