Comment configurer WireGuard sur OverTheBox
Découvrez comment basculer votre service OverTheBox en mode WireGuard et le configurer via l'API OVHcloud
Objectif
OverTheBox propose un mode de fonctionnement WireGuard1, une alternative au tunnel OverTheBox historique (glorytun / MPTCP).
Ce guide vous explique comment basculer votre service OverTheBox en mode WireGuard et le configurer via l'API OVHcloud.
Le mode WireGuard d'OverTheBox est actuellement en phase bêta. Son comportement et les appels API associés sont susceptibles d'évoluer.
Prérequis
- Disposer d'un service OverTheBox Starter ou OverTheBox Business fourni par OVHcloud. WireGuard n'est pas disponible sur les anciennes offres : vous pouvez changer d'offre en consultant le guide « Comment changer l'offre de mon service OverTheBox ».
- Consulter notre guide « Premiers pas avec les API OVHcloud » afin de vous familiariser avec l'APIv6 OVHcloud.
L'IPv6 n'est pas disponible en mode WireGuard. Si vous avez besoin de l'IPv6, utilisez le mode OverTheBox historique et consultez le guide « Comment configurer IPv6 sur OverTheBox ».
Les modes de fonctionnement sont exclusifs : le tunnel OverTheBox historique (glorytun / MPTCP) et WireGuard ne peuvent pas fonctionner en même temps. Basculer vers un mode désactive automatiquement l'autre.
En pratique
Tous les appels API de ce guide sont disponibles dans la section /overTheBox de la console API.
Lors de l'utilisation de l'API, tous les champs marqués d'un astérisque (*) sont obligatoires.
Vérifier le mode de fonctionnement actuel
Récupérez les informations de votre service, notamment le champ operationMode, à l'aide de l'appel suivant :
Le champ operationMode renvoyé indique le mode actif :
overthebox-legacy: le tunnel OverTheBox historique (glorytun / MPTCP).wireguard: le mode WireGuard.
Lister les modes de fonctionnement disponibles
Les modes disponibles dépendent de votre offre. Utilisez l'appel suivant pour connaître ceux accessibles sur votre service :
Le mode wireguard n'apparaît dans la liste que si votre offre le permet (offres Starter ou Business).
Basculer en mode WireGuard
Utilisez l'appel suivant pour changer le mode de fonctionnement de votre service :
Le basculement en mode WireGuard désactive le tunnel OverTheBox historique et rend l'IPv6 indisponible. L'opération peut entraîner une courte interruption de service, le temps que la nouvelle configuration soit appliquée.
Récupérer la configuration du serveur WireGuard
Une fois le service en mode WireGuard, récupérez la configuration du serveur (nécessaire pour configurer vos clients) à l'aide de l'appel suivant :
La réponse contient les informations à reporter dans la configuration de vos clients WireGuard :
Gérer les peers WireGuard
Un peer représente un client autorisé à se connecter au serveur WireGuard de votre OverTheBox.
Lister les peers
Créer un peer
Générez d'abord une paire de clés WireGuard sur votre client, puis transmettez sa clé publique à l'aide de l'appel suivant :
Consulter un peer
Modifier un peer
Supprimer un peer
Régénérer la configuration WireGuard
Cette opération régénère les clés du serveur WireGuard :
La régénération modifie la clé publique du serveur. Vous devrez mettre à jour la configuration de tous vos clients WireGuard pour rétablir la connexion.
Réinitialiser la configuration WireGuard
Cette opération réinitialise la configuration WireGuard du service :
La réinitialisation est une opération destructive : elle supprime les peers configurés et restaure la configuration WireGuard par défaut.
Aller plus loin
Pour des prestations spécialisées (référencement, développement, etc.), contactez les partenaires OVHcloud.
Si vous souhaitez bénéficier d'une assistance à l'usage et à la configuration de vos solutions OVHcloud, nous vous proposons de consulter nos différentes offres de support.
Échangez avec notre communauté d'utilisateurs.
1 : « WireGuard » et le logo « WireGuard » sont des marques déposées de Jason A. Donenfeld. OverTheBox n'est ni affilié, ni approuvé, ni sponsorisé par le projet WireGuard.