Configure Abiquo Tomcat with HTTPS for Remote RS

This page describes how to use TLS/HTTPS to secure communications between an Abiquo Server and a Remote Services server in a remote location, which is called a remote RS server. You can use this, for example, when communications are over the internet.

When the Abiquo remote services will connect to the Abiquo Server over the internet, these communications should use TLS. When users upload or download templates, they need a direct connection to the Appliance Manager remote service, and this connection must be made with TLS.

This document explains how to configure a test environment and it gives examples for a test environment.

When configuring your production environment, always follow the advice of your Security team.

Change our example values to the values for your environment.

For example, replace myremoters.bcn.abiquo.com with the domain name of your remote RS server.

And replace remoters.jks with the name of your server keystore.

Import certificates on Remote RS

For a test environment, create a self-signed certificate for remote RS and import it. You can also use a wildcard certificate for your test environment.

https://devopscube.com/create-self-signed-certificates-openssl/

Log in to the Remote Services server as an administrator
Go to the /etc/pki/tls/ folder
Copy your self-signed Remote Services certificate (and API certificate(s)), or wildcard certificate to the certs folder and your private key to the private folder
Convert your certificates to PCKS12 format. For a wildcard certificate, do this for each server and enter its fully qualified domain name.
1. For the Remote services server, replace ${CERT_NAME} with your certificate name and replace ${REMOTE_SERVICES_FQDN} with the domain name of your remote RS server.
```
openssl pkcs12 -export -in ${CERT_NAME}.crt -inkey ${CERT_NAME}.key -name ${REMOTE_SERVICES_FQDN} -out import_cert_key_rs
```
2. For the API server, replace ${CERT_NAME} with your certificate name and replace ${ABIQUO_SERVER_FQDN} with the domain name of your Abiquo API server.
```
openssl pkcs12 -export -in ${CERT_NAME}.crt -inkey ${CERT_NAME}.key -name ${API_SERVER_FQDN} -out import_cert_key_server 
```
Go to the /opt/abiquo/tomcat/conf folder
Create a .jks keystore with the same name as the hostname of your Remote services server. This keystore configuration is suitable for a test environment only
```
keytool -genkey -keyalg RSA -keystore {REMOTE_SERVICES}.jks -keysize 2048
```

Import the Remote services certificate into the keystore for Tomcat to use

keytool -importkeystore -deststorepass changeit -destkeystore ${REMOTE_SERVICES}.jks -srckeystore import_cert_key_rs -srcstoretype PKCS12

Import the API server certificate into the keystore for Tomcat to use

keytool -importkeystore -deststorepass changeit -destkeystore ${REMOTE_SERVICES}.jks -srckeystore import_cert_key_server -srcstoretype PKCS12

Verify API server location path on remote RS server

Check that your Remote RS server has the correct API path set.

Log in to the Remote RS server as an administrator
View the Abiquo properties file at
```
/opt/abiquo/config/abiquo.properties
```
If the abiquo.server.api.location property is not set to a value with https and no port number, then edit the file and update it.
For example, abiquo.server.api.location=https://myapiserver.bcn.abiquo.com/api.

Define a new HTTPS connector in remote RS Catalina

On the Remote RS server, edit the Tomcat server configuration file at:

/opt/abiquo/tomcat/conf/server.xml

Replace the current remote RS Catalina connector for port 8009 with a new connector.

The example below is a guide only, use the correct file for your version of Tomcat

The important values to change are:

keystoreFile - e.g. use the host name of your remote RS server
keystorePass - use a secure password
keyAlias - you must use the domain name of your remote RS server

Also configure the other parameters according to your environment.

<Service name="Catalina">

        <Connector
           protocol="org.apache.coyote.http11.Http11NioProtocol"
           port="8009" maxThreads="200"
           scheme="https" secure="true" SSLEnabled="true"
           keystoreFile="/opt/abiquo/tomcat/conf/remoters.jks" 
           keystorePass="changeit" 
           keyAlias="myremoters.bcn.abiquo.com"
           clientAuth="false" secretrequired="false" 
           sslProtocol="TLS"/>

Import remote RS certificates on Abiquo server

Log in to the API server that will connect to the remote RS via HTTPS as administrator.

Import the Remote RS certificate, for example, for the default cacerts keystore in a test environment.

keytool -import -trustcacerts -alias ${REMOTE_SERVICES_FQDN} -file /etc/pki/abiquo/${CERT_NAME}.crt -cacerts

If you are using a self-signed certificate, also import your CA certificate.

Enable SSL proxy for Apache

For AM connections to work with TLS (for template upload and download), check or enable SSL proxy for Apache.

Log in the API/UI server as an administrator.
Edit the Apache configuration at /etc/httpd/conf.d/abiquo.conf.

In the Apache virtual host configuration, add the following.

####APACHE SSL PROXY##########
  SSLProxyEngine On
  SSLProxyVerify none
  SSLProxyCheckPeerCN off
  SSLProxyCheckPeerName off
  SSLProxyCheckPeerExpire off
  ##############################

Apply and verify

At this point all configurations are done. Restart both abiquo-tomcat services where changes have been made (in this scenario, remote RS and Abiquo Server) and restart the httpd service on the Abiquo server.

If you are using a self-signed certificate in a test environment, accept the remote RS certificates.
In your browser, open a connection to the remote RS server using the port. In our example, this would be: https://remoters.bcn.abiquo.com:8009/
Then go to Advanced and accept the risk.

Log in to Abiquo as a cloud administrator and add your remote RS using the HTTPS protocol.

For Tomcat TLS troubleshooting, see https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html