Voir la source de Mettre en place SSH pour Gitlab

Ce guide a pour but de t’aider à mettre en place un ordinateur pour utiliser [[GitLab|Gitlab]] avec une authentification SSH. Il s’adresse aux néophytes : pour une introduction plus générale, voir le page principale sur le [[SSH]] et les [[Astuces_ssh|astuces avancées]] du BR.

On décrit les étapes d’installation pour Windows 10 et 11. Pour Linux et macOS, se référer également au guide SSH principal.

La mise en place est relativement simple. Suit scrupuleusement les étapes suivantes.

= Prérequis =

Avant de commencer, assure-toi d’avoir [[Git|git]] installé sur ta machine. Pour vérifier cela :

* ouvrir un terminal cmd ou powershell (touche Windows + R, puis taper <code>cmd</code> ou <code>powershell</code>) ;
* taper <code>git -v</code> et vérifier que git est bien installé et, si ce n’est pas le cas, [https://git-scm.com/downloads installe git ici] ;
* taper ensuite <code>ssh -V</code> pour vérifier que ssh est installé et, si ce n’est pas le cas, [https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse installe OpenSSH ici].

= Mise en place =

== Étape 1 : Générer une clé SSH ==

Ouvre un terminal (cmd ou powershell) et tape la commande suivante :

<syntaxhighlight lang="bash">ssh-keygen -t ed25519 -C "ordi portable vaneau"</syntaxhighlight>
En remplaçant <code>ordi portable vaneau</code> par un nom de ton choix. Tu peux laisser les autres champs vides en appuyant simplement sur la touche <code>Entrée</code> pour chaque option.

À noter qu'il y a une option pour changer le nom de la clé (par défaut <code>id_ed25519</code>) et l’emplacement de sauvegarde. Il y a aussi une autre option pour ajouter un mot de passe (''passphrase'') à la clé, qu'il est recommandé de mettre si ton disque dur n'est pas chiffré.

{{Attention|Cette commande génère deux fichiers dans le dossier <code>C:\Users\<ton_nom>\.ssh</code> : la clé privée (<code>id_ed25519</code>) et la clé publique (<code>id_ed25519.pub</code>). '''IL NE FAUT EN AUCUN CAS PARTAGER LA CLÉ PRIVÉE'''. C’est la '''clé publique''' qui doit être ajoutée sur Gitlab. On n’insistera jamais assez sur ce point. Toute la sécurité repose sur le fait que la clé privée reste secrète.}}

== Étape 2 : Ajouter la clé SSH sur Gitlab ==

# Connecte-toi sur Gitlab avec tes identifiants Sigma BR ;
# Clique sur ton avatar en haut à gauche, puis sur <code>Preferences</code>, puis sur <code>SSH Keys</code> (ou va directement sur [https://gitlab.binets.fr/-/user_settings/ssh_keys cette page]) ;
# Clique sur <code>Add new key</code> ;
# Copie le contenu du fichier <code>C:\Users\&lt;ton_nom&gt;\.ssh\id_ed25519.pub</code> (ou un autre chemin si tu as choisi un autre emplacement) en remplaçant <code>&lt;ton_nom&gt;</code> par ton nom d’utilisateur Windows et colle-le dans le champ <code>Key</code> ;
# (optionnel) Supprime la date d’expiration de la clé si tu veux qu’elle reste valide indéfiniment ;
# Clique sur <code>Add key</code>.

== Étape 3 : Préparer SSH pour utiliser la clé ==

# Ouvre le dossier <code>C:\Users\&lt;ton_nom&gt;\.ssh</code> sur VSCode (ou ton éditeur de texte préféré) ;
# Crée un fichier <code>config</code> ('''sans extension''') ;
# Ajoute le contenu suivant :

 Host gitlab.binets.fr
   User git
   IdentityFile C:\Users\&lt;ton_nom&gt;\.ssh\id_ed25519

En remplaçant <code>&lt;ton_nom&gt;</code> par ton nom d’utilisateur Windows.

== Étape 4 : Activer l'agent SSH ==

Taper <code>ssh-add -L</code>
* Si ta clef ssh est affichée, tout va bien, tu peux passer à l'étape suivante
* Sinon, suit ces étapes :

=== Sur windows ===

# Aller dans la recherche windows et lancer <code>Services</code>
# Chercher OpenSSH Authentification Agent
# Double cliquer dessus et mettre : <code>Type de démarrage : Automatique</code>
# Appuyer sur démarrer
# Dans un terminal, faire <code>ssh-add</code>

=== Sur Linux/Mac ===

Voilà une solution un peu nulle qu'il faudra refaire à chaque fois que tu redémarre ton ordi. Lance un terminal et tape :

 eval `ssh-agent`
 ssh-add

N'hésite pas à trouver une meilleure solution et à l'écrire ici.

== Étape 5 : Tester la connexion SSH ==

Pour tester la connexion SSH, ouvre un terminal et tape la commande suivante :

<syntaxhighlight lang="bash">ssh -T gitlab.binets.fr</syntaxhighlight>
Tu devrais voir un message comme ça :

 The authenticity of host 'gitlab.binets.fr (129.104.201.46)' can't be established.
 ED25519 key fingerprint is SHA256:sn+wsip9OTBcwiY0ZplULWXNij3v3kdj/tP228i2+70.
 Are you sure you want to continue connecting (yes/no/[fingerprint])?

Écrit <code>yes</code> puis appuie sur <code>Entrée</code>.

Si tout s’est bien passé, tu devrais voir un message de bienvenue de Gitlab. Dans le cas contraire, vérifie que tu as bien suivi toutes les étapes précédentes. Si tu rencontres des difficultés, n’hésite pas à demander de l’aide au Binet Réseau en permanence ou sur PaniX.

== Étape 6 : Configurer l’identité Git ==

Pour finir, il faut configurer correctement ton identité sur Git. Dans ton terminal, tape les commandes suivantes :

<syntaxhighlight lang="bash">git config --global user.name "<Ton Nom>"
git config --global user.email "<ton.nom>@polytechnique.edu"</syntaxhighlight>
En remplaçant <code>&lt;Ton Nom&gt;</code> par ton nom et <code>&lt;ton.nom&gt;@polytechnique.edu</code> par les valeurs adéquates.

Félicitations ! À partir de là, tu peux utiliser Gitlab avec une authentification SSH.

'''Lorsque tu clones un dépôt, veille bien à choisir le lien SSH et non HTTPS.'''