sinatra/rack-protection
Olle Jonsson dd96efb34a [rack-protection] drop unused Travis config 2017-09-09 08:46:00 +02:00
..
lib
spec
.gitignore
.rspec
Gemfile
License
README.md Change relative URLs to absolute URLS 2017-05-24 09:48:41 +09:00
Rakefile Write readme to includes as well 2017-05-08 08:59:12 +09:00
rack-protection.gemspec Update RSpec 3 for rack-protection to use latest version. 2017-06-19 12:40:14 +02:00

README.md

Rack::Protection

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:

Cross Site Scripting

Prevented by:

Clickjacking

Prevented by:

Directory Traversal

Prevented by:

Session Hijacking

Prevented by:

Prevented by:

IP Spoofing

Prevented by:

Prevented by:

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'.