Securing ISPConfig 3.1 With a Free Let's Encrypt SSL Certificate

Author: ahrasis

This tutorial shows how to create and configure a free Let's encrypt SSL certificate for the ISPconfig interface (port 8080), the email system (Postfix and Dovecot/Courier), the FTP server (pure-ftpd) and Monit. The commands in this tutorial have been tested on Ubuntu 16.04, they should work for Debian as well. Certain modifications may be necessary to make it work on CentOS.

Help on this guide is available in this forum thread.

Creating A Website Using ISPConfig Server Hostname FQDN

Create a site for your server in ISPConfig panel via Sites > Website > Add new website. Remember! This is your server website and as such it must contain your server fully qualified domain name (FQDN). I will refer to it as `hostname -f` in this guide.

hostname -f

Hopefully, it will work without any changes to your server as well.

Accessing ISPConfig Website Online

Check if your server site is ready and accessible online as Let's Encrypt needs to verify your website is accessible before issuing SSL key, certificate and chain file for your server site. You also have to create its DNS zone and allow it to properly propagate as Let's Encrypt needs to verify it too.

Enabling SSL For ISPConfig 3 Control Panel (Port 8080)

If you haven't enabled SSL during ISPConfig setup i.e. for its control panel at port 8080, enable it by typing ispconfig_update.sh in the terminal and select yes for SSL. We don't need this to be a proper key nor do we want to keep it but we want to work faster, thus we can simply enter for all of its fields. When you finished this, the self-signed SSL should already be enabled for your ISPConfig.

Checking SSL For ISPConfig 3 Control Panel (Port 8080)

Check your browser to confirm by opening ISPConfig control panel at port 8080. Note that you might get some warning at this stage since the created SSL files are self-signed but the browser will confirm that your ISPConfig has SSL enabled or otherwise.

Securing ISPConfig Website With Let's Encrypt SSL

If the above is done, go back to ISPConfig panel > Sites > Website > Website Name, then click SSL and Let's Encrypt check buttons and save - to create Let's Encrypt SSL files and enable them for your server site. If successful your server site shall now be using this Let's Encrypt SSL files but not your ISPConfig 8080 page. If unsuccessful, you will not be able to proceed further, so do check its log file for a clue.

Changing ISPConfig 3 Control Panel (Port 8080)

If LE SSL is already working, then go to your server terminal, go root via sudo su and use the following command to backup and replace the created self-signed SSL files with Let's Encrypt SSL files.

cd /usr/local/ispconfig/interface/ssl/
mv ispserver.crt ispserver.crt-$(date +"%y%m%d%H%M%S").bak
mv ispserver.key ispserver.key-$(date +"%y%m%d%H%M%S").bak
mv ispserver.pem ispserver.pem-$(date +"%y%m%d%H%M%S").bak
ln -s /etc/letsencrypt/live/$(hostname -f)/fullchain.pem ispserver.crt
ln -s /etc/letsencrypt/live/$(hostname -f)/privkey.pem ispserver.key
cat ispserver.{key,crt} > ispserver.pem
chmod 600 ispserver.pem

  • If you haven't created ispserver.pem before, you may ignore the third line which is aimed at renaming the existing one, if any, as a backup.
  • ote that we are using Let's Encrypt live folder instead of archive folder.
  • Also note the last line where ispserver.pem is created by combining files, thuswise, it will not be automatically renewed by Let's Encrypt unlike other files which we merely symlinked them, thus, we will deal with this in the last part of this guide.
  • Note also that you either type in `hostname -f` or server1.example.com as the result is the same because `hostname -f`is server1.example.com.

Using The Same Let's Encrypt SSL Certs For Other Major Services

As additional tips, based on Securing Your ISPConfig 3 Installation you may want to use symlink to ispserver.key or .crt or .pem instead of directly pointing your postfix, dovecot, courier, pure-FTPd and monit to Let's Encrypt SSL files. For dovecot, if it is already using postfix SSL files, it is safe for you to ignore it. In details you only need to do the followings:

a. For Postfix

cd /etc/postfix/
mv smtpd.cert smtpd.cert-$(date +"%y%m%d%H%M%S").bak
mv smtpd.key smtpd.key-$(date +"%y%m%d%H%M%S").bak
ln -s /usr/local/ispconfig/interface/ssl/ispserver.crt smtpd.cert
ln -s /usr/local/ispconfig/interface/ssl/ispserver.key smtpd.key
service postfix restart
service dovecot restart


b. For dovecot: (* Note this shouldn't exist together with courier)

Check if this code exist by using nano /etc/dovecot/dovecot.conf

[...]
ssl_cert = </etc/postfix/smtpd.cert
ssl_key = </etc/postfix/smtpd.key
[...]

Leave them as they are if they exist. Otherwise, fix them. In any event, run service dovecot restart is already covered above.

c. For courier: (* Note this shouldn't exist together with dovecot)

cd /etc/courier/
mv imapd.pem imapd.pem-$(date +"%y%m%d%H%M%S").bak
mv pop3d.pem pop3d.pem-$(date +"%y%m%d%H%M%S").bak
ln -s /usr/local/ispconfig/interface/ssl/ispserver.pem imapd.pem
ln -s /usr/local/ispconfig/interface/ssl/ispserver.pem pop3d.pem
service courier-imap-ssl stop
service courier-imap-ssl start
service courier-pop-ssl stop
service courier-pop-ssl start

d. For pure-FTPd:

cd /etc/ssl/private/
mv pure-ftpd.pem pure-ftpd.pem-$(date +"%y%m%d%H%M%S").bak
ln -s /usr/local/ispconfig/interface/ssl/ispserver.pem pure-ftpd.pem
chmod 600 pure-ftpd.pem
service pure-ftpd-mysql restart

e. For monit: (If you have it installed in your server)

nano /etc/monit/monitrc

Add the above symlink to ispserver.pem we created for pure-ftpd in here as well:

[...]
set httpd port 2812 and
SSL ENABLE
PEMFILE /etc/ssl/private/pure-ftpd.pem
allow admin:'secretpassword'
[...]

And restart monit:

service monit restart


Create Auto Renewal Script For Your ISPConfig Pem File (ispserver.pem)

In this last step, which I haven't found in any guide so far, is the automatic update of ispserver.pem as earlier hinted. Currently, it have to be manually changed right after Let's Encrypt automatically renewed your server SSL files. To avoid overlooking this, you may want to install incron as suggested in the respective incron tutorial and create a script to automatically update your ispserver.pem file, as follows:

Via terminal command, install incron, then create the script file and edit it using nano:

apt install -y incron
nano /etc/init.d/le_ispc_pem.sh

Add this in the le_ispc_pem.sh:

#!/bin/sh
### BEGIN INIT INFO
# Provides: LE ISPSERVER.PEM AUTO UPDATER
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: LE ISPSERVER.PEM AUTO UPDATER
# Description: Update ispserver.pem automatically after ISPC LE SSL certs are renewed.
### END INIT INFO
cd /usr/local/ispconfig/interface/ssl/
mv ispserver.pem ispserver.pem-$(date +"%y%m%d%H%M%S").bak
cat ispserver.{key,crt} > ispserver.pem
chmod 600 ispserver.pem
chmod 600 /etc/ssl/private/pure-ftpd.pem
service pure-ftpd-mysql restart
service monit restart
service postfix restart
service dovecot restart
service nginx restart
  • Note some people do not install monit, so they can safely remove it. Do adjust the above script accordingly.
  • For multi-server setup, do refer to post #203 and add the given scp code in here to automate future update.

We then make it executable, add root as an allowed user for incrontab and then edit incrontab file:

chmod +x /etc/init.d/le_ispc_pem.sh
echo "root" >> /etc/incron.allow
incrontab -e


Add this line in it incrontab:

/etc/letsencrypt/archive/$(hostname -f)/ IN_MODIFY ./etc/init.d/le_ispc_pem.sh

Restarting Your Services

I think that is about it for Securing Your Server With Let's Encrypt. You may want to restart your web server afterwards.

service nginx restart

Remember: if you are using apache, change nginx to apache2 accordingly.

LE4ISPC

As an alternative, you might want to use LE4ISPC script created for this purpose which supports both nginx and apache2 from ISPConfig up to pure-ftpd above except for monit. Before using it, you should already have completed the above steps (1-5) and have :

1. Created the website for your server via ISPConfig;
2. The website accessible online;
3. ISPConfig SSL enabled (via installation or update);
4. LE SSL successfully enabled for the website.

Share this page:

Suggested articles

5 Comment(s)

Add comment

Comments

From: fsisti at: 2018-02-14 09:08:05

Thank you for the tutorial

How can I test if the auto-renew script renewal works well?With the icrontab -l command I get this, is it correct?

/etc/letsencrypt/archive/$(hostname 0 IN_MODIFY ./etc/init.d/le_ispc_pem.sh

From: Marc at: 2018-02-15 22:13:19

Thanks for this tutorial.

I’ve a suggestion. Instead of symlinking '/etc/letsencrypt/live/…' one should symlink the SSL certs in the SSL folder of the website ('/var/www/clients/clientX/webY/ssl/…') as Till suggests here:

https://git.ispconfig.org/ispconfig/ispconfig3/issues/4589#note_62298

Problem is that the LE path can change under some circumstances described in the issue mentioned above.

From: Tom Dings at: 2018-02-17 12:16:22

Thanks. Really interesting piece of information. May I ask how you will do the 'trick' when the setup of IspConfig is done with more than one server ?First thought ... Copying the same certificates to the other servers I guess ? Requesting new ones isn't a good idea I guess. Really like to know how to solve such a setup. Enjoy your weekend!

From: ludo at: 2018-02-17 14:28:05

Thank for this tutorial. And for the auto-renew script!

How can I add mail subdomain (mail.domain.tld) in the LE certificate. At this time, I have only domain.tld and www.domain.tld in the LE certificate, accroding to: openssl x509 -in /etc/letsencrypt/live/domain.tld/fullchain.pem -noout -text

From: onastvar at: 2018-02-19 05:36:15

Will my clients need to update their email settings on their devices if I was to install SSL on my server. It says in description: "This tutorial shows how to create and configure a free Let's encrypt SSL certificate for the ISPconfig interface (port 8080), the email system (Postfix and Dovecot/Courier), the FTP server (pure-ftpd) and Monit."?