gitlab-org--gitlab-foss/doc/security/two_factor_authentication.md

4.2 KiB

type stage group info
howto Manage Access To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers

Enforce Two-factor Authentication (2FA)

Two-factor Authentication (2FA) provides an additional level of security to your users' GitLab account. Once enabled, in addition to supplying their username and password to login, they'll be prompted for a code generated by an application on their phone.

You can read more about it here: Two-factor Authentication (2FA)

Enforcing 2FA for all users

Users on GitLab, can enable it without any admin's intervention. If you want to enforce everyone to set up 2FA, you can choose from two different ways:

  • Enforce on next login.
  • Suggest on next login, but allow a grace period before enforcing.

After the configured grace period has elapsed, users will be able to log in but won't be able to leave the 2FA configuration area at /profile/two_factor_auth.

To enable 2FA for all users:

  1. Navigate to Admin Area > Settings > General (/admin/application_settings/general).
  2. Expand the Sign-in restrictions section, where you can configure both.

If you want 2FA enforcement to take effect on next login, change the grace period to 0.

Enforcing 2FA for all users in a group

If you want to enforce 2FA only for certain groups, you can:

  1. Enable it in the group's Settings > General page. Navigate to Permissions, LFS, 2FA > Two-factor authentication. You can then check the Require all users in this group to setup Two-factor authentication option.
  2. You can also specify a grace period in the Time before enforced option.

To change this setting, you need to be administrator or owner of the group.

From GitLab 12.0, 2FA settings for a group are also applied to subgroups.

If you want to enforce 2FA only for certain groups, you can enable it in the group settings and specify a grace period as above. To change this setting you need to be administrator or owner of the group.

The following are important notes about 2FA:

  • Projects belonging to a 2FA-enabled group that is shared with a 2FA-disabled group will not require members of the 2FA-disabled group to use 2FA for the project. For example, if project P belongs to 2FA-enabled group A and is shared with 2FA-disabled group B, members of group B can access project P without 2FA. To ensure this scenario doesn't occur, prevent sharing of projects for the 2FA-enabled group.
  • If you add additional members to a project within a group or subgroup that has 2FA enabled, 2FA is not required for those individually added members.
  • If there are multiple 2FA requirements (for example, group + all users, or multiple groups) the shortest grace period will be used.

Disabling 2FA for everyone

There may be some special situations where you want to disable 2FA for everyone even when forced 2FA is disabled. There is a Rake task for that:

# Omnibus installations
sudo gitlab-rake gitlab:two_factor:disable_for_all_users

# Installations from source
sudo -u git -H bundle exec rake gitlab:two_factor:disable_for_all_users RAILS_ENV=production

CAUTION: Caution: This is a permanent and irreversible action. Users will have to reactivate 2FA from scratch if they want to use it again.