sidekiq 5.2.9 → 6.4.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of sidekiq might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/Changes.md +318 -1
- data/LICENSE +3 -3
- data/README.md +23 -34
- data/bin/sidekiq +27 -3
- data/bin/sidekiqload +67 -61
- data/bin/sidekiqmon +8 -0
- data/lib/generators/sidekiq/job_generator.rb +57 -0
- data/lib/generators/sidekiq/templates/{worker.rb.erb → job.rb.erb} +2 -2
- data/lib/generators/sidekiq/templates/{worker_spec.rb.erb → job_spec.rb.erb} +1 -1
- data/lib/generators/sidekiq/templates/{worker_test.rb.erb → job_test.rb.erb} +1 -1
- data/lib/sidekiq/api.rb +335 -267
- data/lib/sidekiq/cli.rb +164 -182
- data/lib/sidekiq/client.rb +58 -61
- data/lib/sidekiq/delay.rb +7 -6
- data/lib/sidekiq/exception_handler.rb +10 -12
- data/lib/sidekiq/extensions/action_mailer.rb +13 -22
- data/lib/sidekiq/extensions/active_record.rb +13 -10
- data/lib/sidekiq/extensions/class_methods.rb +14 -11
- data/lib/sidekiq/extensions/generic_proxy.rb +6 -4
- data/lib/sidekiq/fetch.rb +40 -32
- data/lib/sidekiq/job.rb +13 -0
- data/lib/sidekiq/job_logger.rb +33 -7
- data/lib/sidekiq/job_retry.rb +70 -71
- data/lib/sidekiq/job_util.rb +65 -0
- data/lib/sidekiq/launcher.rb +161 -71
- data/lib/sidekiq/logger.rb +170 -0
- data/lib/sidekiq/manager.rb +17 -21
- data/lib/sidekiq/middleware/chain.rb +20 -8
- data/lib/sidekiq/middleware/current_attributes.rb +57 -0
- data/lib/sidekiq/middleware/i18n.rb +5 -7
- data/lib/sidekiq/monitor.rb +133 -0
- data/lib/sidekiq/paginator.rb +20 -16
- data/lib/sidekiq/processor.rb +71 -70
- data/lib/sidekiq/rails.rb +40 -37
- data/lib/sidekiq/redis_connection.rb +48 -48
- data/lib/sidekiq/scheduled.rb +62 -28
- data/lib/sidekiq/sd_notify.rb +149 -0
- data/lib/sidekiq/systemd.rb +24 -0
- data/lib/sidekiq/testing/inline.rb +2 -1
- data/lib/sidekiq/testing.rb +36 -27
- data/lib/sidekiq/util.rb +57 -15
- data/lib/sidekiq/version.rb +2 -1
- data/lib/sidekiq/web/action.rb +15 -11
- data/lib/sidekiq/web/application.rb +88 -75
- data/lib/sidekiq/web/csrf_protection.rb +180 -0
- data/lib/sidekiq/web/helpers.rb +109 -92
- data/lib/sidekiq/web/router.rb +23 -19
- data/lib/sidekiq/web.rb +61 -105
- data/lib/sidekiq/worker.rb +247 -105
- data/lib/sidekiq.rb +77 -44
- data/sidekiq.gemspec +23 -16
- data/web/assets/images/apple-touch-icon.png +0 -0
- data/web/assets/javascripts/application.js +83 -64
- data/web/assets/javascripts/dashboard.js +54 -73
- data/web/assets/stylesheets/application-dark.css +143 -0
- data/web/assets/stylesheets/application-rtl.css +0 -4
- data/web/assets/stylesheets/application.css +45 -232
- data/web/locales/ar.yml +8 -2
- data/web/locales/de.yml +14 -2
- data/web/locales/en.yml +6 -1
- data/web/locales/es.yml +18 -2
- data/web/locales/fr.yml +10 -3
- data/web/locales/ja.yml +7 -1
- data/web/locales/lt.yml +83 -0
- data/web/locales/pl.yml +4 -4
- data/web/locales/ru.yml +4 -0
- data/web/locales/vi.yml +83 -0
- data/web/views/_footer.erb +1 -1
- data/web/views/_job_info.erb +3 -2
- data/web/views/_poll_link.erb +2 -5
- data/web/views/_summary.erb +7 -7
- data/web/views/busy.erb +54 -20
- data/web/views/dashboard.erb +22 -14
- data/web/views/dead.erb +3 -3
- data/web/views/layout.erb +3 -1
- data/web/views/morgue.erb +9 -6
- data/web/views/queue.erb +19 -10
- data/web/views/queues.erb +10 -2
- data/web/views/retries.erb +11 -8
- data/web/views/retry.erb +3 -3
- data/web/views/scheduled.erb +5 -2
- metadata +34 -64
- data/.circleci/config.yml +0 -61
- data/.github/contributing.md +0 -32
- data/.github/issue_template.md +0 -11
- data/.gitignore +0 -15
- data/.travis.yml +0 -11
- data/3.0-Upgrade.md +0 -70
- data/4.0-Upgrade.md +0 -53
- data/5.0-Upgrade.md +0 -56
- data/COMM-LICENSE +0 -97
- data/Ent-Changes.md +0 -238
- data/Gemfile +0 -23
- data/Pro-2.0-Upgrade.md +0 -138
- data/Pro-3.0-Upgrade.md +0 -44
- data/Pro-4.0-Upgrade.md +0 -35
- data/Pro-Changes.md +0 -759
- data/Rakefile +0 -9
- data/bin/sidekiqctl +0 -20
- data/code_of_conduct.md +0 -50
- data/lib/generators/sidekiq/worker_generator.rb +0 -49
- data/lib/sidekiq/core_ext.rb +0 -1
- data/lib/sidekiq/ctl.rb +0 -221
- data/lib/sidekiq/logging.rb +0 -122
- data/lib/sidekiq/middleware/server/active_record.rb +0 -23
@@ -4,9 +4,7 @@ module Sidekiq
|
|
4
4
|
class WebApplication
|
5
5
|
extend WebRouter
|
6
6
|
|
7
|
-
|
8
|
-
CONTENT_TYPE = "Content-Type"
|
9
|
-
REDIS_KEYS = %w(redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human)
|
7
|
+
REDIS_KEYS = %w[redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human]
|
10
8
|
CSP_HEADER = [
|
11
9
|
"default-src 'self' https: http:",
|
12
10
|
"child-src 'self'",
|
@@ -21,7 +19,7 @@ module Sidekiq
|
|
21
19
|
"style-src 'self' https: http: 'unsafe-inline'",
|
22
20
|
"worker-src 'self'",
|
23
21
|
"base-uri 'self'"
|
24
|
-
].join(
|
22
|
+
].join("; ").freeze
|
25
23
|
|
26
24
|
def initialize(klass)
|
27
25
|
@klass = klass
|
@@ -43,9 +41,19 @@ module Sidekiq
|
|
43
41
|
# nothing, backwards compatibility
|
44
42
|
end
|
45
43
|
|
44
|
+
head "/" do
|
45
|
+
# HEAD / is the cheapest heartbeat possible,
|
46
|
+
# it hits Redis to ensure connectivity
|
47
|
+
Sidekiq.redis { |c| c.llen("queue:default") }
|
48
|
+
""
|
49
|
+
end
|
50
|
+
|
46
51
|
get "/" do
|
47
|
-
@redis_info = redis_info.select{ |k, v| REDIS_KEYS.include? k }
|
48
|
-
|
52
|
+
@redis_info = redis_info.select { |k, v| REDIS_KEYS.include? k }
|
53
|
+
days = (params["days"] || 30).to_i
|
54
|
+
return halt(401) if days < 1 || days > 180
|
55
|
+
|
56
|
+
stats_history = Sidekiq::Stats::History.new(days)
|
49
57
|
@processed_history = stats_history.processed
|
50
58
|
@failed_history = stats_history.failed
|
51
59
|
|
@@ -57,14 +65,14 @@ module Sidekiq
|
|
57
65
|
end
|
58
66
|
|
59
67
|
post "/busy" do
|
60
|
-
if params[
|
61
|
-
p = Sidekiq::Process.new(
|
62
|
-
p.quiet! if params[
|
63
|
-
p.stop! if params[
|
68
|
+
if params["identity"]
|
69
|
+
p = Sidekiq::Process.new("identity" => params["identity"])
|
70
|
+
p.quiet! if params["quiet"]
|
71
|
+
p.stop! if params["stop"]
|
64
72
|
else
|
65
73
|
processes.each do |pro|
|
66
|
-
pro.quiet! if params[
|
67
|
-
pro.stop! if params[
|
74
|
+
pro.quiet! if params["quiet"]
|
75
|
+
pro.stop! if params["stop"]
|
68
76
|
end
|
69
77
|
end
|
70
78
|
|
@@ -77,42 +85,53 @@ module Sidekiq
|
|
77
85
|
erb(:queues)
|
78
86
|
end
|
79
87
|
|
88
|
+
QUEUE_NAME = /\A[a-z_:.\-0-9]+\z/i
|
89
|
+
|
80
90
|
get "/queues/:name" do
|
81
91
|
@name = route_params[:name]
|
82
92
|
|
83
|
-
halt(404)
|
93
|
+
halt(404) if !@name || @name !~ QUEUE_NAME
|
84
94
|
|
85
|
-
@count = (params[
|
95
|
+
@count = (params["count"] || 25).to_i
|
86
96
|
@queue = Sidekiq::Queue.new(@name)
|
87
|
-
(@current_page, @total_size, @
|
88
|
-
@
|
97
|
+
(@current_page, @total_size, @jobs) = page("queue:#{@name}", params["page"], @count, reverse: params["direction"] == "asc")
|
98
|
+
@jobs = @jobs.map { |msg| Sidekiq::JobRecord.new(msg, @name) }
|
89
99
|
|
90
100
|
erb(:queue)
|
91
101
|
end
|
92
102
|
|
93
103
|
post "/queues/:name" do
|
94
|
-
Sidekiq::Queue.new(route_params[:name])
|
104
|
+
queue = Sidekiq::Queue.new(route_params[:name])
|
105
|
+
|
106
|
+
if Sidekiq.pro? && params["pause"]
|
107
|
+
queue.pause!
|
108
|
+
elsif Sidekiq.pro? && params["unpause"]
|
109
|
+
queue.unpause!
|
110
|
+
else
|
111
|
+
queue.clear
|
112
|
+
end
|
95
113
|
|
96
114
|
redirect "#{root_path}queues"
|
97
115
|
end
|
98
116
|
|
99
117
|
post "/queues/:name/delete" do
|
100
118
|
name = route_params[:name]
|
101
|
-
Sidekiq::
|
119
|
+
Sidekiq::JobRecord.new(params["key_val"], name).delete
|
102
120
|
|
103
121
|
redirect_with_query("#{root_path}queues/#{CGI.escape(name)}")
|
104
122
|
end
|
105
123
|
|
106
|
-
get
|
107
|
-
@count = (params[
|
108
|
-
(@current_page, @total_size, @dead) = page("dead", params[
|
124
|
+
get "/morgue" do
|
125
|
+
@count = (params["count"] || 25).to_i
|
126
|
+
(@current_page, @total_size, @dead) = page("dead", params["page"], @count, reverse: true)
|
109
127
|
@dead = @dead.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
110
128
|
|
111
129
|
erb(:morgue)
|
112
130
|
end
|
113
131
|
|
114
132
|
get "/morgue/:key" do
|
115
|
-
|
133
|
+
key = route_params[:key]
|
134
|
+
halt(404) unless key
|
116
135
|
|
117
136
|
@dead = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
118
137
|
|
@@ -123,10 +142,10 @@ module Sidekiq
|
|
123
142
|
end
|
124
143
|
end
|
125
144
|
|
126
|
-
post
|
127
|
-
redirect(request.path) unless params[
|
145
|
+
post "/morgue" do
|
146
|
+
redirect(request.path) unless params["key"]
|
128
147
|
|
129
|
-
params[
|
148
|
+
params["key"].each do |key|
|
130
149
|
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
131
150
|
retry_or_delete_or_kill job, params if job
|
132
151
|
end
|
@@ -147,7 +166,8 @@ module Sidekiq
|
|
147
166
|
end
|
148
167
|
|
149
168
|
post "/morgue/:key" do
|
150
|
-
|
169
|
+
key = route_params[:key]
|
170
|
+
halt(404) unless key
|
151
171
|
|
152
172
|
job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
|
153
173
|
retry_or_delete_or_kill job, params if job
|
@@ -155,9 +175,9 @@ module Sidekiq
|
|
155
175
|
redirect_with_query("#{root_path}morgue")
|
156
176
|
end
|
157
177
|
|
158
|
-
get
|
159
|
-
@count = (params[
|
160
|
-
(@current_page, @total_size, @retries) = page("retry", params[
|
178
|
+
get "/retries" do
|
179
|
+
@count = (params["count"] || 25).to_i
|
180
|
+
(@current_page, @total_size, @retries) = page("retry", params["page"], @count)
|
161
181
|
@retries = @retries.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
162
182
|
|
163
183
|
erb(:retries)
|
@@ -173,10 +193,10 @@ module Sidekiq
|
|
173
193
|
end
|
174
194
|
end
|
175
195
|
|
176
|
-
post
|
177
|
-
redirect(request.path) unless params[
|
196
|
+
post "/retries" do
|
197
|
+
redirect(request.path) unless params["key"]
|
178
198
|
|
179
|
-
params[
|
199
|
+
params["key"].each do |key|
|
180
200
|
job = Sidekiq::RetrySet.new.fetch(*parse_params(key)).first
|
181
201
|
retry_or_delete_or_kill job, params if job
|
182
202
|
end
|
@@ -210,9 +230,9 @@ module Sidekiq
|
|
210
230
|
redirect_with_query("#{root_path}retries")
|
211
231
|
end
|
212
232
|
|
213
|
-
get
|
214
|
-
@count = (params[
|
215
|
-
(@current_page, @total_size, @scheduled) = page("schedule", params[
|
233
|
+
get "/scheduled" do
|
234
|
+
@count = (params["count"] || 25).to_i
|
235
|
+
(@current_page, @total_size, @scheduled) = page("schedule", params["page"], @count)
|
216
236
|
@scheduled = @scheduled.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
|
217
237
|
|
218
238
|
erb(:scheduled)
|
@@ -228,10 +248,10 @@ module Sidekiq
|
|
228
248
|
end
|
229
249
|
end
|
230
250
|
|
231
|
-
post
|
232
|
-
redirect(request.path) unless params[
|
251
|
+
post "/scheduled" do
|
252
|
+
redirect(request.path) unless params["key"]
|
233
253
|
|
234
|
-
params[
|
254
|
+
params["key"].each do |key|
|
235
255
|
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
|
236
256
|
delete_or_add_queue job, params if job
|
237
257
|
end
|
@@ -240,7 +260,8 @@ module Sidekiq
|
|
240
260
|
end
|
241
261
|
|
242
262
|
post "/scheduled/:key" do
|
243
|
-
|
263
|
+
key = route_params[:key]
|
264
|
+
halt(404) unless key
|
244
265
|
|
245
266
|
job = Sidekiq::ScheduledSet.new.fetch(*parse_params(key)).first
|
246
267
|
delete_or_add_queue job, params if job
|
@@ -248,23 +269,23 @@ module Sidekiq
|
|
248
269
|
redirect_with_query("#{root_path}scheduled")
|
249
270
|
end
|
250
271
|
|
251
|
-
get
|
272
|
+
get "/dashboard/stats" do
|
252
273
|
redirect "#{root_path}stats"
|
253
274
|
end
|
254
275
|
|
255
|
-
get
|
276
|
+
get "/stats" do
|
256
277
|
sidekiq_stats = Sidekiq::Stats.new
|
257
|
-
redis_stats
|
278
|
+
redis_stats = redis_info.select { |k, v| REDIS_KEYS.include? k }
|
258
279
|
json(
|
259
280
|
sidekiq: {
|
260
|
-
processed:
|
261
|
-
failed:
|
262
|
-
busy:
|
263
|
-
processes:
|
264
|
-
enqueued:
|
265
|
-
scheduled:
|
266
|
-
retries:
|
267
|
-
dead:
|
281
|
+
processed: sidekiq_stats.processed,
|
282
|
+
failed: sidekiq_stats.failed,
|
283
|
+
busy: sidekiq_stats.workers_size,
|
284
|
+
processes: sidekiq_stats.processes_size,
|
285
|
+
enqueued: sidekiq_stats.enqueued,
|
286
|
+
scheduled: sidekiq_stats.scheduled_size,
|
287
|
+
retries: sidekiq_stats.retry_size,
|
288
|
+
dead: sidekiq_stats.dead_size,
|
268
289
|
default_latency: sidekiq_stats.default_queue_latency
|
269
290
|
},
|
270
291
|
redis: redis_stats,
|
@@ -272,60 +293,52 @@ module Sidekiq
|
|
272
293
|
)
|
273
294
|
end
|
274
295
|
|
275
|
-
get
|
296
|
+
get "/stats/queues" do
|
276
297
|
json Sidekiq::Stats::Queues.new.lengths
|
277
298
|
end
|
278
299
|
|
279
300
|
def call(env)
|
280
301
|
action = self.class.match(env)
|
281
|
-
return [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass"
|
302
|
+
return [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass"}, ["Not Found"]] unless action
|
282
303
|
|
304
|
+
app = @klass
|
283
305
|
resp = catch(:halt) do
|
284
|
-
app = @klass
|
285
306
|
self.class.run_befores(app, action)
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
self.class.run_afters(app, action)
|
290
|
-
end
|
291
|
-
|
292
|
-
resp
|
307
|
+
action.instance_exec env, &action.block
|
308
|
+
ensure
|
309
|
+
self.class.run_afters(app, action)
|
293
310
|
end
|
294
311
|
|
295
|
-
|
312
|
+
case resp
|
296
313
|
when Array
|
314
|
+
# redirects go here
|
297
315
|
resp
|
298
316
|
else
|
317
|
+
# rendered content goes here
|
299
318
|
headers = {
|
300
319
|
"Content-Type" => "text/html",
|
301
|
-
"Cache-Control" => "no-
|
320
|
+
"Cache-Control" => "private, no-store",
|
302
321
|
"Content-Language" => action.locale,
|
303
322
|
"Content-Security-Policy" => CSP_HEADER
|
304
323
|
}
|
305
|
-
|
324
|
+
# we'll let Rack calculate Content-Length for us.
|
306
325
|
[200, headers, [resp]]
|
307
326
|
end
|
308
|
-
|
309
|
-
resp[1] = resp[1].dup
|
310
|
-
|
311
|
-
resp[1][CONTENT_LENGTH] = resp[2].inject(0) { |l, p| l + p.bytesize }.to_s
|
312
|
-
|
313
|
-
resp
|
314
327
|
end
|
315
328
|
|
316
|
-
def self.helpers(mod=nil, &block)
|
317
|
-
if
|
329
|
+
def self.helpers(mod = nil, &block)
|
330
|
+
if block
|
318
331
|
WebAction.class_eval(&block)
|
319
332
|
else
|
320
333
|
WebAction.send(:include, mod)
|
321
334
|
end
|
322
335
|
end
|
323
336
|
|
324
|
-
def self.before(path=nil, &block)
|
337
|
+
def self.before(path = nil, &block)
|
325
338
|
befores << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
|
326
339
|
end
|
327
340
|
|
328
|
-
def self.after(path=nil, &block)
|
341
|
+
def self.after(path = nil, &block)
|
329
342
|
afters << [path && Regexp.new("\\A#{path.gsub("*", ".*")}\\z"), block]
|
330
343
|
end
|
331
344
|
|
@@ -338,8 +351,8 @@ module Sidekiq
|
|
338
351
|
end
|
339
352
|
|
340
353
|
def self.run_hooks(hooks, app, action)
|
341
|
-
hooks.select { |p,_| !p || p =~ action.env[WebRouter::PATH_INFO] }
|
342
|
-
|
354
|
+
hooks.select { |p, _| !p || p =~ action.env[WebRouter::PATH_INFO] }
|
355
|
+
.each { |_, b| action.instance_exec(action.env, app, &b) }
|
343
356
|
end
|
344
357
|
|
345
358
|
def self.befores
|
@@ -0,0 +1,180 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# this file originally based on authenticity_token.rb from the sinatra/rack-protection project
|
4
|
+
#
|
5
|
+
# The MIT License (MIT)
|
6
|
+
#
|
7
|
+
# Copyright (c) 2011-2017 Konstantin Haase
|
8
|
+
# Copyright (c) 2015-2017 Zachary Scott
|
9
|
+
#
|
10
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
11
|
+
# a copy of this software and associated documentation files (the
|
12
|
+
# 'Software'), to deal in the Software without restriction, including
|
13
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
14
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
15
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
16
|
+
# the following conditions:
|
17
|
+
#
|
18
|
+
# The above copyright notice and this permission notice shall be
|
19
|
+
# included in all copies or substantial portions of the Software.
|
20
|
+
#
|
21
|
+
# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
22
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
23
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
24
|
+
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
25
|
+
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
26
|
+
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
27
|
+
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
28
|
+
|
29
|
+
require "securerandom"
|
30
|
+
require "base64"
|
31
|
+
require "rack/request"
|
32
|
+
|
33
|
+
module Sidekiq
|
34
|
+
class Web
|
35
|
+
class CsrfProtection
|
36
|
+
def initialize(app, options = nil)
|
37
|
+
@app = app
|
38
|
+
end
|
39
|
+
|
40
|
+
def call(env)
|
41
|
+
accept?(env) ? admit(env) : deny(env)
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def admit(env)
|
47
|
+
# On each successful request, we create a fresh masked token
|
48
|
+
# which will be used in any forms rendered for this request.
|
49
|
+
s = session(env)
|
50
|
+
s[:csrf] ||= SecureRandom.base64(TOKEN_LENGTH)
|
51
|
+
env[:csrf_token] = mask_token(s[:csrf])
|
52
|
+
@app.call(env)
|
53
|
+
end
|
54
|
+
|
55
|
+
def safe?(env)
|
56
|
+
%w[GET HEAD OPTIONS TRACE].include? env["REQUEST_METHOD"]
|
57
|
+
end
|
58
|
+
|
59
|
+
def logger(env)
|
60
|
+
@logger ||= (env["rack.logger"] || ::Logger.new(env["rack.errors"]))
|
61
|
+
end
|
62
|
+
|
63
|
+
def deny(env)
|
64
|
+
logger(env).warn "attack prevented by #{self.class}"
|
65
|
+
[403, {"Content-Type" => "text/plain"}, ["Forbidden"]]
|
66
|
+
end
|
67
|
+
|
68
|
+
def session(env)
|
69
|
+
env["rack.session"] || fail(<<~EOM)
|
70
|
+
Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
|
71
|
+
make sure you mount Sidekiq::Web *inside* your application routes:
|
72
|
+
|
73
|
+
|
74
|
+
Rails.application.routes.draw do
|
75
|
+
mount Sidekiq::Web => "/sidekiq"
|
76
|
+
....
|
77
|
+
end
|
78
|
+
|
79
|
+
|
80
|
+
If this is a Rails app in API mode, you need to enable sessions.
|
81
|
+
|
82
|
+
https://guides.rubyonrails.org/api_app.html#using-session-middlewares
|
83
|
+
|
84
|
+
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
|
85
|
+
|
86
|
+
# first, use IRB to create a shared secret key for sessions and commit it
|
87
|
+
require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
|
88
|
+
|
89
|
+
# now use the secret with a session cookie middleware
|
90
|
+
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
|
91
|
+
run Sidekiq::Web
|
92
|
+
|
93
|
+
EOM
|
94
|
+
end
|
95
|
+
|
96
|
+
def accept?(env)
|
97
|
+
return true if safe?(env)
|
98
|
+
|
99
|
+
giventoken = ::Rack::Request.new(env).params["authenticity_token"]
|
100
|
+
valid_token?(env, giventoken)
|
101
|
+
end
|
102
|
+
|
103
|
+
TOKEN_LENGTH = 32
|
104
|
+
|
105
|
+
# Checks that the token given to us as a parameter matches
|
106
|
+
# the token stored in the session.
|
107
|
+
def valid_token?(env, giventoken)
|
108
|
+
return false if giventoken.nil? || giventoken.empty?
|
109
|
+
|
110
|
+
begin
|
111
|
+
token = decode_token(giventoken)
|
112
|
+
rescue ArgumentError # client input is invalid
|
113
|
+
return false
|
114
|
+
end
|
115
|
+
|
116
|
+
sess = session(env)
|
117
|
+
localtoken = sess[:csrf]
|
118
|
+
|
119
|
+
# Checks that Rack::Session::Cookie actualy contains the csrf toekn
|
120
|
+
return false if localtoken.nil?
|
121
|
+
|
122
|
+
# Rotate the session token after every use
|
123
|
+
sess[:csrf] = SecureRandom.base64(TOKEN_LENGTH)
|
124
|
+
|
125
|
+
# See if it's actually a masked token or not. We should be able
|
126
|
+
# to handle any unmasked tokens that we've issued without error.
|
127
|
+
|
128
|
+
if unmasked_token?(token)
|
129
|
+
compare_with_real_token token, localtoken
|
130
|
+
elsif masked_token?(token)
|
131
|
+
unmasked = unmask_token(token)
|
132
|
+
compare_with_real_token unmasked, localtoken
|
133
|
+
else
|
134
|
+
false # Token is malformed
|
135
|
+
end
|
136
|
+
end
|
137
|
+
|
138
|
+
# Creates a masked version of the authenticity token that varies
|
139
|
+
# on each request. The masking is used to mitigate SSL attacks
|
140
|
+
# like BREACH.
|
141
|
+
def mask_token(token)
|
142
|
+
token = decode_token(token)
|
143
|
+
one_time_pad = SecureRandom.random_bytes(token.length)
|
144
|
+
encrypted_token = xor_byte_strings(one_time_pad, token)
|
145
|
+
masked_token = one_time_pad + encrypted_token
|
146
|
+
Base64.strict_encode64(masked_token)
|
147
|
+
end
|
148
|
+
|
149
|
+
# Essentially the inverse of +mask_token+.
|
150
|
+
def unmask_token(masked_token)
|
151
|
+
# Split the token into the one-time pad and the encrypted
|
152
|
+
# value and decrypt it
|
153
|
+
token_length = masked_token.length / 2
|
154
|
+
one_time_pad = masked_token[0...token_length]
|
155
|
+
encrypted_token = masked_token[token_length..-1]
|
156
|
+
xor_byte_strings(one_time_pad, encrypted_token)
|
157
|
+
end
|
158
|
+
|
159
|
+
def unmasked_token?(token)
|
160
|
+
token.length == TOKEN_LENGTH
|
161
|
+
end
|
162
|
+
|
163
|
+
def masked_token?(token)
|
164
|
+
token.length == TOKEN_LENGTH * 2
|
165
|
+
end
|
166
|
+
|
167
|
+
def compare_with_real_token(token, local)
|
168
|
+
::Rack::Utils.secure_compare(token.to_s, decode_token(local).to_s)
|
169
|
+
end
|
170
|
+
|
171
|
+
def decode_token(token)
|
172
|
+
Base64.strict_decode64(token)
|
173
|
+
end
|
174
|
+
|
175
|
+
def xor_byte_strings(s1, s2)
|
176
|
+
s1.bytes.zip(s2.bytes).map { |(c1, c2)| c1 ^ c2 }.pack("c*")
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|