Discovery OAuth: Add optional PKCE support

Add support for Proof Key for Code Exchange (PKCE) in the Discovery
OAuth provider to improve security of the authorization code flow.

When `enable-pkce = true`:
- Generate a PKCE code verifier/challenge during authorization
- Return verifier alongside the authorization URL
- Include verifier when exchanging the authorization code for a token

This is disabled by default to preserve backward compatibility with
providers that do not support PKCE.

NOTE: This change depends on a Gerrit core update that extends the
OAuthServiceProvider API (OAuthAuthorizationInfo and PKCE-aware
getAccessToken). The plugin will not work with older Gerrit versions.

Also:
- Update configuration and documentation
- Add unit tests covering PKCE authorization and token exchange flows

Contributed-By: Kai Liu <kraml.liu@gmail.com>
Change-Id: I56fa0f4d50333a2c568d95c31c78f2de3afed661
4 files changed
tree: 99b964dae231a4b2f079833acd92596cdbc750e6
  1. .settings/
  2. src/
  3. tools/
  4. .bazelignore
  5. .bazelrc
  6. .bazelversion
  7. .gitignore
  8. .travis.yml
  9. BUILD
  10. external_plugin_deps.MODULE.bazel
  11. LICENSE
  12. LICENSE-scribe
  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

Build Status

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

See the Wiki 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