Extension Visual Studio Code

L'extension GitGuardian pour VSCode renforce la sécurité du code en détectant et en empêchant l'inclusion d'informations sensibles, telles que des clés d'API et des identifiants, directement dans votre environnement de développement. Cet outil s'intègre parfaitement à l'éditeur VS Code, fournissant un retour en temps réel aux développeurs et favorisant des pratiques de codage sécurisées.

L'extension s'appuie sur la CLI GitGuardian intégrée (ggshield) pour scanner votre code à la recherche de plus de 600 types de secrets à mesure que vous l'écrivez ou le modifiez, garantissant une prise de conscience et une action immédiates lorsque des problèmes de sécurité potentiels sont détectés.

L'extension GitGuardian détectant un token GitHub dans VS Code, affichant des informations détaillées sur le secret au survol.

Fonctionnalités clés

• Détection de secrets en temps réel : scanne automatiquement votre code à mesure que vous tapez, mettant en évidence les secrets instantanément avec des indicateurs visuels clairs.
• Remédiation guidée : fournit des recommandations concrètes pour corriger les secrets détectés directement dans VS Code.
• Intégration conviviale pour les développeurs : installation simple en un clic avec CLI intégrée et scan automatique à l'enregistrement.
• Gestion des faux positifs : marquez facilement les faux positifs via la configuration .gitguardian.yaml.

Installation

Depuis la marketplace d'extensions :

1. Ouvrez Visual Studio Code
2. Accédez à la vue Extensions (Ctrl+Shift+X ou Cmd+Shift+X)
3. Recherchez « GitGuardian »
4. Cliquez sur « Install » pour l'extension « GitGuardian Secret Security »
5. Redémarrez VS Code si vous y êtes invité

Configuration

Authentification

Après l'installation, vous devrez vous authentifier auprès de GitGuardian :

1. Ouvrez la Command Palette (Ctrl+Shift+P ou Cmd+Shift+P)
2. Tapez « GitGuardian: Authenticate » et sélectionnez-le
3. Suivez le flux d'authentification pour connecter votre compte GitGuardian

Paramètres

L'extension peut être configurée via les paramètres de VS Code :

1. Accédez à File → Preferences → Settings (ou Ctrl+, / Cmd+,)
2. Recherchez « GitGuardian »
3. Configurez les options disponibles :

Pour les utilisateurs SaaS

• URL de l'API : utilise le endpoint API par défaut de GitGuardian
• Authentification : utilisez le flux d'authentification intégré

Pour les utilisateurs Self-Hosted

• URL de l'API : entrez l'URL personnalisée de votre instance GitGuardian
• Clé API : entrez votre Personal Access Token depuis votre instance self-hosted

Pour configurer pour les instances self-hosted :

{
  "gitguardian.apiUrl": "https://your-gitguardian-instance.com",
  "gitguardian.apiKey": "your-personal-access-token"
}

Utilisation et résultats

L'extension scanne automatiquement les fichiers à l'enregistrement et affiche les résultats de trois manières :

• Surligne les secrets directement dans votre code
• Affiche des icônes d'avertissement dans la barre d'état
• Liste les problèmes dans le panneau Problems (Ctrl+Shift+M ou Cmd+Shift+M)

Pour ignorer les faux positifs, ajoutez les chemins à .gitguardian.yaml :

version: 2

secret:
  # Exclude files and paths by globbing
  ignored_paths:
    - '**/README.md'
    - 'doc/*'
    - 'LICENSE'

info

Personnalisez le message de remédiation et ajoutez le vôtre pour offrir aux développeurs des conseils précis pour résoudre leurs problèmes de code et continuer leur travail.

En savoir plus ici - Message de remédiation personnalisé GitGuardian CLI

Dépannage

Solutions courantes :

• Vérifiez l'authentification et la connexion internet
• Pour les instances self-hosted, vérifiez la clé API et l'URL
• Redémarrez votre IDE si les problèmes persistent
• Excluez les répertoires volumineux dans .gitguardian.yaml pour de meilleures performances

Besoin d'aide ? Consultez notre documentation, notre dépôt GitHub, ou contactez le support.