sinatra/rack-protection
Jordan Owens c7e851f7d7 Bump version to 3.0.0 2022-02-02 16:06:15 -05:00
..
lib Bump version to 3.0.0 2022-02-02 16:06:15 -05:00
spec refactor: use __dir__ in File.expand_path 2022-02-02 15:58:11 -05:00
.gitignore [issue-1275] add rake task to generate docs, similar to sinatra-contrib 2017-04-09 12:30:24 +05:30
.rspec Restore RSpec init default files 2014-09-03 19:25:20 +02:00
Gemfile Fix gem source url 2018-02-23 02:12:20 +09:00
License Update LICENSE(s) 2017-03-19 12:05:31 +09:00
README.md Change relative URLs to absolute URLS 2017-05-24 09:48:41 +09:00
Rakefile refactor: use __dir__ in File.expand_path 2022-02-02 15:58:11 -05:00
rack-protection.gemspec refactor: use __dir__ in File.expand_path 2022-02-02 15:58:11 -05: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'.