🚀 Release candidates should not be considered production-ready nor stable.
🔖 Version 2.0 of OmniAuth includes some changes that may be breaking depending on how you use OmniAuth in your app.
Many thanks to the folks who contributed in code and discussion for these changes.
0️⃣ OmniAuth now defaults to only POST as the allowed request_phase method.
This change also includes an additional configurable phase:
By default, this uses rack-protection's AuthenticityToken class to validate authenticity tokens. If you are using a rack based framework like sinatra, you can find an example of how to add authenticity tokens to your view here.
Because Rails handles its CSRF protection in its RequestForgeryProtection class, and stores tokens in a non-vanilla-rack friendly way, you must pass a rails-friendly validator in instead, similar to what omniauth-rails_csrf_protection does.
# Derived from https://github.com/cookpad/omniauth-rails\_csrf\_protection/blob/master/lib/omniauth/rails\_csrf\_protection/token\_verifier.rb# This specific implementation has been pared down and should not be taken as the most correct way to do this.class TokenVerifierinclude ActiveSupport::Configurableinclude ActionController::RequestForgeryProtectiondef call(env)@request = ActionDispatch::Request.new(env.dup)raise OmniAuth::AuthenticityError unless verified\_request?endprivateattr\_reader :requestdelegate :params, :session, to: :requestend# in an initializerOmniAuth.config.request\_validation\_phase = TokenVerifier.new
Alternatively, if you're already using the omniauth-rails_csrf_protection gem, I have a PR open (cookpad/omniauth-rails_csrf_protection#9) that you can use my branch to automatically configure the request_validation_phase.
💎 If you're using Rails' form helpers, they automatically include an authenticity token.
💅 If you are using hyperlinks or buttons styled to redirect to your login route, you should update these to be a submit input or a submit type button wrapped in a form.
- \<a href='/auth/developer'\>Login with Developer\</a\>+ \<%= form\_tag('/auth/developer', method: 'post') do %\>+ \<button type='submit'\>Login with Developer\</button\>+ \<% end %\>
Because using GET for login poses concerns (see OWASP Cheatsheet), after upgrading OmniAuth will log a
:warnlevel log with every GET request to a login path when your
⚠ If you have a workflow that absolutely requires you to use GET for the request_phase, you can disable this warning using
OmniAuth.config.silence\_get\_warning = true
It is very important that you do not do this just to circumvent having to change your inputs or login flow, as using GET for most auth workflows is not what you want.
OmniAuth now catches exceptions raised during the options_call, request_call, callback_call, and other_phase, and passes them to the
OmniAuth.config.on_failurehandler. For most apps, this means they are passed to the default FailureEndpoint class that OmniAuth provides, and redirected to
/auth/failure. If your app is wrapping OmniAuth in another middleware such as this example in Discourse, then you may need to instead write your own failure handler.
OmniAuth will no longer find constants from an ancestor class when looking for the strategy class. What this means is that
OmniAuth.builder.new(@app) doprovider :my\_providerend
Will no longer find
::MyProvideras a strategy, and instead will only look under the
OmniAuth::Strategiesnamespace for the
The failure route will now respect a strategy's path_prefix option, meaning if your strategy uses
/authas its path prefix, the failure route for that strategy will be
The OmniAuth middleware should now be thread-safe, as we run tests with rack-freeze to check for middleware mutability. This does not guarantee that the downstream strategy is thread-safe however. If you have concerns, ask your strategy maintainers.
💎 OmniAuth will no longer throw errors if trying to run it in an app with
Relative Root Apps
OmniAuth now respects the 'SCRIPT_NAME' env value, so if your app lives at
myapp.com/super, your request path will be
/super/auth/provider, your callback path
/super/auth/provider/callbackand your failure path
🚀 This release includes minor changes that remove code specific to rack versions we no longer support, it also loosens the top-end of the version of hashie we require.
🚀 No breaking changes are expected with this change. If a breaking change has been introduced with this release, please open an issue.
You can view a list of commits and changed files here: v1.9.0...v1.9.1
- 👉 Use
- 👉 Use
⚡️ Updates / Fixes
- 🐎 Performance benchmarks for middleware call (PR: #775)
- 0️⃣ Simplify Default Strategy Options (PR: #777)
- 👌 Improve perf by using
- ✅ Pass through
test_modewith alternate request method (PR: #779)
- ✅ Avoid Minitest warnings (PR: #850)
omniauth.headerson the request phase (PR: #806)
- 🤡 Set params when mocking a failure (PR: #812; Issue: #811)
- 📄 docs: TestCase expects class in strategy method array (PR: #868)
- ⚡️ Update
AuthHash#regular_writerto ensure that
#infois a Hash (#848)
- 🐎 Loosen
hashierequirements to fix potential performance issues. Please define
3.4.6in your Gemfile if you experience issues with
3.5.x. (PR: #887; Issue: #886)
👍 Defined Support
- 💎 Required Ruby version:
- ⚡️ Updated Hashie's
⚡️ Updated Dependencies & Security Updates
⬇️ Dropped Support
- 💎 Required Ruby version: