The configuration of the @PLUGIN@ plugin is done in the
auth.type must be set to
[auth] type = OAUTH
Providers are configured under @PLUGIN@ section, appended with provider suffix: e.g.
[plugin "@PLUGIN@-google-oauth"] client-id = "<client-id>" client-secret = "<client-secret>" link-to-existing-openid-accounts = true [plugin "@PLUGIN@-github-oauth"] root-url = "<github url>" # https://github.com/ or https://git.company.com/ client-id = "<client-id>" client-secret = "<client-secret>" [plugin "@PLUGIN@-cas-oauth"] root-url = "<cas url>" client-id = "<client-id>" client-secret = "<client-secret>" [plugin "@PLUGIN@-gitlab-oauth"] root-url = "<gitlab url>" client-id = "<client-id>" client-secret = "<client-secret>" [plugin "@PLUGIN@-dex-oauth"] domain = "<domain for username manipulation (optional)>" service-name = "<custom service name (optional)>" root-url = "<dex url>" client-id = "<client-id>" client-secret = "<client-secret>" [plugin "@PLUGIN@-airvantage-oauth"] client-id = "<client-id>" client-secret = "<client-secret>"
When one from the sections above is omitted, OAuth SSO is used. The login form with provider selection isn’t shown. When all sections are omitted, Gerrit will not start.
Google OAuth provider seamlessly supports linking of OAuth identity to existing OpenID accounts. This feature is deactivated by default. To activate it, add
plugin.gerrit-oauth-provider-google-oauth.link-to-existing-openid-accounts = true
to Google OAuth configuration section.
It is possile to restrict sign-in to accounts of one or more (hosted) domains for Google OAuth. Multiple
domain options can be added:
plugin.gerrit-oauth-provider-google-oauth.domain = "mycollege.edu" plugin.gerrit-oauth-provider-google-oauth.domain = "myschool.net"
(See the spec)[https://developers.google.com/identity/protocols/OpenIDConnect#hd-param] for more information. To protect against client-side request modification, the returned ID token is checked to contain a matching hd claim (which is proof the account does belong to the hosted domain). If the hd claim wasn‘t included in ID token or didn’t match the provided
domain configuration option the authentication is rejected. Note: Because of current limitation of the OAuth extension point in gerrit (blame /me for that) the user would only see “Unauthorized” message.
By default the Google OAuth provider will not set a username (used for ssh) and the user can choose one from the web ui (needed before using ssh). It is possible to automatically use the user part from the google apps email. This is deactivated by default. To activate it, add:
plugin.gerrit-oauth-provider-google-oauth.use-email-as-username = true
Note: the usernames are unique in gerrit. If a username already exists this will be ignored and the user will have to choose a different one from the web ui.
For CAS OAuth setting
plugin.gerrit-oauth-provider-cas-oauth.root-url = "https://example.com/cas"
is required, since CAS is a self-hosted application.
Note that the CAS OAuth plugin only supports CAS V5 and higher.
The plugin expects CAS to make several attributes available to it:
For Dex OAuth setting
plugin.gerrit-oauth-provider-dex-oauth.root-url = "https://example.com"
is required, since Dex is a self-hosted application.
To obtain client-id and client-secret for Google OAuth, go to Google Developers Console:
Create a project
Go inside the created project
In “APIs & auth”/“Credentials” select “Create new Client ID” and create Client ID for a Web application
Enter additional information about the project, which will be presented to user during the authentication process
Specify authorized redirect URL:
After the final step, the page will show generated client id and secret.
To obtain client-id and client-secret for GitHub OAuth, go to Applications settings in your GitHub account:
Select “Register new application” and enter information about the application.
Note that it is important that authorization callback URL points to
After application is registered, the page will show generated client id and secret.