Definieren von benutzerdefinierten Mustern für die Geheimnisüberprüfung

Definieren eines benutzerdefinierten Musters mit Copilot

Sie können reguläre Copilot geheimen Scan Ausdrücke basierend auf einer Textbeschreibung des Typs des Musters generieren, das Sie erkennen möchten, einschließlich optionaler Beispielzeichenfolgen, die erkannt werden sollen. Weitere Informationen findest du unter Generieren regulärer Ausdrücke für benutzerdefinierte Muster mit der Copilot-Geheimnisüberprüfung.

Definieren eines benutzerdefinierten Musters für ein Repository

Bevor Sie ein benutzerdefiniertes Muster definieren, müssen Sie sicherstellen, dass sie Secret Protection in Ihrem Repository aktiviert ist. Weitere Informationen finden Sie unter Geheime Scans für Ihr Repository aktivieren.

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.

   

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

4. Klicken Sie unter "Secret Protection" rechts neben "Benutzerdefinierte Muster" auf "Neues Muster".

5. Gib die Details für dein neues benutzerdefiniertes Muster ein. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.

   1. Gib im Feld „Mustername“ einen Namen für dein Muster ein.
   2. Geben Sie im Feld "Geheimes Format" einen regulären Ausdruck für das Format Ihres geheimen Musters ein.
   3. Du kannst auf More options klicken, um weitere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das Geheimnisformat bereitzustellen. Weitere Informationen findest du unter Referenz zu benutzerdefinierten Mustern.
   4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.
   

6. Wenn Sie bereit sind, Ihr neues benutzerdefiniertes Muster zu testen, um Übereinstimmungen im Repository zu identifizieren, ohne Warnungen zu erstellen, klicken Sie auf Save and dry run (Speichern und Probelauf).

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

   

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

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

10. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren. Weitere Informationen finden Sie unter Informationen zum Pushschutz.

    Hinweis

    Die Schaltfläche „Enable“ ist erst verfügbar, nachdem der Testlauf erfolgreich abgeschlossen wurde und du das Muster veröffentlicht hast.

Nachdem Ihr Muster erstellt wurde, finden Sie weitere Informationen darüber, wie Sie anzeigen können, unter AUTOTITLE.

Erstellen eines benutzerdefinierten Musters für eine Organisation

Bevor Sie ein benutzerdefiniertes Muster definieren, müssen Sie sicherstellen, dass Sie secret scanning für die Repositories aktivieren, die Sie in Ihrer Organisation überprüfen möchten. Sie können security configurations verwenden, um secret scanning in allen Repositorys Ihrer Organisation zu aktivieren. Weitere Informationen finden Sie unter Informationen zum Aktivieren von Sicherheitsfunktionen in großem Umfang.

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

2. Wählen Sie eine Organisation aus, indem Sie darauf klicken.

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

   

4. Wählen Sie im Abschnitt "Sicherheit" der Randleiste das Advanced Security Dropdownmenü aus, und klicken Sie dann auf Global settings.

5. Klicken Sie unter "Benutzerdefinierte Muster" auf "Neues Muster".

6. Gib die Details für dein neues benutzerdefiniertes Muster ein. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.

   1. Gib im Feld „Mustername“ einen Namen für dein Muster ein.
   2. Geben Sie im Feld "Geheimes Format" einen regulären Ausdruck für das Format Ihres geheimen Musters ein.
   3. Du kannst auf More options klicken, um weitere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das Geheimnisformat bereitzustellen. Weitere Informationen findest du unter Referenz zu benutzerdefinierten Mustern.
   4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.
   

7. Wenn du bereit bist, dein neues benutzerdefiniertes Muster zu testen, um Übereinstimmungen in bestimmten Repositories zu identifizieren, ohne dabei Warnungen zu generieren, klicke auf Speichern und Probelauf.

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

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

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.

    

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.

13. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren. Weitere Informationen finden Sie unter Informationen zum Pushschutz.

    Hinweis

    • Die Option zum Aktivieren des Pushschutzes ist nur für veröffentlichte Muster sichtbar.
    • Der Pushschutz für benutzerdefinierte Muster wird nur auf Repositorys in deiner Organisation angewendet, bei denen die secret scanning als Pushschutz aktiviert ist.
    • Die Aktivierung des Pushschutzes für häufig vorkommende benutzerdefinierte Muster kann für Mitwirkende störend sein.

Nachdem Ihr Muster erstellt wurde, sucht secret scanning nach Geheimnissen in Repositorys in Ihrer Organisation und durchsucht dabei auch den gesamten Git-Verlauf in allen Zweigen. Organisationsbesitzer und Repositoryadministratoren erhalten Warnungen zu allen gefundenen Geheimnissen und können die Warnung im Repository überprüfen, in dem das Geheimnis gefunden wurde. Weitere Informationen zum Anzeigen von Warnungen zur Geheimnisüberprüfung sehen Sie unter Verwalten von Warnungen zur Geheimnisüberprüfung.

Definieren eines benutzerdefinierten Musters für ein Unternehmenskonto

1. Navigieren Sie zu Ihrem Unternehmen. Beispielsweise auf der Seite Unternehmen in GitHub.com.

2. Klicke oben auf der Seite auf Policies.

3. Klicke unter „Policies“ auf Advanced Security.

4. Klicken Sie unter "Advanced Security" auf "Sicherheitsfeatures".

5. Klicke unter „Benutzerdefinierte Muster zur Geheimnisüberprüfung“ auf Neues Muster.

6. Gib die Details für dein neues benutzerdefiniertes Muster ein. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.

   1. Gib im Feld „Mustername“ einen Namen für dein Muster ein.
   2. Geben Sie im Feld "Geheimes Format" einen regulären Ausdruck für das Format Ihres geheimen Musters ein.
   3. Du kannst auf More options klicken, um weitere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das Geheimnisformat bereitzustellen. Weitere Informationen findest du unter Referenz zu benutzerdefinierten Mustern.
   4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.
   

7. Wenn du dein neues benutzerdefiniertes Muster testen möchtest, um Übereinstimmungen im Unternehmen zu identifizieren, ohne Warnungen zu erstellen, klicke auf Speichern und Probelauf.

8. Du kannst nach Repositorys suchen und bis zu zehn Repositorys für den Probelauf auswählen.

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

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.

    

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.

13. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren. Weitere Informationen finden Sie unter Informationen zum Pushschutz.

    Hinweis

    • Um den Pushschutz für benutzerdefinierte Muster zu ermöglichen, muss der secret scanning als Pushschutz auf Unternehmensebene aktiviert werden.
    • Die Aktivierung des Pushschutzes für häufig vorkommende benutzerdefinierte Muster kann für Mitwirkende störend sein.

Nachdem Ihr Muster erstellt wurde, secret scanning sucht nach Geheimnissen in Repositorys in Ihren Organisationen mit aktiviertem GitHub Secret Protection, einschließlich des gesamten Git-Verlaufs in allen Branches. Organisationsbesitzer und Repositoryadministratoren erhalten Warnungen zu allen gefundenen Geheimnissen und können die Warnung im Repository überprüfen, in dem das Geheimnis gefunden wurde. Weitere Informationen zur Ansicht von Warnungen zur Geheimnisüberprüfungfinden Sie unter Verwalten von Warnungen zur Geheimnisüberprüfung.

Weiterführende Lektüre

• Verwalten von benutzerdefinierten Mustern
• Anzeigen von Metriken für benutzerdefinierte Muster