mirror of
https://github.com/discourse/discourse.git
synced 2024-11-23 19:01:52 +08:00
dd6ec65061
2FA support in Discourse was added and grown gradually over the years: we first added support for TOTP for logins, then we implemented backup codes, and last but not least, security keys. 2FA usage was initially limited to logging in, but it has been expanded and we now require 2FA for risky actions such as adding a new admin to the site. As a result of this gradual growth of the 2FA system, technical debt has accumulated to the point where it has become difficult to require 2FA for more actions. We now have 5 different 2FA UI implementations and each one has to support all 3 2FA methods (TOTP, backup codes, and security keys) which makes it difficult to maintain a consistent UX for these different implementations. Moreover, there is a lot of repeated logic in the server-side code behind these 5 UI implementations which hinders maintainability even more. This commit is the first step towards repaying the technical debt: it builds a system that centralizes as much as possible of the 2FA server-side logic and UI. The 2 main components of this system are: 1. A dedicated page for 2FA with support for all 3 methods. 2. A reusable server-side class that centralizes the 2FA logic (the `SecondFactor::AuthManager` class). From a top-level view, the 2FA flow in this new system looks like this: 1. User initiates an action that requires 2FA; 2. Server is aware that 2FA is required for this action, so it redirects the user to the 2FA page if the user has a 2FA method, otherwise the action is performed. 3. User submits the 2FA form on the page; 4. Server validates the 2FA and if it's successful, the action is performed and the user is redirected to the previous page. A more technically-detailed explanation/documentation of the new system is available as a comment at the top of the `lib/second_factor/auth_manager.rb` file. Please note that the details are not set in stone and will likely change in the future, so please don't use the system in your plugins yet. Since this is a new system that needs to be tested, we've decided to migrate only the 2FA for adding a new admin to the new system at this time (in this commit). Our plan is to gradually migrate the remaining 2FA implementations to the new system. For screenshots of the 2FA page, see PR #15377 on GitHub.
21 lines
626 B
Ruby
21 lines
626 B
Ruby
# frozen_string_literal: true
|
|
|
|
module SessionControllerExtension
|
|
def self.included(base)
|
|
base.skip_before_action :check_xhr, only: %i(test_second_factor_restricted_route)
|
|
end
|
|
|
|
def test_second_factor_restricted_route
|
|
result = run_second_factor!(TestSecondFactorAction) do |manager|
|
|
manager.allow_backup_codes! if params[:allow_backup_codes]
|
|
end
|
|
if result.no_second_factors_enabled?
|
|
render json: { result: 'no_second_factors_enabled' }
|
|
else
|
|
render json: { result: 'second_factor_auth_completed' }
|
|
end
|
|
end
|
|
end
|
|
|
|
SessionController.class_eval { include SessionControllerExtension }
|