Before we can claim to run a secure grid all services must use https rather than http. Moving the services to https (SSL/TLS) is easy, updating existing clients to use the new URLs is also easy, but will take more time.
NOTE: the web services themselves do not need to be updated; only clients that call the services need to be updated to use the new URLs.
Work Item Investigate redirects so access to the unsecured service port is automatically redirected to the secure service port.
To serve requests over https Tomcat needs a private key and public key (certificate) that it can use to sign and encode/decode messages. These keys are stored in a “keystore” which is created with the Java keytool program.
Update: Since all LAPPS Grid members are also members of the [InCommon Federation](https://www.incommon.org) server certificats can be obtained through the [InCommon Certificate Service](https://www.incommon.org/certificates/). Please contact the appropriate person in your IT department for information on obtaining certificates through your institution.
This means you can also skip the first two steps and most of the third step below and go directly to the [Configure Tomcat](#configure-tomcat) section.
Create a keystore.
The following instructions assume the keytool program is on your $PATH, otherwise the full path is $JAVA_HOME/bin/keytool.
keytool -genkey -keysize 2048 -alias tomcat -keyalg RSA -keystore /path/to/keystore
The /path/to/keystore is the keystore file that will be generated.
The keytool program will ask for the following information:
- What is your first and last name? Enter the domain name that will be secured with this keystore. You can protect multiple subdomains by using a wildcard domain, e.g. *.anc.org.
- What is the name of your organizational unit? (Optional) Put the name of your institution here.
- What is the name of your organization? This must be Language Application Grid or I will not be able to sign your certificate.
- Fill in appropriate values for the remaining questions (City, State, Country).
You will also be asked to generate two passwords; these passwords must be the same or Tomcat will have problems.
Generate a Certificate Signing Request (CSR)
This step is optional if you already have a security certificate for you server. However, if your certificate is self-signed you should generate a new certificate for use with Tomcat that can be signed by the LAPPS Certificate Authority (LAPPSCA).
If you already have a (non-self-signed) security certificate that you would like to use skip this step and move directly to the Installing the Certificate step below.
keytool -certreq -keyalg RSA -alias tomcat -file server-name.csr -keystore /path/to/keystore
Replace server-name.csr with your appropriate server name; e.g. grid.anc.org.csr.
Email the CSR to me and I will send you three certificates in return:
- Your signed security certificate for your server. This will be server-name.crt where server-name is the server name used by the CSR.
- The security certificate for the LAPPS Signing Authority: lapps-sa.crt
- The security certificate for the LAPPS Certificate Authority: lapps-ca.crt
All three certificates need to be installed into the Java keystore we created above.
Installing the Certificate
If you are using your existing security certificate you only need to perform the last command, substituting the filename of you existing certificate for server-name.crt.
keytool -import -alias root -keystore /path/to/keystore -trustcacerts -file lapps-ca.crt keytool -import -alias signer -keystore /path/to/keystore -trustcacerts -file lapps-sa.crt bin/keytool -import -alias tomcat -keystore /path/to/keystore -trustcacerts -file server-name.crt
Edit $CATALINE_HOME/conf/server.xml and uncomment the Connector for port 8443.
<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" />
Add two attributes to the Connector:
The final XML should look like:
<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="/path/to/keystore" keystorePass="password"/>
You can change the port number to any port not already in use on your system. For example grid.anc.org runs two Tomcat instances; one on port 8443 that hosts the service manager and another on port 9443 that hosts the services. Both Tomcat instances are configured to use the same keystore.
NOTE: Make sure that the redirectPort for the other Connectors uses the same port number used for the HTTPS Conntector. For example, if you decide to have Tomcat listen for HTTPS connections on port 1234 then the other Connectors (if any) should use 1234 as their redirectPort.
NOTE: All Tomcat instances involved in running LAPPS services must be configured to use HTTPS. That is, you can not configure the services to use HTTPS but continue to run the Service Manager over HTTP. Similarly, you can not just configure the Service Manager to use HTTPS and continue to use HTTP for the services. It has to be HTTPS from end to end.
Restart you Tomcat instance(s) and try to connect via https: e.g.
Secure Access Only
After a month or so the Connector for port 8080 should be commented out of the
file. This will restrict access to the secure port only.
End users should install the LAPPS CA Root Certificate before accessing any secured LAPPS services. Firefox will ask users if they want to trust the certificate as soon as they click the above link. Other browsers will download the certificate and usually double clicking the downloaded file will install the certificate.
SHA1: B0 13 82 B6 3C DA 91 16 52 11 82 1C 81 A4 18 FB 43 97 B0 94
MD5: F6 F0 CF CF A9 10 7B 25 79 82 49 02 4C 4A 3E F4