Class: Rack::Protection::Base
- Inherits:
-
Object
- Object
- Rack::Protection::Base
show all
- Defined in:
- lib/rack/protection/base.rb
Direct Known Subclasses
AuthenticityToken, ContentSecurityPolicy, CookieTossing, EscapedParams, FrameOptions, HttpOrigin, IPSpoofing, JsonCsrf, PathTraversal, RemoteReferrer, SessionHijacking, StrictTransport, XSSHeader
Constant Summary
collapse
- DEFAULT_OPTIONS =
{
:reaction => :default_reaction, :logging => true,
:message => 'Forbidden', :encryptor => Digest::SHA1,
:session_key => 'rack.session', :status => 403,
:allow_empty_referrer => true,
:report_key => "protection.failed",
:html_types => %w[text/html application/xhtml text/xml application/xml]
}
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(app, options = {}) ⇒ Base
Returns a new instance of Base.
33
34
35
|
# File 'lib/rack/protection/base.rb', line 33
def initialize(app, options = {})
@app, @options = app, default_options.merge(options)
end
|
Instance Attribute Details
#app ⇒ Object
Returns the value of attribute app.
19
20
21
|
# File 'lib/rack/protection/base.rb', line 19
def app
@app
end
|
#options ⇒ Object
Returns the value of attribute options.
19
20
21
|
# File 'lib/rack/protection/base.rb', line 19
def options
@options
end
|
Class Method Details
.default_options(options) ⇒ Object
21
22
23
|
# File 'lib/rack/protection/base.rb', line 21
def self.default_options(options)
define_method(:default_options) { super().merge(options) }
end
|
.default_reaction(reaction) ⇒ Object
25
26
27
|
# File 'lib/rack/protection/base.rb', line 25
def self.default_reaction(reaction)
alias_method(:default_reaction, reaction)
end
|
Instance Method Details
#accepts?(env) ⇒ Boolean
41
42
43
|
# File 'lib/rack/protection/base.rb', line 41
def accepts?(env)
raise NotImplementedError, "#{self.class} implementation pending"
end
|
#call(env) ⇒ Object
45
46
47
48
49
50
51
|
# File 'lib/rack/protection/base.rb', line 45
def call(env)
unless accepts? env
instrument env
result = react env
end
result or app.call(env)
end
|
#default_options ⇒ Object
29
30
31
|
# File 'lib/rack/protection/base.rb', line 29
def default_options
DEFAULT_OPTIONS
end
|
#deny(env) ⇒ Object
Also known as:
default_reaction
70
71
72
73
|
# File 'lib/rack/protection/base.rb', line 70
def deny(env)
warn env, "attack prevented by #{self.class}"
[options[:status], {'Content-Type' => 'text/plain'}, [options[:message]]]
end
|
#drop_session(env) ⇒ Object
89
90
91
|
# File 'lib/rack/protection/base.rb', line 89
def drop_session(env)
session(env).clear if session? env
end
|
#encrypt(value) ⇒ Object
110
111
112
|
# File 'lib/rack/protection/base.rb', line 110
def encrypt(value)
options[:encryptor].hexdigest value.to_s
end
|
#html?(headers) ⇒ Boolean
120
121
122
123
|
# File 'lib/rack/protection/base.rb', line 120
def html?()
return false unless = .detect { |k,v| k.downcase == 'content-type' }
options[:html_types].include? .last[/^\w+\/\w+/]
end
|
#instrument(env) ⇒ Object
64
65
66
67
68
|
# File 'lib/rack/protection/base.rb', line 64
def instrument(env)
return unless i = options[:instrumenter]
env['rack.protection.attack'] = self.class.name.split('::').last.downcase
i.instrument('rack.protection', env)
end
|
#origin(env) ⇒ Object
100
101
102
|
# File 'lib/rack/protection/base.rb', line 100
def origin(env)
env['HTTP_ORIGIN'] || env['HTTP_X_ORIGIN']
end
|
#random_string(secure = defined? SecureRandom)) ⇒ Object
104
105
106
107
108
|
# File 'lib/rack/protection/base.rb', line 104
def random_string(secure = defined? SecureRandom)
secure ? SecureRandom.hex(16) : "%032x" % rand(2**128-1)
rescue NotImplementedError
random_string false
end
|
#react(env) ⇒ Object
53
54
55
56
|
# File 'lib/rack/protection/base.rb', line 53
def react(env)
result = send(options[:reaction], env)
result if Array === result and result.size == 3
end
|
#referrer(env) ⇒ Object
93
94
95
96
97
98
|
# File 'lib/rack/protection/base.rb', line 93
def referrer(env)
ref = env['HTTP_REFERER'].to_s
return if !options[:allow_empty_referrer] and ref.empty?
URI.parse(ref).host || Request.new(env).host
rescue URI::InvalidURIError
end
|
#report(env) ⇒ Object
75
76
77
78
|
# File 'lib/rack/protection/base.rb', line 75
def report(env)
warn env, "attack reported by #{self.class}"
env[options[:report_key]] = true
end
|
#safe?(env) ⇒ Boolean
37
38
39
|
# File 'lib/rack/protection/base.rb', line 37
def safe?(env)
%w[GET HEAD OPTIONS TRACE].include? env['REQUEST_METHOD']
end
|
#secure_compare(a, b) ⇒ Object
114
115
116
|
# File 'lib/rack/protection/base.rb', line 114
def secure_compare(a, b)
Rack::Utils.secure_compare(a.to_s, b.to_s)
end
|
#session(env) ⇒ Object
84
85
86
87
|
# File 'lib/rack/protection/base.rb', line 84
def session(env)
return env[options[:session_key]] if session? env
fail "you need to set up a session middleware *before* #{self.class}"
end
|
#session?(env) ⇒ Boolean
80
81
82
|
# File 'lib/rack/protection/base.rb', line 80
def session?(env)
env.include? options[:session_key]
end
|
#warn(env, message) ⇒ Object
58
59
60
61
62
|
# File 'lib/rack/protection/base.rb', line 58
def warn(env, message)
return unless options[:logging]
l = options[:logger] || env['rack.logger'] || ::Logger.new(env['rack.errors'])
l.warn(message)
end
|