aligent / bypass2fa
Magento 2 module for bypassing 2-factor authentication in local development environments.
Installs: 9 527
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 8
Forks: 1
Open Issues: 0
Type:magento2-module
Requires
- php: >=7.4
- magento/framework: *
- magento/module-two-factor-auth: 1.1.*
This package is auto-updated.
Last update: 2024-11-17 03:06:22 UTC
README
This module is designed to allow developers to bypass the need for 2-factor authentication (2FA) in local development environments.
Configuration
The bypassing of 2FA is made possible for both admin access and the generation of admin tokens via API.
Both methods of access are controlled by setting variables in the environment's app/etc/env.php
file:
BYPASS_2FA_ADMIN
when set totrue
(must be a boolean, setting truthy or falsy values like 1, 'true' is not supported), this variable allows bypassing of 2FA for admin actions.BYPASS_2FA_API
when set totrue
, this variable allows bypassing of 2FA for admin token generation.
Additionally, there is an added security measure, to prevent 2FA being bypassed accidentally (or intentionally) in production environments.
The app/etc/config.php
file must have the following config setting added under system => default
:
'system' => [
'default' => [
'bypass_2fa' => [
'settings' => [
'allowed_hostnames' => [
'hostname1',
'hostname2',
...
],
'allowed_usernames' => [
'username1',
'username2'
]
]
]
]
]
The configured (partial) hostnames are checked against the base URL, with the configured name needing to be contained wholly within the base URL.
If no match is found, then 2FA is not bypassed for the request.
By committing this setting to the codebase, it prevents someone from overriding the allowed hosts in environments such as Magento Cloud hosting (where app/etc/config.php
is not writable).
Magento Cloud
Magento Cloud environment-specific variables can be used to switch this feature on and off on a per cloud instance, especially
useful for integration environments where emails may not be configured. First make sure that you've added
the hostname to config.php
in the allowed_hostnames
section, and then also check you've added the usernames in the allowed_usernames
section that need to be bypassed 2FA when generating the admin tokens.
Then, in the Cloud dashboard:
- Click
Configure enviroment
and enter theVariables
tab - Add
env:BYPASS_2FA_ADMIN
andenv:BYPASS_2FA_API
as needed, setting the value to 1 to enable bypass