actionpack-per_form_csrf_tokens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3dbf92626e5ce7f75cef9db6b0b50a6ce6bac99
+  data.tar.gz: d26e97ae9a24d33fdbc50d1cc38d7953867a423b
+SHA512:
+  metadata.gz: 2c3a4c98ce2955c2d8b8e2e3b52f22e28c4c1791d6e5813a3f9e64641ecd049fa9eff183f5fce76dd9d6fccc73c74c0f4ebca8db64c1e6588374fe2a0da3f32a
+  data.tar.gz: 7db96a3b05f5bb9ab91c1f4ddc19dc42927aa5b38430777e3ceaa6a1dbf80434ba4b4e751c3b574912f8d18b7a349a79f7f748b5fe5ca5971d02c5fe0b5a7dce

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## [0.1.0](https://github.com/yasaichi/actionpack-per_form_csrf_tokens/releases/tag/v0.1.0) (September 8, 2021)
+
+- The initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yuichi Goto
+
+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 OR COPYRIGHT HOLDERS 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,43 @@
+# Actionpack::PerFormCsrfTokens
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/actionpack/per_form_csrf_tokens`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'actionpack-per_form_csrf_tokens'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actionpack-per_form_csrf_tokens
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/[USERNAME]/actionpack-per_form_csrf_tokens. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActionPack::PerFormCsrfTokens project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/actionpack-per_form_csrf_tokens/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/actionpack/per_form_csrf_tokens/request_forgery_protection.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/security_utils"
+require "openssl"
+require "uri"
+
+module ActionPack
+  module PerFormCsrfTokens
+    module RequestForgeryProtection
+      GLOBAL_CSRF_TOKEN_IDENTIFIER = "!real_csrf_token"
+      private_constant :GLOBAL_CSRF_TOKEN_IDENTIFIER
+
+      private
+
+      def compare_with_global_token(token, session)
+        ::ActiveSupport::SecurityUtils.secure_compare(token, global_csrf_token(session))
+      end
+
+      def csrf_token_hmac(session, identifier)
+        ::OpenSSL::HMAC.digest(
+          ::OpenSSL::Digest.new("SHA256"),
+          real_csrf_token(session),
+          identifier
+        )
+      end
+
+      def decode_csrf_token(encoded_csrf_token)
+        ::Base64.strict_decode64(encoded_csrf_token)
+      rescue ::ArgumentError
+        ::Base64.urlsafe_decode64(encoded_csrf_token)
+      end
+
+      def global_csrf_token(session)
+        csrf_token_hmac(session, GLOBAL_CSRF_TOKEN_IDENTIFIER)
+      end
+
+      def per_form_csrf_token(session, action_path, method)
+        csrf_token_hmac(session, [action_path, method.downcase].join("#"))
+      end
+
+      # Override
+      def real_csrf_token(session)
+        session[:_csrf_token] ||= ::SecureRandom.base64(self.class::AUTHENTICITY_TOKEN_LENGTH)
+        decode_csrf_token(session[:_csrf_token])
+      end
+
+      def unmask_token(masked_token)
+        # Split the token into the one-time pad and the encrypted
+        # value and decrypt it.
+        one_time_pad = masked_token[0...self.class::AUTHENTICITY_TOKEN_LENGTH]
+        encrypted_csrf_token = masked_token[self.class::AUTHENTICITY_TOKEN_LENGTH..-1]
+        xor_byte_strings(one_time_pad, encrypted_csrf_token)
+      end
+
+      # Override
+      def valid_authenticity_token?(session, encoded_masked_token)
+        return false if encoded_masked_token.nil? || encoded_masked_token.empty? || !encoded_masked_token.is_a?(String)
+
+        begin
+          masked_token = decode_csrf_token(encoded_masked_token)
+        rescue ::ArgumentError # encoded_masked_token is invalid Base64
+          return false
+        end
+
+        # See if it's actually a masked token or not. In order to
+        # deploy this code, we should be able to handle any unmasked
+        # tokens that we've issued without error.
+
+        case masked_token.length
+        when self.class::AUTHENTICITY_TOKEN_LENGTH
+          # This is actually an unmasked token. This is expected if
+          # you have just upgraded to masked tokens, but should stop
+          # happening shortly after installing this gem.
+          compare_with_real_token(masked_token, session)
+
+        when self.class::AUTHENTICITY_TOKEN_LENGTH * 2
+          csrf_token = unmask_token(masked_token)
+
+          compare_with_global_token(csrf_token, session) ||
+            compare_with_real_token(csrf_token, session) ||
+            valid_per_form_csrf_token?(csrf_token, session)
+        else
+          false # Token is malformed.
+        end
+      end
+
+      def valid_per_form_csrf_token?(token, session)
+        correct_token = per_form_csrf_token(
+          session,
+          request.path.chomp("/"),
+          request.request_method
+        )
+
+        ::ActiveSupport::SecurityUtils.secure_compare(token, correct_token)
+      end
+    end
+  end
+end

data/lib/actionpack/per_form_csrf_tokens/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionPack
+  module PerFormCsrfTokens
+    VERSION = "0.1.0"
+  end
+end

data/lib/actionpack/per_form_csrf_tokens.rb

@@ -0,0 +1,8 @@
+require "active_support"
+require "active_support/lazy_load_hooks"
+require "actionpack/per_form_csrf_tokens/request_forgery_protection"
+require "actionpack/per_form_csrf_tokens/version"
+
+ActiveSupport.on_load(:action_controller) do
+  include(ActionPack::PerFormCsrfTokens::RequestForgeryProtection)
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: actionpack-per_form_csrf_tokens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuichi Goto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Backport of per-form CSRF tokens into Rails 4
+email:
+- yasaichi@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/actionpack/per_form_csrf_tokens.rb
+- lib/actionpack/per_form_csrf_tokens/request_forgery_protection.rb
+- lib/actionpack/per_form_csrf_tokens/version.rb
+homepage: https://github.com/yasaichi/actionpack-per_form_csrf_tokens
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Backport of per-form CSRF tokens
+test_files: []