ssh_keys_restrictions.md 2.19 KB
Newer Older
1 2
---
type: reference, howto
Mike Jang's avatar
Mike Jang committed
3 4
stage: Manage
group: Access
5
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
6
---
7

8 9 10 11
# Restrict allowed SSH key technologies and minimum length

`ssh-keygen` allows users to create RSA keys with as few as 768 bits, which
falls well below recommendations from certain standards groups (such as the US
Nick Thomas's avatar
Nick Thomas committed
12
NIST). Some organizations deploying GitLab will need to enforce minimum key
13 14 15
strength, either to satisfy internal security policy or for regulatory
compliance.

Nick Thomas's avatar
Nick Thomas committed
16 17 18
Similarly, certain standards groups recommend using RSA, ECDSA, or ED25519 over
the older DSA, and administrators may need to limit the allowed SSH key
algorithms.
19 20 21 22

GitLab allows you to restrict the allowed SSH key technology as well as specify
the minimum key length for each technology.

23
In **Admin Area > Settings** (`/admin/application_settings/general`), expand the
24
**Visibility and access controls** section:
25 26

![SSH keys restriction admin settings](img/ssh_keys_restrictions_settings.png)
27 28 29 30 31 32 33 34

If a restriction is imposed on any key type, users will be unable to upload new SSH keys that don't meet the requirement. Any existing keys that don't meet it will be disabled but not removed and users will be unable to pull or push code using them.

An icon will be visible to the user of a restricted key in the SSH keys section of their profile:

![Restricted SSH key icon](img/ssh_keys_restricted_key_icon.png)

Hovering over this icon will tell you why the key is restricted.
35 36 37 38 39 40 41 42 43 44 45 46

<!-- ## 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. -->