Generating regular expressions for custom patterns with Copilot secret scanning

You can use Copilot Geheimnisüberprüfung's Generator für reguläre Ausdrücke to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.

Wer kann dieses Feature verwenden?

Repositorybesitzerinnen, Organisationsbesitzerinnen, Sicherheitsmanagerinnen und Benutzerinnen mit der Administratorrolle

In diesem Artikel

Generating a regular expression for a repository with Copilot Geheimnisüberprüfung

Hinweis

Sie benötigen kein Abonnement für GitHub Copilot, um den Generator für reguläre Ausdrücke von GitHub Copilot nutzen zu können. Copilot Geheimnisüberprüfung-Features sind in Repositorys im Besitz von Organisationen und Unternehmen verfügbar, die GitHub Secret Protection aktiviert haben.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke unter dem Repositorynamen auf Settings. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  3. Klicke im Abschnitt „Security“ der Randleiste auf Advanced Security.

  4. Under "Secret Protection", under "Custom patterns", click New pattern.

  5. Geben Sie im Feld „Mustername“ einen Namen für Ihr Muster ein.

  6. Klicken Sie oben rechts auf Mit KI generieren.

    Hinweis

    Du kannst einen regulären Ausdruck manuell eingeben, anstatt den Generator zu verwenden, indem du einen regulären Ausdruck für das Format deines geheimen Musters im Feld „Secret format“ eingibst. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Repository oder Definieren eines benutzerdefinierten Musters für eine Organisation.

  7. Im Schiebebereich, der angezeigt wird:

    • Füllen Sie das Feld „Ich möchte einen regulären Ausdruck“ aus, der im Idealfall in einfachem Englisch beschreibt, welche Muster der reguläre Ausdruck erfassen soll. Sie können andere natürliche Sprachen verwenden, aber die Leistung ist möglicherweise nicht so gut wie bei Englisch.

    • Füllen Sie das Feld „Beispiele für das Gesuchte“ aus, und geben Sie ein Beispiel für ein Muster, nach dem Sie suchen möchten.

    • Klicken Sie auf Vorschläge generieren.

    • Klicken Sie optional auf einen Vorschlag, um eine Beschreibung des regulären Ausdrucks anzuzeigen.

    • Klicken Sie auf Ergebnisse verwenden, das angezeigt wird, für das Ergebnis, das Sie verwenden möchten.

      Screenshot eines ausgefüllten benutzerdefinierten secret scanning Musterformulars, das der Generator verwenden soll.

  8. Du kannst auf More options klicken, um weitere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das Geheimnisformat bereitzustellen. GitHub fügt die Beispiele hinzu, die Sie im Schiebebereich eingegeben haben, zum Feld Zeichenfolge testen.

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

  10. Wenn der Probelauf abgeschlossen ist, wird eine Auswahl der Ergebnisse (bis zu 1000) angezeigt. Überprüfe die Ergebnisse, und identifiziere alle falsch positiven Ergebnisse.

    Screenshot mit Ergebnissen aus dem Probelauf

  11. Bearbeite das neue benutzerdefinierte Muster, um Probleme mit den Ergebnissen zu beheben, und klicke dann auf Speichern und Probelauf ausführen, um deine Änderungen zu testen.

  12. Wenn du mit deinem neuen benutzerdefinierten Muster zufrieden bist, klicke auf Muster veröffentlichen.

Sie können secret scanning so konfigurieren, dass Pushes auf benutzerdefinierte Muster überprüft werden, bevor Commits mit dem Standardbranch zusammengeführt werden. Weitere Informationen findest du unter Aktivieren des Push-Schutzes für ein benutzerdefiniertes Muster.

Generating a regular expression for an organization with Copilot Geheimnisüberprüfung

  1. Klicke in der rechten oberen Ecke von GitHub auf dein Profilbild und dann auf Your organizations.

  2. Klicke neben der Organisation auf Einstellungen.

  3. Klicke im Abschnitt „Security“ der Randleiste auf Advanced Security und anschließend auf Global settings.

  4. Klicken Sie unter „Benutzerdefinierte Muster“ auf Neues Muster.

  5. Geben Sie im Feld „Mustername“ einen Namen für Ihr Muster ein.

  6. Klicken Sie oben rechts auf Mit KI generieren.

    Hinweis

    Du kannst einen regulären Ausdruck manuell eingeben, anstatt den Generator zu verwenden, indem du einen regulären Ausdruck für das Format deines geheimen Musters im Feld „Secret format“ eingibst. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Repository oder Definieren eines benutzerdefinierten Musters für eine Organisation.

  7. Im Schiebebereich, der angezeigt wird:

    • Füllen Sie das Feld „Ich möchte einen regulären Ausdruck“ aus, der im Idealfall in einfachem Englisch beschreibt, welche Muster der reguläre Ausdruck erfassen soll. Sie können andere natürliche Sprachen verwenden, aber die Leistung ist möglicherweise nicht so gut wie bei Englisch.

    • Füllen Sie das Feld „Beispiele für das Gesuchte“ aus, und geben Sie ein Beispiel für ein Muster, nach dem Sie suchen möchten.

    • Klicken Sie auf Vorschläge generieren.

    • Klicken Sie optional auf einen Vorschlag, um eine Beschreibung des regulären Ausdrucks anzuzeigen.

    • Klicken Sie auf Ergebnisse verwenden, das angezeigt wird, für das Ergebnis, das Sie verwenden möchten.

      Screenshot eines ausgefüllten benutzerdefinierten secret scanning Musterformulars, das der Generator verwenden soll.

  8. Du kannst auf More options klicken, um weitere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das Geheimnisformat bereitzustellen. GitHub fügt die Beispiele hinzu, die Sie im Schiebebereich eingegeben haben, zum Feld Zeichenfolge testen.

  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. Wähle die Repositorys aus, in denen du den Probelauf ausführen möchtest.

    • Um den Probelauf in der gesamten Organisation auszuführen, wählen Sie Alle Repositorys in der Organisation aus.
    • Wenn du die Repositorys angeben möchtest, in denen der Probelauf ausgeführt werden soll, klicke auf Ausgewählte Repositorys, suche dann bis zu 10 Repositorys, und wähle sie aus.

  11. Klicke auf Ausführen, wenn du bereit bist, das neue benutzerdefinierte Muster zu testen.

  12. Wenn der Probelauf abgeschlossen ist, wird eine Auswahl der Ergebnisse (bis zu 1000) angezeigt. Überprüfe die Ergebnisse, und identifiziere alle falsch positiven Ergebnisse.

    Screenshot mit Ergebnissen aus dem Probelauf

  13. Bearbeite das neue benutzerdefinierte Muster, um Probleme mit den Ergebnissen zu beheben, und klicke dann auf Speichern und Probelauf ausführen, um deine Änderungen zu testen.

  14. Wenn du mit deinem neuen benutzerdefinierten Muster zufrieden bist, klicke auf Muster veröffentlichen.

Sie können secret scanning so konfigurieren, dass Pushes auf benutzerdefinierte Muster überprüft werden, bevor Commits mit dem Standardbranch zusammengeführt werden. Weitere Informationen findest du unter Aktivieren des Push-Schutzes für ein benutzerdefiniertes Muster.

Further reading