Add OAuth access-token refresh support

Teach refresh-capable providers to request and preserve refresh tokens,
stamp issued tokens with provider ids, and refresh expired access tokens
through the native HTTP client. Add provider configuration docs
(discovery, Keycloak, GitLab) and refresh the config overview.

This intentionally leaves the oauth-token SSH command and token
encryption in Gerrit core.

Change-Id: I16c64bce8041b9fe2cb998ed7e63dd70045c1f27
21 files changed
tree: 664d5cd27d4b54f6cf418ad3bfb0f75a02be3080
  1. .settings/
  2. contrib/
  3. src/
  4. tools/
  5. .bazelignore
  6. .bazelrc
  7. .bazelversion
  8. .gitignore
  9. .travis.yml
  10. BUILD
  11. external_plugin_deps.MODULE.bazel
  12. LICENSE
  13. MODULE.bazel
  14. MODULE.bazel.lock
  15. oauth_plugin_deps.lock.json
  16. oauth_third_party_runtime_jars.allowlist.txt
  17. README.md
README.md

Gerrit OAuth2 authentication provider

With this plugin Gerrit can use OAuth2 protocol for authentication. Supported OAuth providers:

Auth0, Authentik, Amazon Cognito, LemonLDAP::NG and Tuleap were previously shipped as dedicated providers. They are standard OpenID Connect providers, so they have been removed in favour of the generic Discovery provider; see Documentation/config-discovery.md for how to migrate their configuration.

See Documentation/providers.md for a per-provider capability matrix, and the Wiki for what it can do for you.

Prebuilt artifacts

Prebuilt binary artifacts are available on release page. Make sure to pick the right JAR for your Gerrit version.

Build

To build the plugin with Bazel, install Bazel and run the following:

  git clone https://gerrit.googlesource.com/plugins/oauth
  cd oauth && bazel build oauth

Install

Copy the bazel-bin/oauth.jar to $gerrit_site/plugins and re-run init to configure it:

  java -jar gerrit.war init -d <site>
  [...]
  *** OAuth Authentication Provider
  ***
  Use Bitbucket OAuth provider for Gerrit login ? [Y/n]? n
  Use Google OAuth provider for Gerrit login ? [Y/n]?
  Application client id          : <client-id>
  Application client secret      : 
                confirm password : 
  Link to OpenID accounts? [true]: 
  Use GitHub OAuth provider for Gerrit login ? [Y/n]? n

Reporting bugs

Make sure to read the FAQ before reporting issues.

License

Apache License 2.0