Securing Stash behind HAProxy using SSL

This page describes how to establish a network topology in which the HAProxy server acts as a reverse proxy for Stash. Typically, such a configuration would be used when either when:

  1. Stash is installed in a protected zone 'behind the firewall', and HAProxy provides a gateway through which users outside the firewall can access Stash.
  2. Stash needs to be served on protected ports (e.g. ports < 1024 on Linux). Stash cannot access these ports directly as it must not be run as a privileged user (e.g root). In this case HAProxy can bind to these ports and forward the requests to Stash.

On this page:

The configuration described on this page results in a scenario where:

  • External client connections with HAProxy are secured using SSL. Connections between HAProxy and Stash are unsecured.
  • Stash and HAProxy run on the same machine.
  • Stash is currently available at http://mycompany.com:7990.
  • Stash is to be made available at https://mycompany.com/stash.

Stash_topo_nginx

Please note that:

  • We assume that you already have a running instance of HAProxy.
  • SSL certificates must be installed on the server machine.
  • Any existing links with other applications will need to be reconfigured using the new URL for Stash.
  • Securing Git operations between the user's computer and Stash is a separate consideration - see Enabling SSH access to Git.
  • It is also possible to get Stash to directly use SSL without the help of a proxy as documented in Securing Stash with Tomcat using SSL.

Note that the Atlassian Support Offering does not cover HAProxy integration, but you can get assistance with HAProxy from the Atlassian community on answers.atlassian.com, or from an Atlassian Expert.

Step 1: Set a context path for Stash

Stash and HAProxy need to be serving from the same context. Stash is currently accessed at http://mycompany.com:7990. It needs to be changed to serve from http://mycompany.com:7990/stash to match context https://mycompany.com/stash.

In Tomcat's <Stash home directory>/shared/server.xml file, set the context path to /stash:

<Context path="/stash" docBase="${catalina.home}/atlassian-stash" reloadable="false" useHttpOnly="true">
    ....
</Context>
  • If you use a context path, it is important that the same path is appended to the context path of Stash's base URL (Step 2). 
  • The context path for serving from the root context is path="" (i.e not path="/").

Step 2: Change Stash's base URL

Open a browser window and log into Stash using an administrator account. Go to the Stash administration area and click Server settings (under 'Settings'), and change Base URL to match the URL HAProxy will be serving. For this example, use https://mycompany.com/stash.

Step 3: Configure the Tomcat Connector

Find the normal (non-SSL) Connector directive in Tomcat's <Stash home directory>/shared/server.xml file, and add the securescheme proxyNameproxyPort and redirectPort attributes. These attributes tell Tomcat how HAProxy is serving Stash so it can generate correct URLs. Following our example:

<Connector port="7990" 
     protocol="HTTP/1.1"
     connectionTimeout="20000"
     useBodyEncodingForURI="true"
     redirectPort="443"
     compression="on"
     compressableMimeType="text/html,text/xml,text/plain,text/css,application/json,application/javascript,application/x-javascript"
     secure="true"
     scheme="https"
     proxyName="mycompany.com" 
     proxyPort="443" />
  • proxyPort is set to 443 to indicate that HAProxy is accepting connections over on the standard HTTPS port 443. 
  • proxyName and scheme are are set to the values that HAProxy is serving Stash over. 
  • secure attribute is also set to true to tell Stash that the connection between the client and HAProxy is considered secure. 
  • redirectPort is set to 443 so that Tomcat knows how to send a user to a secure location when necessary (this is not really necessary in this example because this connector is already secure). 

For more information about configuring the Tomcat Connector, refer to the Apache Tomcat 7.0 HTTP Connector Reference.

Step 4: Configure HAProxy

Merge the example below into your HAProxy configuration (e.g /etc/haproxy/haproxy.cfg). This is a complete HAProxy 1.5.x configuration. Note that HAProxy 1.5.x or greater is required for SSL support. You can just take the bits that fit your needs. The important configuration is in the stash_http_frontend and stash_http_backend.

global
	log /dev/log local0
	log /dev/log local1 notice
	user haproxy
	group haproxy
	daemon
    ssl-default-bind-options no-sslv3
    maxconn 1000

defaults
	log	global
	mode http
	option httplog
	option dontlognull
    timeout connect 5000
    timeout client  50000
    timeout server  50000
 
# Tells HAProxy to start listening for HTTPS requests. It uses the SSL key 
# and certificate found within certAndKey.pem. All requests will be routed 
# to the stash_http_backend.
frontend stash_http_frontend
    bind *:443 ssl crt /etc/haproxy/certAndKey.pem ciphers HIGH:!aNULL:!MD5
    default_backend stash_http_backend
    # This is an optional rule that will redirect all requests to https://mycompany.com
    # to https://mycompany.com/stash.
    redirect location /stash if { path -i / }

# The stash_http_backend simply forwards all requests onto http://mycompany.com:7990/. 
# It will only allow 50 concurrent connections to the server at once.
backend stash_http_backend
    mode http
    option httplog
    option forwardfor
    option http-server-close
    option httpchk
    server stash01 mycompany.com:7990 maxconn 50

(Optional) Step 4: Redirect SSH connections 

HAProxy also has the ability to proxy all Stash SSH traffic. See Setting up SSH port forwarding for details.

Resources

Here are some resources you may find helpful in setting up Stash behind HAProxy:

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport