OmniAuth v2.0.0-rc1 Release Notes

Release Date: 2020-12-11 // 3 months ago
  • ๐Ÿš€ 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.

    โš  Hopefully, you were already doing this as a result of the warnings due to CVE-2015-9284.
    ๐Ÿ‘€ For detailed context, see:
    #960
    #809
    Resolving CVE-2015-9284

    This change also includes an additional configurable phase: request_validation_phase.

    Rack/Sinatra

    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.

    ๐Ÿš… Rails

    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
    

    Example Rails App

    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 %\>
    

    GET

    Because using GET for login poses concerns (see OWASP Cheatsheet), after upgrading OmniAuth will log a :warn level log with every GET request to a login path when your OmniAuth.config.allowed_request_methods include :get.

    โš  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.

    Unhandled Exceptions

    OmniAuth now catches exceptions raised during the options_call, request_call, callback_call, and other_phase, and passes them to the OmniAuth.config.on_failure handler. 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.

    Provider Namespacing

    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 ::MyProvider as a strategy, and instead will only look under the OmniAuth::Strategies namespace for the MyProvider class.

    Failure Route

    The failure route will now respect a strategy's path_prefix option, meaning if your strategy uses /external instead of /auth as its path prefix, the failure route for that strategy will be /external/failure.

    Thread Safety

    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.

    Frozen Strings

    ๐Ÿ’Ž OmniAuth will no longer throw errors if trying to run it in an app with RUBYOPT="--enable-frozen-string-literal".

    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/callback and your failure path /super/auth/failure.


Previous changes from v1.9.1

  • ๐Ÿš€ 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