rack-cors-csrf_prevention 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 875f008ae969331b4266a00a131b2edf9399d24ea347c2622d9cd79eaa6fcd71
+  data.tar.gz: 7de16bb4d69a5783829281c312290c94ec5b544963c45bc03ae38942968eb795
+SHA512:
+  metadata.gz: fb20827ff14fa2a57ac931ab263adedc4f87e0422d8ddb1c021abb4878a8023638ded968c05616ab163ce218e14e09ce2026b85101569b8afd25070f31c08635
+  data.tar.gz: f8bcbb4e2b5330e27285e3e296d9d2c6db64e6350843e2bb16d0fcef844728120237a81eed4f00f0e426d0fab98c81af349b196288df1d4550298c67a4c1a74c

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - *.gemspec
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-cors-csrf_prevention.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    rack-cors-csrf_prevention (0.1.0)
+      rack (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rack (2.2.7)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  rack-cors-csrf_prevention!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.4

data/README.md

@@ -0,0 +1,59 @@
+# Rack::Cors::CsrfPrevention
+
+Ruby implementation of [CSRF prevention from the Apollo Router](https://www.apollographql.com/docs/router/configuration/csrf/).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add rack-cors-csrf_prevention
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install rack-cors-csrf_prevention
+```
+
+## Configuration
+
+### Rails Configuration
+
+Specify paths for CSRF prevention:
+
+```ruby
+# config/initializers/cors.rb
+
+Rails.application.config.middleware.use Rack::Cors::CsrfPrevention,
+                                        paths: %w[/graphql]
+```
+
+You can also specify custom headers that allow execution. By default, it's `X-Apollo-Operation-Name` or `Apollo-Require-Preflight` headers, but you can configure to allow a `Some-Special-Header` header:
+
+```ruby
+# config/initializers/cors.rb
+
+Rails.application.config.middleware.use Rack::Cors::CsrfPrevention,
+                                        paths: %w[/graphql],
+                                        required_headers: %w[
+                                          X-APOLLO-OPERATION-NAME
+                                          APOLLO-REQUIRE-PREFLIGHT
+                                          SOME-SPECIAL-HEADER
+                                        ]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/digitaz/rack-cors-csrf_prevention.

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/lib/rack/cors/csrf_prevention/logger.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Rack
+  class Cors
+    class CsrfPrevention
+      module Logger
+        def logger(env)
+          @logger = if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+                      Rails.logger
+                    elsif env[RACK_LOGGER]
+                      env[RACK_LOGGER]
+                    else
+                      ::Logger.new($stdout).tap do |logger|
+                        logger.level = ::Logger::Severity::DEBUG
+                      end
+                    end
+        end
+      end
+    end
+  end
+end

data/lib/rack/cors/csrf_prevention/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rack
+  class Cors
+    class CsrfPrevention
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/rack/cors/csrf_prevention.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "rack"
+require_relative "csrf_prevention/logger"
+require_relative "csrf_prevention/version"
+
+module Rack
+  class Cors
+    class CsrfPrevention
+      include Rack::Cors::CsrfPrevention::Logger
+
+      APOLLO_CUSTOM_PREFLIGHT_HEADERS = %w[
+        X-APOLLO-OPERATION-NAME
+        APOLLO-REQUIRE-PREFLIGHT
+      ].freeze
+
+      NON_PREFLIGHTED_CONTENT_TYPES = %w[
+        application/x-www-form-urlencoded
+        multipart/form-data
+        text/plain
+      ].freeze
+
+      ERROR_MESSAGE = <<~HEREDOC
+        This operation has been blocked as a potential Cross-Site Request Forgery (CSRF).
+
+        Please either specify a "Content-Type" header (with a mime-type that is not one of #{NON_PREFLIGHTED_CONTENT_TYPES.join(', ')}) or provide one of the following headers: #{APOLLO_CUSTOM_PREFLIGHT_HEADERS.join(', ')}.
+      HEREDOC
+
+      def initialize(
+        app,
+        paths:,
+        required_headers: APOLLO_CUSTOM_PREFLIGHT_HEADERS
+      )
+        @app = app
+        @paths = paths
+        @required_headers = required_headers
+      end
+
+      def call(env)
+        request = ::Rack::Request.new(env)
+
+        return @app.call(env) unless protected_path?(request.path)
+
+        if preflighted?(request)
+          logger(env).debug { "Request is preflighted" }
+
+          @app.call(env)
+        else
+          logger(env).debug { "Request isn't preflighted" }
+
+          Rack::Response[400, { "Content-Type" => "text/plain" }, ERROR_MESSAGE].to_a
+        end
+      end
+
+      private
+
+      def protected_path?(path)
+        @paths.include?(path)
+      end
+
+      def preflighted?(request)
+        content_type_requires_preflight?(request) || recommended_header_provided?(request)
+      end
+
+      def content_type_requires_preflight?(request)
+        return false unless request.media_type
+
+        !NON_PREFLIGHTED_CONTENT_TYPES.include?(request.media_type)
+      end
+
+      def recommended_header_provided?(request)
+        @required_headers.any? { |header| request.has_header?("HTTP_#{header}") }
+      end
+    end
+  end
+end

data/rack-cors-csrf_prevention.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "lib/rack/cors/csrf_prevention/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rack-cors-csrf_prevention"
+  spec.version = Rack::Cors::CsrfPrevention::VERSION
+  spec.author = "Digital Classifieds LLC"
+  spec.license = "MIT"
+
+  spec.summary = "Ruby implementation of CSRF prevention from the Apollo Router."
+  spec.description = <<~HEREDOC
+    The middleware makes sure any request to specified paths would have been
+    preflighted if it was sent by a browser.
+
+    We don't want random websites to be able to execute actual GraphQL
+    operations from a user's browser unless our CORS policy supports it. It's
+    not good enough just to ensure that the browser can't read the response from
+    the operation; we also want to prevent CSRF, where the attacker can cause
+    side effects with an operation or can measure the timing of a read
+    operation. Our goal is to ensure that we don't run the context function or
+    execute the GraphQL operation until the browser has evaluated the CORS
+    policy, which means we want all operations to be pre-flighted. We can do
+    that by only processing operations that have at least one header set that
+    appears to be manually set by the JS code rather than by the browser
+    automatically.
+
+    POST requests generally have a content-type `application/json`, which is
+    sufficient to trigger preflighting. So we take extra care with requests that
+    specify no content-type or that specify one of the three non-preflighted
+    content types. For those operations, we require one of a set of specific
+    headers to be set. By ensuring that every operation either has a custom
+    content-type or sets one of these headers, we know we won't execute
+    operations at the request of origins who our CORS policy will block.
+  HEREDOC
+  spec.homepage = "https://github.com/digitaz/rack-cors-csrf_prevention"
+  spec.required_ruby_version = ">= 2.6.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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", ">= 1"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  # spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rack-cors-csrf_prevention
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Digital Classifieds LLC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  The middleware makes sure any request to specified paths would have been
+  preflighted if it was sent by a browser.
+
+  We don't want random websites to be able to execute actual GraphQL
+  operations from a user's browser unless our CORS policy supports it. It's
+  not good enough just to ensure that the browser can't read the response from
+  the operation; we also want to prevent CSRF, where the attacker can cause
+  side effects with an operation or can measure the timing of a read
+  operation. Our goal is to ensure that we don't run the context function or
+  execute the GraphQL operation until the browser has evaluated the CORS
+  policy, which means we want all operations to be pre-flighted. We can do
+  that by only processing operations that have at least one header set that
+  appears to be manually set by the JS code rather than by the browser
+  automatically.
+
+  POST requests generally have a content-type `application/json`, which is
+  sufficient to trigger preflighting. So we take extra care with requests that
+  specify no content-type or that specify one of the three non-preflighted
+  content types. For those operations, we require one of a set of specific
+  headers to be set. By ensuring that every operation either has a custom
+  content-type or sets one of these headers, we know we won't execute
+  operations at the request of origins who our CORS policy will block.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rack/cors/csrf_prevention.rb
+- lib/rack/cors/csrf_prevention/logger.rb
+- lib/rack/cors/csrf_prevention/version.rb
+- rack-cors-csrf_prevention.gemspec
+homepage: https://github.com/digitaz/rack-cors-csrf_prevention
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/digitaz/rack-cors-csrf_prevention
+  source_code_uri: https://github.com/digitaz/rack-cors-csrf_prevention
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Ruby implementation of CSRF prevention from the Apollo Router.
+test_files: []