schof0rl / keycloakjiraplugin

A Plugin for Atlassian Jira which hopefully enables SSO with Keycloak

#Preamble and warnings

This plugin was created with the Atlassian SDK. See, for example, the official introduction. To run it, go to the root directory and enter 'atlas-run' in your favorite command shell. You may configure keycloak by editing the keycloak.json file according to the documentation here. This was originally developed with Keycloak 4.8.3.Final and Jira 7.13. Please do notice that this is not necessarily the most efficient way possible to authenticate to Jira with Keycloak. Also if you are looking for actual support please investigate the marketplace for your needs. There should be way better options available to you than using this plugin

#Disclaimer This plugin currently does not support single log-out. If users logout from JIRA they are logged out from Keycloak. The reverse does not apply. e.g if a user logs out from CONFLUENCE and CONFLUENCE is also configured as a Keycloak client the JIRA-session will not be ended. All your Jira users MUST be known to Keycloak for this plugin to work properly. Alternatively users may login the "old school" way by appending a query parameter "noSSO" to the URL when accessing JIRA for the first time

This plugin was only tested with Jira running on localhost, though the keycloakserver was on a different machine.

#Getting this plugin running

1. Make sure keycloak is running on localhost:8180. You can get that done via docker or just by downloading and unziping the official distribution
2. Make a basic realm and configure a client for Jira. Here are some links that might prove useful for this
3. Create a user admin, so you can test immediately
4. Edit the keycloak.json file according to your configuration
5. If you did not already install the Atlassian SDK. Here is a link to a tutorial for windows
6. Clone this repository
7. Open your favourite command prompt and navigate into the root folder of this plugin, e.g C:/Users/user/Desktop/myFirstPlugin
8. Run 'atlas-run' in your command shell
9. Wait for Jira deployment to be finished
10. Navigate to http://localhost:2990/jira. You should be redirected to a login page from keycloak. Login with user 'admin' and the password you configured
11. You should now be logged into jira as well

If you just want to use this plugin in your Jira deployment without making changes to it

1. Create an appropriate client for Jira at your Keycloak server
2. Adjust the keycloak.json file accordingly
3. Open your favourite command shell and navigate into the root directory of this git project, that is the folder holding the pom.xml
4. Execute 'atlas-package' or 'atlas-mvn package' in your shell, they basically do the same exact thing anyways
5. Upload the plugin to your Jira deployment

#Troubleshooting

• If you are using Atlassian's quick reload feature in development you should delete your session cookies before further testing. You will run into Classcastexceptions otherwise. This is easily accomplished by restarting your browser since session cookies usually expire upon browser shutdown.
• You can send me an email at [email protected]. Please be aware that I will most likely not answer requests concerning this plugin or security issues. This plugin neither claims its the most optimal nor most efficient solution to integrate Keycloak into your Jira deployment. You are most likely better of using a commercial plugin.
• If you are avoiding the usage of the Atlassian SDK you might have to manually install the jndi and jta dependencies into your local maven repository as the needed versions are not hosted on Atlassian's Maven repository anymore. Blame Atlassian for having broken builds.