SSO Connector for Confluence and Crowd

Download And Installation

• Log into your Confluence instance as an admin.
• Navigate to the settings menu and Click Manage Apps.
• Click Find new apps or Find new add-ons from the left-hand side of the page.
• Locate SSO connector for Crowd and Confluence via search.
• Click Try free to begin a new trial or Buy now to purchase a license of SSO connector for Crowd and Confluence.
• Enter your information and click Generate license when redirected to MyAtlassian.
• Click Apply license.

Plugin Configuration

• To configure the plugin, firstly configure Crowd SAML Single Sign-On (SSO) plugin for your Identity Provider as mentioned in the steps.
• Now, Enable Crowd SSO for your Confluence instance.
You can find the steps to integrate your Crowd server with your Confluence instance here.



Enable SSO integration with Crowd

1. If Confluence is running, shut it down first.

2. Now, edit the file CONFLUENCE/confluence/WEB-INF/classes/seraph-config.xml
   Comment out the line:-

   <!-- <authenticator class="com.atlassian.confluence.user.ConfluenceAuthenticator"/> -->
                         

   Uncomment the line:-

   <authenticator class="com.atlassian.confluence.user.ConfluenceCrowdSSOAuthenticator"/>
                         

3. Copy the crowd.properties file from CROWD/client/conf/ to CONFLUENCE/confluence/WEB-INF/classes.

4. Edit CONFLUENCE/confluence/WEB-INF/classes/crowd.properties. Change the following properties:

   Key	Value
   application.name	confluence The application.name and application.password must match the Name and Password that you specified when defining the application in Crowd (see Step 1 above).
   application.password	The application.name and application.password must match the Name and Password that you specified when defining the application in Crowd (see Step 1 above).
   crowd.base.url	http://localhost:8095/crowd/ If your Crowd server's port is configured differently from the default (i.e. 8095), set it accordingly.
   session.validationinterval	This is the number of minutes between validation requests, when Crowd validates whether the user is logged in to or out of the Crowd SSO server. Set to the required number of minutes between validation requests. The recommended default is 2 minutes. Setting this value to 1 or higher will increase the performance of Crowd's integration.

• Go to SSO Configuration tab of Confluence-Crowd Connector plugin.
• Enter Crowd Base URL and click on Save.

• Now, all the IdPs are listed that you have configured with SAML SSO Crowd plugin.
• The Enable SSO button is provided for every individual IdP. You can enable SSO for specific IdPs with the help of the buttons.

SSO Redirection

• If you have only one IDP configured, then you can use the features provided on the SSO Redirection tab and Redirection Rules tab of the plugin to manage the redirection on the login page.
• Enable the Auto Redirect to IDP option on the SSO Redirection tab if you want to allow users to log in only using IDP.
• Use the Emergency/Backdoor Login URL to allow all admins to access the Confluence default login page and log in using Crowd credentials.
• Use the settings given on Redirection Rules tab to redirect the users on login page based on their email domains, groups and directories. This feature is more useful in case you have multiple IDPs configured. Please refer to the next section.

Managing SSO with multiple IDPs

• If you have multiple IDPs configured, you can choose how you want your end users to use these IDPs to perform SSO.
• For example you can show the buttons for the different IDPs configured on the login page nad let the users decide which IDP to use for SSO.
• Or you could force certain users to use a specific IDP based on the domain of their username/email.
• You will be able to configure these rules in the Redirection Rules section, under the Redirection Rules tab.
• By default one rule is always configured that will be applicable to all the users, irrespective of their user domains.
• For instance, if you want to display the login page with SSO buttons for each of the IDPs then your Default Rule will be as follows :

• Based on the default rule mentioned above, the login form will contain buttons for each IDP. The users will be free to choose whichever IDP they want to use to initiate SSO.

• You can also configure a rule so that your users will automatically be redirected to an IDP based on their email domains.
• For example, if you want users with example.com as domain to be redirected to IDP 1 you can add a rule by :
  
  
  1. Click on the Add Rule button in the Redirection Rules tab.
  2. Enter a name for your rule in Rule Name.
  3. In the IF statement select Email Domain in the first drop-down.
  4. For the same statement select equals in the second drop-down.
  5. In the last field of the IF statement, enter the email domain(example.com for the purpose of this example).
  6. In the Then Redirect To drop-down, select the IDP you want the users with example.com to be redirected to(IDP 1 in this case).
  7. Click on Save.
  
• When a rule such as an example given above is configured, a login form will be displayed to the users where they will have to input their email address.

Customize your login page

• Go to the Look and Feel tab of the plugin.
• Here, you can design your own login template that will be used to initiate SSO. This will display your customized login page instead of application's default login page.

Crowd Troubleshooting

Recommended Add-Ons

Additional Resources

• Crowd Troubleshooting Guide
• What is SAML?
• What is Crowd SSO?
• Crowd and Confluence Integration
• SSO Connector for Jira and Crowd
• SSO Connector for Bitbucket and Crowd