static-rails 0.0.7 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c1a0e6ce72ea1feb691e3cbfae0bec8bf723f1512cda383aeae57d56fd9765
-  data.tar.gz: 4d8d3c148661b2498ccfeb3677553e94a91c2cb68b5c48ba47aaace89be8adfe
+  metadata.gz: 3c9c3f77b3746fd75f797c4c33815e5c699af9e4c1c9a88f56234117406d1b7f
+  data.tar.gz: bf8d899c95891497e8a17492d58315993af2d189f7a3ea3e848937f04e252a81
 SHA512:
-  metadata.gz: cc39f818e745f67930b8821dbf3b38cdfd34d33accd25979801a4fbc34df67cdf600e517a2fe806f6094e43bc2e797fcef2aa4b1bb7006f3d75317a26b19ea82
-  data.tar.gz: c0879dc6ef5950806aaa662035ac7593a78c334dc578f65bd5e13526d1f4c770a08b9cf1f2b8fc8e21a9d00372876736924e05687e4d33ebbb780acc5b802ea1
+  metadata.gz: 8ae97c0207f5fcfe0516d78e43738ec6c8def425312dd0af03070c488927ee812824b1ec3742ee21e874e3d8e47568f44e1bd577757aa0054f8a3dcadce7c943
+  data.tar.gz: f840d03e50b3017ecccc9a259d9f89e0ce92dc76b735f47bc6a8873c17efb6f87ece051eb6167f6a11f603e88c5e5c5ca2afac9b9f2d886bf098e63fc0491133

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## 0.0.12
+
+* Fix an issue in which enabling force_ssl would result in redirects to the
+  obfuscated `/_static_rails/` path. Resolved this by placing the static-rails
+  middleware after `ActionDispatch::SSL`. Note that this will break if you
+  remove `Rack::SendFile` from your app's middleware stack
+
+## 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

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    static-rails (0.0.7)
+    static-rails (0.0.12)
       rack-proxy (~> 0.6)
       railties (>= 5.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.1)
-      actionview (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -32,21 +32,20 @@ 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)
+    loofah (2.6.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 (2.2.3)
     rack-proxy (0.6.5)
       rack
     rack-test (1.1.0)
@@ -56,34 +55,38 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       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/lib/generators/templates/static.rb

@@ -34,14 +34,14 @@ StaticRails.config do |config|
     #   url_root_path: "/",
     #
     #   # Don't serve/redirect routes whose paths start with these strings
-    #   url_skip_paths_starting_with: ["/api"]
+    #   url_skip_paths_starting_with: ["/api"],
     #
     #   # Whether to run the local development/test server or not
     #   start_server: !Rails.env.production?,
     #
     #   # If start_server is true, wait to proxy requests to the server until it
     #   #   can connect to server_host over TCP on server_port
-    #   ping_server: true
+    #   ping_server: true,
     #
     #   # Any environment variables you need to pass to the server & compile
     #   #   commands as a hash (e.g. `env: {"BUNDLE_PATH" => "vendor/bundle"}`)
@@ -65,7 +65,7 @@ StaticRails.config do |config|
     #   compile_command: "hugo",
     #
     #   # The destination of production-compiled assets, relative to Rails root
-    #   compile_dir: "static/blog/dist"
+    #   compile_dir: "static/blog/dist",
     #
     #   # A 404 page to be sent when serving compiled assets and no file matches
     #   compile_404_file_path: "404.html"

data/lib/static-rails/configuration.rb

@@ -36,7 +36,7 @@ module StaticRails
     attr_reader :sites
     def sites=(sites)
       @sites = Array.wrap(sites).map { |site|
-        Site.new(site)
+        Site.new(**site)
       }
     end
   end

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,21 +1,35 @@
+require_relative "request_forgery_protection_fallback"
+
 module StaticRails
   class GetsCsrfToken
+    include RequestForgeryProtectionFallback
+
     def call(req)
       masked_authenticity_token(req.session)
     end
 
     private
 
+    [
+      :csrf_token_hmac,
+      :mask_token,
+      :xor_byte_strings
+    ].each do |method|
+      define_method method do |*args, **kwargs, &blk|
+        ActionController::RequestForgeryProtection.instance_method(method).bind(self).call(*args, **kwargs, &blk)
+      end
+    end
+
     def masked_authenticity_token(session, form_options: {})
-      ActionController::RequestForgeryProtection.instance_method(:masked_authenticity_token).bind(self).call(session, form_options)
+      ActionController::RequestForgeryProtection.instance_method(:masked_authenticity_token).bind(self).call(session, form_options: form_options)
     end
 
-    def real_csrf_token(session)
-      ActionController::RequestForgeryProtection.instance_method(:real_csrf_token).bind(self).call(session)
+    def global_csrf_token(session)
+      ActionController::RequestForgeryProtection.instance_method(:global_csrf_token).bind(self).call(session)
     end
 
-    def xor_byte_strings(s1, s2)
-      ActionController::RequestForgeryProtection.instance_method(:xor_byte_strings).bind(self).call(s1, s2)
+    def real_csrf_token(session)
+      ActionController::RequestForgeryProtection.instance_method(:real_csrf_token).bind(self).call(session)
     end
 
     def per_form_csrf_tokens

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/railtie.rb

@@ -10,7 +10,7 @@ module StaticRails
     end
 
     initializer "static_rails.middleware" do
-      config.app_middleware.insert_before 0, SiteMiddleware
+      config.app_middleware.insert_after Rack::Sendfile, SiteMiddleware
       config.app_middleware.use SitePlusCsrfMiddleware
     end
 

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

@@ -4,7 +4,7 @@ require_relative "determines_whether_to_handle_request"
 
 module StaticRails
   class SiteMiddleware
-    PATH_INFO_OBFUSCATION = "JujJVj31M3SpzTjIGBJ2-3iE0lKXOIOlbLuk9Lxwe-Ll2uLuwH5KD8dmt1MqyZ"
+    PATH_INFO_OBFUSCATION = "__static-rails__"
 
     def initialize(app)
       @app = app
@@ -40,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

data/lib/static-rails/site_plus_csrf_middleware.rb

@@ -13,10 +13,10 @@ module StaticRails
     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)
 

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

@@ -1,5 +1,9 @@
+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
@@ -7,6 +11,9 @@ module StaticRails
     private
 
     [
+      :compare_with_global_token,
+      :global_csrf_token,
+      :csrf_token_hmac,
       :valid_authenticity_token?,
       :unmask_token,
       :compare_with_real_token,

data/lib/static-rails/version.rb

@@ -1,3 +1,3 @@
 module StaticRails
-  VERSION = "0.0.7"
+  VERSION = "0.0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.12
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -64,11 +64,13 @@ 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