Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/curityio/slack-authenticator

Slack oauth authenticator that can be used with any Java-based Web API
https://github.com/curityio/slack-authenticator

authenticator login oauth2 plugin slack

Last synced: about 1 month ago
JSON representation

Slack oauth authenticator that can be used with any Java-based Web API

Awesome Lists containing this project

README 

        
Slack Authenticator Plug-in

===========================



.. image:: https://img.shields.io/badge/quality-demo-red

    :target: https://curity.io/resources/code-examples/status/



.. image:: https://img.shields.io/badge/availability-source-blue

    :target: https://curity.io/resources/code-examples/status/



This project provides an opens source Slack 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 Slack credentials. The app that integrates with Curity may also be configured to receive the Slack access token, allowing it to manage resources in a Slack.



System Requirements

~~~~~~~~~~~~~~~~~~~



* Curity Identity Server 7.0.2 and `its system requirements `_



Requirements for Building from Source

"""""""""""""""""""""""""""""""""""""



* Maven 3

* Java SDK 17 or later



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/slack``. (The name of the last directory, ``slack``, 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 Slack

~~~~~~~~~~~~~~~~~~~~~~~~



As `described in the Slack documentation `_, You can `create and register `_ an OAuth App.



Creating a new Slack application



    .. figure:: docs/images/create-slack-app1.png

            :name: new-slack-app

            :align: center

            :width: 500px



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



When you view the app's configuration after creating it, you'll find the ``Client ID`` and ``Client Secret`` in the ``Basic Information`` section. These will be needed later when configuring the plug-in in Curity.



Slack will also display the Redirect URLs in the new app's ``OAuth & Permissions`` section. This needs to match the yet-to-be-created Slack 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/$slackAuthnticatorId/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``.

``slackAuthenticatorId``         This is the name given to the Slack authenticator when defining it (e.g., ``slack1``).

============================== =========================================================================================



    .. figure:: docs/images/slack-permissions.png

            :name: new-slack-app

            :align: center

            :width: 500px



Once the redirect URI is updated, you need to configure at least one scope ``Read User``.



.. figure:: docs/images/slack-scope.png

    :align: center

    :width: 500px



.. figure:: docs/images/slack-scope-selected.png

    :align: center

    :width: 500px



It could be helpful to also enable additional scopes. Scopes are the Slack-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 Slack API, additional scopes probably should be enabled. Refer to the `Slack documentation on scopes `_ for an explanation of those that can be enabled and what they allow.



.. warning::



    If the app configuration in Slack does not allow a certain scope (e.g., the ``Read User Email`` 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.



The final step for your app to be ready is to ``Activate Public Distribution`` in ``Manage Distribution`` section of app's configuration.



.. figure:: docs/images/manage-slack-distribution.png

    :align: center

    :width: 500px



Creating a Slack Authenticator in Curity

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



The easiest way to configure a new Slack 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., ``slack1``). This name needs to match the URI component in the callback URI set in the Slack app.

4. For the type, pick the ``Slack`` option:



    .. figure:: docs/images/slack-authenticator-type-in-curity.png

        :align: center

        :width: 600px



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 Slack-specific options can be found.



    .. note::



    The Slack-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 Slack OAuth server's token and user info endpoints. To define this, do the following:



    A. click the ``Facilities`` button at the top-right of the screen.

    B. Next to ``HTTP``, click ``New``.

    C. Enter some name (e.g., ``slackClient``).

    D. Click ``Apply``.



        .. figure:: docs/images/slack-http-client.png

                :align: center

                :width: 400px



7. Back in the Slack authenticator instance that you started to define, select the new HTTP client from the dropdown.



        .. figure:: docs/images/http-client.png



8. In the ``Client ID`` textfield, enter the client ID from the Slack app configuration.

9. Also enter the matching ``Client Secret``.

10. If you wish to limit the scopes that Curity will request of Slack, select the desired scopes from dropdown.



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.