FishEye SSL Configuration

This page contains instructions on using SSL with FishEye.

On this page:

1. Obtain an SSL Certificate

An SSL certificate is required in order for SSL to work in FishEye. There are two ways to obtain one:

by signing one yourself, or
by getting one signed via a Certificate Authority.

Self-Signed Certificate

Self-signed certificates are useful in cases where you require encryption, but do not need to verify the website's identity. They are commonly used for testing and on internal corporate networks (intranets). If a certificate is not signed by a Certification Authority (CA), users may get prompted that the site is untrusted. They may then have to perform several steps to "accept" the certificate before they can access the site. This usually only occurs the first time the site is accessed.

Please note, the following approach to create the certificate uses Java's keytool, and has been designed for use with Java 1.6. There are other tools for generating certificates such as openSSL, but the examples will be for keytools, unless the functionality required does not exist in keytools.

To obtain a self-signed certificate,

Run the following command to create a new keystore file in the FishEye home directory (if one does not already exist):

Windows:

"%JAVA_HOME%\bin\keytool" -keystore %FISHEYE_HOME%/keystore -alias fisheye -genkey -keyalg RSA

Unix/Linux:

$JAVA_HOME/bin/keytool -keystore $FISHEYE_HOME/keystore -alias fisheye -genkey -keyalg RSA

When the keytool utility prompts you with 'What is your first and last name?', enter the fully qualified hostname of the server running FishEye/Crucible. Do not enter your first name and last name.
What is the fully qualified hostname of my server?
The fully qualified hostname of your server is the name you would type in your web browser, after the http:// section, to access a conventional website. When the client web browser examines the certificate, it checks this field to make sure it matches the hostname. If it does not, the browser may prevent access to the site and will at least generate messages saying that there is a mismatch. An example of a qualified hostname is: support.atlassian.com
When the keytool utility prompts you to enter the keystore password and key password, enter your desired passwords. You must also specify these passwords in the FishEye/Crucible web admin (recommended) or specify these passwords directly in your config.xml in the corresponding attributes (see Configure FishEye/Crucible SSL below).
```
<web-server context="/crucible" 
      site-url="http://localhost:6060/crucible/">
  <http bind=":6060"/>
  <ssl bind=":6443" keystore="keystore" keystore-password="password123" 
      truststore="keystore" truststore-password="password123"/>
</web-server>
```
You now have the minimal requirements to run SSL in FishEye. Next, configure FishEye/Crucible to use SSL as described in the Configure FishEye/Crucible SSL section below.

Certificate Authority Certificate

Digital Certificates issued by trusted 3rd party Certification Authorities (CAs) provide verification of the identity of your website. Many CAs simply verify the domain name and issue the certificate. Other CAs such as VeriSign also verify the existence of your business, the ownership of your domain name and the authority to whom the certificate application was made, thereby providing a higher standard of identification and authenticity.

A list of CA's can be found here. Some of the most well-known CAs are:

Verisign
Thawte
CAcert (relatively new CA, providing free CA certificates)

This list is not an endorsement of the given certificate authorities by Atlassian, and is only provided as an example.

To obtain a certificate signed by a CA,

Follow the instructions from the certificate authority you want your certificate signed by. Most CAs have their own instructions for you to follow, e.g. GoDaddy and VeriSign.

If your CA requires a certificate signing request (CSR), use the following command:

Windows:

"%JAVA_HOME%\bin\keytool" -certreq -alias fisheye -keystore %FISHEYE_HOME%\keystore -file %FISHEYE_HOME%\fisheye.csr

Unix/Linux:

$JAVA_HOME/bin/keytool -certreq -alias fisheye -keystore $FISHEYE_HOME/keystore -file $FISHEYE_HOME/fisheye.csr

Ensure that the keystore being used to generate the signing request contains an existing key/cert keypair. If you don't already have a key/cert keypair, follow the steps in Self Signed Certificates to generate a keypair.
If you have a key and a certificate in separate files, you need to combine them into a PKCS12 format file for loading into a new keystore. Keytool does not perform any of these conversions. Therefore, the easiest way to do this is via openssl, by running the following command:
```
openssl x509 -in certificate.der 
         -inform DER -outform PEM -out certificate.crt
```
to convert between DER and PEM. See these instructions for information on how to convert these separate files into PKCS12 format.

Load the certificate into the keystore, as follows:

CA certificate in PEM format:

Windows:

"%JAVA_HOME%\bin\keytool" -keystore %FISHEYE_HOME%\keystore 
         -import -alias fisheye -file %FISHEYE_HOME%\certificate.crt 
         -trustcacerts

Unix/Linux:

$JAVA_HOME/bin/keytool -keystore $FISHEYE_HOME\keystore 
         -import -alias fisheye -file $FISHEYE_HOME/certificate.crt 
         -trustcacerts

CA certificate in PKCS12 format:

Windows:

%JAVA_HOME%\bin\keytool -importkeystore 
         -srckeystore %FISHEYE_HOME%\certificate.pkcs12 
         -srcstoretype PKCS12 -destkeystore %FISHEYE_HOME\keystore

Unix/Linux:

$JAVA_HOME/bin/keytool -importkeystore 
         -srckeystore $FISHEYE_HOME/certificate.pkcs12 
         -srcstoretype PKCS12 -destkeystore $FISHEYE_HOME/keystore

You will now have a keystore file with your certificate in it. Next, configure FishEye/Crucible to use SSL as described in the Configure FishEye/Crucible SSL section below.

2. Configure FishEye SSL

FishEye requires additional configuration in order to use SSL. This configuration can be done from the web admin as described below (recommended), or added directly into your config.xml. Setting the bind address and the keystore and password field, as described below, will enable SSL in FishEye. You will need to restart your server after updating the settings, for the changes to take effect.

To configure FishEye to use SSL,

Navigate to the FishEye web admin and click 'Server' under the 'Global Settings' section. The 'Server Settings' page will be displayed (see 'Server Settings' screenshot below).
Click the 'Edit Settings' link in the 'Web Server' section. The settings will refresh as editable.

Update the following fields (see 'Example SSL Settings' screenshot below):

Field	Description	Example value
SSL Bind Address	The SSL port. Most browsers default to 443 as the SSL port for the https protocol.	443
SSL Keystore	Path to the keystore file (as generated in the steps above). This path can be a relative path - e.g., putting in `keystore` will mean that the file is in `FISHEYE_HOME/keystore`	keystore
SSL Keystore Password	The password you used in the above step when creating the keystore file. If you did not set a password, leave this empty. See the passwords section
SSL Truststore	Optional setting. Path to the truststore file. May be the same as the keystore. Truststore is a list of trusted CAs. Format is the same as the keystore entry.
SSL Truststore Password	Optional setting. The password you used in the above step when creating the truststore file. If you did not set a password, leave this empty. See the passwords section

Restart your server.

Screenshots: Fisheye Server Settings (click to view larger images)


1. Server Settings	2. Example SSL Settings

All Versions

FishEye 2.4 Documentation

Child pages

1. Obtain an SSL Certificate

Self-Signed Certificate

Certificate Authority Certificate

2. Configure FishEye SSL