gitlab-org--gitlab-foss/doc/integration/oauth2_generic.md

stage	group	info
Ecosystem	Integrations	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

Sign into GitLab with (almost) any OAuth2 provider (FREE SELF)

The omniauth-oauth2-generic gem allows Single Sign-On between GitLab and your own OAuth2 provider (or any OAuth2 provider compatible with this gem)

This strategy is designed to allow configuration of the simple OmniAuth SSO process outlined below:

1. Strategy directs client to your authorization URL (configurable), with specified ID and key
2. OAuth provider handles authentication of request, user, and (optionally) authorization to access user's profile
3. OAuth provider directs client back to GitLab where Strategy handles retrieval of access token
4. Strategy requests user information from a configurable "user profile" URL (using the access token)
5. Strategy parses user information from the response, using a configurable format
6. GitLab finds or creates the returned user and logs them in

Limitations of this Strategy

• It can only be used for Single Sign on, and doesn't provide any other access granted by any OAuth provider (importing projects or users, etc)
• It only supports the Authorization Grant flow (most common for client-server applications, like GitLab)
• It is not able to fetch user information from more than one URL
• It has not been tested with user information formats other than JSON

Configuration Instructions

1. Register your application in the OAuth2 provider you wish to authenticate with.

   The redirect URI you provide when registering the application should be:

   http://your-gitlab.host.com/users/auth/oauth2_generic/callback
   

2. You should now be able to get a Client ID and Client Secret. Where this shows up differs for each provider. This may also be called Application ID and Secret

3. On your GitLab server, open the configuration file.

   For Omnibus package:

   sudo editor /etc/gitlab/gitlab.rb
   

   For installations from source:

   cd /home/git/gitlab
   sudo -u git -H editor config/gitlab.yml
   

4. See Configure initial settings for initial settings

5. Add the provider-specific configuration for your provider, for example:

   gitlab_rails['omniauth_providers'] = [
     {
       name: "oauth2_generic",
       label: "Provider name", # optional label for login button, defaults to "Oauth2 Generic"
       app_id: "<your_app_client_id>",
       app_secret: "<your_app_client_secret>",
       args: {
         client_options: {
           site: "<your_auth_server_url>",
           user_info_url: "/oauth2/v1/userinfo",
           authorize_url: "/oauth2/v1/authorize",
           token_url: "/oauth2/v1/token"
         },
         user_response_structure: {
           root_path: [],
           id_path: ["sub"],
           attributes: {
             email: "email",
             name: "name"
           }
         },
         authorize_params: {
           scope: "openid profile email"
         },
         strategy_class: "OmniAuth::Strategies::OAuth2Generic"
       }
     }
   ]
   

   For more information about these settings, see the gem's README.

6. Save the configuration file

7. Restart GitLab for the changes to take effect

On the sign in page there should now be a new button below the regular sign in form. Click the button to begin your provider's authentication process. This directs the browser to your OAuth2 Provider's authentication page. If everything goes well the user is returned to your GitLab instance and is signed in.