rails_cloudflare_turnstile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ce536746c6d1d1f449d59496cfa6c8f03473cdce982577ae6972700a9508cc9
+  data.tar.gz: 9044b74740d86b7e7b32bb541ea8aff5c91aa316b024fc5a8b273194aea3676d
+SHA512:
+  metadata.gz: bc15941cad051ee625472d759b848c69a26a2d0eb2e24d41f49484c9e82421df220f5780ed6978243c7e4983823a6df14a04194dce6e5dfef102a74f43af26e7
+  data.tar.gz: e83b60d1b28fdb0b958444f7c20b66dd4e1aef49201b62a66f01883f059229b2dbfde15a99b9b45771af45476044ddfe600117a628800eec24bfcb7b907b3e01

data/README.md

@@ -0,0 +1,47 @@
+# RailsCloudflareTurnstile
+
+This is a Rails plugin adding support for [Cloudflare Turnstile](https://www.cloudflare.com/products/turnstile/)
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_cloudflare_turnstile'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_cloudflare_turnstile
+```
+
+Next, configure it by creating a `config/initializers/cloudflare_turnstile.rb` with contents like the following:
+
+```ruby
+RailsCloudflareTurnstile.configure do |c|
+  c.site_key = "XXXXXX"
+  c.secret_key = "XXXXXXXX"
+  c.fail_open = true
+end
+```
+
+To totally disable Turnstile, you can set `c.enabled = false` and all other config values are ignored.
+
+To use Turnstile for a view:
+
+   1. Call `cloudflare_turnstile_script_tag` in your layout
+   2. Call `cloudflare_turnstile` in your form View
+   3. Call `validate_cloudflare_turnstile` as a `before_action` in your controller.
+
+If the challenge fails, the exception `RailsCloudflareTurnstile::Forbidden` will be raised; you should handle this with
+a `rescue_from` block.
+
+## License
+The gem is available as open source under the terms of the [ISC License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/rails_cloudflare_turnstile/configuration.rb

@@ -0,0 +1,45 @@
+module RailsCloudflareTurnstile
+  class Configuration
+    # site key (your public key)
+    attr_accessor :site_key
+
+    # secret key
+    attr_accessor :secret_key
+
+    # if true, then a failure to contact cloudflare will allow all requests
+    # if false, then a failure to contact cloudflare will block all requests
+    # defaults to true
+    attr_accessor :fail_open
+
+    attr_accessor :validation_url
+
+    # Timeout for operations with Cloudflare
+    attr_accessor :timeout
+
+    # size for the widget ("regular" or "compact")
+    attr_accessor :size
+
+    attr_accessor :enabled
+
+    def initialize
+      @site_key = nil
+      @secret_key = nil
+      @fail_open = true
+      @enabled = nil
+      @timeout = 5.0
+      @size = :regular
+      @validation_url = "https://challenges.cloudflare.com/turnstile/v0/siteverify"
+    end
+
+    def validate!
+      raise "Must set site key" if @site_key.nil?
+      raise "Must set secret key" if @secret_key.nil?
+      @size = @size.to_sym
+      raise "Size must be one of ':regular' or ':compact'" unless [:regular, :compact].include? @size
+    end
+
+    def disabled?
+      @enabled == false
+    end
+  end
+end

data/lib/rails_cloudflare_turnstile/controller_helpers.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module RailsCloudflareTurnstile
+  module ControllerHelpers
+    def cloudflare_turnstile_ok?
+      return true unless RailsCloudflareTurnstile.enabled?
+
+      config = RailsCloudflareTurnstile.configuration
+
+      url = URI(config.validation_url)
+
+      body = {
+        secret: config.secret_key,
+        response: params["cf-turnstile-response"],
+        remoteip: request.remote_ip
+      }
+
+      begin
+        resp = Faraday.new(url) { |conn|
+          conn.options.timeout = config.timeout
+          conn.options.open_timeout = config.timeout
+          conn.use Faraday::Response::RaiseError
+          conn.request :json
+          conn.response :json
+        }.post(url, body)
+      rescue Faraday::Error => e
+        Rails.logger.error "Error response from CloudFlare Turnstile: #{e}"
+        if config.fail_open
+          return true
+        else
+          return false
+        end
+      end
+
+      json = resp.body
+
+      success = json["success"]
+
+      return true if success
+
+      error = json["error-codes"][0]
+
+      ActiveSupport::Notifications.instrument(
+        "rails_cloudflare_turnstile.failure",
+        message: error,
+        remote_ip: request.remote_ip,
+        user_agent: request.user_agent,
+        controller: params[:controller],
+        action: params[:action],
+        url: request.url
+      )
+
+      false
+    end
+
+    private
+
+    def validate_cloudflare_turnstile
+      return if cloudflare_turnstile_ok?
+      raise RailsCloudflareTurnstile::Forbidden
+    end
+  end
+end

data/lib/rails_cloudflare_turnstile/errors.rb

@@ -0,0 +1,7 @@
+module RailsCloudflareTurnstile
+  class Error < StandardError
+  end
+
+  class Forbidden < Error
+  end
+end

data/lib/rails_cloudflare_turnstile/railtie.rb

@@ -0,0 +1,13 @@
+module RailsCloudflareTurnstile
+  class Railtie < ::Rails::Railtie
+    initializer "rails_cloudflare_turnstile" do
+      ActiveSupport.on_load(:action_controller) do
+        include RailsCloudflareTurnstile::ControllerHelpers
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include RailsCloudflareTurnstile::ViewHelpers
+      end
+    end
+  end
+end

data/lib/rails_cloudflare_turnstile/version.rb

@@ -0,0 +1,3 @@
+module RailsCloudflareTurnstile
+  VERSION = "0.1.0"
+end

data/lib/rails_cloudflare_turnstile/view_helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RailsCloudflareTurnstile
+  module ViewHelpers
+    def cloudflare_turnstile(action: "other")
+      return nil unless RailsCloudflareTurnstile.enabled?
+      content_tag(:div, class: "cloudflare-turnstile") do
+        concat turnstile_div(action)
+      end
+    end
+
+    def cloudflare_turnstile_script_tag
+      return nil unless RailsCloudflareTurnstile.enabled?
+      content_tag(:script, :src => js_src, "async" => true) do
+        ""
+      end
+    end
+
+    private
+
+    def turnstile_div(action)
+      config = RailsCloudflareTurnstile.configuration
+      content_tag(:div, :class => "cf-turnstile", "data-sitekey" => site_key, "data-size" => config.size, "data-action" => action) do
+        ""
+      end
+    end
+
+    def site_key
+      RailsCloudflareTurnstile.configuration.site_key
+    end
+
+    def js_src
+      "https://challenges.cloudflare.com/turnstile/v0/api.js"
+    end
+  end
+end

data/lib/rails_cloudflare_turnstile.rb

@@ -0,0 +1,35 @@
+require "rails_cloudflare_turnstile/version"
+require "rails_cloudflare_turnstile/configuration"
+require "rails_cloudflare_turnstile/errors"
+require "rails_cloudflare_turnstile/controller_helpers"
+require "rails_cloudflare_turnstile/view_helpers"
+require "rails_cloudflare_turnstile/railtie"
+
+module RailsCloudflareTurnstile
+  LOCK = Mutex.new
+
+  def self.configure
+    yield(configuration) if block_given?
+    unless configuration.disabled?
+      configuration.validate!
+    end
+    if configuration.enabled.nil?
+      configuration.enabled = true
+    end
+  end
+
+  def self.enabled?
+    configuration.enabled == true
+  end
+
+  def self.reset_configuration!
+    LOCK.synchronize do
+      @configuration = nil
+    end
+  end
+
+  def self.configuration
+    @configuration = nil unless defined?(@configuration)
+    @configuration || LOCK.synchronize { @configuration ||= RailsCloudflareTurnstile::Configuration.new }
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails_cloudflare_turnstile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Brown
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Rails extension for Cloudflare's Turnstile CAPTCHA alternative. This gem should work with
+      Rails 5.x, 6.x, and 7.x, and with Faraday 1.x and 2.x.
+email:
+- james@instrumentl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rails_cloudflare_turnstile.rb
+- lib/rails_cloudflare_turnstile/configuration.rb
+- lib/rails_cloudflare_turnstile/controller_helpers.rb
+- lib/rails_cloudflare_turnstile/errors.rb
+- lib/rails_cloudflare_turnstile/railtie.rb
+- lib/rails_cloudflare_turnstile/version.rb
+- lib/rails_cloudflare_turnstile/view_helpers.rb
+homepage: https://github.com/instrumentl/rails_cloudflare-turnstile
+licenses:
+- ISC
+metadata:
+  homepage_uri: https://github.com/instrumentl/rails_cloudflare-turnstile
+  source_code_uri: https://github.com/instrumentl/rails_cloudflare-turnstile
+  changelog_uri: https://github.com/dotenv-org/cloudflare_turnstile
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: Rails extension for Cloudflare's Turnstile CAPTCHA alternative
+test_files: []