Changes

Jump to navigation Jump to search
12,580 bytes removed ,  18:38, 15 December 2023
m
Line 1: Line 1:  
{{Languages|Letsencrypt}}
 
{{Languages|Letsencrypt}}
 
{{Level|Medium}}
 
{{Level|Medium}}
==Introduction==
+
<!-- here we define the contrib name variable -->
 +
<!-- we get the page title, remove suffix for translated version; if needed you can define there with the value you want-->
 +
{{#vardefine:contribname| {{lc: {{#titleparts:  {{BASEPAGENAME}} |1}} }} }}
 +
{{#vardefine:smecontribname| smeserver-{{lc: {{#titleparts:  {{BASEPAGENAME}} |1}} }} }}
 +
<!-- we define the language -->
 +
{{#vardefine:lang| {{lc:  {{#titleparts:    {{PAGENAME}} | | -1}}  }} |en }}
 +
{{Infobox contribs
 +
|name={{#var:contribname}}
 +
|image={{#var:contribname}}.jpg
 +
|description_image= {{#var:contribname}} logo
 +
|maintainer= John Crisp
 +
|licence= MIT license
 +
|url= https://github.com/dehydrated-io/dehydrated
 +
|category= certificates
 +
|tags=dehydrated,letsencrypt,dns,http,ssl
 +
}}
 +
==Mainteneur==
 +
John Crisp
 +
 
 +
== Version ==
 +
{{#set: Version=Contrib10}}
 +
{{#smeversion:smeserver-letsencrypt }}
 +
<br>
 +
 
 +
==Description==
 +
 
 +
{{warning box|type=Attention !| Le protocole original utilisé par Let’s Encrypt pour l’émission et la gestion des certificats est appelé ACMEv1. En mars 2018, Letsencrypt a introduit le support pour ACMEv2, une version plus récente du protocole qui correspond à ce qui a été finalisé aujourd'hui sous la RFC 8555 328. Ils encouragent les abonnés à passer au protocole ACMEv2.
 +
 
 +
En mars 2019, ils ont annoncé un plan de fin de vie pour ACMEv1.
 +
 
 +
En novembre 2019, ils ne permettront plus les nouvelles inscriptions de compte via leur point de terminaison API ACMEv1. '' 'IMPORTANT' '' Les comptes existants continueront à fonctionner normalement.
 +
 
 +
En juin 2020, ils ne permettront plus aux nouveaux domaines d'être validés via ACMEv1.
 +
 
 +
À compter du début de 2021, ils désactiveront occasionnellement l'émission et le renouvellement d'ACMEv1 pour des périodes de 24 heures, pas plus d'une fois par mois (le service OCSP ne sera pas affecté). Le but est d’induire des erreurs client susceptibles d’encourager les abonnés à se mettre à jour vers des clients ou des configurations utilisant ACMEv2.
 +
 
 +
Les échecs de renouvellement doivent être limités car les nouvelles validations de domaine seront déjà désactivées et nous recommandons de renouveler les certificats 30 jours avant leur expiration.
 +
 
 +
En juin 2021, ils désactiveront complètement ACMEv1 en tant que moyen viable d’obtenir un certificat Let’s Encrypt.}}
 +
 
 
[https://letsencrypt.org/ Let’s Encrypt] est une nouvelle Autorité de Certification (CA) :  
 
[https://letsencrypt.org/ Let’s Encrypt] est une nouvelle Autorité de Certification (CA) :  
 
c'est gratuit, automatique et libre. Son but principal est de permettre aux gens de crypter leur trafic gratuitement, facilement et automatiquement. Les certificats délivrés doivent être renouvelés tous les 3 mois.
 
c'est gratuit, automatique et libre. Son but principal est de permettre aux gens de crypter leur trafic gratuitement, facilement et automatiquement. Les certificats délivrés doivent être renouvelés tous les 3 mois.
Line 12: Line 51:     
Plusieurs clients sont disponibles pour les services Letsencrypt. Le client « certbot » officiel de letsencrypt.org est assez complet mais possède un certain nombre de dépendances qu'il est nécessaire d'installer. Il nécessite aussi une version plus récente de Python que celle fournie avec une installation de serveur KOOZALI SME standard. En raison de cette complexité et du manque de compatibilité avec SME 8.X, ce document décrit l'installation et l'utilisation de ''[https://github.com/lukas2511/dehydrated dehydrated]'', un client alternatif mis en œuvre en tant que script shell BASH.
 
Plusieurs clients sont disponibles pour les services Letsencrypt. Le client « certbot » officiel de letsencrypt.org est assez complet mais possède un certain nombre de dépendances qu'il est nécessaire d'installer. Il nécessite aussi une version plus récente de Python que celle fournie avec une installation de serveur KOOZALI SME standard. En raison de cette complexité et du manque de compatibilité avec SME 8.X, ce document décrit l'installation et l'utilisation de ''[https://github.com/lukas2511/dehydrated dehydrated]'', un client alternatif mis en œuvre en tant que script shell BASH.
  −
=== Version ===
  −
{{ #smeversion:smeserver-letsencrypt }}
  −
<br>
  −
{{ #smeversion:dehydrated }}
  −
<br>
      
==Prérequis==
 
==Prérequis==
Line 44: Line 77:  
  config show modSSL > "/root/db_configuration_modSSL_backup_$(date +%Y%m%d_%H%M%S)"
 
  config show modSSL > "/root/db_configuration_modSSL_backup_$(date +%Y%m%d_%H%M%S)"
   −
==Installation de la contribution de Dehydrated==
+
==Installation de la contribution de Dehydrated letsencrypt==
 
John Crisp a préparé le fichier pour le script de Dehydrated, en créant les fichiers de configuration appropriés et en l'intégrant au système de modèles SME. C'est la manière la plus simple d'installer Dehydrated sur votre serveur KOOZALI SME.
 
John Crisp a préparé le fichier pour le script de Dehydrated, en créant les fichiers de configuration appropriés et en l'intégrant au système de modèles SME. C'est la manière la plus simple d'installer Dehydrated sur votre serveur KOOZALI SME.
 +
<tabs container style="display: inline-block;"><tab name="Pour SME 10">
 +
yum install smeserver-letsencrypt
 +
 +
Vous aurez ensuite besoin de configurer les domaines et les hôtes pour lesquels vous voulez demander un certificat. Voir la section suivante « Configuration ».
    +
Si votre dépôt « smeaddons » a été désactivé, ajoutez «  --enablerepo=smeaddons » et réactivez-le, comme il devrait l'être par défaut.
 +
db yum_repositories setprop smeaddons status enabled
 +
signal-event yum-modify
 +
 +
</tab><tab name="Pour SME 9">
 
===Installation===
 
===Installation===
  yum install smeserver-letsencrypt --enablerepo=smecontribs
+
  yum install smeserver-letsencrypt
 +
signal-event console-save
   −
Vous devez ensuite configurer les domaines et les hôtes pour lesquels vous souhaitez demander un certificat. Voir plus bas, la section « Configuration ».
+
Vous aurez ensuite besoin de configurer les domaines et les hôtes pour lesquels vous voulez demander un certificat. Voir la section suivante « Configuration ».
 +
Si votre dépôt « smeaddons » a été désactivé, ajoutez «  --enablerepo=smeaddons » et réactivez-le, comme il devrait l'être par défaut.
 +
db yum_repositories setprop smeaddons status enabled
 +
signal-event yum-modify
   −
===Mises à jour===
   
Votre serveur disposera de mises à jour disponibles dans le dépôt smecontribs. Si vous avez déjà installé smeserver-letsencrypt à partir du dépôt « reetp », vous devez vous assurer que vous avez défini la propriété de configuration de « ACCEPT_TERMS » :
 
Votre serveur disposera de mises à jour disponibles dans le dépôt smecontribs. Si vous avez déjà installé smeserver-letsencrypt à partir du dépôt « reetp », vous devez vous assurer que vous avez défini la propriété de configuration de « ACCEPT_TERMS » :
   −
config setprop letsencrypt ACCEPT_TERMS yes
+
 
signal-event console-save
      
===Ré-actualisation===
 
===Ré-actualisation===
Line 62: Line 106:     
Une mise à jour complète peut être effectuée comme suit :
 
Une mise à jour complète peut être effectuée comme suit :
  yum update smeserver-letsencrypt dehydrated --enablerepo=smecontribs
+
  yum update smeserver-letsencrypt dehydrated
 
+
  config setprop letsencrypt ACCEPT_TERMS yes
Il est important d'effectuer l'usuel :
  −
  signal-event post-upgrade;  signal-event reboot
  −
 
  −
à défaut :
   
  signal-event console-save
 
  signal-event console-save
    
Ne pas le faire pourrait laisser la contribution hors service et vos certificats ne seraient pas renouvelés.
 
Ne pas le faire pourrait laisser la contribution hors service et vos certificats ne seraient pas renouvelés.
 +
</tab>
 +
</tabs>
   −
===Configuration===
+
==Configuration==
 
Il y a plusieurs configurations d'entrées de la base de données qui doivent être faites afin de mettre en place cette contribution. La plupart d'entre elles indiquent aux scripts quels noms d'hôte doivent faire partie de votre certificat.
 
Il y a plusieurs configurations d'entrées de la base de données qui doivent être faites afin de mettre en place cette contribution. La plupart d'entre elles indiquent aux scripts quels noms d'hôte doivent faire partie de votre certificat.
    +
===Exemples de démarrage rapide===
 +
Pour le test ('''régler les domaines et les hôtes''') :
 +
<tabs container style="display: inline-block;"><tab name="Pour SME 10">
 +
config setprop letsencrypt ACCEPT_TERMS yes status test
 +
# tâche très rapide pour activer le domaine principal :
 +
db domains setprop $(config get DomainName) letsencryptSSLcert enabled
 +
#pour chacun de vos domaines pour lesquels vous voulez le SSL, faites :
 +
db domains setprop '''domain1.com''' letsencryptSSLcert enabled
 +
#pour chacun de vos hôtes (sous-domaines) pour lesquels vous voulez le SSL, faites :
 +
db hosts setprop '''www.domain1.com''' letsencryptSSLcert enabled
 +
signal-event smeserver-letsencrypt-update
 +
dehydrated -c
 +
</tab><tab name="Pour SME 9">
 +
config setprop letsencrypt ACCEPT_TERMS yes status test API 2
 +
#pour chacun de vos domaines pour lesquels vous voulez le SSL, faites :
 +
db domains setprop '''domain1.com''' letsencryptSSLcert enabled
 +
#pour chacun de vos hôtes (sous-domaines) pour lesquels vous voulez le SSL, faites :
 +
db hosts setprop '''www.domain1.com''' letsencryptSSLcert enabled
 +
signal-event console-save
 +
dehydrated -c
 +
</tab>
 +
</tabs>
 +
Vérifiez que les certificats sont valables (votre fureteur détectera encore une erreur mais vous pouvez explorer le contenu du certificat pour voir que l'Autorité de Certification (CA en anglais) a été utilisée pour signer votre certificat SSL et que tous vos domaines et hôtes sont dans la propriété « Autre nom de l'objet du certificat ».
 +
 +
Pour la production ('''régler votre adresse électronique'''):
 +
<tabs container style="display: inline-block;"><tab name="Pour SME 10">
 +
config setprop letsencrypt status enabled email admin@$(config get DomainName)
 +
signal-event smeserver-letsencrypt-update
 +
dehydrated -c -x
 +
</tab><tab name="Pour SME 9">
 +
config setprop letsencrypt status enabled email '''admin@domain1.com'''
 +
signal-event console-save
 +
dehydrated -c -x
 +
</tab>
 +
</tabs>
 +
 +
===Configuration étape par étape===
 
====Hôtes et domaines du certificat====
 
====Hôtes et domaines du certificat====
 
Cette contribution permettra d'obtenir un seul certificat de Let's Encrypt. Le certificat inclura tous les domaines et noms d'hôtes qui :
 
Cette contribution permettra d'obtenir un seul certificat de Let's Encrypt. Le certificat inclura tous les domaines et noms d'hôtes qui :
Line 84: Line 163:     
* domaine1.com
 
* domaine1.com
: www.domaine1.com
+
** www.domaine1.com
: mail.domaine1.com
+
** mail.domaine1.com
: ftp.domaine1.com
+
** ftp.domaine1.com
 
* domaine2.com
 
* domaine2.com
: www.domaine2.com
+
** www.domaine2.com
: mail.domaine2.com
+
** mail.domaine2.com
    
Pour chaque DOMAINE que vous voulez voir inclus dans le certificat, exécutez cette commande :
 
Pour chaque DOMAINE que vous voulez voir inclus dans le certificat, exécutez cette commande :
Line 120: Line 199:     
Avec la configuration du système décrite ci-dessus :
 
Avec la configuration du système décrite ci-dessus :
* la définition de «domains» obtiendra un certificat couvrant domain1.com et domain2.com, mais pas www.domain1.com, etc. ;
+
* la définition de « domains » obtiendra un certificat couvrant domain1.com et domain2.com, mais pas www.domain1.com, etc. ;
 
* le réglage sur « hosts » obtiendra un certificat couvrant www.domain1 .com, mail.domain1.com, ftp.domain1.com, etc., mais pas domain1.com ou domain2.com ;
 
* le réglage sur « hosts » obtiendra un certificat couvrant www.domain1 .com, mail.domain1.com, ftp.domain1.com, etc., mais pas domain1.com ou domain2.com ;
* le réglage de cette propriété sur « all » inclura tous les noms de domaine et les noms d'hôtes dans le certificat. '' 'voyez [[Letsencrypt # Some_challenges_complete_successfully_but_some_hostnames_fail | NOTE]] avant de régler ceci sur « all ».' ''
+
* le réglage de cette propriété sur « all » inclura tous les noms de domaine et les noms d'hôtes dans le certificat. '''Voyez cette [[Letsencrypt/Troubleshooting#Some_challenges_complete_successfully_but_some_hostnames_fail | NOTE en anglais]] avant de régler ce paramètre sur « all ».'''
 
  −
====Autres paramètres de configuration ====
  −
Aucun autre paramètre n'est obligatoire. Cependant, il est recommandé de configurer une adresse courriel. S'il y a un problème avec le renouvellement de votre certificat, et qu'il arrive à expiration, les serveurs de Let's Encrypt vous en informeront. Faites-le avec cette commande :
  −
  config setprop letsencrypt email admin@domaine1.com
  −
 
  −
Le domaine de messagerie spécifié ici n'a pas besoin de correspondre à l'un des domaines pour lesquels vous allez demander un certificat.
  −
 
  −
Vous pouvez également définir la longueur de la clé privée de votre certificat, si vous ne voulez pas la valeur par défaut de '''4096''' bits. Cela ne devrait pas être nécessaire dans la plupart des cas, mais si vous le souhaitez, utilisez cette commande pour le faire :
  −
 
  −
config setprop letsencrypt keysize NOMBRE
  −
 
  −
===Accepter les conditions de Let's Encrypt ===
  −
Lisez d'abord, s.v.p., les termes des conditions d'utilisation de Let's Encrypt [[https://letsencrypt.org/documents/LE-SA-v1.1.1-August-1-2016.pdf]]
  −
puis exécutez :
  −
config setprop letsencrypt ACCEPT_TERMS yes
  −
 
  −
===Activer le mode test ===
  −
L'étape suivante consiste à activer le mode test. Cela va obtenir des certificats du serveur d'étape. Les limites de quantité présentées dans l'introduction ne s'appliqueront pas, donc toute erreur ou autre problème ne vous empêchera pas d'obtenir votre certificat de production. Activer le mode test en utilisant cette commande :
      +
====Activer le mode test ====
 +
Après avoir installé et configuré tous les domaines et hôtes, l'étape suivante consiste à utiliser le mode test, qui est activé par défaut. Cela procurera des certificats du serveur intermédiaire. Les limites renouvellement exposées dans l'introduction ne s'appliqueront pas, donc toute erreur ou tout autre problème ne vous empêcheront pas d'obtenir votre certificat de production.
 +
Activer le mode test en utilisant cette commande :
 
  config setprop letsencrypt status test
 
  config setprop letsencrypt status test
 
  signal-event console-save
 
  signal-event console-save
Line 151: Line 215:  
S'il s'imprime uniquement "# INFO: Using main config file /etc/dehydrated/config"" et vous renvoie à l'invite du shell, voir [[Bugzilla:10300]].
 
S'il s'imprime uniquement "# INFO: Using main config file /etc/dehydrated/config"" et vous renvoie à l'invite du shell, voir [[Bugzilla:10300]].
   −
Si cela fonctionne sans erreur, essayez de vous connecter à la page du gestionnaire de votre serveur. Vous devriez voir une erreur indiquant que le certificat de sécurité n'a pas été émis par une autorité de certification approuvée. c'est parfaitement normal. Cependant, il devrait y avoir un certificat, il devrait inclure tous les noms d'hôte que vous vouliez inclure, et il devrait être valide pour les quatre-vingt-dix prochains jours. Si cela a réussi, passez à la production.
+
{{Note box|type=Note :| solution pour l'erreur « ID de compte mal formé dans l'URL d'en-tête KeyID » à l'aide de l'API 2, pour les versions de contribution 0.6.13 ou antérieures, voir [[Bugzilla: 10828]] ou mettre à jour la contribution.}}
   −
===Activer le mode production ===
+
Si cela fonctionne sans erreur, essayez de vous connecter à la page du gestionnaire de votre serveur. Vous devriez voir une erreur indiquant que le certificat de sécurité n'a pas été émis par une autorité de certification approuvée. C'est parfaitement normal. Cependant, il devrait y avoir un certificat, il devrait inclure tous les noms d'hôte que vous vouliez inclure, et il devrait être valide pour les quatre-vingt-dix prochains jours. Si cela a réussi, passez à la production.
 +
 
 +
====Activer le mode production ====
 
Une fois que vous avez testé avec succès votre installation, réglez-la en mode production en utilisant les commandes suivantes :
 
Une fois que vous avez testé avec succès votre installation, réglez-la en mode production en utilisant les commandes suivantes :
   Line 162: Line 228:  
  dehydrated -c -x
 
  dehydrated -c -x
   −
L'indicateur -x ici est nécessaire pour forcer la déshydratation à obtenir un nouveau certificat, même si vous avez un certificat existant qui est valide pendant plus de 30 jours.
+
L'indicateur -x ici est nécessaire pour forcer «dehydrated» à obtenir un nouveau certificat, même si vous avez un certificat existant qui est valide pendant plus de 30 jours.
   −
Si cette commande a réussi, félicitations ! Vous avez réussi à obtenir un certificat TLS de confiance et valide, qui se renouvellera automatiquement à perpétuité.
+
Si cette commande a réussi, félicitations ! Vous avez réussi à obtenir un certificat TLS de confiance et valide, qui se renouvellera automatiquement perpétuellement.
    
Une fois que vous avez obtenu votre certificat et configuré votre serveur, testez votre serveur avec un outil comme [https://www.ssllabs.com/ssltest/ SSLLabs.com] pour vous assurer qu'il fonctionne correctement.
 
Une fois que vous avez obtenu votre certificat et configuré votre serveur, testez votre serveur avec un outil comme [https://www.ssllabs.com/ssltest/ SSLLabs.com] pour vous assurer qu'il fonctionne correctement.
   −
===Exemples de démarrage rapide===
+
====Archiver les vieux certificats====
Pour le test ('' 'ajuster les domaines et les hôtes' '') :
  −
  config setprop letsencrypt ACCEPT_TERMS yes status test
  −
  #pour chacun de vos domaines où vous voulez SSL, faire ce qui suit :
  −
  db domains setprop '''domaine1.com''' letsencryptSSLcert enabled
  −
  #pour chacun de vos hôtes (sous-domaines) où vous voulez SSL, faire ce qui suit :
  −
  db hosts setprop '''www.domaine1.com''' letsencryptSSLcert enabled
  −
  signal-event console-save
  −
  dehydrated -c
  −
 
  −
Vérifiez que les certificats sont disponibles (votre navigateur émettra toujours une erreur, mais vous pouvez explorer le contenu du certificat pour voir que l'autorité de certification de test Let's Encrypt a été utilisée pour signer votre certificat SSL et que tous vos domaines et hôtes sont dans le propriété « Certificate Subject Alt Name ».
  −
 
  −
Pour la production ('' 'ajustez votre adresse courriel' '') :
  −
 
  −
config setprop letsencrypt status enabled email '''admin@domaine1.com'''
  −
signal-event console-save
  −
dehydrated -c -x
  −
 
  −
==Installation manuellle de « Dehydrated »==
  −
{{warning box| type=Attention :| les éléments suivants ne doivent pas être exécutés si vous avez installé le paquet de la contribution smeserver-letsencrypt car cela est déjà géré par la contribution.}}
  −
As discussed above, dehydrated is a lightweight ACME client that's implemented as a BASH script.  It has very few dependencies, and is a better fit for the "SME way" of doing things than the official certbot client.  If you'd prefer to configure it manually, rather than installing the contrib described above, you may do so manually or by pulling a copy of the latest version using git.
  −
 
  −
===Install of Dehydrated rpm from smecontrib repository===
  −
The dehydrated script has been imported into the contribs repository and can be installed as follows:
  −
 
  −
yum --enablerepo=smecontribs install dehydrated
  −
 
  −
The script must be configured as described below.
  −
 
  −
===Git install of latest version===
  −
 
  −
If you need or want the absolute latest version of the script then you can manually install as follows:
  −
 
  −
Begin by installing git:
  −
yum install git
  −
 
  −
Then download the Dehydrated client:
  −
cd /etc
  −
git clone https://github.com/lukas2511/dehydrated
  −
mv dehydrated/dehydrated /usr/local/bin/
  −
 
  −
===Manual Configuration of Dehydrated===
  −
 
  −
You'll need to create two configuration files for Dehydrated.
  −
cd /etc/dehydrated
  −
mkdir -p /home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge
  −
nano -w domains.txt
  −
 
  −
In this file, you'll list every hostname that you want your certificate to cover, all on one line.  It will look like this:
  −
domain1.com www.domain1.com mail.domain1.com domain2.net www.domain2.net domain3.org ftp.domain3.org
  −
Ctrl-X to exit, Y to save.
  −
 
  −
Second, you'll need to create the configuration file '''config''':
  −
nano -w config
  −
 
  −
It should look like this:
  −
#!/bin/bash
  −
# config
  −
# CA="https://acme-staging.api.letsencrypt.org/directory"
  −
WELLKNOWN="/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge"
  −
HOOK="/usr/local/bin/dehydrated-hook"
  −
# E-mail to use during the registration (default: <unset>)
  −
CONTACT_EMAIL="admin@yourdomain.com"
  −
 
  −
Ctrl-X to exit, Y to save.
  −
 
  −
For testing purposes, it's recommended that you uncomment the third line (so it begins with "CA=").  Any certificates issued while testing will not be trusted, but they will also not count against your rate limits.  Once your configuration is set, you can comment out that line and re-run dehydrated.
  −
 
  −
You'll need to create a custom "hook" script to set the config database up properly, and to trigger reloads of your system services when a certificate is issued or renewed.
  −
nano /usr/local/bin/dehydrated-hook
  −
 
  −
Its contents should look like this:
  −
#!/bin/bash
  −
  −
if [ $1 = "deploy_cert" ]; then
  −
  KEY=$3
  −
  CERT=$4
  −
  CHAIN=$6
  −
  /sbin/e-smith/db configuration setprop modSSL key $KEY
  −
  /sbin/e-smith/db configuration setprop modSSL crt $CERT
  −
  /sbin/e-smith/db configuration setprop modSSL CertificateChainFile $CHAIN
  −
  /sbin/e-smith/signal-event ssl-update
  −
fi
  −
 
  −
Ctrl-X to exit, Y to save.  Then make it executable:
  −
chmod +x /usr/local/bin/dehydrated-hook
  −
 
  −
You'll also need to create a custom template fragment for Apache:
  −
mkdir -p /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf
  −
nano -w /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/VirtualHosts40ACME
  −
 
  −
The contents of that file should look like:
  −
# Alias for letsencrypt
  −
Alias /.well-known/acme-challenge /home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge
  −
Again, Ctrl-X to exit, Y to save.
  −
 
  −
Expand the template and restart apache:
  −
expand-template /etc/httpd/conf/httpd.conf
  −
service httpd-e-smith restart
  −
 
  −
Now you're ready to run dehydrated and get your certificate.
  −
dehydrated -c
  −
 
  −
The script will run for a moment and should report success.  If it does, look in /etc/dehydrated/certs/YOURDOMAIN and see if you have your files there.  You should see a number of .pem files, at least one .csr file, and five symbolic links (chain.pem, cert.csr, cert.pem, fullchain.pem, and privkey.pem).  If you do, congratulations!  You've successfully obtained your certificate.  The hook script should have also configured your server to use the new certificate.  To make sure, run
  −
config show modSSL
  −
and make sure there are values set for crt, key, and CertificateChainFile.
  −
 
  −
If dehydrated ran successfully in test mode, comment out the CA= line in /etc/dehydrated/config and run
  −
dehydrated -c -x
  −
 
  −
to obtain trusted a trusted certificate.
  −
 
  −
===Renewal===
  −
When run, the dehydrated script will check your existing certificate to see how long it's valid.  If it has less than 30 days' lifetime remaining (by default; this can be changed by setting RENEW_DAYS in config to something other than 30), the script will renew your certificates.  If more than 30 days remain, the script will exit without further action.  All that's necessary is to run dehydrated daily:
  −
nano -w /etc/cron.daily/call-dehydrated
  −
 
  −
Enter the following in this file:
  −
#!/bin/bash
  −
/usr/bin/dehydrated -c
  −
Ctrl-X to exit, Y to save.  Then make it executable:
  −
chmod +x /etc/cron.daily/call-dehydrated
  −
 
  −
{{warning box| end of the manual installation and configuration of dehydrated without smeserver-letsencrypt contrib}}
  −
 
  −
==Imposer le SSL ==
  −
Que vous ayez utilisé la contribution ou que vous ayez configuré « dehydrated » manuellement, vous souhaiterez probablement configurer votre serveur pour forcer les connexions Web sécurisées. Pour les baies d'informations (i-bays), vous pouvez le faire en utilisant la page du gestionnaire du serveur ou en utilisant une commande shell. Pour la baie principale (Primary), vous devez utiliser la commande shell :
  −
 
  −
db accounts setprop {accountname} SSL enabled
  −
ou
  −
db accounts setprop Primary SSL enabled
  −
  −
==Sauvegarde ==
  −
Votre certificat, votre clé privée et d'autres informations importantes sont stockés dans /etc/dehydrated, ce qui n'est pas inclus dans les routines de sauvegarde normale du serveur KOOZALI SME. Assurez-vous d'ajouter ce répertoire à vos sauvegardes. Voir, par exemple, [[Backup with dar#Adding_Files_and_Directories|Sauvegardes avec dar]] si vous utilisez la fonction de sauvegarde de poste de travail. Si vous utilisez Affa pour la sauvegarde, ajoutez :
  −
 
  −
Include=/etc/dehydrated
  −
 
  −
au fichier de configuration d'Affa.
  −
 
  −
== Troubleshooting ==
  −
===Certificate Errors===
  −
Errors in the certificate files may prevent Apache and some other services from starting.  If you previously had custom settings for modSSL, revert those with:
  −
config setprop modSSL crt (old value)
  −
config setprop modSSL key (old value)
  −
config setprop modSSL CertificateChainFile (old value--if this property was empty, delete it using the command line below)
  −
 
  −
If you did not have custom settings for modSSL, remove your changes with:
  −
config delprop modSSL crt
  −
config delprop modSSL key
  −
config delprop modSSL CertificateChainFile
  −
 
  −
Once you've made these changes, do:
  −
signal-event post-upgrade
  −
signal-event reboot
  −
 
  −
===Authorization Errors===
  −
The first thing is to check all your domains can resolve
  −
 
  −
http://my.domain/.well-known/acme-challenge
  −
 
  −
Check that the following files are correctly generated
  −
 
  −
/etc/dehydrated/config
  −
/etc/dehydrated/domains.txt
  −
 
  −
Set letsencrypt back to test and remove any generated keys
  −
 
  −
db configuration setprop letsencrypt status test
  −
 
  −
rm /etc/dehydrated/certs/* -rf
  −
rm /etc/dehydrated/accounts/* -rf
  −
 
  −
Then run letsencrypt again
  −
 
  −
dehydrated -c
  −
 
  −
To restore the original certificates:
  −
 
  −
config delprop modSSL CertificateChainFile
  −
config delprop modSSL crt
  −
config delprop modSSL key
  −
 
  −
signal-event console-save
  −
 
  −
===Errors===
      +
Une nouvelle fonction vous permet de nettoyer les vieux certificats et de les archiver.
   −
====No registration exists matching provided key====
+
dehydrated --cleanup (-gc)
    +
===Paramètres de configuration===
 +
{| class="wikitable"
 +
!Clé
 +
!propriété
 +
!par défaut
 +
!valeurs
 +
!
 +
|-
 +
| rowspan="10" |letsencrypt
 +
|ACCEPT_TERMS
 +
|
 +
|empty, yes
 +
|configurer à « yes » pour accepter les termes du service ; si le paramètre est laissé à « empty », la contribution ne fonctionnera pas.
 +
|-
 +
|API
 +
|2
 +
|1, 2
 +
|obsolète, sera toujours v2, car v1 est obsolète depuis juin 2021.
 +
|-
 +
|configure
 +
|none
 +
|none, all, domains, hosts
 +
|cela changera le comportement par défaut sur les domaines ou les hôtes non explicites avec « letsencryptSSLcert enabled ». Par défaut, ne sera pas utilisé : si « hosts » est défini, demandera un certificat pour tous les hôtes ; si « domains » est définis, demandera un certificat pour tous les domaines ; si « all » est défini, demandera un certificat à la fois pour tous les domaines et pour tous les hôtes. Dans toutes les situations, il demandera un certificat pour les domaines/hôtes où « letsencryptSSLcert enabled » est défini et rien si « letsencryptSSLcert disabled » est défini.
 +
|-
 +
|email
 +
|
 +
|email
 +
|entrer l'adresse courriel pour créer le compte et recevoir des mises à jour de Let's Encrypt.
 +
|-
 +
|hookScript
 +
|disabled
 +
|enabled, disabled
 +
|déclenchera un script hook avancé s'il est activé, même s'il est désactivé, la partie signal-event ssl-update pour propager le certificat s'exécutera.
 +
|-
 +
|hostOverride
 +
|disabled
 +
|yes, disabled
 +
|désactivé par défaut. S'il est désactivé, il ne demandera que le certificat pour les hôtes (si sélectionné selon la configuration et avec « letsencryptSSLcert enabled ») pour les hôtes avec type=Self. Si défini sur « yes », inclura tous les hôtes répertoriés, qu'ils soient distants ou locaux.
 +
|-
 +
|keysize
 +
|4096
 +
|base 2 number
 +
|longueur de la clé privée de votre certificat si vous ne voulez pas la '''valeur par défaut de 4096''' bits. Ce ne sera pas nécessaire dans la majorité des cas mais, si c'est désiré, utilisez cette commande pour le faire.
 +
|-
 +
|status
 +
|test
 +
|enabled, disabled, test
 +
|par défaut, le statut est désactivé. '''Dans un premier temps, configurez sur « test »''' pour se connecter au serveur de test de Let's Encrypt afin de vérifier si votre serveur est bien configuré. Après avoir vérifié que tout va bien, vous pouvez configurer le statut sur « enabled ».
 +
|}
   −
If you see the following:
+
==Dépannage==
 +
Voir cette [[Letsencrypt/Troubleshooting |page (en anglais).]]
   −
{"type":"urn:acme:error:unauthorized","detail":"No registration exists matching provided key","status":403}
+
==Fonctions avancées==
 +
Voir cette [[Letsencrypt/Advanced/fr |page.]]
   −
https://github.com/lukas2511/letsencrypt.sh/issues/2
+
==Désinstallation==
 
+
  yum remove smeserver-letsencrypt  letsencrypt
See above for removing private keys and regenerating
  −
 
  −
====rateLimited, Too many currently pending Authorizations====
  −
 
  −
If you see something like this you may have hit the rate limit:
  −
 
  −
{"type":"urn:acme:error:rateLimited","detail":"Error creating new authz :: Too many currently pending authorizations.","status":429}
  −
 
  −
https://github.com/lukas2511/letsencrypt.sh/blob/master/docs/staging.md
  −
 
  −
https://letsencrypt.org/docs/rate-limits/
  −
 
  −
====Some challenges complete successfully but some hostnames fail====
  −
 
  −
If you see some of your challenges returned without error but some fail, you possibly do not have Public DNS A or MX records for all the host names that you are adding to your certificate.
  −
 
  −
Using the command:
  −
config setprop letsencrypt configure all
  −
 
  −
Is likely to cause this error. When a domain is added to an SME server, several host names are created automatically. these include ftp.your-domain.com, wpad.your-domain.com, proxy.your-domain.com, mail.your-domain.com, www.your-domain.com. Most of us do not create public DNS records for all these host names. When letsencrypt issues a challenge for a list of host names and '''ONE''' does not resolve, the challenge will fail and the certificate will not generate at all.
  −
 
  −
To resolve this, issue the following command:
  −
config setprop letsencrypt configure none
  −
 
  −
Then follow up with the commands to enable letsencrypt for each PUBLIC resolvable domain and hostname:
  −
db domains setprop domain1.com letsencryptSSLcert enabled
  −
and for each hostname:
  −
db hosts setprop www.domain1.com letsencryptSSLcert enabled
  −
 
  −
db hosts setprop mail.domain1.com letsencryptSSLcert enabled
  −
until all the public facing hostnames are enabled
  −
followed by:
  −
signal-event console-save
  −
 
  −
Thanks to MSmith for the following forum thread.
  −
 
  −
https://forums.contribs.org/index.php/topic,53052.0.html
  −
 
  −
====Challenge fails with unauthorized 403 error====
  −
 
  −
If your challenge returns something like the following:
  −
ERROR: Challenge is invalid! (returned: invalid) (result: {
  −
  "type": "http-01",
  −
  "status": "invalid",
  −
  "error": {
  −
    "type": "urn:acme:error:unauthorized",
  −
    "detail": "Invalid response from http://www.your-domain.com/.well-known/acme-challenge/<redacted text>
  −
    "status": 403
  −
and your ''httpd error_log'' on your server shows something like this:
  −
(13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied
  −
(13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied
  −
(13)Permission denied: access to /.well-known/acme-challenge/<redacted> denied
  −
 
  −
You need to check the ownership and rights on ''/home/e-smith/files/ibays/Primary'' and on ''/home/e-smith/files/ibays/Primary/html''. The contrib creates a hidden working directory at ''/home/e-smith/files/ibays/Primary/html/.well-known'' and inside that directory a second directory with the following path ''/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge''. The script creates the two new directories with the correct ownerships and rights, however, if the ownership and rights on the ibay and the html directory do not allow the script to access the new location, the challenge will fail with ''access denied''
  −
 
  −
use the following to check the rights:
  −
cd /home/e-smith/files/ibays
  −
then
  −
ls -l
  −
on my test server with only the Primary ibay I get the following (you will probably show a bunch more ibays on your server but we are only concerned with Primary):
  −
total 4
  −
drwxr-xr-x 5 root root 4096 Jul 25  2016 Primary
  −
 
  −
If this is not what you see, you need to correct it.
  −
 
  −
'''THIS MAY BREAK NON STANDARD CUSTOMIZATION OF YOUR SERVER, YOU NEED TO UNDERSTAND WHY THIS HAS BEEN CHANGED BEFORE YOU REVERSE IT'''
  −
 
  −
From within ''/home/e-smith/files/ibays/'' issue the following:
  −
chown root:root Primary
  −
If the rights are not correct, issue:
  −
chmod 0755 Primary
  −
 
  −
Next check the html directory.
  −
cd /home/e-smith/files/ibays/Primary
  −
then
  −
ls -l
  −
on my test server I have the following
  −
[root@backupserver Primary]# ls -l
  −
total 12
  −
drwxr-s--- 2 admin shared 4096 Jul 25  2016 cgi-bin
  −
drwxr-s--- 2 admin shared 4096 Jul 25  2016 files
  −
'''drwxr-s--- 3 admin shared 4096 Jun 11 08:06 html'''
  −
 
  −
If this is not what you see,
  −
 
  −
'''FIRST READ ABOVE WARNING'''
  −
 
  −
then adjust as follows
  −
chown admin:shared html
  −
If the rights are not correct, issue:
  −
chmod 2750 html
  −
 
  −
rerun
  −
dehydrated -c
  −
 
  −
and your challenges should complete.
  −
 
  −
https://forums.contribs.org/index.php/topic,53147.0.html
  −
 
  −
==Advanced Topics==
  −
===Obtaining certificates for other servers===
  −
The dehydrated client can be used to obtain certificates for other servers on your network, if the hostnames resolve (from outside your network) to your SME Server. Here's how to do this using the smeserver-letsencrypt contrib.
  −
 
  −
You'll need to create two template fragments: one to add your hostname to /etc/dehydrated/domains.txt, and the second to handle the certificate once it's generated.  To create the first, do
  −
 
  −
  mkdir -p /etc/e-smith/templates-custom/etc/dehydrated/domains.txt
  −
nano -w /etc/e-smith/templates-custom/etc/dehydrated/domains.txt/15Hostname
  −
 
  −
You can replace "Hostname" in "15Hostname" with something that's descriptive of the host you're obtaining a certificate for.  If you want more than one additional certificate, create separate fragments for each one.  In the file, just enter the fully-qualified domain name of the system:
  −
 
  −
hostname.domain.tld
  −
 
  −
Then Ctrl-X to exit, Y to save.
  −
 
  −
The second template fragment will be a portion of the hook script, so the dehydrated client knows what to do with this certificate.  This must be present, otherwise dehydrated will configure your SME server to use this certificate rather than the certificate for the SME Server.
  −
 
  −
mkdir -p /etc/e-smith/templates-custom/usr/bin/hook-script.sh/
  −
nano -w 05deploy_cert_hostname
  −
 
  −
As above, replace "hostname" with something that describes the host that this script will apply to.  The numeric portion can be changed, but MUST be less than 10.
  −
 
  −
At a minimum, this fragment will need to recognize that it's being called for a certificate other than the main server certificate, and exit in order to prevent later portions of the script from installing that certificate as the main server certificate.  The minimal form of this fragment would be:
  −
 
  −
{
  −
    use strict;
  −
    use warnings;
  −
    use esmith::ConfigDB;
  −
  −
    my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB");
  −
  −
    my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' )    || 'disabled';
  −
  −
    if ( $letsencryptStatus ne 'disabled' ) {
  −
  −
    $OUT .=<<'_EOF';
  −
if [ $1 = "deploy_cert" ] && [ $2 = "hostname.domain.tld" ]; then
  −
  echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@yourdomain.com
  −
  exit 0
  −
fi
  −
_EOF
  −
  −
    }
  −
}
  −
 
  −
Depending on the characteristics of the other system, though, this script may be able to install the certificate on that system.  The following fragment would copy the certificate files to a remote Linux system running Apache for the web server, and reload Apache to get it to begin using the new certificate:
  −
 
  −
{
  −
    use strict;
  −
    use warnings;
  −
    use esmith::ConfigDB;
  −
  −
    my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB");
  −
  −
    my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' )    || 'disabled';
  −
  −
    if ( $letsencryptStatus ne 'disabled' ) {
  −
  −
    $OUT .=<<'_EOF';
  −
if [ $1 = "deploy_cert" ] && [ $2 = "hostname.domain.tld" ]; then
  −
  KEY=$3
  −
  CERT=$4
  −
  CHAIN=$6
  −
  scp $CERT root@hostname:/etc/pki/tls/certs/pbx.familybrown.org.crt
  −
  scp $KEY root@hostname:/etc/pki/tls/private/pbx.familybrown.org.key
  −
  scp $CHAIN root@hostname:/etc/pki/tls/certs/server-chain.crt
  −
  ssh root@pbx "/sbin/service httpd reload"
  −
  echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@domain.tld
  −
  exit 0
  −
fi
  −
_EOF
  −
  −
    }
  −
}
  −
 
  −
The following fragment would install the new certificate on a Proxmox VE host:
  −
 
  −
{
  −
    use strict;
  −
    use warnings;
  −
    use esmith::ConfigDB;
  −
  −
    my $configDB = esmith::ConfigDB->open_ro or die("can't open Config DB");
  −
  −
    my $letsencryptStatus = $configDB->get_prop( 'letsencrypt', 'status' )    || 'disabled';
  −
  −
    if ( $letsencryptStatus ne 'disabled' ) {
  −
  −
    $OUT .=<<'_EOF';
  −
if [ $1 = "deploy_cert" ] && [ $2 = "pve.domain.tld" ]; then
  −
  KEY=$3
  −
  CHAIN=$5
  −
  scp $KEY root@pve:/etc/pve/nodes/pve/pveproxy-ssl.key
  −
  scp $CHAIN root@pve:/etc/pve/nodes/pve/pveproxy-ssl.pem
  −
  ssh root@pve "systemctl restart pveproxy"
  −
  echo "$2 certificate renewed" | mail -s "Certificate renewal" admin@domain.tld
  −
  exit 0
  −
fi
  −
_EOF
  −
  −
    }
  −
}
  −
 
  −
Once you've created the template fragments, expand the templates and run dehydrated to generate the certificates:
  −
signal-event console-save
  −
dehydrated -c
  −
 
  −
These certificates will be automatically renewed, just like the main server certificate.
  −
 
  −
===Obtaining certificates for a private SME Server===
  −
As noted above in the prerequisites section, your SME Server must ordinarily be accessible from the Internet so that the Let's Encrypt servers can validate that you control it.  However, if your SME Server is not accessible from the Internet, the smeserver-letsencrypt contrib provides a method that can be used to validate domain control.  In order to use this method, the following conditions must be true:
  −
* The hostname of your internal SME Server (example: internal.mydomain.tld) resolves, on the public Internet, to a valid IP address
  −
* The host to which internal.mydomain.tld resolves (example: external.mydomain.tld) has a running web server on port 80
  −
* The root user from internal.mydomain.tld can connect to external.mydomain.tld via SSH without entering a password (i.e., you've set up SSH public key authentication)
  −
 
  −
This method uses a simple script that's included in the smeserver-letsencrypt contrib, which requires that four database entries be set:
  −
config setprop letsencrypt hookScript enabled
  −
config setprop letsencrypt host '''external.mydomain.tld'''
  −
config setprop letsencrypt user '''root'''
  −
config setprop letsencrypt path '''/home/e-smith/files/ibays/Primary/html/.well-known/acme-challenge'''
  −
signal-event console-save
     −
The parts in bold above should be changed to match your situation; the path variable should be the filesystem location that external.mydomain.tld serves as /.well-known/acme-challenge/ .  When dehydrated creates the challenge file, it will transfer it via scp to user@host:path/, and then allow the Let's Encrypt server to validate.  Once validation is accomplished, the script will remove the challenge file from user@host:path/
     −
= Bugs =
+
= Bogues =
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
+
Veuillez ouvrir des bogues dans la section SME-Contribs dans [http://bugs.contribs.org/enter_bug.cgi bugzilla]
and select the smeserver-letsencrypt component or use {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-letsencrypt|title=this link}}
+
et sélectionner le composant smeserver-letsencrypt ou utiliser {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-letsencrypt|title=ce lien.}}
    
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-letsencrypt |disablecache=1|noresultsmessage="No open bugs found."}}
 
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-letsencrypt |disablecache=1|noresultsmessage="No open bugs found."}}
   −
= Changelog =
+
= Journal des modifications =
Only released version in smecontrib are listed here.
+
Seules les versions publiées dans le dépôt smecontrib sont rapportées ici.
    
{{#smechangelog:smeserver-letsencrypt}}
 
{{#smechangelog:smeserver-letsencrypt}}
   −
[[Category:Howto/fr]] [[Category:Security]]
+
[[Category:Contrib/fr]]
 +
[[Category:Howto/fr]]  
 +
[[Category:Security]]
 
[[Category: Administration:Certificates]]
 
[[Category: Administration:Certificates]]
3,054

edits

Navigation menu