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 repository can enable secret scanning for the repository.

Les Secret scanning est disponible pour les référentiels détenus par l’organisation dans GitHub Enterprise Server si votre entreprise dispose d’une licence pour GitHub Advanced Security. Pour plus d’informations, consultez « À propos des secret scanning sur GitHub Enterprise Server » et « À propos de la GitHub Advanced Security ».

Remarque : votre administrateur de site doit activersecret scanning pour your GitHub Enterprise Server instance afin que vous puissiez utiliser cette fonctionnalité. Pour plus d’informations, consultez « Configuration de secret scanning pour votre appliance ».

Activation de secret scanning

Vous pouvez activer secret scanning pour tout dépôt appartenant à une organisation . 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 , 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. Si Advanced Security n’est pas déjà activé pour le dépôt, à droite de « GitHub Advanced Security », cliquez sur Activer. Activez GitHub Advanced Security pour votre dépôt

  4. Passez en revue l’impact de l’activation d’Advanced Security, puis cliquez sur Activer GitHub Advanced Security pour ce dépôt.

  5. Quand vous activez Advanced Security, l’secret scanning peut être automatiquement activée pour le dépôt en raison des paramètres de l’organisation. Si « Secret scanning » s’affiche avec un bouton Activer, vous devez toujours activer l’secret scanning en cliquant sur Activer. Si vous voyez un bouton Désactiver, l’secret scanning est déjà activée. Activer l’secret scanning pour votre dépôt

  6. Si vous souhaitez activer la protection des poussées, cliquez sur Activer à droite de « Protection des poussées ». Lorsque vous activez la protection des poussées, secret scanning vérifie également les poussées des secrets avec un taux de confiance élevé (ceux identifiés avec un taux faible de faux positifs). Secret scanning liste les secrets qu’elle détecte afin que l’auteur puisse passer en revue les secrets et les supprimer ou, si nécessaire, autoriser ces secrets à être poussés. Pour plus d’informations, consultez « Protection des poussées avec l’secret scanning ». Activer la protection des poussées pour votre dépôt

Exclusion de répertoires de secret scanning

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 , 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 ».

Pour aller plus loin