Jira SAML 2.0 Plugin

A plugin for Atlassian Jira to support connecting to a SAML 2.0 IdP.

This library adheres to SemVer. Pre v1.0.0 is considered alpha level software.

Usage

Please see the wiki page for usage information

Installation

The normal way to install this plugin is via the Universal Plugin Manager (UPM) in Jira - search for SAML. The plugin can also be found in the Atlassian Marketplace

Development Setup

Note: this assumes you have a JDK installed and configured. If not, look here

Install the Atlassian SDK

Homebrew Setup

1. brew tap atlassian/tap
2. brew install atlassian/tap/atlassian-plugin-sdk

Install the Atlassian SAML Commons

1. git clone https://github.com/bitium/atlassian-saml.git
2. install the library with maven: mvn clean install

Compile and run the plugin

1. go to the directory where the source code was downloaded
2. run atlas-run to build the plugin and start jira
3. after everything compiles and jira starts, a URL will be displayed
4. enter the url into your browser * username: admin * password: admin
5. click the "cog" menu and select "add-ons"
6. enter "SAML" into the search box and select "All Add-ons" from the dropdown

Packaging and installing manually

1. In the project directory, run atlas-package to generate a jar
2. In jira, login and go to the "manage add-ons" admin area
3. Select the option to upload a plugin
4. Find the packaged jar under {project home}/target/SAML2PluginJira-{version}.jar

Tips

1. Use Atlassian QuickReload plugin to speed up developement by automatically deploying changes without needing to restart the host application.
2. A remote debugger can be attached after launching the host app using atlas-debug --product jira, see Creating a Remote Debug Target

Reporting Bugs

Please use github issues to log tickets

Documentation

Docs can be found in the wiki

Compatibility

This plugin is compatible with the Bitium IdP but other IdP's that support SAML 2.0 may also work. If you have success using it with another system please let us know so we can list that in the wiki.

Contributing

Submit your pull request to the develop branch. This allows us to merge your change into our internal master and then push out the change in the next release.

1. Fork it
2. Create your feature branch (git checkout -b feature/my-new-feature develop)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin feature/my-new-feature)
5. Create new Pull Request

Licensing

This plugin is licensed under GPLv3.

© Bitium, Inc 2014