Skip to main content

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

Sie können eigene benutzerdefinierte Muster definieren, um die Funktionen von secret scanning zu erweitern, indem Sie einen oder mehrere reguläre Ausdrücke generieren.

Wer kann dieses Feature verwenden?

Warnungen zur Geheimnisüberprüfung für Partner wird automatisch in öffentlichen Repositorys und öffentlichen npm-Paketen ausgeführt, um Dienstanbieter über kompromittierte Geheimnisse auf GitHub.com zu informieren.

Warnungen zur Geheimnisüberprüfung für Benutzerinnen sind in allen öffentlichen Repositorys kostenlos verfügbar. Organisationen, die GitHub Enterprise Cloud mit einer Lizenz für GitHub Advanced Security verwenden, können Warnungen zur Geheimnisüberprüfung für Benutzerinnen für ihre privaten und internen Repositorys aktivieren. Weitere Informationen findest du unter Informationen zur Geheimnisüberprüfung und Informationen zu GitHub Advanced Security.

Informationen zum kostenlosen Testen von GitHub Advanced Security sind unter „Einrichten einer Testversion von GitHub Advanced Security“ zu finden.

Informationen zu benutzerdefinierten Mustern für secret scanning

Du kannst benutzerdefinierte Muster definieren, um Geheimnisse zu identifizieren, die nicht von den Standardmustern erkannt werden, die von secret scanning unterstützt werden. Beispielsweise hast du möglicherweise ein geheimes Muster, das intern für deine Organisation ist. Weitere Informationen zu den unterstützten Geheimnissen und Dienstanbietern finden Sie unter Geheimnisüberprüfungsmuster.

Du kannst benutzerdefinierte Muster für dein Unternehmen, deine Organisation oder dein Repository definieren. Secret scanning unterstützt bis zu 500 benutzerdefinierte Muster für jedes Organisations- oder Unternehmenskonto und bis zu 100 benutzerdefinierte Muster pro Repository.

Du kannst auch den Pushschutz für benutzerdefinierte Muster aktivieren. Weitere Informationen zum Pushschutz finden Sie unter Pushschutz für Repositorys und Organisationen.

Informationen zur Verwendung regulärer Ausdrücke für benutzerdefinierte Muster

Sie können benutzerdefinierte Muster für die secret scanning als einen oder mehrere reguläre Ausdrücke angeben.

Secret scanning verwendet die Hyperscan-Bibliothek und unterstützt nur Hyperscan-RegEx-Konstrukte, die eine Teilmenge der PCRE-Syntax sind. Hyperscan-Optionsmodifizierer werden nicht unterstützt. Weitere Informationen zu Hyperscan-Musterkonstrukten finden Sie in der Hyperscan-Dokumentation unter Musterunterstützung.

Reguläre Ausdrücke können manuell eingegeben oder mithilfe des Generators für den regulären Ausdruck generiert werden.

Syntax für reguläre Ausdrücke zur manuellen Definition benutzerdefinierter Muster

Der Abschnitt Weitere Optionen in der Benutzeroberfläche hilft Ihnen beim manuellen Schreiben regulärer Ausdrücke.

  • Geheimnisformat: ein Ausdruck, der das Format des Geheimnisses selbst beschreibt.
  • Vor dem Geheimnis: ein Ausdruck, der die Zeichen beschreibt, die vor dem Geheimnis kommen. Dies ist standardmäßig auf \A|[^0-9A-Za-z] festgelegt, was bedeutet, dass das Geheimnis am Anfang einer Zeile sein muss oder ihm ein nicht alphanumerisches Zeichen vorangestellt werden muss.
  • Nach dem Geheimnis: ein Ausdruck, der die Zeichen beschreibt, die nach dem Geheimnis kommen. Dies ist standardmäßig auf \z|[^0-9A-Za-z] festgelegt, was bedeutet, dass dem Geheimnis eine neue Zeile oder ein nicht alphanumerisches Zeichen folgen muss.
  • Zusätzliche Übereinstimmungsanforderungen: mindestens ein optionaler Ausdruck, dem das Geheimnis entsprechen muss oder nicht entsprechen darf.

Für einfache Token musst du normalerweise nur ein Geheimnisformat angeben. Die anderen Felder bieten Flexibilität, sodass du komplexere Geheimnisse angeben kannst, ohne komplexe reguläre Ausdrücke zu erstellen. Ein Beispiel für ein benutzerdefiniertes Muster finden Sie unter Beispiel für ein benutzerdefiniertes Muster, das mithilfe zusätzlicher Anforderungen angegeben wird.

Verwenden des Generators für reguläre Ausdrücke

Der Generator verwendet ein generatives KI-Modell, bei dem Sie eine Textbeschreibung des Mustertyps eingeben, das Sie erkennen möchten, einschließlich optionaler Beispielzeichenfolgen, die erkannt werden sollen. Das Modell gibt bis zu drei reguläre Ausdrücke zurück, die Sie überprüfen können. Weitere Informationen finden Sie unter „Informationen zum Generator für reguläre Ausdrücke für benutzerdefinierte Muster“ und „Generieren regulärer Ausdrücke für benutzerdefinierte Muster mit KI“.

Definieren eines benutzerdefinierten Musters für ein Repository

Bevor du ein benutzerdefiniertes Muster definierst, musst du sicherstellen, dass secret scanning im Repository aktiviert ist. Weitere Informationen findest du unter Konfigurieren der Geheimnisüberprüfung für deine Repositorys.

  1. Navigiere auf GitHub.com zur Hauptseite des Repositorys.

  2. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. 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 „Sicherheit“ auf der Randleiste auf Codesicherheit und -analyse.

  4. Suche unter „Codesicherheit und Analyse“ GitHub Advanced Security".

  5. Klicke unter Secret scanning 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. Alternativ können Sie den Generator verwenden, um einen regulären Ausdruck für Sie zu generieren. Weitere Informationen findest du unter Generieren regulärer Ausdrücke für benutzerdefinierte Muster mit KI.
    3. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.
    4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.

    Screenshot: ausgefülltes benutzerdefiniertes secret scanning-Musterformular

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

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

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

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

  11. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren.

    Hinweis: Die Schaltfläche „Aktivieren“ ist erst verfügbar, wenn der Testlauf erfolgreich war und du das Muster veröffentlichst.

    Weitere Informationen zum Pushschutz finden Sie unter Pushschutz für Repositorys und Organisationen.

Nachdem dein Muster erstellt wurde, secret scanning sucht in Ihrem gesamten Git-Verlauf auf allen Branches, die in Ihrem GitHub-Repository vorhanden sind, nach Geheimnissen. Weitere Informationen zum Anzeigen von Warnungen zur Geheimnisüberprüfung finden Sie unter Verwalten von Warnungen aus der Geheimnisüberprüfung.

Beispiel für ein benutzerdefiniertes Muster, das mithilfe zusätzlicher Anforderungen angegeben ist

Ein Unternehmen verfügt über ein internes Token mit fünf Merkmalen. Du verwendest die verschiedenen Felder, um anzugeben, wie Token wie folgt identifiziert werden:

MerkmalFeld und regulärer Ausdruck
Länge zwischen 5 und 10 ZeichenGeheimnisformat: [$#%@AA-Za-z0-9]{5,10}
Endet nicht mit .Nach dem Geheimnis: [^\.]
Enthält Zahlen und GroßbuchstabenZusätzliche Anforderungen: Geheimnis muss mit [A-Z] und [0-9] übereinstimmen
Enthält nicht mehr als einen Kleinbuchstaben in einer ZeileZusätzliche Anforderungen: Geheimnis darf nicht mit [a-z]{2,} übereinstimmen
Enthält eines der folgenden Zeichen: $%@!Zusätzliche Anforderungen: Geheimnis muss mit [$%@!] übereinstimmen

Diese Token entsprechen dem oben beschriebenen benutzerdefinierten Muster:

a9@AAfT!         # Secret string match: a9@AAfT
ee95GG@ZA942@aa  # Secret string match: @ZA942@a
a9@AA!ee9        # Secret string match: a9@AA

Diese Zeichenfolgen entsprechen nicht dem oben beschriebenen benutzerdefinierten Muster:

a9@AA.!
a@AAAAA
aa9@AA!ee9
aAAAe9

Definieren eines benutzerdefinierten Musters für eine Organisation

Bevor du ein benutzerdefiniertes Muster definierst, musst du sicherstellen, dass du secret scanning für die Repositorys aktivierst, die du in deiner Organisation überprüfen möchtest. Informationen zum Aktivieren von secret scanning für alle Repositorys in deiner Organisation finden Sie unter Verwalten von Sicherheits- und Analyseeinstellungen für deine Organisation.

  1. Wähle in der oberen rechten Ecke von GitHub.com dein Profilfoto aus. Klicke dann auf Deine Organisationen.

    Screenshot des Dropdownmenüs unter dem Profilbild von @octocat. „Deine Organisationen“ ist in dunklem Orange eingerahmt.

  2. Klicke neben der Organisation auf Einstellungen.

  3. Klicke im Abschnitt „Sicherheit“ auf der Randleiste auf Codesicherheit und -analyse.

  4. Suche unter „Codesicherheit und Analyse“ GitHub Advanced Security".

  5. Klicke unter Secret scanning 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. Alternativ können Sie den Generator verwenden, um einen regulären Ausdruck für Sie zu generieren. Weitere Informationen findest du unter Generieren regulärer Ausdrücke für benutzerdefinierte Muster mit KI.
    3. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.
    4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.

    Screenshot: ausgefülltes benutzerdefiniertes secret scanning-Musterformular

  7. Wenn du bereit bist, dein neues benutzerdefiniertes Muster zu testen, um Übereinstimmungen in bestimmten Repositorys zu identifizieren, ohne Warnungen zu erstellen, klicke auf Save and dry run (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ähle 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. 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.

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

    Hinweise:

    • Der Pushschutz für benutzerdefinierte Muster wird nur auf Repositorys in deiner Organisation angewendet, bei denen die secret scanning als Pushschutz aktiviert ist. Weitere Informationen findest du unter Pushschutz für Repositorys und Organisationen.
    • Die Aktivierung des Pushschutzes für häufig vorkommende benutzerdefinierte Muster kann für Mitwirkende störend sein.

Nachdem dein Muster erstellt wurde, sucht die secret scanning nach Geheimnissen in Repositorys in deiner Organisation, einschließlich ihres gesamten Git-Verlaufs auf 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 zum Anzeigen von Warnungen zur Geheimnisüberprüfung finden Sie unter Verwalten von Warnungen aus der Geheimnisüberprüfung.

Definieren eines benutzerdefinierten Musters für ein Unternehmenskonto

Bevor du ein benutzerdefiniertes Muster definierst, musst du sicherstellen, dass du die Geheimnisüberprüfung für dein Unternehmenskonto aktivierst. Weitere Informationen finden Sie unter Aktivieren von GitHub Advanced Security für dein Unternehmen.

Hinweise:

  • Auf Unternehmensebene kann nur der Ersteller eines benutzerdefinierten Musters das Muster bearbeiten und in einem Probelauf verwenden.
  • Du kannst einen Testlauf nur für Repositorys ausführen, auf die du Administratorzugriff hast. Unternehmensbesitzer*innen, die Zugriff zum Ausführen von Testläufen für ein Repository in einer Organisation wünschen, muss die Rolle „Organisationsbesitzer“ zugewiesen sein. Weitere Informationen findest du unter Verwalten deiner Rolle in einer Organisation, die deinem Unternehmen gehört.
  1. Klicke in der oberen rechten Ecke von GitHub.com auf dein Profilfoto und dann auf Deine Unternehmen.

  2. Klicke in der Liste der Unternehmen auf das Unternehmen, das du anzeigen möchtest.

  3. Wähle auf der Randleiste des Unternehmenskontos die Option Richtlinien aus. 1. Klicke unter „ Richtlinien“ auf Codesicherheit und -analyse.

  4. Klicke unter „Codesicherheit und -analyse“ 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. Alternativ können Sie den Generator verwenden, um einen regulären Ausdruck für Sie zu generieren. Weitere Informationen findest du unter Generieren regulärer Ausdrücke für benutzerdefinierte Muster mit KI.
    3. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.
    4. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.

    Screenshot: ausgefülltes benutzerdefiniertes secret scanning-Musterformular

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

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

    Hinweise:

    • Um den Pushschutz für benutzerdefinierte Muster zu aktivieren, muss die secret scanning als Pushschutz auf Unternehmensebene aktiviert werden. Weitere Informationen findest du unter Pushschutz für Repositorys und Organisationen.
    • Die Aktivierung des Pushschutzes für häufig vorkommende benutzerdefinierte Muster kann für Mitwirkende störend sein.

Nachdem dein Muster erstellt wurde, sucht die secret scanning nach Geheimnissen in Repositorys in den Organisationen deines Unternehmens, bei denen GitHub Advanced Security aktiviert ist, einschließlich ihres gesamten Git-Verlaufs auf 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 zum Anzeigen von Warnungen zur Geheimnisüberprüfung finden Sie unter Verwalten von Warnungen aus der Geheimnisüberprüfung.

Bearbeiten eines benutzerdefinierten Musters

Wenn du eine Änderung an einem benutzerdefinierten Muster speicherst, werden alle Warnungen zur Geheimnisüberprüfung geschlossen, die mit der vorherigen Version des Musters erstellt wurden.

  1. Navigiere zu der Stelle, an der das benutzerdefinierte Muster erstellt wurde. Ein benutzerdefiniertes Muster kann in einem Repository, einer Organisation oder einem Unternehmenskonto erstellt werden.

  2. Klicke unter „Secret scanning“ rechts neben dem benutzerdefinierten Muster, das du bearbeiten möchtest, auf .

  3. Wenn du bereit bist, dein bearbeitetes benutzerdefiniertes Muster zu testen, um Übereinstimmungen zu identifizieren, ohne Warnungen zu erstellen, klicke auf Speichern und Probelauf.

  4. Wenn du deine Änderungen überprüft und getestet hast, klicke auf Änderungen veröffentlichen.

  5. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren.

    Hinweis:

    • Der Pushschutz für benutzerdefinierte Muster wird nur auf Repositorys angewendet, bei denen die secret scanning als Pushschutz aktiviert ist. Weitere Informationen zum Aktivieren des Pushschutzes findest du unter Pushschutz für Repositorys und Organisationen.
    • Die Aktivierung des Pushschutzes für häufig vorkommende benutzerdefinierte Muster kann für Mitwirkende störend sein.

    Screenshot: Seite eines benutzerdefinierten Musters mit hervorgehobener Schaltfläche zum Aktivieren des Pushschutzes

  6. Klicke optional auf Deaktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu deaktivieren.

    Screenshot der Seite „Benutzerdefiniertes Muster“ mit der dunkelorange umrandeten Schaltfläche zum Deaktivieren des Pushschutzes.

Entfernen eines benutzerdefinierten Musters

  1. Navigiere zu der Stelle, an der das benutzerdefinierte Muster erstellt wurde. Ein benutzerdefiniertes Muster kann in einem Repository, einer Organisation oder einem Unternehmenskonto erstellt werden.
  2. Klicke rechts neben dem benutzerdefinierten Muster, das du entfernen möchtest, auf .
  3. Überprüfe die Bestätigung, und wähle eine Methode für den Umgang mit geöffneten Warnungen im Zusammenhang mit dem benutzerdefinierten Muster aus.
  4. Klicke auf Ja, dieses Muster löschen.

Metriken für benutzerdefinierte Muster

Organisationsbesitzer*innen und Personen mit Administratorberechtigungen können eine Übersicht über die Aktivität für benutzerdefinierte Muster anzeigen. Die Übersicht enthält Warnungs- und Pushschutzaktivitäten für das benutzerdefinierte Muster in den letzten 30 Tagen.

Hinweis: Metriken für benutzerdefinierte Muster sind als öffentliche Betaversion verfügbar und können sich ändern.

Anzeigen von Metriken für benutzerdefinierte Muster

  1. Navigiere zu der Stelle, an der das benutzerdefinierte Muster erstellt wurde. Ein benutzerdefiniertes Muster kann in einem Repository, einer Organisation oder einem Unternehmenskonto erstellt werden.
  2. Klicke unter „Secret scanning“ auf das benutzerdefinierte Muster, das du anzeigen möchtest.

Die Metriken werden unter dem Namen des benutzerdefinierten Musters angezeigt.