tbsCertBot - prise en main rapide
Une fois votre utilisateur API créé, la mise en place de tbsCertBot ne prend que quelques minutes. Vous trouverez les étapes essentielles à la configuration et l'utilisation de l'outil ci-dessous.
Pré-requis
TBSCertBot fonctionne avec php 5.4 et supérieur.
Note : TBSCertbot autodétecte et installe des dépendances. Cependant si vous rencontrez des difficultés, nous vous invitons à mettre à jour vos librairies :
#composer update
1 - Créer un utilisateur API
Avant de pouvoir utiliser tbsCertBot il faut créer un utilisateur API.
Attention : tbsCertBot est disponible en environnement de test et de production. Il faut créer un utilisateur API pour chacun des environnements sur lesquels vous souhaitez travailler.
Pour se faire, connectez-vous à votre espace client (sur l'environnement concerné) puis rendez-vous dans la rubrique "Administration" > "Utilisateurs".
Depuis cette page il vous sera possible d'ajouter un (ou plusieurs) utilisateur API.
Environnement de test :
ouvrir un compte /
accéder au compte
Environnement de production :
ouvrir un compte /
accéder au compte
2 - Installer tbsCertBot
Dans un premier temps, il faut télécharger tbsCertBot.
Décompressez l'archive. Un dossier tbsCertBot est créé et les librairies nécessaires à l'outil se mettent à jour.
# tar jxvf tbscertbot.tar.bz2
3 - Configuration de tbsCertBot
TBSCertBot nécessite un fichier de configuration pour fonctionner. Ce dernier rassemble tous les éléments nécessaires à la gestion d'un certificat : identifiant et mot de passe API, type de certificat, validité, organisation, méthode DCV...
Récupérer un fichier de configuration depuis un dossier
Il est possible de générer un fichier de configuration depuis un dossier. Ce dernier sera alors complété avec les données du certificat choisi.
À noter : Le bouton de téléchargement est présent sur toute page statut de certificat pris en charge par l'API.
Vous pourrez choisir le serveur sur lequel vous souhaitez utiliser TBSCertBot ainsi qu'un utilisateur API.
Une fois le fichier téléchargé et enregistré dans le répertoire data/ de TBSCertBot il faut simplement y ajouter le mot de passe de l'utilisateur API sélectionné.
Créer un fichier de configuration
Si vous n'avez pas de fichier de configuration, alors lancez TBSCertBot. Il vérifie en premier lieu la présence d'un fichier de configuration. En l’absence de ce dernier il vous proposera d'en créer un :
php tbscertbot.php The config file doesn't exist. Do you want create a new config file ? [Y/n]
Il vous sera demandé vos identifiants et mot de passe API. Vous devrez également choisir le serveur sur lequel vous souhaitez travailler.
Avant de pouvoir passer commande il faut éditer le fichier de configuration pour indiquer les informations relatives à vos futures commandes : type de certificat, validité, organisation, méthode DCV...
Il est possible de passer commande sans retoucher au fichier de configuration cependant il faudra alors donner toutes ces informations en mode prompt.
4 - Passer une commande
À ce stade tbsCertBot est prêt à être utilisé. Pour passer une commande, rien de plus simple :
# php tbscertbot.php order
Une fois la commande passée, la référence est affichée.
Quand le certificat est prêt, il suffit de lancer la commande "download" pour télécharger le certificat. Par défaut le certificat et la chaîne de certification sont installés dans le dossier /data/certs/ et la clé privée dans /data/keys/.
5 - Les Hooks
Les hooks vous permettent d'associer des scripts à la fin de certaines opérations dont la commande, le renouvellement, ou le téléchargement d'un certificat.
Dans l'exemple ci-dessous nous utilisons les hooks pour définir un dossier spécifique pour l'installation d'un certificat après livraison. Ce hook sera donc exécuté lors de la commande "download".
Dans un premier temps, il faut indiquer le chemin vers le hook dans le fichier de configuration. Une fois fait, créer / modifier le fichier hook pour indiquer le fichier de destination de vos certificat, chaîne de certification et clé privée.
Note : Vous pouvez créer autant de hooks que vous le souhaitez. Une fonctionnalité de test intitulée « test-hook » existe au sein de TBSCertBot spécifiquement pour tester vos hooks.
Comment tester vos hooks ?
Pour tester un hook, il faut utiliser la commande :
php tbscertbot.php test-hook NOM_DU_HOOK [Référence TBS].
La référence TBS est optionnelle. Indiquez-là si vous souhaitez tester votre hook sur une commande sépcifique. Exemple :
php tbscertbot.php test-hook download 1234567890.
Cette commande relancera le script lié au hook de téléchargement sur la commande 1234567890. Vous trouverez quelques exemples de hooks dans le répertoire data/testhooks de votre installation TBSCertBot.