Aller au contenu principal

configuration de la machine ggshield

Description​

Configurez la protection ggshield sur cette machine.

ggshield machine setup [OPTIONS]

Configure toutes les protections en une seule exécution idempotente : le hook IA ggshield pour chaque assistant de code IA détecté, les hooks git globaux pre-commit/pre-push, et un honeytoken pour détecter les intrusions sur les endpoints. Peut être relancé en toute sécurité — il ajoute ce qui manque et laisse les entrées existantes intactes.

Chaque protection est activée par défaut ; désactivez-en une avec --no-ai-hooks, --no-git-hooks ou --no-honeytokens. --agent / --exclude-agent restreignent quels assistants reçoivent le hook IA. Lorsqu'elle est exécutée en tant que root (ou avec --system), les hooks git sont installés pour l'ensemble de la machine pour chaque utilisateur.

Enfin, cette commande enregistre cette machine et les utilisateurs cibles du honeytoken sur la page Endpoints, même avant le premier scan. Cette étape au mieux prend au maximum cinq secondes et ne modifie jamais le code de sortie. Elle est ignorée en CI, avec endpoint_registration: false dans .gitguardian.yaml, ou lorsque GGSHIELD_NO_ENDPOINT_REGISTRATION est défini à une valeur non vide.

Git est facultatif pour cette commande. Il n'est nécessaire que pour les hooks git ; sans lui, cette étape est ignorée avec un avertissement.

Options​

  • --no-ai-hooks : Ne pas configurer les hooks de l'assistant IA.
  • --no-git-hooks : Ne pas installer les hooks git globaux.
  • --no-honeytokens : Ne pas déployer de honeytoken sur cette machine.
  • --agent ASSISTANT : Configurer le hook IA uniquement pour ces assistants (répétable). Par défaut, tous les assistants détectés sur cette machine.
  • --exclude-agent ASSISTANT : Ignorer ces assistants lors de la configuration du hook IA (répétable).
  • --system : Installer les hooks git pour l'ensemble de la machine (tous les utilisateurs) au lieu de l'utilisateur courant. Implicite lors de l'exécution en tant que root, par exemple sous un MDM.

Cette commande prend en charge toutes les options globales de ggshield.