Truedoc

h1. Usare Let's Encrypt

{{>toc}}

h2. Installazione

h3. da pacchetti

Per l'uso della nuova Certification Authority libera e gratuita promossa da EFF, Mozilla e molti altri, il meccanismo più semplice è quello di installare i pacchetti della distribuzione, disponibili in Debian a partire da jessie-backports e stretch.

Se necessario abilitare @jessie-backports@ in @sources.list@, quindi

<pre>

apt-get install python-certbot-apache -t jessie-backports

</pre>

h3. dal repository ufficiale

In alternativa, per distribuzioni più vecchie è necessario usare la versione nel repository ufficiale:

<pre>

git clone https://github.com/certbot/certbot

</pre>

per verificarne il funzionamento occorrerà porsi nella directory in cui lo si è installato e per fargli installare i pacchetti mancanti eseguire (da root):

<pre>

cd certbot

./certbot-auto --help

</pre>

il programma inoltre si autoaggiornerà ad ogni esecuzione, e se lanciato senza argomenti cercherà di eseguire una installazione automatica, la verifica della richiesta per poter emettere i certificati ed infine anche la configurazione del web server per usare i certificati ottenuti, fornendo indicazioni qualora tutto ciò non sia possibile.

Le modalità di utilizzo dipendono infatti dalla disponibilità o meno di alcuni pacchetti nella propria distribuzione, ad esempio con Debian Wheezy non si può utilizzare l'autoconfigurazione automatica di Apache, mancando sufficiente supporto. Tratteremo comunque soltanto la modalità di configurazione non automatica, coprendo con questo anche la configurazione di altri servizi che non siano i server web, come la posta elettronica o la messaggistica.

h3. note storiche: @letsencrypt-auto@

Le vecchie versioni avevano come nome @letsencrypt@ anziché @certbot@; il funzionamento è lo stesso, usando il comando @letsencrypt-auto@ anziché @certbot-auto@

h2. La generazione dei certificati

h3. Creazione del primo certificato

In generale, quando non è possibile o non si vuole utilizzare la configurazione automatica dei servizi, e si deve ricorrere all'uso del comando @certonly@, come indicato anche dal programma stesso se l'automatismo è impossibile:

<pre>

root@holland:~/certbot# ./certbot-auto

Checking for new version...

Requesting root privileges to run letsencrypt...

   /root/.local/share/letsencrypt/bin/letsencrypt

   No installers seem to be present and working on your system; fix that or try running letsencrypt with the "certonly" command

</pre>

L'uso del sottocomando @certonly@ consente soltanto di ottenere i certificati, la configurazione dei servizi dovrà essere eseguita manualmente. Per emettere un certificato Let's Encrypt deve effettuare la validazione del dominio per cui questo viene richiesto, cosa che viene effettuata con una richiesta via web al dominio stesso, e l'uso di un meccanismo di challenge and response basato sulla possibilità di scaricare un file dal quel dominio.

Questa procedura può essere realizzata direttamente dal programma se si usa dopo il comando @certonly@ l'opzione @--standalone@, che si incarica di far partire un servizio web sulla porta 80 o 443, ma in tal caso occorre fermare apache (o altro webserver) se attivi sul dominio.

Si può evitare tutto questo utilizzando l'opzione @--webroot@ se si dispone dell'accesso alla "_document root"_ del sito per cui si vuole ottenere il certificato, in tal caso infatti il programma crea i file necessari alla validazione sotto la directory @/.well-known/acme-challenge@, che però deve poter essere servita (occorre pertanto verificare che la configurazione del server web mantenga accessibile questa directory, per @nginx@ è in genere necessaria un configurazione ad hoc, ci torneremo più avanti).

La directory della "_document root"_ deve essere indicata con l'opzione @-w@, mentre il dominio (o i domini se sono più di uno, nel qual caso saranno aggiunti allo stesso certificato come nomi alternativi) devono essere richiesti con l'opzione @-d@. Se si hanno diversi siti con diverse "_document root"_ in teoria si potrebbe eseguire l'operazione in un solo passo usando prima l'opzione @-w@ per indicarle e poi l'opzione @-d@ per indicare il dominio, quest'ultima infatti assume si stia usando come "_document root"_ la directory indicata con l'ultima occorrenza precedente di @-w@, ma tutte devono essere egualmente accessibili, o si ripetere l'operazione per ciascun dominio, generando certificati separati, oppure si può usare la stessa "_document root"_ per tutti i domini (usando le configurazioni descritte in seguito per consentire ad essa l'accesso via web per ciascuno di essi). Un esempio di invocazione del comando è il seguente:

<pre>

# ./certbot-auto certonly --webroot -w /var/www/letsencrypt/ -d mail.truelite.it

[...]

IMPORTANT NOTES:

 - Congratulations! Your certificate and chain have been saved at

   /etc/letsencrypt/live/mail.truelite.it/fullchain.pem. Your cert will

   expire on 2016-07-07. To obtain a new version of the certificate in

   the future, simply run Let's Encrypt again.

 - If you lose your account credentials, you can recover through

   e-mails sent to xxx@truelite.it.

 - Your account credentials have been saved in your Let's Encrypt

   configuration directory at /etc/letsencrypt. You should make a

   secure backup of this folder now. This configuration directory will

   also contain certificates and private keys obtained by Let's

   Encrypt so making regular backups of this folder is ideal.

 - If you like Let's Encrypt, please consider supporting our work by:

   Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate

   Donating to EFF:                    https://eff.org/donate-le

</pre>

Se un certificato deve essere valido per numerosi domini, si possono salvare in un file, nell'esempio @valid_hosts.txt@  (un dominio per riga) ed usare il comando:

<pre>

# ./certbot-auto certonly --webroot -w /var/www/letsencrypt/ -d $(xargs < valid_hosts.txt | sed 's/ /,/g')

</pre>

La prima volta verrà richiesta una email di contatto (per comunicazione e recupero delle chiavi) e poi generato un certificato. La prima volta che si esegue il comando su una macchina oltre ad indicare la email di contatto si dovranno anche accettare le condizioni di Let's Encrypt. I certificati rilasciati durano tre mesi, e vengono installati sotto @/etc/letsencrypt/live@ in una directory corrispondente al nome a dominio indicato (nel caso @mail.truelite.it/@). 

h3. Aggiunta di nuovi certificati distinti

Ogni invocazione successiva con nomi a dominio diversi si limiterà a creare i certificati richiesti in maniera distinta, pertanto con qualcosa del tipo:

<pre>

# ./certbot-auto certonly --webroot -w /var/www/letsencrypt/ -d bd2.truelite.it 

Checking for new version...

Requesting root privileges to run letsencrypt...

   /root/.local/share/letsencrypt/bin/letsencrypt certonly --webroot -w /var/www/letsencrypt/ -d bd2.truelite.it

IMPORTANT NOTES:

 - Congratulations! Your certificate and chain have been saved at

   /etc/letsencrypt/live/bd2.truelite.it/fullchain.pem. Your cert will

   expire on 2016-07-07. To obtain a new version of the certificate in

   the future, simply run Let's Encrypt again.

 - If you like Let's Encrypt, please consider supporting our work by:

   Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate

   Donating to EFF:                    https://eff.org/donate-le

</pre>

Si otterrà un'altro certificato, posto stavolta sotto @/etc/letsencrypt/live/bd2.truelite.it@.

Con lo script @listlecert.sh@ si può stampare un elenco dei certificati creati, e dei domini da essi coperti.

h3. Modifica delle informazioni di registrazione

Qualora si vogliano modificare le informazioni inserite in fase di registrazione, in particolare qualora si voglia cambiare l'email a cui il progetto invia gli avvisi in caso di mancato rinnovo e le eventuali comunicazioni sul servizio, il comando da usare è il seguente:

<pre>

root@gato:~/letsencrypt# ./certbot-auto register --update-registration --email nuovaemail@truelite.it 

Saving debug log to /var/log/letsencrypt/letsencrypt.log

-------------------------------------------------------------------------------

Would you be willing to share your email address with the Electronic Frontier

Foundation, a founding partner of the Let's Encrypt project and the non-profit

organization that develops Certbot? We'd like to send you email about EFF and

our work to encrypt the web, protect its users and defend digital rights.

-------------------------------------------------------------------------------

(Y)es/(N)o: y

IMPORTANT NOTES:

 - Your e-mail address was updated to nuovaemail@truelite.it.

</pre>

h2. Configurazioni per consentire la validazione

Come accennato per effettuare la validazione del dominio con la modalità @--webroot@ è necessario che siano raggiungibili i contenuti corrispondenti alla URL:

<pre>

http://mio.dominio.it/.well-known/acme-challenge/xxx

</pre>

cosa che può dipendere dalla configurazione del proprio webserver.

h3. Nginx

Nel caso di Nginx la modalità suggerita per consentire questa configurazione è creare un frammento di configurazione (nel caso @/etc/nginx/snippets/letsencrypt-acme-challenge.conf@) contenente le direttive necessarie per consentire l'accesso: 

<pre>

location ^~ /.well-known/acme-challenge/ {

    default_type "text/plain";

    root         /var/www/letsencrypt;

}

location = /.well-known/acme-challenge/ {

    return 404;

}

</pre>

queste istruzioni consentono di eseguire la validazione indicando come @webroot@ la directory @/var/www/letsencrypt@, posto che il frammento di cui sopra sia stato incluso come prima direttiva nelle configurazioni dei virtual host coinvolti (basta anche inserirlo solo nelle direttive in chiaro), ad esempio con qualcosa del tipo:

<pre>

server {

        listen 80;

        root /var/www/html;

        server_name bd.truelite.it;

        include /etc/nginx/snippets/letsencrypt-acme-challenge.conf;

        location / {

            rewrite ^/(.*)$ https://bd.truelite.it/$1 permanent;

        }       

}

</pre>

h3. Apache

una analoga configurazione per Apache si può effettuare inserendo in @/etc/apache2/conf.d@ (o con Jessie in @/etc/apache2/conf-available/@ per poi abilitarlo con @a2enconf@) il seguente frammento di configurazione:

<pre>

Alias /.well-known/acme-challenge/ /var/www/letsencrypt/.well-known/acme-challenge/

<Directory "/var/www/letsencrypt/.well-known/acme-challenge/">

    Options None

    AllowOverride None

    ForceType text/plain

    # avoid access to anything not resembling a challenge

    RedirectMatch 404 "^(?!/\.well-known/acme-challenge/[\w-]{43}$)"

</Directory>

</pre>

Si tenga presente però che quando si usa Apache come reverse proxy occorrerà anche inserire una opportuna eccezione alle regole di proxy per la suddetta URL, in sostanza si dovrà aggiungere alla configurazione del virtual host una riga:

<pre>

ProxyPass /.well-known/acme-challenge !

</pre>

Infine, quando si forza la redirezione su SSL delle connessioni in chiaro, occorre evitare che questo avvenga anche per le richieste di Let's Encrypt, pertanto occorrerà sostituire una eventuale direttiva di redirezione generica come la seguente:

<pre>

VirtualHost *:80>

    ServerName ci.truelite.it

    Redirect permanent / https://ci.truelite.it/

</VirtualHost>

</pre>

con una più specifica che escluda la redirezione per la URL utilizzata da Let's Encrypt:

<pre>

VirtualHost *:80>

    ServerName ci.truelite.it

    RedirectMatch 301 ^/((?!.well-known\/acme-challenge).*)$ https://ci.truelite.it/$1

</VirtualHost>

</pre>

h2. Esempi di configurazione dei servizi

Una volta completata la validazione del proprio dominio, nella directory di installazione dei certificati (@/etc/letsencrypt/live/mio.dominio.it@) vengono sempre creati i file:

| *file*    | *contenuto* |

|cert.pem      | cerficato |

|chain.pem     | catena dalla CA |

|fullchain.pem | catena + certificato|

|privkey.pem   | chiave privata |

Dove @chain.pem@ è il certificato intermedio (o la catena di certificati intermedi) che validano @cert.pem@ che è il certificato del proprio dominio, mentre @fullchain.pem@ è l'insieme completo del certificato e della catena. Infine la chiave privata è in @privkey.pem@.

In qualunque configurazione occorre sempre fare riferimento a questi file, che sono link simbolici, in quanto @letsencrypt@ aggiornerà automaticamente gli stessi con la procedura di rinnovo automatico che vedremo più avanti.

h3. Apache

I file @cert.pem@ e @chain.pem@ sono quelli che si usano nella configurazione di Apache, che li vuole separati, ad esempio con quelli ottenuti in precedenza la configurazione utilizzata è:

<pre>

SSLCertificateFile /etc/letsencrypt/live/mail.truelite.it/cert.pem

SSLCertificateChainFile /etc/letsencrypt/live/mail.truelite.it/chain.pem

SSLCertificateKeyFile /etc/letsencrypt/live/mail.truelite.it/privkey.pem

</pre>

h3. Postfix

Invece @fullchain.pem@ è l'insieme del certificato e di tutta la sua catena di firma, che viene richiesto da Postfix, Dovecot e Nginx. Per Postfix occorrerà farvi riferimento in @/etc/postfix/main.cf@ con le direttive:

<pre>

smtpd_tls_cert_file=/etc/letsencrypt/live/mail.truelite.it/fullchain.pem

smtpd_tls_key_file=/etc/letsencrypt/live/mail.truelite.it/privkey.pem

</pre>

h3. Dovecot

mentre per Dovecot di dovanno utilizzare in @/etc/dovecot/conf.d/90-user.conf@ le direttive:

<pre>

ssl_cert = </etc/letsencrypt/live/mail.truelite.it/fullchain.pem

ssl_key = </etc/letsencrypt/live/mail.truelite.it/privkey.pem

</pre>

h3. Nginx

ed infine per Nginx si dovrà inserire nella configurazione del proprio virtual host qualcosa del tipo:

<pre>

server {

   listen 443 ssl;

   server_name bd.truelite.it;

   root /var/www/html;

   ssl_certificate /etc/letsencrypt/live/bd.truelite.it/fullchain.pem;

   ssl_certificate_key /etc/letsencrypt/live/bd.truelite.it/privkey.pem;

   ...

</pre>

h3. ejabberd

Infine per configurare ejabberd (server jabber) occorre generare dai file di Let's Encrypt un unico file contenente in testa la chiave privata (il programma non consente di specificarli separatamente), se pertanto @/etc/ejabberd/ejabberd.pem@ è il file usato dal programma, occorrerà rigenerarlo ogni volta che si generano o rinnovano i certificati con:

<pre>

cat /etc/letsencrypt/live/jabber.truelite.it/privkey.pem \

    /etc/letsencrypt/live/jabber.truelite.it/fullchain.pem > ejabberd.pem

</pre>

In tutti i casi deve essere effettuato un riavvio completo dei servizi.

h2. Il rinnovo dei certificati

La scadenza dei certificati emessi da Let's Encrypt è di tre mesi, ma una volta ottenuti questi possono essere facilmente rinnovati utilizzando il sottocomando @renew@, in particolare se si esegue il comando dopo averli ottenuti si otterrà qualcosa del tipo:

<pre>

# ./certbot-auto renew

Checking for new version...

Requesting root privileges to run letsencrypt...

   /root/.local/share/letsencrypt/bin/letsencrypt renew

-------------------------------------------------------------------------------

Processing /etc/letsencrypt/renewal/mail.truelite.it.conf

-------------------------------------------------------------------------------

The following certs are not due for renewal yet:

  /etc/letsencrypt/live/mail.truelite.it/fullchain.pem (skipped)

No renewals were attempted.

</pre>

la cosa si può automatizzare inserendo banalmente nel cron il comando, ad esempio creando il file @/etc/cron.d/letencrypt@ con il contenuto:

<pre>

00 23 * * 6  root /root/letsencrypt/certbot-auto renew

</pre>

oppure usare lo script @le-renew@ allegato, che esegue anche il riavvio dei servizi, avendo cura di adattarlo alle proprie esigenze; in tal caso il suggerimento è di inserirlo fra quelli di  @/etc/cron.weekly@.

h3. Rimozione di certificati non più raggiungibili

Nel caso si siano richiesti certificati con più nomi di dominio e alcuni di questi non fossero più verificabili (in quanto non più raggiungibili, o spostati su altra macchina) si riceverà un errore in fase di rinnovo. È possibile ovviare al problema usando l'opzione @--allow-subset-of-names@ per rinnovare un certificato valido solo per il sottoinsieme di domini ancora verificabili:

<pre>

# ./certbot-auto renew --allow-subset-of-names

</pre>

tutti i domini non verificati verranno quindi rimossi dal certificato, e i rinnovi successivi andranno a buon fine anche senza tale opzione.

Ovviamente, si deve avere cura di non lanciare questo comando in caso di non raggiungibilità _temporanea_ di alcuni dei domini, ed è quindi opportuno non usare questa opzione in contesti automatizzati.