|
|
| (7 révisions intermédiaires par le même utilisateur non affichées) |
| Ligne 3 : |
Ligne 3 : |
| | | | |
| | ==Bonnes pratiques== | | ==Bonnes pratiques== |
| − | Un ensemble de bonnes pratiques sont recommandées sur le [https://wiki.jenkins.io/display/JENKINS/Jenkins+Best+Practices site officiel de Jenkins]. | + | Un ensemble de bonnes pratiques est recommandé sur le [https://wiki.jenkins.io/display/JENKINS/Jenkins+Best+Practices site officiel de Jenkins]. |
| | | | |
| | Il convient donc de les suivre dès que cela est possible. | | Il convient donc de les suivre dès que cela est possible. |
| | | | |
| − | ==Choix version de PHP== | + | == Liste des pages == |
| − | ===Avec la variable d'environnement $PATH===
| + | {{#subpages:default=''}} |
| − | Dans le cadre d'une utilisation multiple des versions de PHP, il est nécessaire de pouvoir indiquer aux jobs Jenkins quelle version de PHP utiliser pour le build.
| |
| − | | |
| − | A ce titre, le plugin [[#Environment Injector|Environment Injector]] a été installé.
| |
| − | | |
| − | Pour indiquer à un projet Jenkins quel version de PHP utiliser, se rendre sur le projet en question et cliquer sur ''Configurer'' :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150054.PNG|none|thumb|300px|Jenkins - Projet]]
| |
| − | | |
| − | Dans la configuration du projet, se rendre dans la section ''Environnements de Build'' et cliquer sur ''Inject environment variables to the build process'' :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150116.PNG|none|thumb|300px|Jenkins - Projet - Environnements de Build]]
| |
| − | | |
| − | Dans la section précédemment ouverte, dans le champ ''Properties Content'', définir le <code>PATH</code> comme ceci : <code>/local/php/php7/bin:$PATH</code>. Dans cet exemple, le chemin des binaires PHP 7 a été mis <u>devant</u> la variable <code>$PATH</code>. De ce fait, en cas de présence déjà existante de chemins d'autres versions de PHP, ce sera celui de PHP 7 qui prévaudra.
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150136.PNG|none|thumb|300px|Jenkins - Projet - Properties Content]]
| |
| − | | |
| − | Pour tester et vérifier la bonne prise en compte, dans la section ''Build'', ajouter une étape ''Exécuter un script shell'' et renseigner les lignes suivantes :
| |
| − | which php
| |
| − | composer -v
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150205.PNG|none|thumb|300px|Jenkins - Projet - Build - Shell]]
| |
| − | | |
| − | Cliquer sur Sauver :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150222.PNG|none|thumb|300px|Jenkins - Projet - Sauver]]
| |
| − | | |
| − | Lancer ensuite un build en cliquant sur ''Lancer un build'' :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150240.PNG|none|thumb|300px|Jenkins - Projet - Lancer build]]
| |
| − | | |
| − | Un build supplémentaire apparaît dans la section ''Historique des builds'' :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150256.PNG|none|thumb|300px|Jenkins - Projet - Historique des builds]]
| |
| − | | |
| − | Cliquer sur le dernier build puis cliquer sur ''Console Output'' pour afficher le détail :
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150333.PNG|none|thumb|300px|Jenkins - Projet - Détail build]]
| |
| − | | |
| − | Cela affiche la sortie de la console avec le résultat des commandes définies plus haut dans la section ''Exécuter un script shell''
| |
| − | | |
| − | :[[Fichier:ClipCapIt-190813-150352.PNG|none|thumb|300px|Jenkins - Projet - Build - Sortie console]]
| |
| − | | |
| − | La version de PHP utilisé est bien la 7, comme défini plus haut, et Composer est fonctionnel.
| |
| − | | |
| − | ===Avec Gradle via du Groovy===
| |
| − | Lors de son installation, Jenkins est livré avec 3 outils globaux configurables : Maven, Gradle et JDK.
| |
| − | | |
| − | Ces outils offrent des possibilités intéressantes, qui sont difficiles à mettre en oeuvre pour du PHP. De ce fait, pour charger les binaires de PHP selon la version souhaitée, il est possible de galvauder Gradle.
| |
| − | | |
| − | ====Côté administration Jenkins====
| |
| − | Aller dans l'[http://myjenkinsserver:8080/manage administration Jenkins] puis dans [http://myjenkinsserver:8080/configureTools/ Configuration globale des outils].
| |
| − | | |
| − | Dans la section ''Gradle'', cliquer sur ''Ajouter Gradle'' pour ajouter une version de PHP :
| |
| − | :[[Fichier:ClipCapIt-190813-150440.PNG|none|thumb|300px|Jenkins - Ajouter Gradle]]
| |
| − | | |
| − | Nommer le champ ''name'' PHP suivi de la version majeure concernée, définir ''GRADLE_HOME'' sur la localisation du répertoire d'installation de la version de PHP et décocher ''Install automatically'' :
| |
| − | :[[Fichier:ClipCapIt-190813-150500.PNG|none|thumb|300px|Jenkins - Ajouter Gradle - PHP]]
| |
| − | | |
| − | Répéter l'action autant de fois que de versions différentes de PHP désirées et cliquer sur ''Enregistrer''.
| |
| − | | |
| − | Cette action aura pour effet de rajouter dans le PATH le dossier ''bin'' d'une version de PHP lorsqu'elle sera appelée via un script Groovy.
| |
| − | | |
| − | ====Côté utilisation Jenkins====
| |
| − | Lors de la création/modification d'un job Jenkins au travers d'un script Groovy, pour définir la version de PHP à utiliser, il suffit d'appeler l'outil ''gradle'' correspondant à la version de PHP à utiliser. Cela se fait dans la section ''tools'', après la déclaration de l'''agent'', au début du script. Exemple pour utiliser PHP en version 7 :
| |
| − | <syntaxhighlight lang="groovy">
| |
| − | pipeline {
| |
| − | agent any
| |
| − | tools {
| |
| − | gradle 'PHP7'
| |
| − | }
| |
| − | | |
| − | stages {
| |
| − | stage('Test appel PHP') {
| |
| − | steps {
| |
| − | sh '''
| |
| − | php -v
| |
| − | which php
| |
| − | echo $PATH
| |
| − | composer --version
| |
| − | '''
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Cela aura pour effet de produire la sortie suivante :
| |
| − | <pre>
| |
| − | ...
| |
| − | [workspace] Running shell script
| |
| − | + php -v
| |
| − | PHP 7.2.19 (cli) (built: Jul 25 2019 16:09:54) ( ZTS )
| |
| − | Copyright (c) 1997-2018 The PHP Group
| |
| − | Zend Engine v3.2.0, Copyright (c) 1998-2018 Zend Technologies
| |
| − | with Xdebug v2.7.2, Copyright (c) 2002-2019, by Derick Rethans
| |
| − | + which php
| |
| − | /local/php/php7/bin/php
| |
| − | + echo /local/php/php7/bin:/local/php/php7/bin:/var/lib/jenkins/tools/hudson.tasks.Maven_MavenInstallation/MAVEN_3.5.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/bin/X11:/usr/games:/local/mysql/5.6.23/bin:/local/mysql/5.6.23/share/mysql:/home/tools/bin:/usr/lib/oracle/10.2.0.4/client64/bin:/local/www/2.4.12/bin/:.
| |
| − | /local/php/php7/bin:/local/php/php7/bin:/var/lib/jenkins/tools/hudson.tasks.Maven_MavenInstallation/MAVEN_3.5.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/bin/X11:/usr/games:/local/mysql/5.6.23/bin:/local/mysql/5.6.23/share/mysql:/home/tools/bin:/usr/lib/oracle/10.2.0.4/client64/bin:/local/www/2.4.12/bin/:.
| |
| − | + composer --version
| |
| − | Composer version 1.5.2 2017-09-11 16:59:25
| |
| − | ...
| |
| − | </pre>
| |
| − | | |
| − | ==Plugins== | |
| − | ===Environment Injector===
| |
| − | Le plugin EnvInject fournit les fonctionnalités suivantes:
| |
| − | *Supprime des variables d'environnement héritées par le processus Java Jenkins
| |
| − | *Injecte des variables d'environnement au démarrage du noeud (maître / esclave)
| |
| − | *Exécute un script de configuration avant ou/et après une extraction SCM pour une exécution
| |
| − | *Injecte des variables d'environnement avant ou/et après une extraction SCM pour une exécution
| |
| − | *Injecte des variables d'environnement en tant qu'étape de construction pour une exécution
| |
| − | *Injecte des valeurs de mot de passe pour une exécution
| |
| − | *Exporte des variables d'environnement à la fin de la construction afin de connaître l'ensemble des variables d'environnement utilisées pour chaque construction
| |
| − | | |
| − | Plus d'informations sur https://plugins.jenkins.io/envinject.
| |
| − | | |
| − | ==Récupérer les mots de passe stockés==
| |
| − | Procédure trouvée sur https://looselytyped.com/blog/2017/10/25/uncovering-passwords-in-jenkins/.
| |
| − | ===Point de départ===
| |
| − | La première chose qui est nécessaire est d'avoir accès au serveur Jenkins lui-même.
| |
| − | | |
| − | Commencer par se connecter en SSH sur le serveur Jenkins et localiser le home directory (<code>$JENKINS_HOME</code>) de Jenkins avec la commande suivante :
| |
| − | grep jenkins /etc/passwd|awk -F: '{print $6}'
| |
| − | | |
| − | Ensuite, il faut déterminer où est stocké le mot de passe dans Jenkins. Jenkins utilise plusieurs emplacements différents pour stocker les informations d'identification, selon qu'elles sont au niveau du système ou spécifiques à un job. Quelques fichiers et répertoires qui stockent les informations d’identification sont :
| |
| − | | |
| − | *<code>$JENKINS_HOME/credentials.xml</code>
| |
| − | **Ce fichier est utilisé par le plugin [https://wiki.jenkins.io/display/JENKINS/Credentials+Plugin Credentials] utilise pour stocker les informations d'identification.
| |
| − | *<code>$JENKINS_HOME/jobs/</code>
| |
| − | **C'est le répertoire dans lequel Jenkins stocke tous les jobs qui ont été configurés, ainsi que leurs fichiers ''config.xml'' respectifs. Dans ces fichiers se trouveront toutes les informations d'identification qui ont été fournies dans le cadre de la configuration du job.
| |
| − | **Par exemple, le plug-in [https://wiki.jenkins.io/display/JENKINS/Artifactory+Plugin Artifactory] permet de remplacer les informations d'identification par défaut pour chaque job. De tels remplacements sont stockés dans la configuration des jobs et ils sont localisés (chiffrés bien entendu) ici.
| |
| − | | |
| − | Généralement, un grep dans <code>$JENKINS_HOME</code> avec le nom d'utilisateur dont on souhaite découvrir les informations d'identification est le moyen le plus rapide de déterminer où chercher.
| |
| − | | |
| − | ===Détermination de la classe utilisée pour le cryptage / décryptage===
| |
| − | Une fois le fichier dans lequel rechercher à été trouvé, l'étape suivante consiste à déterminer comment déchiffrer le mot de passe. Heureusement, Jenkins stocke la quasi-totalité de sa configuration dans des fichiers XML. La visualisation du fichier peut donc se faire via un <code>cat</code> ou un <code>less</code>, ou simplement via un <code>scp</code> du fichier sur la machine locale et le lire avec un éditeur de texte.
| |
| − | | |
| − | Par exemple, si le nom d'utilisateur est jenkins-user@mycompany.com et que les informations d'identification recherchées sont effectivement stockées dans <code>credentials.xml</code>, le fichier peut contenir un extrait comme celui-ci :
| |
| − | <syntaxhighlight lang="xml">
| |
| − | <username>jenkins-user@mycompany.com</username>
| |
| − | <password>{AQAAABAAAAAgyqp9mI73xTYaYkaMRNolxwxR+X0qev7q6Hb3KcchbM9VA5ERj0RG1Nrl/aFw7haU}</password>
| |
| − | </syntaxhighlight>
| |
| − | *L'extrait de code peut être différent de celui de l'exemple, mais tant que le nom d'utilisateur correspond, cela signifie qu'on est au bon endroit.
| |
| − | | |
| − | La balise <code><password/></code> apparaît. Il reste donc à décrypter son contenu.
| |
| − | | |
| − | Remonter ensuite dans la hiérarchie des balises jusqu'à la rencontre d'une balise ressemblant à un nom de classe Java pleinement qualifié. Par exemple :
| |
| − | <syntaxhighlight lang="xml">
| |
| − | <com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl>
| |
| − | <scope>SYSTEM</scope>
| |
| − | <id>5dc3bbe5-e5a6-496e-a616-199a207d8122</id>
| |
| − | <description>This is a user</description>
| |
| − | <username>jenkins-user@mycompany.com</username>
| |
| − | <password>{AQAAABAAAAAQ5Qp/KX1Ibliy/23sM6e3Lepwa/OObLtGHC5svihnTr4=}</password>
| |
| − | </com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl>
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Cela permet de connaître la classe que Jenkins instancie pour prendre en charge cette propriété.
| |
| − | | |
| − | Il faut donc maintenant trouver le code source et déterminer le mécanisme utilisé par cette classe pour chiffrer / déchiffrer le mot de passe. Utiliser un [https://www.google.com/search?hl=en&q=com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl&aq=f&oq= moteur de recherche] pour trouver le code source. Dans ce cas précis, il suffit de chercher <code>com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl</code>.
| |
| − | | |
| − | Un rapide examen du code source fait ressortir ce [https://github.com/jenkinsci/credentials-plugin/blob/3b9555eca6cfa02fca8e5163235f5abbe057865f/src/main/java/com/cloudbees/plugins/credentials/impl/UsernamePasswordCredentialsImpl.java#L65-L73 constructeur] :
| |
| − | <syntaxhighlight lang="java">
| |
| − | @DataBoundConstructor
| |
| − | @SuppressWarnings("unused") // by stapler
| |
| − | public UsernamePasswordCredentialsImpl(@CheckForNull CredentialsScope scope,
| |
| − | @CheckForNull String id, @CheckForNull String description,
| |
| − | @CheckForNull String username, @CheckForNull String password) {
| |
| − | super(scope, id, description);
| |
| − | this.username = Util.fixNull(username);
| |
| − | this.password = Secret.fromString(password);
| |
| − | }
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Ainsi, <code>com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl</code> utilise <code>hudson.util.Secret</code> pour chiffrer le mot de passe. Lors de la recherche suivante, le code source <code>hudson.util.Secrets</code> indique à son tour une méthode de déchiffrement :
| |
| − | <syntaxhighlight lang="java">
| |
| − | @CheckForNull
| |
| − | public static Secret decrypt(@CheckForNull String data) {
| |
| − | ...
| |
| − | } | |
| − | </syntaxhighlight>
| |
| − | | |
| − | La classe est utilisée pour chiffrer / déchiffrer le mot de passe est donc <code>Secret</code>. Il faut ensuite découvrir comment l'utiliser. Il pourrait être possible d'essayer de simplifier l’implémentation et d’arriver en quelque sorte à l’exécuter de façon isolée, peut-être dans une classe de test avec une méthode principale, mais cela serait compliqué, surtout si cette classe a des dépendances sur d’autres classes.
| |
| − | | |
| − | Il est donc nécessaire d'avoir un environnement d'exécution où il sera possible charger cette classe, ainsi que toutes ses dépendances, et de simplement appeler <code>hudson.util.Secret#déchiffrer</code> en passant le mot de passe trouvé dans <code>credentials.xml</code>. Jenkins fourni cet environnement d'exécution.
| |
| − | | |
| − | ===Utiliser la console de script pour découvrir le mot de passe===
| |
| − | Jenkins est livré avec une [http://myjenkinsserver:8080/script console de script] qu'il est possible utiliser pour exécuter arbitrairement des scripts Groovy. Dans cette console, exécuter le code suivant permettra de révéler un mot de passe :
| |
| − | <syntaxhighlight lang="groovy">
| |
| − | import hudson.util.Secret;
| |
| − | | |
| − | println Secret.decrypt("{AQAAABAAAAAQ5Qp/KX1Ibliy/23sM6e3Lepwa/OObLtGHC5svihnTr4=}");
| |
| − | | |
| − | // Résultat : jenkins
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Le mot de passe est ainsi retrouvé.
| |
