Defining custom patterns for secret scanning

Defining a custom pattern with Copilot

You can use Analyse des secrets avec Copilot to generate regular expressions based on a text description of the type of pattern you would like to detect, including optional example strings that should be detected. See Générateur d’expressions régulières pour des modèles personnalisés avec Copilot secret scanning.

Defining a custom pattern for a repository

Before defining a custom pattern, you must ensure that Secret Protection is enabled on your repository. For more information, see Enabling secret scanning for your repository.

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la section « Sécurité » de la barre latérale, cliquez sur Advanced Security.

4. Under "Secret Protection", to the right of "Custom patterns", click New pattern.

5. Entrez les détails de votre nouveau modèle personnalisé. Vous devez au moins fournir le nom de votre modèle, ainsi qu’une expression régulière pour le format de votre modèle de secret.

   1. Dans le champ Nom du modèle, saisissez un nom pour votre modèle.
   2. Dans le champ « Format secret », tapez une expression régulière pour le format de votre modèle secret.
   3. Vous pouvez cliquer sur Plus d'options pour fournir d'autres contenus contextuels ou des critères supplémentaires pour la correspondance pour le format secret. Consultez Informations de référence sur les modèles personnalisés.
   4. Fournissez un exemple de chaîne de test pour vérifier que votre configuration correspond aux modèles que vous attendez.
   

6. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click Save and dry run.

7. Une fois le test à blanc terminé, vous voyez un échantillon de résultats (jusqu’à 1000). Passez en revue les résultats et identifiez les faux résultats positifs.

   

8. Modifiez le nouveau modèle personnalisé pour résoudre les problèmes liés aux résultats, puis cliquez sur Enregistrer et effectuer un test à blanc pour tester vos modifications.

9. Quand vous êtes satisfait de votre nouveau modèle personnalisé, cliquez sur Publier le modèle.

10. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    Remarque

    The "Enable" button isn't available until after the dry run succeeds and you publish the pattern.

After your pattern is created, secret scanning recherche les secrets dans l’historique Git de toutes les branches présentes dans votre référentiel GitHub. For more information on viewing Alertes de détection de secrets, see Gérer les alertes d’analyse des secrets.

Defining a custom pattern for an organization

Before defining a custom pattern, you must ensure that you enable secret scanning for the repositories that you want to scan in your organization. You can use security configurations to enable secret scanning on all repositories in your organization. For more information, see Enabling security features at scale.

1. Dans le coin supérieur droit de GitHub, cliquez sur votre photo de profil, puis sur Vos organisations.

2. Sélectionnez une organisation en cliquant dessus.

3. Sous le nom de votre organisation, cliquez sur Settings. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

4. In the "Security" section of the sidebar, select the Advanced Security dropdown menu, then click Global settings.

5. Sous « Modèles personnalisés », cliquez sur Nouveau modèle.

6. Entrez les détails de votre nouveau modèle personnalisé. Vous devez au moins fournir le nom de votre modèle, ainsi qu’une expression régulière pour le format de votre modèle de secret.

   1. Dans le champ Nom du modèle, saisissez un nom pour votre modèle.
   2. Dans le champ « Format secret », tapez une expression régulière pour le format de votre modèle secret.
   3. Vous pouvez cliquer sur Plus d'options pour fournir d'autres contenus contextuels ou des critères supplémentaires pour la correspondance pour le format secret. Consultez Informations de référence sur les modèles personnalisés.
   4. Fournissez un exemple de chaîne de test pour vérifier que votre configuration correspond aux modèles que vous attendez.
   

7. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click Save and dry run.

8. Sélectionnez les référentiels dans lesquels vous souhaitez effectuer le test.

   • Pour effectuer l’exécution sèche dans l’ensemble de l’organisation, sélectionnez Tous les référentiels de l’organisation.
   • Pour spécifier les référentiels dans lesquels vous souhaitez effectuer le test, sélectionnez Référentiels sélectionnés, puis recherchez et sélectionnez jusqu’à 10 référentiels.

9. Lorsque vous êtes prêt à tester votre nouveau modèle personnalisé, cliquez sur Exécuter.

10. Une fois le test à blanc terminé, vous voyez un échantillon de résultats (jusqu’à 1000). Passez en revue les résultats et identifiez les faux résultats positifs.

    

11. Modifiez le nouveau modèle personnalisé pour résoudre les problèmes liés aux résultats, puis cliquez sur Enregistrer et effectuer un test à blanc pour tester vos modifications.

12. Quand vous êtes satisfait de votre nouveau modèle personnalisé, cliquez sur Publier le modèle.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    Remarque

    • L'option permettant d'activer la protection push n'est visible que pour les modèles publiés.
    • La protection push pour les modèles personnalisés s'applique uniquement aux dépôts de votre organisation pour lesquels l'option secret scanning est activée en tant que protection push.
    • L’activation de la protection des envois (push) pour les modèles personnalisés courants peut entraîner des perturbations pour les contributeurs.

After your pattern is created, secret scanning scans for any secrets in repositories in your organization, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found and can review the alert in the repository where the secret is found. For more information on viewing Alertes de détection de secrets, see Gérer les alertes d’analyse des secrets.

Defining a custom pattern for an enterprise account

1. Accédez à votre entreprise. Par exemple, depuis la page Entreprises sur GitHub.com.

2. En haut de la page, cliquez sur Stratégies.

3. Sous  » Politiques », cliquez sur Advanced SecurityCode security.

4. Under "Advanced SecurityCode security", click Security features.

5. Under "Secret scanning custom patterns", click New pattern.

6. Entrez les détails de votre nouveau modèle personnalisé. Vous devez au moins fournir le nom de votre modèle, ainsi qu’une expression régulière pour le format de votre modèle de secret.

   1. Dans le champ Nom du modèle, saisissez un nom pour votre modèle.
   2. Dans le champ « Format secret », tapez une expression régulière pour le format de votre modèle secret.
   3. Vous pouvez cliquer sur Plus d'options pour fournir d'autres contenus contextuels ou des critères supplémentaires pour la correspondance pour le format secret. Consultez Informations de référence sur les modèles personnalisés.
   4. Fournissez un exemple de chaîne de test pour vérifier que votre configuration correspond aux modèles que vous attendez.
   

7. When you're ready to test your new custom pattern, to identify matches in the enterprise without creating alerts, click Save and dry run.

8. Recherchez et sélectionnez jusqu’à 10 référentiels dans lesquels vous souhaitez effectuer le test.

9. Lorsque vous êtes prêt à tester votre nouveau modèle personnalisé, cliquez sur Exécuter.

10. Une fois le test à blanc terminé, vous voyez un échantillon de résultats (jusqu’à 1000). Passez en revue les résultats et identifiez les faux résultats positifs.

    

11. Modifiez le nouveau modèle personnalisé pour résoudre les problèmes liés aux résultats, puis cliquez sur Enregistrer et effectuer un test à blanc pour tester vos modifications.

12. Quand vous êtes satisfait de votre nouveau modèle personnalisé, cliquez sur Publier le modèle.

13. Optionally, to enable push protection for your custom pattern, click Enable. For more information, see Push protection.

    Remarque

    • Pour rendre possible la protection des envois (push) dans le cadre des modèles personnalisés, l’secret scanning doit être activée comme protection des envois (push) au niveau de l’entreprise.
    • L’activation de la protection des envois (push) pour les modèles personnalisés courants peut entraîner des perturbations pour les contributeurs.

After your pattern is created, secret scanning scans for any secrets in repositories within your organizations with GitHub Secret Protection enabled, including their entire Git history on all branches. Organization owners and repository administrators will be alerted to any secrets found, and can review the alert in the repository where the secret is found. For more information on viewing Alertes de détection de secrets, see Gérer les alertes d’analyse des secrets.