Generating regular expressions for custom patterns with Copilot secret scanning

You can use Analyse des secrets Copilot's générateur d’expressions régulières to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.

Qui peut utiliser cette fonctionnalité ?

Propriétaires de référentiels, propriétaire d’organisations, gestionnaires de sécurité et utilisateurs avec le rôle d’administrateur

Dans cet article

Generating a regular expression for a repository with Analyse des secrets Copilot

Note

Vous n’avez pas besoin d’un abonnement à GitHub Copilot pour utiliser le générateur d’expressions régulières de Analyse des secrets Copilot. Les fonctionnalités de Analyse des secrets Copilot sont disponibles pour les référentiels privés dans les entreprises GitHub Enterprise Cloud avec GitHub Advanced Security activée.

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

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

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

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

  4. Sous « Sécurité et analyse du code », recherchez « GitHub Advanced Security ».

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

  6. Dans le champ Nom du modèle, saisissez un nom pour votre modèle.

  7. En haut à droite, cliquez sur Générer avec l’IA.

    Remarque : vous pouvez entrer manuellement une expression régulière au lieu d’utiliser le générateur en tapant une expression régulière pour le format de votre modèle secret dans le champ Format secret. Pour plus d’informations, consultez « Définition d’un modèle personnalisé pour un référentiel » ou « Définition d’un modèle personnalisé pour une organisation ».

  8. Dans le panneau glissant qui s’affiche :

    • Complétez le champ Je veux une expression régulière qui, décrivant, idéalement en langage clair, les modèles que vous souhaitez capturer pour votre expression régulière. Vous pouvez utiliser d’autres langages naturels, mais les performances peuvent ne pas être aussi bonnes que si vous utilisez l’anglais.

    • Complétez le champ Exemples de ce que je recherche en donnant un exemple de modèle que vous souhaitez rechercher.

    • Cliquez sur Générer des suggestions.

    • Vous pouvez cliquer sur une suggestion pour afficher une description de l’expression régulière.

    • Cliquez sur Utiliser les résultats dans la section Résultats qui s’affiche pour le résultat que vous souhaitez utiliser.

      Capture d’écran d’un formulaire de modèle d’secret scanning personnalisé rempli qui sera utilisé par le générateur.

  9. Vous pouvez cliquer sur Autres options pour fournir tout autre contenu environnant ou des exigences de correspondance supplémentaires pour le format du secret. GitHub ajoute les exemples que vous avez tapés dans le panneau glissant au champ Chaîne de test.

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

  11. 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.

    Capture d’écran montrant les résultats d’un test à blanc.

  12. 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.

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

Vous pouvez configurer secret scanning de sorte à vérifier les poussées en fonction de modèles personnalisés avant que les validations ne soient fusionnées dans la branche par défaut. Pour plus d’informations, consultez cet article.

Generating a regular expression for an organization with Analyse des secrets Copilot

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

  2. En regard de l’organisation, cliquez sur Paramètres.

  3. In the "Security" section of the sidebar, click Code security then Global settings.

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

  5. Dans le champ Nom du modèle, saisissez un nom pour votre modèle.

  6. En haut à droite, cliquez sur Générer avec l’IA.

    Remarque : vous pouvez entrer manuellement une expression régulière au lieu d’utiliser le générateur en tapant une expression régulière pour le format de votre modèle secret dans le champ Format secret. Pour plus d’informations, consultez « Définition d’un modèle personnalisé pour un référentiel » ou « Définition d’un modèle personnalisé pour une organisation ».

  7. Dans le panneau glissant qui s’affiche :

    • Complétez le champ Je veux une expression régulière qui, décrivant, idéalement en langage clair, les modèles que vous souhaitez capturer pour votre expression régulière. Vous pouvez utiliser d’autres langages naturels, mais les performances peuvent ne pas être aussi bonnes que si vous utilisez l’anglais.

    • Complétez le champ Exemples de ce que je recherche en donnant un exemple de modèle que vous souhaitez rechercher.

    • Cliquez sur Générer des suggestions.

    • Vous pouvez cliquer sur une suggestion pour afficher une description de l’expression régulière.

    • Cliquez sur Utiliser les résultats dans la section Résultats qui s’affiche pour le résultat que vous souhaitez utiliser.

      Capture d’écran d’un formulaire de modèle d’secret scanning personnalisé rempli qui sera utilisé par le générateur.

  8. Vous pouvez cliquer sur Autres options pour fournir tout autre contenu environnant ou des exigences de correspondance supplémentaires pour le format du secret. GitHub ajoute les exemples que vous avez tapés dans le panneau glissant au champ Chaîne de test.

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

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

    • Pour effectuer le test 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.

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

  12. 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.

    Capture d’écran montrant les résultats d’un test à blanc.

  13. 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.

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

Vous pouvez configurer secret scanning de sorte à vérifier les poussées en fonction de modèles personnalisés avant que les validations ne soient fusionnées dans la branche par défaut. Pour plus d’informations, consultez cet article.

Further reading