rack-steady_etag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 733d26f0e71001a540dcd32beb688dd0b78e72ded8d6695bcb489db227a31d35
+  data.tar.gz: 429c9a93ffad20173a5e8f603d427f54daeb964a748c955a4685d6dd8a7d2f70
+SHA512:
+  metadata.gz: 041f32e35729ad2a7cb72d447814dea132d2a463e9c13f5d4af113ffa4f5fc568791c7c6a67cc724046628560737ec9a9401c8c5c34dde9319af251aa3f7cc7c
+  data.tar.gz: 20ecac0974ebf4dd59d55360ca872af812b5c2cf1fd4c20f81c9a0f6cb90cd89cb7980e8a8a667536bf4b79e5673c4b5220f7de3419e2e7ec8b3e448a9cee70b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-steady-etag.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem 'byebug'

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rack-steady_etag (0.1.0)
+      activesupport (>= 3.2)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rack (2.2.3)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  rack-steady_etag!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Based on Rack, Copyright (C) 2007-2021 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
+Modifications Copyright (C) 2021 Henning Koch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Rack::SteadyETag
+
+`Rack::SteadyTag` is a Rack middleware that generates the same default [`ETag`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) for responses that only differ in CSRF tokens or CSP nonces.
+
+By default Rails uses [`Rack::ETag`](https://rdoc.info/github/rack/rack/Rack/ETag) to generate `ETag` headers by hashing the response body. In theory this would [enable caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) for multiple requests to the same resource. However, since most Rails application layouts insert randomly rotating CSRF tokens and CSP nonces into the HTML, two requests for the same content and user will never produce the same response bytes. This means the default ETags from Rails will [never hit a cache](https://github.com/rails/rails/issues/29889).
+
+`Rack::SteadyETag` is a drop-in replacement for `Rack::ETag`. It excludes random content (like CSRF tokens) from the generated ETag, causing two requests for the same content to usually carry the same ETag.
+
+## What is ignored
+
+`Rack::SteadyTag`  ignores the following patterns from the `ETag` hash:
+
+```html
+<meta name="csrf-token" value="random" ...>
+<meta name="csp-nonce" value="random" ...>
+<input name="authenticity_token" value="random" ...>
+<script nonce="random" ...> <!-- only the [nonce] attribute -->
+```
+
+You can add your own patterns:
+
+```ruby
+Rack::SteadyETag::IGNORED_PATTERNS << /<meta name="XSRF-TOKEN" value="[^"]+">/
+```
+
+You can also push lambda for arbitrary transformations:
+
+```ruby
+Rack::SteadyETag::IGNORED_PATTERNS << -> { |text| text.gsub(/<meta name="XSRF-TOKEN" value="[^"]+">/, '') }
+```
+
+Transformations are only applied for the `ETag` hash. The response body will not be changed.
+
+## Covered edge cases
+
+- Different `ETags` are generated when the same content is accessed with different Rack sessions.
+- `ETags` are only generated when the response is `Cache-Control: private` (this is a default in Rails).
+- No `ETag` is generated when the response already has an `ETag` header.
+- No `ETag` is generated when the response already has an `Last-Modified` header.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-steady_etag'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+In your `config/application.rb`:
+
+```ruby
+config.middleware.swap Rack::ETag, Rack::SteadyETag
+```
+
+
+## Development
+
+- After checking out the repo, run `bin/setup` to install dependencies.
+- Run `bundle exec rspec` to run the tests.
+- You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Credits
+
+This library is based on `Rack::ETag`, created by the [Rack Core Team](https://github.com/rack/rack#label-Thanks) and [Rack contributors](https://github.com/rack/rack/graphs/contributors).
+
+Additional changes by [Henning Koch](https://twitter.com/triskweline) from [makandra](https://makandra.com).
+
+## Limitations
+
+- No streaming support. [This will be broken until at least Rack 3](https://github.com/rack/rack/issues/1619). This is not a use case of mine.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rack/steady/etag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/steady_etag/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class SteadyEtag
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/steady_etag.rb

@@ -0,0 +1,124 @@
+require 'byebug'
+require 'digest/sha2'
+require "active_support/all"
+require_relative "steady_etag"
+require_relative "steady_etag/version"
+
+module Rack
+
+  # Based on Rack::Etag
+  # https://github.com/rack/rack/blob/master/lib/rack/etag.rb
+  #
+  # Automatically sets the ETag header on all String bodies.
+  #
+  # The ETag header is skipped if ETag or Last-Modified headers are sent or if
+  # a sendfile body (body.responds_to :to_path) is given (since such cases
+  # should be handled by apache/nginx).
+  class SteadyETag
+    DEFAULT_CACHE_CONTROL = "max-age=0, private, must-revalidate"
+
+    IGNORE_PATTERNS = [
+      /<meta\b[^>]*\bname=(["'])csrf-token\1[^>]+>/i,
+      /<meta\b[^>]*\bname=(["'])csp-nonce\1[^>]+>/i,
+      /<input\b[^>]*\bname=(["'])authenticity_token\1[^>]+>/i,
+      lambda { |string| string.gsub(/(<script\b[^>]*)\bnonce=(["'])[^"']+\2+/i, '\1') }
+    ]
+
+    def initialize(app, no_digest_cache_control: nil, digest_cache_control: DEFAULT_CACHE_CONTROL, ignore_patterns: IGNORE_PATTERNS.dup)
+      @app = app
+      @digest_cache_control = digest_cache_control
+      @no_digest_cache_control = no_digest_cache_control
+      @ignore_patterns = ignore_patterns
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers = Utils::HeaderHash[headers]
+      session = env[RACK_SESSION]
+
+      if etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
+        original_body = body
+        digest, new_body = digest_body(body, headers, session)
+        body = Rack::BodyProxy.new(new_body) do
+          original_body.close if original_body.respond_to?(:close)
+        end
+        headers[ETAG] = %(W/"#{digest}") if digest
+      end
+
+      [status, headers, body]
+    end
+
+    private
+
+    def set_cache_control_with_digest(headers)
+      headers[CACHE_CONTROL] ||= @digest_cache_control if @digest_cache_control
+    end
+
+    def set_cache_control_without_digest(headers)
+      headers[CACHE_CONTROL] ||= @no_digest_cache_control if @no_digest_cache_control
+    end
+
+    def etag_status?(status)
+      status == 200 || status == 201
+    end
+
+    def etag_body?(body)
+      !body.respond_to?(:to_path)
+    end
+
+    def skip_caching?(headers)
+      headers.key?(ETAG) || headers.key?('Last-Modified')
+    end
+
+    def cache_control_private?(headers)
+      headers[CACHE_CONTROL] && headers[CACHE_CONTROL] =~ /\bprivate\b/
+    end
+
+    def digest_body(body, headers, session)
+      parts = []
+      digest = nil
+
+      body.each do |part|
+        parts << part
+
+        if part.present?
+          set_cache_control_with_digest(headers)
+
+          if cache_control_private?(headers)
+            part = strip_ignore_patterns(part)
+          end
+
+          unless digest
+            digest = Digest::SHA256.new
+
+            if session && (session_id = session['session_id'])
+              digest << session_id.to_s
+            end
+          end
+
+          digest << part
+        end
+      end
+
+      if digest
+        digest = digest.hexdigest.byteslice(0,32)
+      else
+        set_cache_control_without_digest(headers)
+      end
+
+      [digest, parts]
+    end
+
+    def strip_ignore_patterns(html)
+      @ignore_patterns.each do |ignore_pattern|
+        if ignore_pattern.respond_to?(:call)
+          html = ignore_pattern.call(html)
+        else
+          html = html.gsub(ignore_pattern, '')
+        end
+      end
+      html
+    end
+
+  end
+end

data/rack-steady_etag.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/rack/steady_etag/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rack-steady_etag"
+  spec.version = Rack::SteadyEtag::VERSION
+  spec.authors = ["Henning Koch"]
+  spec.email = ["henning.koch@makandra.de"]
+
+  spec.summary = "Rack Middleware that produces the same ETag for responses that only differ in CSRF tokens or CSP nonce"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/makandra/rack-steady_etag"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rack"
+  spec.add_dependency 'activesupport', '>= 3.2'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rack-steady_etag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Koch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rack Middleware that produces the same ETag for responses that only differ
+  in CSRF tokens or CSP nonce
+email:
+- henning.koch@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/steady_etag.rb
+- lib/rack/steady_etag/version.rb
+- rack-steady_etag.gemspec
+homepage: https://github.com/makandra/rack-steady_etag
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/makandra/rack-steady_etag
+  source_code_uri: https://github.com/makandra/rack-steady_etag
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.6
+signing_key: 
+specification_version: 4
+summary: Rack Middleware that produces the same ETag for responses that only differ
+  in CSRF tokens or CSP nonce
+test_files: []