Confluence Docs 3.0 : Adding SSL for Secure Logins and Page Security
This page last changed on Sep 30, 2009 by jlargman.
This document describes how to configure Confluence to use a HTTPS encrypted secure socket layer for user logins and page data. Unencrypted confidential data within Confluence may be intercepted by an attacker. To secure user logins, you can enable access via HTTPS (HTTP over SSL), and require its use for pages where passwords are sent. In some cases where issue data is sensitive, all pages can be set to be accessed over HTTPS. Enabling SSL access is different for each application server, but specifying which pages to require protection for is generic. This document is specific to Tomcat, the default application server shipped with Confluence. On this page: Adding Secure User LoginsAdding HTTPS requires a valid SSL certificate. If you have a Certificate prepared, skip to the 'Modify the <INSTALL>/conf/server.xml File' section. Creating A New SSL CertificateCreating a self-signed certificate
On Windows, perform the following at the command prompt: "%JAVA_HOME%\bin\keytool" -genkey -alias tomcat -keyalg RSA Or on other platforms, perform the following at the command prompt: $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA Some questions will be asked, including a password for the certificate (the default is 'changeit'). Please note down what you choose, as it will be used in the next step.
Modify the <INSTALL>/conf/server.xml FileIn the confluence directory, open the conf/server.xml file and insert one of the following just after the closing </Engine> tag:
Establishing a CA-issued CertificateIn preparation for a production instance, an official CA-issued key pair is required. Find instructions in the Tomcat documentation. Verify the Certificate is in the Correct LocationBy default, Tomcat will look for the certificates in the file C:\Documents and Settings\\#CURRENT_USER#\.keystore on Windows or ~/.keystore on Unix. If your Certificate is not in this location, you will need to update your <INSTALL>/conf/server.xml file as outlined below, so that Tomcat can find it.
Specifying URL Patterns to be RedirectedRestart Tomcat and access your instance on https://<MY_BASE_URL>:8443/. For more detailed information on setting up SSL with Tomcat (including additional configuration options), have a look at Tomcat 5.5 SSL or Tomcat 6 SSL. Although HTTPS is now activated and available, the old HTTP URLs (http://localhost:8080) are still available. In most situations one wants these URLs to continue working, but for some to redirect to their HTTPS equivalent.
If security is a concern, we recommend using SSL encryption site wide, for the reasons listed here: CONF-4116. To do this: Edit the confluence/WEB-INF/web.xml file and add the following declaration to the end, before the </web-app> tag: <security-constraint> <web-resource-collection> <web-resource-name>Restricted URLs</web-resource-name> <url-pattern>/</url-pattern> </web-resource-collection> <user-data-constraint> <transport-guarantee>CONFIDENTIAL</transport-guarantee> </user-data-constraint> </security-constraint> Once this change is made, restart Confluence and access http://localhost:8080. You should be redirected to https://localhost:8443/login.action. If you'd like to protect login.action only:
<security-constraint> <web-resource-collection> <web-resource-name>Login and Restricted Space URLs</web-resource-name> <url-pattern>/login.action</url-pattern> </web-resource-collection> <user-data-constraint> <transport-guarantee>CONFIDENTIAL</transport-guarantee> </user-data-constraint> </security-constraint> Note that the example above specifies a url-pattern for the login URL /login.action. This means that whenever a user tries to access the unprotected version of the login page, they will be redirected automatically to the secured version of it. If you want to protect individual spaces, there isn't a complete way of doing this at the moment. You can add a pattern like this: <security-constraint> <web-resource-collection> <web-resource-name>Login and Restricted Space URLs</web-resource-name> <url-pattern>/login.action</url-pattern> <url-pattern>/display/SALARIES/*</url-pattern> </web-resource-collection> <user-data-constraint> <transport-guarantee>CONFIDENTIAL</transport-guarantee> </user-data-constraint> </security-constraint> TroubleshootingCheck the Confluence Knowledge Base articles at Troubleshooting SSL. |
![]() |
Document generated by Confluence on Nov 05, 2009 23:27 |