Skip to main content

Configuration de l’analyse des secrets pour vos dépôts

Vous pouvez configurer la façon dont GitHub recherche dans vos dépôts des secrets divulgués et génère des alertes.

Who can use this feature

People with admin permissions to a public repository can enable secret scanning for the repository.

Les Secret scanning alerts for partners s’exécutent automatiquement sur les dépôts publics dans tous les produits sur GitHub.com. Les Secret scanning alerts for users sont disponibles dans les dépôts publics ainsi que dans les dépôts détenus par des organisations qui utilisent GitHub Enterprise Cloud et qui disposent d’une licence pour GitHub Advanced Security.

Les Pour plus d’informations, consultez « À propos des secret scanning alerts for users » et « À propos de la GitHub Advanced Security ».

Activation de secret scanning alerts for users

Remarque : la fonctionnalité secret scanning alerts for users est disponible en version bêta pour les utilisateurs des plans GitHub Free, GitHub Pro ou GitHub Team et est susceptible d’être modifiée.

Vous pouvez activer secret scanning alerts for users pour tout dépôt free public dont vous êtes le propriétaire . Une fois activée, secret scanning recherche les secrets dans l’historique Git de toutes les branches présentes dans votre référentiel GitHub.

  1. Dans GitHub.com, accédez à la page principale du dépôt. 1. Sous le nom de votre dépôt, cliquez sur Paramètres. Bouton Paramètres du dépôt

  2. Dans la section « Sécurité » de la barre latérale, cliquez sur Sécurité et analyse du code.

  3. Faites défiler vers le bas de la page, puis cliquez sur Activer pour secret scanning. Si vous voyez un bouton Désactiver, cela signifie que l’secret scanning est déjà activée pour le dépôt. Activer l’secret scanning pour votre dépôt

Exclusion de répertoires de secret scanning alerts for users

Vous pouvez utiliser un fichier secret_scanning.yml pour exclure des répertoires de l’secret scanning. Par exemple, vous pouvez exclure des répertoires qui contiennent des tests ou du contenu généré de manière aléatoire.

  1. Dans GitHub.com, accédez à la page principale du dépôt. 1. Au-dessus de la liste des fichiers, en utilisant la liste déroulante Ajouter un fichier, cliquez sur Créer un fichier. « Créer un fichier » dans la liste déroulante « Ajouter un fichier »

  2. Dans le champ du nom de fichier, tapez .github/secret_scanning.yml.

  3. Sous Modifier le nouveau fichier, tapez paths-ignore: suivi des chemins que vous souhaitez exclure de l’secret scanning.

    paths-ignore:
      - "foo/bar/*.js"
    

    Vous pouvez utiliser des caractères spéciaux tels que * pour filtrer les chemins. Pour plus d’informations sur les modèles de filtre, consultez « Syntaxe de workflow pour GitHub Actions ».

    Remarques :

    • S’il y a plus de 1 000 entrées dans paths-ignore, l’secret scanning n’exclut que les 1 000 premiers répertoires des analyses.
    • Si la taille de secret_scanning.yml est supérieure à 1 Mo, l’secret scanning ignore la totalité du fichier.

Vous pouvez également ignorer des alertes individuelles de l’secret scanning. Pour plus d’informations, consultez « Gestion des alertes d’secret scanning ».