Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

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

Du kannst secret scanning erweitern, um Geheimnisse zu erkennen, die über die Standardmuster hinausgehen.

Secret scanning alerts for partners wird automatisch in öffentlichen Repositorys ausgeführt. Wenn du über eine Lizenz für GitHub Advanced Security verfügst, kannst du secret scanning alerts for users für jedes Repository im Besitz einer Organisation aktivieren und konfigurieren. Weitere Informationen findest du unter Informationen zu secret scanning alerts for users und Informationen zu GitHub Advanced Security.

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 Details zu unterstützten Geheimnissen und Dienstanbietern findest du unter Secret scanning-Muster.

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 Aktivieren des Pushschutzes findest du unter Schützen von Pushes mit der Geheimnisüberprüfung.

Syntax regulärer Ausdrücke für benutzerdefinierte Muster

Du kannst benutzerdefinierte Muster für die secret scanning als einen oder mehrere reguläre Ausdrücke angeben.

  • 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 findest du unter Beispiel für ein benutzerdefiniertes Muster, das mithilfe zusätzlicher Anforderungen angegeben wird.

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 findest du in der Hyperscan-Dokumentation unter Musterunterstützung.

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 von secret scanning für deine Repositorys.

  1. Navigiere auf GitHub.com zur Hauptseite des Repositorys. 1. Klicke unter dem Repositorynamen auf Einstellungen. Schaltfläche „Repositoryeinstellungen“

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

  3. Suche unter „Codesicherheit und Analyse“ GitHub Advanced Security". 1. Klicke unter Secret scanning unter „Benutzerdefinierte Muster“ auf Neues Muster. 1. Gib die Details für ihr neues benutzerdefiniertes Muster ein:

  4. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.

  5. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.

  6. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.  Erstellen eines benutzerdefinierten secret scanning-Musterformulars

  7. Wenn du bereit bist, dein neues benutzerdefiniertes Muster zu testen, um Übereinstimmungen im Repository zu identifizieren, ohne Warnungen zu erstellen, klicke 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 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. 1. 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.

    Hinweis:

    • Der Pushschutz für benutzerdefinierte Muster wird nur auf Repositorys angewendet, bei denen die secret scanning als Pushschutz aktiviert ist. Weitere Informationen findest du unter Aktivieren der secret scanning als Pushschutz für ein Repository.
    • 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

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 secret scanning alerts findest du unter Verwalten von Warnungen aus der secret scanning.

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 findest du unter Verwalten von Sicherheits- und Analyseeinstellungen für deine Organisation.

  1. Klicke in der oberen rechten Ecke von GitHub.com auf dein Profilfoto, und klicke dann auf Deine Organisationen. Deine Organisationen im Profilmenü 2. Klicke neben der Organisation auf Einstellungen. Schaltfläche „Einstellungen“

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

  3. Suche unter „Codesicherheit und Analyse“ GitHub Advanced Security". 1. Klicke unter Secret scanning unter „Benutzerdefinierte Muster“ auf Neues Muster. 1. Gib die Details für ihr neues benutzerdefiniertes Muster ein:

  4. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.

  5. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.

  6. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.  Erstellen eines benutzerdefinierten secret scanning-Musterformulars

  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. Screenshot: ausgewählte Repositorys für den Probelauf
    • 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. Screenshot: ausgewählte Repositorys für den Probelauf
  9. Klicke auf Ausführen, wenn du bereit bist, das neue benutzerdefinierte Muster zu testen. 1. 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 Probelauf

  10. 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. 1. 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:

    • 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 Aktivieren der secret scanning als Pushschutz für eine Organisation.
    • 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

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 secret scanning alerts findest du unter Verwalten von Warnungen aus der secret scanning.

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 findest du 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.
  • Unternehmensbesitzer können Probeläufe nur für Repositorys verwenden, auf die sie Zugriff haben, und Unternehmensbesitzer verfügen nicht unbedingt über Zugriff auf alle Organisationen oder Repositorys innerhalb des Unternehmens.
  1. Klicke in der oberen rechten Ecke von GitHub.com auf dein Profilfoto und dann auf Deine Unternehmen. „Deine Unternehmen“ im Dropdownmenü für das Profilfoto auf GitHub Enterprise Cloud

  2. Klicke in der Liste der Unternehmen auf das Unternehmen, das du anzeigen möchtest. Name eines Unternehmens in der Liste deiner Unternehmen

  3. Klicke in der Unternehmensrandleiste auf Richtlinien. Registerkarte „Richtlinien“ auf der Randleiste des Enterprise-Kontos 1. Klicke unter Richtlinien auf „Codesicherheit und -analyse“. Screenshot der „Codesicherheit und -analyse“-Richtlinien in der Seitenleiste

  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 ihr neues benutzerdefiniertes Muster ein:

    1. Du musst zumindest den Namen für dein Muster und einen regulären Ausdruck für das Format deines geheimen Musters angeben.
    2. Du kannst auf Weitere Optionen klicken, um andere umgebende Inhalte oder zusätzliche Übereinstimmungsanforderungen für das geheime Format bereitzustellen.
    3. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.  Erstellen eines benutzerdefinierten secret scanning-Musterformulars
  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. Screenshot: ausgewählte Repositorys für den Probelauf

  9. Klicke auf Ausführen, wenn du bereit bist, das neue benutzerdefinierte Muster zu testen. 1. 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 Probelauf

  10. 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. 1. 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:

    • Um den Pushschutz für benutzerdefinierte Muster zu aktivieren, muss die secret scanning als Pushschutz auf Unternehmensebene aktiviert werden. Weitere Informationen findest du unter Aktivieren der secret scanning als Pushschutz für dein Unternehmen.
    • 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

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 secret scanning alerts findest du unter Verwalten von Warnungen aus der secret scanning.

Bearbeiten eines benutzerdefinierten Musters

Wenn du eine Änderung an einem benutzerdefinierten Muster speicherst, werden alle secret scanning alerts 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. 1. Klicke optional auf Aktivieren, um den Pushschutz für dein benutzerdefiniertes Muster zu aktivieren.

    Hinweis:

    • Der Pushschutz für benutzerdefinierte Muster gilt nur für Repositorys, in denen secret scanning als Pushschutz aktiviert ist. Weitere Informationen zum Aktivieren des Pushschutzes findest du unter Schützen von Pushes mit Geheimnisscans.
    • Wenn der Pushschutz für häufig gefundene benutzerdefinierte Muster aktiviert ist, können Mitwirkende das als störend wahrnehmen.

    Screenshot: Seite mit benutzerdefiniertem Muster mit hervorgehobener Schaltfläche zum Aktivieren des Pushschutzes

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

    Screenshot: Seite eines benutzerdefinierten Musters mit hervorgehobener 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.

    Bestätigen der Löschung eines benutzerdefinierten secret scanning-Musters