sinatra/rack-protection
Jordan Owens aac8e3bce4 Mitigate BREACH attack 2016-08-16 21:22:49 -04:00
..
lib Mitigate BREACH attack 2016-08-16 21:22:49 -04:00
spec Mitigate BREACH attack 2016-08-16 21:22:49 -04: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 I guess rvm started failing the build once sudo was enabled 2016-07-25 17:35:59 +09:00
Gemfile Update CI matrix to match current support by Sinatra 2016-07-25 17:26:58 +09:00
License
README.md Add cookie tossing protection 2016-07-30 19:04:44 -04:00
Rakefile Bump version for developing 2.0.0 alpha 2016-07-25 16:57:04 +09:00
rack-protection.gemspec Bump version for developing 2.0.0 alpha 2016-07-25 16:57:04 +09: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 and Chrome only)
  • Rack::Protection::ContentSecurityPolicy

Clickjacking

Prevented by:

  • Rack::Protection::FrameOptions

Directory Traversal

Prevented by:

  • Rack::Protection::PathTraversal

Session Hijacking

Prevented by:

  • Rack::Protection::SessionHijacking

Prevented by:

  • Rack::Protection::CookieTossing (not included by use Rack::Protection)

IP Spoofing

Prevented by:

  • Rack::Protection::IPSpoofing

Prevented by:

  • Rack::Protection::StrictTransport (not included by use Rack::Protection)

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