Add admin MFA enforcement feature

This commit is contained in:
Fredys Fonseca 2025-07-17 05:50:45 +00:00
parent 331599fa2b
commit 218a9e70c5
3 changed files with 275 additions and 0 deletions

View File

@ -0,0 +1,39 @@
# frozen_string_literal: true
module MfaForceConcern
extend ActiveSupport::Concern
included do
before_action :check_mfa_requirement, if: :user_signed_in?
end
private
def check_mfa_requirement
return unless mfa_force_enabled?
return if current_user.otp_enabled?
return if mfa_setup_allowed_paths?
flash[:warning] = I18n.t('mfa_force.required_message')
redirect_to settings_otp_authentication_path
end
def mfa_force_enabled?
ENV['MFA_FORCE'] == 'true'
end
def mfa_setup_allowed_paths?
allowed_paths = [
settings_otp_authentication_path,
new_settings_two_factor_authentication_confirmation_path,
settings_two_factor_authentication_confirmation_path,
settings_two_factor_authentication_methods_path,
settings_two_factor_authentication_recovery_codes_path,
destroy_user_session_path,
auth_setup_path,
edit_user_registration_path,
]
allowed_paths.any? { |path| request.path.start_with?(path) }
end
end

139
docs/MFA_FORCE.md Normal file
View File

@ -0,0 +1,139 @@
# MFA Force Feature
## Overview
The MFA Force feature allows administrators to require all users to enable two-factor authentication (2FA) before they can access the platform. This is useful for organizations with strict security policies.
## Configuration
### Environment Variable
To enable MFA forcing, set the following environment variable:
```bash
MFA_FORCE=true
```
### Docker Compose
Add the environment variable to your `.env.production` file:
```env
MFA_FORCE=true
```
Or add it directly to your `docker-compose.yml`:
```yaml
services:
web:
environment:
- MFA_FORCE=true
# ... other configuration
```
## Behavior
When `MFA_FORCE=true` is set:
1. **After Login**: Users who don't have 2FA enabled will be automatically redirected to the 2FA setup page (`/settings/otp_authentication`)
2. **Message Display**: A warning message (using Mastodon's flash message system) is shown explaining that 2FA is required due to security policies
3. **Access Restriction**: Users cannot access most parts of the platform until they configure 2FA
4. **Allowed Pages**: Users can still access:
- 2FA setup pages (`/settings/otp_authentication`)
- 2FA confirmation pages (`/settings/two_factor_authentication/confirmation`)
- Account settings (`/settings/profile`)
- Logout (`/auth/sign_out`)
- Setup pages for unconfirmed users (`/auth/setup`)
5. **User Experience**: A clear message explains why 2FA is required and guides users through the setup process
## User Interface
### Message Display
When MFA forcing is enabled, users will see:
- **Warning Message**: "The administrator of this site has configured as mandatory that users enable two-factor authentication due to security policies. Please configure your two-factor authentication to continue using the platform."
- **Flash Message**: Uses Mastodon's built-in flash message system with warning styling
- **Visual Indicator**: A prominent notice on the 2FA setup page with a security icon
### Multi-language Support
The feature includes translations for:
- English
- Spanish
- And other supported languages
## Implementation Details
### Files Modified
1. **`app/controllers/concerns/mfa_force_concern.rb`**: Core logic for checking MFA requirements
2. **`app/controllers/application_controller.rb`**: Includes the MFA force concern
3. **`app/helpers/flashes_helper.rb`**: Updated to support warning flash messages
4. **`app/views/settings/two_factor_authentication/otp_authentication/show.html.haml`**: Updated to show the forced MFA message
5. **`app/javascript/styles/mastodon/forms.scss`**: Added styles for the MFA force notice
6. **`config/locales/en.yml`**: English translations
7. **`config/locales/es.yml`**: Spanish translations
### Testing
Run the tests to verify the functionality:
```bash
bundle exec rspec spec/controllers/concerns/mfa_force_concern_spec.rb
```
## Security Considerations
- **Existing Users**: Users who already have 2FA enabled are not affected
- **New Users**: All new users must configure 2FA before accessing the platform
- **Admin Access**: Administrators are also subject to this requirement
- **Graceful Degradation**: If the environment variable is not set, the feature is disabled
## Troubleshooting
### Common Issues
1. **Users can't access the platform**: Ensure they complete 2FA setup
2. **Message not appearing**: Check that `MFA_FORCE=true` is set correctly
3. **Translation missing**: Add translations to the appropriate locale files
### Disabling the Feature
To disable MFA forcing:
```bash
# Remove the environment variable or set it to false
MFA_FORCE=false
# or
unset MFA_FORCE
```
## Migration Guide
### For Existing Instances
1. **Backup**: Always backup your database before enabling this feature
2. **Communication**: Inform users about the new requirement
3. **Testing**: Test in a staging environment first
4. **Gradual Rollout**: Consider enabling for specific user groups first
### For New Instances
1. Set `MFA_FORCE=true` in your environment configuration
2. All new users will be required to set up 2FA during registration
## Related Features
- **Two-Factor Authentication**: The underlying 2FA system
- **Account Security**: General security features
- **User Management**: Admin tools for managing user accounts

View File

@ -0,0 +1,97 @@
# frozen_string_literal: true
require 'rails_helper'
RSpec.describe MfaForceConcern do
controller(ApplicationController) do
def index
render plain: 'OK'
end
end
let(:user) { Fabricate(:user) }
before do
routes.draw { get 'index' => 'anonymous#index' }
end
describe 'MFA force functionality' do
context 'when MFA_FORCE is enabled' do
before do
allow(ENV).to receive(:[]).with('MFA_FORCE').and_return('true')
sign_in user, scope: :user
end
context 'when user has MFA enabled' do
before do
user.update(otp_required_for_login: true)
end
it 'allows access to normal pages' do
get :index
expect(response).to have_http_status(200)
end
end
context 'when user does not have MFA enabled' do
before do
user.update(otp_required_for_login: false)
end
it 'redirects to MFA setup page' do
get :index
expect(response).to redirect_to(settings_otp_authentication_path)
end
it 'shows the required message' do
get :index
expect(flash[:warning]).to eq(I18n.t('mfa_force.required_message'))
end
context 'when accessing MFA setup pages' do
it 'allows access to OTP authentication page' do
allow(controller.request).to receive(:path).and_return('/settings/otp_authentication')
get :index
expect(response).to have_http_status(200)
end
it 'allows access to MFA confirmation page' do
allow(controller.request).to receive(:path).and_return('/settings/two_factor_authentication/confirmation')
get :index
expect(response).to have_http_status(200)
end
it 'allows access to logout' do
allow(controller.request).to receive(:path).and_return('/auth/sign_out')
get :index
expect(response).to have_http_status(200)
end
end
end
end
context 'when MFA_FORCE is disabled' do
before do
allow(ENV).to receive(:[]).with('MFA_FORCE').and_return('false')
sign_in user, scope: :user
user.update(otp_required_for_login: false)
end
it 'allows access to normal pages' do
get :index
expect(response).to have_http_status(200)
end
end
context 'when user is not signed in' do
before do
allow(ENV).to receive(:[]).with('MFA_FORCE').and_return('true')
end
it 'allows access to normal pages' do
get :index
expect(response).to have_http_status(200)
end
end
end
end