rack-simple_csrf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc1560d053a3c6e140795a8ed52edbab6718888c
+  data.tar.gz: c35998ea6d6e873baf8f98bc2fa9dfe9f53c0372
+SHA512:
+  metadata.gz: 61ebfca10811016cf01de6267b27ba424efd4b56ef331ddae5a7a60a587d6d4c2fddb2aac581b25a6c4e4da1bdd5c9b7c020c69194e9e855e04deb80233e4e83
+  data.tar.gz: 93d11241740bc891deb13389154fc1f64e24a36c7a94493b655cccb2dc4a9d1abdb16c0f56557155fa89fa296ce734375b4ddc88a68111cdec55b05b2af3051e

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gemspec
+
+group :development do
+  gem "rake"
+end

data/License

@@ -0,0 +1,21 @@
+Copyright (c) 2013 Jordon Bedwell
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,3 @@
+require "rspec/core/rake_task"
+task :default => :spec
+RSpec::Core::RakeTask.new :spec

data/Readme.md

@@ -0,0 +1,61 @@
+# Rack::Csrf
+
+[![Build Status](https://travis-ci.org/envygeeks/rack-simple_csrf.png?branch=master)](https://travis-ci.org/envygeeks/rack-simple_csrf) [![Coverage Status](https://coveralls.io/repos/envygeeks/rack-simple_csrf/badge.png?branch=master)](https://coveralls.io/r/envygeeks/rack-simple_csrf) [![Code Climate](https://codeclimate.com/github/envygeeks/rack-simple_csrf.png)](https://codeclimate.com/github/envygeeks/rack-simple_csrf) [![Dependency Status](https://gemnasium.com/envygeeks/rack-simple_csrf.png)](https://gemnasium.com/envygeeks/rack-simple_csrf)
+
+Rack::SimpleCsrf is my personal version of CSRF for Rack.  It implements only a skip list where everything else must be run through the validator.  It does not allow you to be explicit in what you validate, only explicit in what you do not validate.  The goal is to increase security and make you think about what you are doing before you decide to do it.
+
+# Usage
+
+Rack::SimpleCsrf has a default output of "Denied", the example belows shows you passing your own caller for us.
+
+```ruby
+require "sinatra/base"
+require "rack/simple_csrf"
+require "logger"
+
+class MyApp < Sinatra::Base
+  set(:logger, Logger.new($stdout))
+
+  CSRF_SKIP_LIST = [
+    "/my-path",
+    "POST:/my-other-path"
+  ]
+
+  class << self
+    def denied!(exception)
+      MyApp.logger.error { exception }
+      [403, {}, ["Nice try asshole!"]]
+    end
+  end
+
+  post "/" do
+    puts "Hello World"
+  end
+
+  helpers Rack::SimpleCsrf::Helpers
+  use Rack::SimpleCsrf, {
+    :skip => CSRF_SKIP_LIST,
+    :render_with => proc { |*a|
+      denied!(*a)
+    }
+  }
+end
+```
+
+# Options
+
+`:header` - `HTTP_X_CSRF_TOKEN` The header key<br />
+`:key` - `csrf` -- The cookie key<br />
+`:field` - `auth`  -- The auth_field token (meta and form)<br />
+`:raise` - `false` -- Raise `Rack::SimpleCsrf::CSRFFailedToValidateError`
+<br /><br />
+Skip supports an array with values as "METHOD:/url" or "/url".<br /><br />
+
+If you chose not to raise you can optionally set `:render_with` with a callback. The callback will always recieve the `env` for you to call `Rack::Lint` or `Sinatra::Request` yourself. It is done this way so that people who wish to log can log since I don't accept a logger directly, you might also want to do other shit that I don't care about, so rather than giving a shit I might as well just accept a callback and let you do whatever the hell you want.
+
+# Helpers
+
+```ruby
+csrf_meta_tag(:field => "auth")
+csrf_form_tag(:tag => "div", :field => "auth")
+```

data/lib/rack/csrf.rb

@@ -0,0 +1,2 @@
+require "simple_csrf"
+Rack.const_set(:Csrf, Rack::SimpleCsrf)

data/lib/rack/simple_csrf.rb

@@ -0,0 +1,94 @@
+require_relative "simple_csrf/version"
+require "securerandom"
+
+class String
+  def strip_heredoc(offset = 0)
+    gsub(/^[ \t]{#{(scan(/^[ \t]*(?=\S)/).min || "").size}}/, offset = "\s" * (offset || 0))
+  end
+end
+
+module Rack
+  class SimpleCsrf
+    class CSRFSessionUnavailableError < StandardError
+      def initialize(msg = nil)
+        super msg || "CSRF requires session."
+      end
+    end
+
+    class CSRFFailedToValidateError < StandardError
+      def initialize(msg = nil)
+        super msg || "CSRF did not pass."
+      end
+    end
+
+    def initialize(app, opts = {})
+      @field = opts.fetch(:field, "auth")
+      @raise = opts.fetch(:raise, false)
+      @key = opts.fetch(:key, "csrf")
+      @skip = opts.fetch(:skip, [])
+
+      @app = app
+
+      @render_with = opts[:render_with]
+      @header = opts.fetch(:header, "HTTP_X_CSRF_TOKEN")
+      @methods = (%w(POST PUT DELETE PATCH) + opts.fetch(:http_methods, [])).flatten.uniq
+    end
+
+    def call(env, req = Rack::Request.new(env))
+      raise_if_session_unavailable_for! req
+      setup_csrf_for! req
+      return @app.call(env) if continue?(req)
+      @raise ? raise(CSRFFailedToValidateError) : render_error_for!(env)
+    end
+
+    private
+    def continue?(req)
+      req.params[@field] == req.env["rack.session"][@key] ||
+      req.env[@header] == req.env["rack.session"][@key] ||
+      ! @methods.include?(req.request_method) || any_skips?(req)
+    end
+
+    private
+    def any_skips?(req)
+      (Array === @skip && @skip.any? do |url|
+        meth, path = Regexp.escape(req.request_method), Regexp.escape(req.path)
+        url =~ /^#{meth}:#{path}$/ || url =~ /^#{path}$/
+      end)
+    end
+
+    private
+    def raise_if_session_unavailable_for!(req)
+      unless req.env["rack.session"]
+        raise CSRFSessionUnavailableError
+      end
+    end
+
+    private
+    def setup_csrf_for!(req)
+      req.env["rack.session"][@key] ||= SecureRandom.hex(32)
+    end
+
+    private
+    def render_error_for!(env)
+      Proc === @render_with ? @render_with.call(env) : [403, {}, ["Unauthorized"]]
+    end
+
+    module Helpers
+      extend self
+
+      def csrf_meta_tag(opts = {}, session = session)
+        %Q{<meta name="#{opts[:field] || "auth"}" content="#{session[opts[:key] || "csrf"]}">}
+      end
+
+      def csrf_form_tag(opts = {}, session = session)
+        session_key = session[opts[:key] || "csrf"]
+        tag = opts[:tag] || "div"
+        <<-HTML.strip_heredoc(opts[:offset])
+          <#{tag} class="hidden">
+            <input type="hidden" name="#{opts[:field] || "auth"}" value="#{session_key}">
+          </#{tag}>
+        HTML
+      end
+    end
+  end
+end

data/lib/rack/simple_csrf/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class SimpleCsrf
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rack-simple_csrf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordon Bedwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-expect_error
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: envygeeks-coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: luna-rspec-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: A simpler CSRF middleware for Rack.
+email:
+- envygeeks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- lib/rack/csrf.rb
+- lib/rack/simple_csrf.rb
+- lib/rack/simple_csrf/version.rb
+homepage: https://envygeeks.com/projects/rack-csrf
+licenses: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A simpler CSRF middleware for Rack.
+test_files: []