static-rails 0.0.6 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2349033fed70d1dbc50caca67852f874e22800cf89dd94ef51580b3ed3a66452
-  data.tar.gz: 75bfdbdf6dbaef89c4c6b6674de1e08d99ca18dff795fa12b25f3d6bb00b218d
+  metadata.gz: d5808adb0f3f344a5706a6dddb5053899047f5d8aa4bbddb577168319b9aa046
+  data.tar.gz: d84c08d618e80a28b95be9da396f34d57636985ecf83859a906c5997a1532238
 SHA512:
-  metadata.gz: 3ea5b2102c354c715a09ebb33874b5488e1039349dc3b0c3e98135ea03108d52d88f8ca8cba7ec9ffcafff8f94a007792b5813f02f5c86ea5f88f6103b860427
-  data.tar.gz: e2ba3a00c004b86eb1364f4ea34559f86695347733ee158b3d57cea9cf669864585449ba042e59b1efbe1b1ce14487d470b6f732e9e2843030e057cf848050b3
+  metadata.gz: adb43e14b69561af8ce12989d319782b95d8c915b30968c4ce28d6bbf109426b8d606ba83d860002c2d793c16be3fbfe6c962be473df83507fd18d1e16de66c4
+  data.tar.gz: 7f4e6b9a9ed8dabaccd3a0da66671c36605a56e15da8483fe17f9518badbe3be6e2b82369ac4e7a05af9b4d594eaec1b010ad7616fc77b3aa835f81e0f87aa57

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 0.0.11
+
+* Inline the `ActionDispatch::FileHandler` from Rails master so that we can
+  target a single stable version of its API and control what MIME types it
+  considers to be compressible (bonus is that it effectively backports brotli
+  compression to pre-6.1 rails apps)
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    static-rails (0.0.6)
+    static-rails (0.0.11)
       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/file_handler.rb

@@ -0,0 +1,173 @@
+module StaticRails
+  # This class was extracted from Ruby on Rails:
+  #
+  #   - actionpack/lib/action_dispatch/middleware/static.rb
+  #
+  # Copyright (c) 2005-2020 David Heinemeier Hansson, Ryan Edward Hall, Jeremy Daer
+  #
+  # License here: https://github.com/rails/rails/blob/master/MIT-LICENSE
+  #
+  # This endpoint serves static files from disk using Rack::File.
+  #
+  # URL paths are matched with static files according to expected
+  # conventions: +path+, +path+.html, +path+/index.html.
+  #
+  # Precompressed versions of these files are checked first. Brotli (.br)
+  # and gzip (.gz) files are supported. If +path+.br exists, this
+  # endpoint returns that file with a +Content-Encoding: br+ header.
+  #
+  # If no matching file is found, this endpoint responds 404 Not Found.
+  #
+  # Pass the +root+ directory to search for matching files, an optional
+  # +index: "index"+ to change the default +path+/index.html, and optional
+  # additional response headers.
+  class FileHandler
+    # Accept-Encoding value -> file extension
+    PRECOMPRESSED = {
+      "br" => ".br",
+      "gzip" => ".gz",
+      "identity" => nil
+    }
+
+    def initialize(root, index: "index", headers: {}, precompressed: %i[br gzip], compressible_content_types: /\A(?:text\/|application\/javascript)/)
+      @root = root.chomp("/").b
+      @index = index
+
+      @precompressed = Array(precompressed).map(&:to_s) | %w[identity]
+      @compressible_content_types = compressible_content_types
+
+      @file_server = ::Rack::File.new(@root, headers)
+    end
+
+    def call(env)
+      attempt(env) || @file_server.call(env)
+    end
+
+    def attempt(env)
+      request = Rack::Request.new env
+
+      if request.get? || request.head?
+        if (found = find_file(request.path_info, accept_encoding: request.accept_encoding))
+          serve request, *found
+        end
+      end
+    end
+
+    def serve(request, filepath, content_headers)
+      original, request.path_info =
+          request.path_info, ::Rack::Utils.escape_path(filepath).b
+
+      @file_server.call(request.env).tap do |status, headers, body|
+        # Omit Content-Encoding/Type/etc headers for 304 Not Modified
+        if status != 304
+          headers.update(content_headers)
+        end
+      end
+    ensure
+      request.path_info = original
+    end
+
+    # Match a URI path to a static file to be served.
+    #
+    # Used by the +Static+ class to negotiate a servable file in the
+    # +public/+ directory (see Static#call).
+    #
+    # Checks for +path+, +path+.html, and +path+/index.html files,
+    # in that order, including .br and .gzip compressed extensions.
+    #
+    # If a matching file is found, the path and necessary response headers
+    # (Content-Type, Content-Encoding) are returned.
+    def find_file(path_info, accept_encoding:)
+      each_candidate_filepath(path_info) do |filepath, content_type|
+        if (response = try_files(filepath, content_type, accept_encoding: accept_encoding))
+          return response
+        end
+      end
+    end
+
+    private
+
+    def try_files(filepath, content_type, accept_encoding:)
+      headers = {"Content-Type" => content_type}
+
+      if compressible? content_type
+        try_precompressed_files filepath, headers, accept_encoding: accept_encoding
+      elsif file_readable? filepath
+        [filepath, headers]
+      end
+    end
+
+    def try_precompressed_files(filepath, headers, accept_encoding:)
+      each_precompressed_filepath(filepath) do |content_encoding, precompressed_filepath|
+        if file_readable? precompressed_filepath
+          # Identity encoding is default, so we skip Accept-Encoding
+          # negotiation and needn't set Content-Encoding.
+          #
+          # Vary header is expected when we've found other available
+          # encodings that Accept-Encoding ruled out.
+          if content_encoding == "identity"
+            return precompressed_filepath, headers
+          else
+            headers["Vary"] = "Accept-Encoding"
+
+            if accept_encoding.any? { |enc, _| /\b#{content_encoding}\b/i.match?(enc) }
+              headers["Content-Encoding"] = content_encoding
+              return precompressed_filepath, headers
+            end
+          end
+        end
+      end
+    end
+
+    def file_readable?(path)
+      file_stat = File.stat(File.join(@root, path.b))
+    rescue SystemCallError
+      false
+    else
+      file_stat.file? && file_stat.readable?
+    end
+
+    def compressible?(content_type)
+      @compressible_content_types.match?(content_type)
+    end
+
+    def each_precompressed_filepath(filepath)
+      @precompressed.each do |content_encoding|
+        precompressed_ext = PRECOMPRESSED.fetch(content_encoding)
+        yield content_encoding, "#{filepath}#{precompressed_ext}"
+      end
+
+      nil
+    end
+
+    def each_candidate_filepath(path_info)
+      return unless (path = clean_path(path_info))
+
+      ext = ::File.extname(path)
+      content_type = ::Rack::Mime.mime_type(ext, nil)
+      yield path, content_type || "text/plain"
+
+      # Tack on .html and /index.html only for paths that don't have
+      # an explicit, resolvable file extension. No need to check
+      # for foo.js.html and foo.js/index.html.
+      unless content_type
+        default_ext = ::ActionController::Base.default_static_extension
+        if ext != default_ext
+          default_content_type = ::Rack::Mime.mime_type(default_ext, "text/plain")
+
+          yield "#{path}#{default_ext}", default_content_type
+          yield "#{path}/#{@index}#{default_ext}", default_content_type
+        end
+      end
+
+      nil
+    end
+
+    def clean_path(path_info)
+      path = ::Rack::Utils.unescape_path path_info.chomp("/")
+      if ::Rack::Utils.valid_path? path
+        ::Rack::Utils.clean_path_info path
+      end
+    end
+  end
+end

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,6 +1,6 @@
 require "rack-proxy"
-require "action_dispatch/middleware/static"
 
+require_relative "file_handler"
 require_relative "matches_request_to_static_site"
 
 module StaticRails
@@ -18,9 +18,8 @@ module StaticRails
       if (req.get? || req.head?) && (site = @matches_request_to_static_site.call(req))
         file_handler = file_handler_for(site)
         path = req.path_info.gsub(/^#{site.url_root_path}/, "").chomp("/")
-        if (match = matching_file_for(file_handler, site, path))
-          req.path_info = match
-          return file_handler.serve(req)
+        if (found = find_file_for(file_handler, site, path, req.accept_encoding))
+          return file_handler.serve(req, *found)
         end
       end
 
@@ -32,16 +31,20 @@ module StaticRails
     # The same file handler used by Rails when serving up files from /public
     #   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
+      @file_handlers[site] ||= FileHandler.new(
+        StaticRails.config.app.root.join(site.compile_dir).to_s,
+        headers: {
+          "cache-control" => "public; max-age=31536000"
+        },
+        compressible_content_types: /^text\/|[\/+](javascript|json|text|xml|css|yaml)$/i
       )
     end
 
-    def matching_file_for(file_handler, site, path)
-      if (match = file_handler.match?(path))
-        match
+    def find_file_for(file_handler, site, path, accept_encoding)
+      if (found = file_handler.find_file(path, accept_encoding: accept_encoding))
+        found
       elsif site.compile_404_file_path.present?
-        file_handler.match?(site.compile_404_file_path)
+        file_handler.find_file(site.compile_404_file_path, accept_encoding: accept_encoding)
       end
     end
   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.6"
+  VERSION = "0.0.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.11
 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
@@ -64,17 +64,20 @@ files:
 - lib/static-rails/configuration.rb
 - lib/static-rails/determines_whether_to_handle_request.rb
 - lib/static-rails/error.rb
+- lib/static-rails/file_handler.rb
 - lib/static-rails/gets_csrf_token.rb
 - lib/static-rails/matches_request_to_static_site.rb
 - 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