Skip to content

Commit 24c35e6

Browse files
committed
Add note about sessions and Rails apps in API mode
1 parent f508a30 commit 24c35e6

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

Changes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ HEAD
66
---------
77

88
- Update RTT warning logic to handle transient RTT spikes [#4851]
9+
- Fix very low priority CVE on unescaped queue name [#4852]
10+
- Add note about sessions and Rails apps in API mode
911

1012
6.2.0
1113
---------
@@ -36,6 +38,10 @@ If this is a bare Rack app, use a session middleware before Sidekiq::Web:
3638
# now, update your Rack app to include the secret with a session cookie middleware
3739
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
3840
run Sidekiq::Web
41+
42+
If this is a Rails app in API mode, you need to enable sessions.
43+
44+
https://guides.rubyonrails.org/api_app.html#using-session-middlewares
3945
```
4046

4147
6.1.3

lib/sidekiq/web/csrf_protection.rb

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,19 @@ def session(env)
7777
end
7878
7979
80-
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
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
8183
84+
If this is a bare Rack app, use a session middleware before Sidekiq::Web:
8285
83-
# first, use IRB to create a shared secret key for sessions and commit it
84-
require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
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)) }
8588
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
8692
87-
# now use the secret with a session cookie middleware
88-
use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
89-
run Sidekiq::Web
9093
EOM
9194
end
9295

0 commit comments

Comments
 (0)