debian-mirror-gitlab/doc/user/admin_area/settings/sign_in_restrictions.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

142 lines
6.1 KiB
Markdown
Raw Normal View History

2019-12-26 22:10:19 +05:30
---
2021-01-29 00:20:46 +05:30
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-12-26 22:10:19 +05:30
---
2021-03-11 19:13:27 +05:30
# Sign-in restrictions **(FREE SELF)**
2019-12-26 22:10:19 +05:30
2020-07-28 23:09:34 +05:30
You can use **Sign-in restrictions** to customize authentication restrictions for web interfaces as well as Git over HTTP(S).
## Settings
To access sign-in restriction settings:
2021-11-11 11:23:49 +05:30
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > General**.
2020-07-28 23:09:34 +05:30
1. Expand the **Sign-in restrictions** section.
2019-12-26 22:10:19 +05:30
## Password authentication enabled
You can restrict the password authentication for web interface and Git over HTTP(S):
2022-03-02 08:16:31 +05:30
- **Web interface**: When this feature is disabled, the **Standard** sign-in tab
is removed and an [external authentication provider](../../../administration/auth/index.md)
must be used.
- **Git over HTTP(S)**: When this feature is disabled, a [Personal Access Token](../../profile/personal_access_tokens.md)
or LDAP password must be used to authenticate.
2019-12-26 22:10:19 +05:30
2021-11-18 22:05:49 +05:30
In the event of an external authentication provider outage, use the [GitLab Rails console](../../../administration/operations/rails_console.md) to [re-enable the standard web sign-in form](../../../administration/troubleshooting/gitlab_rails_cheat_sheet.md#re-enable-standard-web-sign-in-form). This configuration can also be changed over the [Application settings REST API](../../../api/settings.md#change-application-settings) while authenticating with an administrator account's personal access token.
2021-04-29 21:17:54 +05:30
## Admin Mode
2021-11-11 11:23:49 +05:30
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2158) in GitLab 13.10.
2021-04-29 21:17:54 +05:30
When this feature is enabled, instance administrators are limited as regular users. During that period,
they do not have access to all projects, groups, or the **Admin Area** menu.
To access potentially dangerous resources, an administrator can activate Admin Mode by:
- Selecting the *Enable Admin Mode* button
2022-04-04 11:22:00 +05:30
- Trying to access any part of the UI that requires administrator access, specifically those which call `/admin` endpoints.
2021-04-29 21:17:54 +05:30
The main use case allows administrators to perform their regular tasks as a regular
user, based on their memberships, without having to set up a second account for
security reasons.
When Admin Mode status is disabled, administrative users cannot access resources unless
they've been explicitly granted access. For example, when Admin Mode is disabled, they
get a `404` error if they try to open a private group or project, unless
they are members of that group or project.
2FA should be enabled for administrators and is supported for the Admin Mode flow, as are
OmniAuth providers and LDAP auth. The Admin Mode status is stored in the active user
session and remains active until it is explicitly disabled (it will be disabled
automatically after a timeout otherwise).
### Limitations of Admin Mode
The following access methods are **not** protected by Admin Mode:
- Git client access (SSH using public keys or HTTPS using Personal Access Tokens).
- API access using a Personal Access Token.
In other words, administrators who are otherwise limited by Admin Mode can still use
Git clients, and access RESTful API endpoints as administrators, without additional
authentication steps.
We may address these limitations in the future. For more information see the following epic:
2022-07-16 23:28:13 +05:30
[Admin Mode for GitLab Administrators](https://gitlab.com/groups/gitlab-org/-/epics/2158).
2021-04-29 21:17:54 +05:30
### Troubleshooting Admin Mode
If necessary, you can disable **Admin Mode** as an administrator by using one of these two methods:
- **API**:
```shell
curl --request PUT --header "PRIVATE-TOKEN:$ADMIN_TOKEN" "<gitlab-url>/api/v4/application/settings?admin_mode=false"
```
- [**Rails console**](../../../administration/operations/rails_console.md#starting-a-rails-console-session):
```ruby
2021-09-04 01:27:46 +05:30
::Gitlab::CurrentSettings.update!(admin_mode: false)
2021-04-29 21:17:54 +05:30
```
2021-09-04 01:27:46 +05:30
2019-12-26 22:10:19 +05:30
## Two-factor authentication
2021-04-29 21:17:54 +05:30
When this feature is enabled, all users must use the [two-factor authentication](../../profile/account/two_factor_authentication.md).
2019-12-26 22:10:19 +05:30
2021-03-11 19:13:27 +05:30
After the two-factor authentication is configured as mandatory, users are allowed
2019-12-26 22:10:19 +05:30
to skip forced configuration of two-factor authentication for the configurable grace
period in hours.
![Two-factor grace period](img/two_factor_grace_period.png)
2020-07-28 23:09:34 +05:30
## Email notification for unknown sign-ins
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218457) in GitLab 13.2.
When enabled, GitLab notifies users of sign-ins from unknown IP addresses or devices. For more information,
see [Email notification for unknown sign-ins](../../profile/unknown_sign_in_notification.md).
![Email notification for unknown sign-ins](img/email_notification_for_unknown_sign_ins_v13_2.png)
2019-12-26 22:10:19 +05:30
## Sign-in information
2021-02-22 17:27:13 +05:30
All users that are not logged in are redirected to the page represented by the configured
**Home page URL** if value is not empty.
2019-12-26 22:10:19 +05:30
2021-11-18 22:05:49 +05:30
All users are redirected to the page represented by the configured **After sign-out path**
2019-12-26 22:10:19 +05:30
after sign out if value is not empty.
2021-02-22 17:27:13 +05:30
In the **Sign-in restrictions** section, scroll to the **Sign-in text** field. You can add a
2021-01-29 00:20:46 +05:30
custom message for your users in Markdown format.
For example, if you include the following information in the noted text box:
```markdown
# Custom sign-in text
2021-09-04 01:27:46 +05:30
To access this text box:
1. On the top bar, select **Menu > Admin**.
2021-11-11 11:23:49 +05:30
1. On the left sidebar, select **Settings > General**, and expand the **Sign-in restrictions** section.
2021-01-29 00:20:46 +05:30
```
2021-02-22 17:27:13 +05:30
Your users see the **Custom sign-in text** when they navigate to the sign-in screen for your
2021-09-04 01:27:46 +05:30
GitLab instance.
2019-12-26 22:10:19 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->