Bitbucket oauth authenticator that can be used with any Java-based Web API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/images
src/main
.gitignore
.travis.yml
LICENSE
README.rst
pom.xml

README.rst

Bitbucket Authenticator Plug-in

https://travis-ci.org/curityio/bitbucket-authenticator.svg?branch=master

This project provides an opens source Bitbucket Authenticator plug-in for the Curity Identity Server. This allows an administrator to add functionality to Curity which will then enable end users to login using their Bitbucket credentials. The app that integrates with Curity may also be configured to receive the Bitbucket access token and refresh token, allowing it to manage resources in Bitbucket.

System Requirements

Requirements for Building from Source

  • Maven 3
  • Java JDK v. 8

Compiling the Plug-in from Source

The source is very easy to compile. To do so from a shell, issue this command: mvn package.

Installation

To install this plug-in, either download a binary version available from the releases section of this project's GitHub repository or compile it from source (as described above). If you compiled the plug-in from source, the package will be placed in the target subdirectory. The resulting JAR file or the one downloaded from GitHub needs to placed in the directory ${IDSVR_HOME}/usr/share/plugins/bitbucket. (The name of the last directory, bitbucket, which is the plug-in group, is arbitrary and can be anything.) After doing so, the plug-in will become available as soon as the node is restarted.

Note

The JAR file needs to be deployed to each run-time node and the admin node. For simple test deployments where the admin node is a run-time node, the JAR file only needs to be copied to one location.

For a more detailed explanation of installing plug-ins, refer to the Curity developer guide.

Creating an App in Bitbucket

As described in the Bitbucket documentation, you can create apps that use the Bitbucket APIs as shown in the following figure:

docs/images/new-bitbucket-app.png
docs/images/new-bitbucket-app1.png
docs/images/new-bitbucket-app2.png

Then, give the app a name, e.g., Curity-Integration-App.

After you save the changes, toggle the consumer name in consumers list to see the generated Key and Secret value for your consumer. These will be needed later when configuring the plug-in in Curity.

Bitbucket will also display the Callback URL in the new app's configuration. This needs to match the yet-to-be-created Bitbucket authenticator instance in Curity. The default will not work, and, if used, will result in an error. This should be updated to some URL that follows the pattern $baseUrl/$authenticationEndpointPath/$bitbucketAuthnticatorId/callback, where each of these URI components has the following meaning:

URI Component Meaning
baseUrl The base URL of the server (defined on the System --> General page of the admin GUI). If this value is not set, then the server scheme, name, and port should be used (e.g., https://localhost:8443).
authenticationEndpointPath The path of the authentication endpoint. In the admin GUI, this is located in the authentication profile's Endpoints tab for the endpoint that has the type auth-authentication.
bitbucketAuthenticatorId This is the name given to the Bitbucket authenticator when defining it (e.g., bitbucket1).

Once the Callback URL is updated, the only thing left is to configure scopes.

docs/images/bitbucket-scopes.png

It could be helpful to also enable additional scopes. Scopes are the Bitbucket-related rights or permissions that the app is requesting. If the final application (not Curity, but the downstream app) is going to perform actions using the Bitbucket API, additional scopes probably should be enabled. Refer to the Bitbucket documentation on scopes for an explanation of those that can be enabled and what they allow.

Warning

If the app configuration in Bitbucket does not allow a certain scope (e.g., the Projects write scope) but that scope is enabled in the authenticator in Curity, a server error will result. For this reason, it is important to align these two configurations or not to define any when configuring the plug-in in Curity.

Creating a Bitbucket Authenticator in Curity

The easiest way to configure a new Bitbucket authenticator is using the Curity admin UI. The configuration for this can be downloaded as XML or CLI commands later, so only the steps to do this in the GUI will be described.

  1. Go to the Authenticators page of the authentication profile wherein the authenticator instance should be created.

  2. Click the New Authenticator button.

  3. Enter a name (e.g., bitbucket1). This name needs to match the URI component in the callback URI set in the Bitbucket app.

  4. For the type, pick the Bitbucket option:

    docs/images/bitbucket-authenticator-type-in-curity.png
  5. On the next page, you can define all of the standard authenticator configuration options like any previous authenticator that should run, the resulting ACR, transformers that should executed, etc. At the bottom of the configuration page, the Bitbucket-specific options can be found.

    Note

    The Bitbucket-specific configuration is generated dynamically based on the configuration model defined in the Java interface.

  6. Certain required and optional configuration settings may be provided. One of these is the HTTP Client setting. This is the HTTP client that will be used to communicate with the Bitbucket OAuth server's token and user info endpoints. To define this, do the following:

    1. click the Facilities button at the top-right of the screen.

    2. Next to HTTP, click New.

    3. Enter some name (e.g., bitbucketClient).

      docs/images/bitbucket-http-client.png
  7. Back in the Bitbucket authenticator instance that you started to define, select the new HTTP client from the dropdown.

    docs/images/http-client.png
  8. In the Client ID textfield, enter the Key from the Bitbucket app consumer.

  9. Also enter the matching Client Secret.

  10. If you wish to limit the scopes that Curity will request of Bitbucket, toggle on the desired scopes (e.g., Account Info or Read Repository).

Once all of these changes are made, they will be staged, but not committed (i.e., not running). To make them active, click the Commit menu option in the Changes menu. Optionally enter a comment in the Deploy Changes dialogue and click OK.

Once the configuration is committed and running, the authenticator can be used like any other.

License

This plugin and its associated documentation is listed under the Apache 2 license.

More Information

Please visit curity.io for more information about the Curity Identity Server.

Copyright (C) 2017 Curity AB.