mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2025-02-25 18:55:31 -06:00
Added support for Two-factor authentication for improving security. Fixes #6543
This commit is contained in:
committed by
Akshay Joshi
parent
fe096116be
commit
36c9eb3dfd
@@ -33,6 +33,7 @@ Mode is pre-configured for security.
|
||||
|
||||
deployment
|
||||
login
|
||||
mfa
|
||||
user_management
|
||||
change_user_password
|
||||
restore_locked_user
|
||||
|
||||
BIN
docs/en_US/images/mfa_registration.png
Normal file
BIN
docs/en_US/images/mfa_registration.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
57
docs/en_US/mfa.rst
Normal file
57
docs/en_US/mfa.rst
Normal file
@@ -0,0 +1,57 @@
|
||||
.. _mfa:
|
||||
|
||||
*************************************************
|
||||
`Enabling two-factor authentication (2FA)`:index:
|
||||
*************************************************
|
||||
|
||||
About two-factor authentication
|
||||
===============================
|
||||
Two-factor authentication (2FA) is an extra layer of security used when logging
|
||||
into websites or apps. With 2FA, you have to log in with your username and
|
||||
password and provide another form of authentication that only you know or have
|
||||
access to.
|
||||
|
||||
|
||||
Setup two-factor authentication
|
||||
===============================
|
||||
To set up 2FA for pgAdmin 4, you must configure the Two-factor Authentication
|
||||
settings in *config_local.py* or *config_system.py* (see the
|
||||
:ref:`config.py <config_py>` documentation) on the system where pgAdmin is
|
||||
installed in Server mode. You can copy these settings from *config.py* file and
|
||||
modify the values for the following parameters.
|
||||
|
||||
.. csv-table::
|
||||
:header: "**Parameter**", "**Description**"
|
||||
:class: longtable
|
||||
:widths: 35, 55
|
||||
|
||||
"MFA_ENABLED","The default value for this parameter is False.
|
||||
To enable 2FA, set the value to *True*"
|
||||
"SUPPORTED_MFA_LIST", "Set the authentication methods to be supported "
|
||||
"MFA_EMAIL_SUBJECT", "<APP_NAME> - Verification Code e.g. pgAdmin 4 -
|
||||
Verification Code"
|
||||
"MFA_FORCE_REGISTRATION", "Force the user to configure the authentication
|
||||
method on login (if no authentication is already configured)."
|
||||
|
||||
*NOTE: You must set the 'Mail server settings' in config_local.py or
|
||||
config_system.py in order to use 'email' as two-factor authentication method
|
||||
(see the* :ref:`config.py <config_py>` *documentation).*
|
||||
|
||||
|
||||
Configure two-factor authentication
|
||||
===================================
|
||||
To configure 2FA for a user, you must click on 'Two-factor Authentication'
|
||||
in the `User` menu in right-top corner. It will list down all the supported
|
||||
multi factor authentication methods. Click on 'Setup' of one of those methods
|
||||
and follow the steps for each authentication method. You will see the `Delete`
|
||||
button for the authentication method, which is already been configured.
|
||||
Clicking on `Delete` button will deregister the authentication method for the
|
||||
current user.
|
||||
|
||||
.. image:: images/mfa_registration.png
|
||||
:alt: Configure two-factor authentication
|
||||
:align: center
|
||||
|
||||
You can also force users to configure the two-factor
|
||||
authentication methods on login by setting *MFA_FORCE_REGISTRATION* parameter
|
||||
to *True*.
|
||||
@@ -9,6 +9,7 @@ This release contains a number of bug fixes and new features since the release o
|
||||
New features
|
||||
************
|
||||
|
||||
| `Issue #6543 <https://redmine.postgresql.org/issues/6543>`_ - Added support for Two-factor authentication for improving security.
|
||||
| `Issue #6872 <https://redmine.postgresql.org/issues/6872>`_ - Include GSSAPI support in the PostgreSQL libraries and utilities on macOS.
|
||||
|
||||
Housekeeping
|
||||
|
||||
Reference in New Issue
Block a user