sinatra/rack-protection
Zachary Scott 1d011e5cab Add build status image to README 2016-07-25 13:23:53 +09:00
..
lib Fix permissions back to 0644 2015-01-16 15:13:23 +01:00
spec Fix permissions back to 0644 2015-01-16 15:13:23 +01:00
.gitignore ignore Gemfile.lock 2011-09-30 15:50:51 -05:00
.rspec Restore RSpec init default files 2014-09-03 19:25:20 +02:00
.travis.yml deal with rbx travis setup later 2014-01-15 10:36:13 +01:00
Gemfile Use magic comment 2013-05-14 21:14:21 -07:00
License initial commit 2011-05-23 10:07:54 +02:00
README.md Add build status image to README 2016-07-25 13:23:53 +09:00
Rakefile v1.4.0 2013-03-01 15:55:54 +11:00
rack-protection.gemspec Merge pull request #87 from mdesantis/rspec3 2015-04-11 20:18:23 -07:00

README.md

Rack::Protection

Build Status

This gem protects against typical web attacks. Should work for all Rack apps, including Rails.

Usage

Use all protections you probably want to use:

# config.ru
require 'rack/protection'
use Rack::Protection
run MyApp

Skip a single protection middleware:

# config.ru
require 'rack/protection'
use Rack::Protection, :except => :path_traversal
run MyApp

Use a single protection middleware:

# config.ru
require 'rack/protection'
use Rack::Protection::AuthenticityToken
run MyApp

Prevented Attacks

Cross Site Request Forgery

Prevented by:

  • Rack::Protection::AuthenticityToken (not included by use Rack::Protection)
  • Rack::Protection::FormToken (not included by use Rack::Protection)
  • Rack::Protection::JsonCsrf
  • Rack::Protection::RemoteReferrer (not included by use Rack::Protection)
  • Rack::Protection::RemoteToken
  • Rack::Protection::HttpOrigin

Cross Site Scripting

Prevented by:

  • Rack::Protection::EscapedParams (not included by use Rack::Protection)
  • Rack::Protection::XSSHeader (Internet Explorer only)

Clickjacking

Prevented by:

  • Rack::Protection::FrameOptions

Directory Traversal

Prevented by:

  • Rack::Protection::PathTraversal

Session Hijacking

Prevented by:

  • Rack::Protection::SessionHijacking

IP Spoofing

Prevented by:

  • Rack::Protection::IPSpoofing

Installation

gem install rack-protection

Instrumentation

Instrumentation is enabled by passing in an instrumenter as an option.

use Rack::Protection, instrumenter: ActiveSupport::Notifications

The instrumenter is passed a namespace (String) and environment (Hash). The namespace is 'rack.protection' and the attack type can be obtained from the environment key 'rack.protection.attack'.