Composant GitLeaks GitLab CI

Un composant GitLab CI pour Gitleaks - un outil SAST pour détecter et prévenir les secrets codés en dur comme les mots de passe, les clés API et les jetons dans les dépôts git.

Fonctionnalités

• Détection de secrets : Analyse les dépôts à la recherche de secrets codés en dur et d'informations sensibles
• Règles complètes : Ensemble étendu de règles intégrées pour détecter divers types de secrets
• Configuration personnalisée : Prise en charge des fichiers de configuration locaux et distants
• Formats de sortie multiples : Prise en charge des formats JSON, SARIF et autres formats de rapport
• Arguments flexibles : Transmettez des indicateurs supplémentaires directement à Gitleaks
• Configuration à distance : Téléchargez et utilisez des fichiers de configuration depuis des URL distantes
• Paramètres de travail configurables : Personnalisez le nom du travail, l'étape et l'image du conteneur

Utilisation

Utilisation de base

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest

stages:
  - test

Avec configuration personnalisée

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_CONFIG: ".gitleaks.toml"
      GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"

stages:
  - test

Avec configuration à distance

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"

stages:
  - test

Entrées

Fichiers de configuration

Configuration locale

Placez un fichier .gitleaks.toml à la racine de votre dépôt ou spécifiez le chemin à l'aide de GITLEAKS_CONFIG.

Configuration à distance

Définissez GITLEAKS_REMOTE_CONFIG pour télécharger un fichier de configuration depuis une URL. Utile pour partager des configurations entre plusieurs projets.

Configuration par défaut

Si aucune configuration locale ou distante n'est spécifiée, le composant utilisera les règles intégrées par défaut de Gitleaks.

Artefacts

Le composant génère les artefacts suivants :

• gitleaks-report.json : Résultats d'analyse au format JSON (ou autre format selon l'argument --report-format)

Documentation

Pour plus d'informations sur la configuration et les options de Gitleaks, consultez :

• Documentation Gitleaks
• Guide de configuration
• Options de la ligne de commande