Skip to content

Latest commit

 

History

History
324 lines (227 loc) · 16.4 KB

access_and_permissions.md

File metadata and controls

324 lines (227 loc) · 16.4 KB
Raw
stage group info
Data Stores
Tenant Scale
To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Group access and permissions

Configure your groups to control group permissions and access.

Group push rules (PREMIUM)

Group push rules allow group maintainers to set push rules for newly created projects in the specific group.

In GitLab 15.4 and later, to configure push rules for a group:

  1. On the left sidebar, select Settings > Repository.
  2. Expand the Pre-defined push rules section.
  3. Select the settings you want.
  4. Select Save Push Rules.

In GitLab 15.3 and earlier, to configure push rules for a group:

  1. On the left sidebar, select Push rules.
  2. Select the settings you want.
  3. Select Save Push Rules.

The group's new subgroups have push rules set for them based on either:

  • The closest parent group with push rules defined.
  • Push rules set at the instance level, if no parent groups have push rules defined.

Restrict Git access protocols

You can set the permitted protocols used to access a group's repositories to either SSH, HTTPS, or both. This setting is disabled when the instance setting is configured by an administrator.

To change the permitted Git access protocols for a group:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. Choose the permitted protocols from Enabled Git access protocols.
  5. Select Save changes.

Restrict group access by IP address (PREMIUM)

  • Introduced in GitLab 12.0.
  • Moved from GitLab Ultimate to GitLab Premium in 13.1.

To ensure only people from your organization can access particular resources, you can restrict access to groups by IP address. This top-level group setting applies to:

Administrators can combine restricted access by IP address with globally-allowed IP addresses.

To restrict group access by IP address:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. In the Restrict access by IP address text box, enter a list of IPv4 or IPv6 address ranges in CIDR notation. This list:
    • Has no limit on the number of IP address ranges.
    • Has a size limit of 1 GB.
    • Applies to both SSH or HTTP authorized IP address ranges. You cannot split this list by type of authorization.
  5. Select Save changes.

Security implications

Keep in mind that restricting group access by IP address has the following implications:

  • Administrators and group Owners can access group settings from any IP address, regardless of IP restriction. However:
    • Group Owners can access the subgroups, but not the projects belonging to the group or subgroups, when accessing from a disallowed IP address.
    • Administrators can access projects belonging to the group when accessing from a disallowed IP address. Access to projects includes cloning code from them.
    • Users can still see group and project names and hierarchies. Only the following are restricted:
  • When you register a runner, it is not bound by the IP restrictions. When the runner requests a new job or an update to a job's state, it is also not bound by the IP restrictions. But when the running CI/CD job sends Git requests from a restricted IP address, the IP restriction prevents code from being cloned.
  • Users might still see some events from the IP-restricted groups and projects on their dashboard. Activity might include push, merge, issue, or comment events.
  • IP access restrictions for Git operations via SSH are supported on GitLab SaaS. IP access restrictions applied to self-managed instances are possible with gitlab-sshd with PROXY protocol enabled.

Restrict group access by domain (PREMIUM)

  • Support for specifying multiple email domains added in GitLab 13.1.
  • Support for restricting access to projects in the group added in GitLab 14.1.2.
  • Support for restricting group memberships to groups with a subset of the allowed email domains added in GitLab 15.1.1

You can prevent users with email addresses in specific domains from being added to a group and its projects.

To restrict group access by domain:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. In the Restrict membership by email field, enter the domain names.
  5. Select Save changes.

Any time you attempt to add a new user, the user's primary email is compared against this list. Only users with a primary email that matches any of the configured email domain restrictions can be added to the group.

The most popular public email domains cannot be restricted, such as:

  • gmail.com, yahoo.com, aol.com, icloud.com
  • hotmail.com, hotmail.co.uk, hotmail.fr
  • msn.com, live.com, outlook.com

When you share a group, both the source and target namespaces must allow the domains of the members' email addresses.

NOTE: Removing a domain from the Restrict membership by email list does not remove the users with this email domain from the groups and projects under this group. Also, if you share a group or project with another group, the target group can add more email domains to its list that are not in the list of the source group. Hence, this feature does not ensure that the current members always conform to the Restrict membership by email list.

Prevent group sharing outside the group hierarchy

You can configure a top-level group so its subgroups and projects cannot invite other groups outside of the top-level group's hierarchy. This option is only available for top-level groups.

For example, in the following group and project hierarchy:

  • Animals > Dogs > Dog Project
  • Animals > Cats
  • Plants > Trees

If you prevent group sharing outside the hierarchy for the Animals group:

  • Dogs can invite the group Cats.
  • Dogs cannot invite the group Trees.
  • Dog Project can invite the group Cats.
  • Dog Project cannot invite the group Trees.

To prevent sharing outside of the group's hierarchy:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand Permissions and group features.
  4. Select Members cannot invite groups outside of <group_name> and its subgroups.
  5. Select Save changes.

Prevent a project from being shared with groups

Sharing a project with another group increases the number of users who can invite yet more members to the project. Each (sub)group can be an additional source of access permissions, which can be confusing and difficult to control.

To restrict the permission to invite project members to a single source, prevent a project from being shared with other groups:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. Select Projects in <group_name> cannot be shared with other groups.
  5. Select Save changes.

This setting applies to all subgroups unless overridden by a group Owner. Groups already added to a project lose access when the setting is enabled.

Prevent users from requesting access to a group

As a group Owner, you can prevent non-members from requesting access to your group.

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. Clear the Allow users to request access checkbox.
  5. Select Save changes.

Prevent project forking outside group (PREMIUM)

Introduced in GitLab 13.3.

By default, projects in a group can be forked. Optionally, on GitLab Premium and Ultimate tiers, you can prevent the projects in a group from being forked outside of the current top-level group.

This setting is removed from the SAML setting page, and migrated to the group settings page. In the interim period, both of these settings are taken into consideration. If even one is set to true, then the group does not allow outside forks.

To prevent projects from being forked outside the group:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. Check Prevent project forking outside current group.
  5. Select Save changes.

Existing forks are not removed.

Prevent members from being added to projects in a group (PREMIUM)

As a group Owner, you can prevent any new project membership for all projects in a group, allowing tighter control over project membership.

For example, if you want to lock the group for an Audit Event, you can guarantee that project membership cannot be modified during the audit.

If group membership lock is enabled, the group Owner can still:

  • Invite groups or add members to groups to give them access to projects in the locked group.
  • Change the role of group members.

The setting does not cascade. Projects in subgroups observe the subgroup configuration, ignoring the parent group.

To prevent members from being added to projects in a group:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > General.
  3. Expand the Permissions and group features section.
  4. Under Membership, select Users cannot be added to projects in this group.
  5. Select Save changes.

After you lock the membership for a group:

  • All users who previously had permissions can no longer add members to a group.
  • API requests to add a new user to a project are not possible.

Manage group memberships via LDAP (PREMIUM SELF)

Group syncing allows LDAP groups to be mapped to GitLab groups. This provides more control over per-group user management. To configure group syncing, edit the group_base DN ('OU=Global Groups,OU=GitLab INT,DC=GitLab,DC=org'). This OU contains all groups that are associated with GitLab groups.

Group links can be created by using either a CN or a filter. To create these group links, go to the group's Settings > LDAP Synchronization page. After configuring the link, it may take more than an hour for the users to sync with the GitLab group.

For more information on the administration of LDAP and group sync, refer to the main LDAP documentation.

NOTE: When you add LDAP synchronization, if an LDAP user is a group member and they are not part of the LDAP group, they are removed from the group.

You can use a workaround to manage project access through LDAP groups.

Create group links via CN (PREMIUM SELF)

To create group links via CN:

  1. Select the LDAP Server for the link.
  2. As the Sync method, select LDAP Group cn.
  3. In the LDAP Group cn field, begin typing the CN of the group. There is a dropdown list with matching CNs in the configured group_base. Select your CN from this list.
  4. In the LDAP Access section, select the permission level for users synced in this group.
  5. Select Add Synchronization.

Create group links via filter (PREMIUM SELF)

To create group links via filter:

  1. Select the LDAP Server for the link.
  2. As the Sync method, select LDAP user filter.
  3. Input your filter in the LDAP User filter box. Follow the documentation on user filters.
  4. In the LDAP Access section, select the permission level for users synced in this group.
  5. Select Add Synchronization.

Override user permissions (PREMIUM SELF)

LDAP user permissions can be manually overridden by an administrator. To override a user's permissions:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. On the left sidebar, select Manage > Members. If LDAP synchronization has granted a user a role with:
    • More permissions than the parent group membership, that user is displayed as having direct membership of the group.
    • The same or fewer permissions than the parent group membership, that user is displayed as having inherited membership of the group.
  3. Optional. If the user you want to edit is displayed as having inherited membership, filter the subgroup to show direct members before overriding LDAP user permissions.
  4. In the row for the user you are editing, select the pencil ({pencil}) icon.
  5. Select Edit permissions in the modal.

Now you can edit the user's permissions from the Members page.

Troubleshooting

Verify if access is blocked by IP restriction

If a user sees a 404 when they would usually expect access, and the problem is limited to a specific group, search the auth.log rails log for one or more of the following:

  • json.message: 'Attempting to access IP restricted group'
  • json.allowed: false

In viewing the log entries, compare remote.ip with the list of allowed IP addresses for the group.

Cannot update permissions for a group member

If a group Owner cannot update permissions for a group member, check which memberships are listed. Group Owners can only update direct memberships.

If a parent group membership has the same or higher role than a subgroup, the inherited membership is listed on the subgroup members page, even if a direct membership on the group exists.

To view and update direct memberships, filter the group to show direct members.

The need to filter members by type through a redesigned members page that lists both direct and inherited memberships is proposed in issue 337539.