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

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 findest du unter Secret scanning patterns.

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.

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 .

1. Navigiere auf dein Unternehmen zur Hauptseite des Repositorys. 1. Klicke unter dem Repositorynamen auf 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 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.

4. Gib im Feld „Mustername“ einen Namen für dein Muster ein.

5. Gib im Feld „Geheimnisformat“ einen regulären Ausdruck für das Format deines Geheimnismusters ein.

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

7. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.

   

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

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

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.

    Hinweis: Das Feature „Probelauf“ befindet sich derzeit in der Betaversion und kann noch geändert werden.

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

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 findest du 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:

Merkmal	Feld und regulärer Ausdruck
Länge zwischen 5 und 10 Zeichen	Geheimnisformat: [$#%@AA-Za-z0-9]{5,10}
Endet nicht mit .	Nach dem Geheimnis: [^\.]
Enthält Zahlen und Großbuchstaben	Zusätzliche Anforderungen: Geheimnis muss mit [A-Z] und [0-9] übereinstimmen
Enthält nicht mehr als einen Kleinbuchstaben in einer Zeile	Zusä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 AE auf dein Profilfoto, und klicke dann auf Deine Organisationen.

   2. Klicke neben der Organisation auf 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 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.

4. Gib im Feld „Mustername“ einen Namen für dein Muster ein.

5. Gib im Feld „Geheimnisformat“ einen regulären Ausdruck für das Format deines Geheimnismusters ein.

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

7. Gib eine Beispieltestzeichenfolge an, um sicherzustellen, dass deine Konfiguration den erwarteten Mustern entspricht.

   

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

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

10. Klicke auf Probelauf, 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.

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.

    Hinweis: Das Feature „Probelauf“ befindet sich derzeit in der Betaversion und kann noch geändert werden.

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

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 findest du unter Verwalten von Warnungen aus der Geheimnisüberprüfung.

Definieren eines benutzerdefinierten Musters für ein Unternehmenskonto

1. Klicke oben rechts auf GitHub AE auf dein Profilfoto und dann auf Unternehmenseinstellungen. 1. Wähle auf der Randleiste des Unternehmenskontos die Option Richtlinien aus. 1. Klicke unter Richtlinien auf „Erweiterte Sicherheit“. 1. Klicke unter „Erweiterte GitHub-Sicherheit“ auf die Registerkarte Sicherheitsfeatures.

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

3. 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. Gib im Feld „Geheimnisformat“ einen regulären Ausdruck für das Format deines Geheimnismusters ein.

   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.

      

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

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

6. Klicke auf Probelauf, 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.

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

   Hinweis: Das Feature „Probelauf“ befindet sich derzeit in der Betaversion und kann noch geändert werden.

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

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 findest du 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.
   • Zeige für ein Repository oder eine Organisation die Einstellungen unter „Sicherheit und Analyse“ für das Repository oder die Organisation an, in dem bzw. der das benutzerdefinierte Muster erstellt wurde. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Repository oder Definieren eines benutzerdefinierten Musters für eine Organisation oben.
   • Für ein Unternehmen zeigst du unter „Richtlinien“ den Bereich „Erweiterte Sicherheit“ an und klickst dann auf Sicherheitsfeatures. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Unternehmenskonto oben.
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.

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.

   • Zeige für ein Repository oder eine Organisation die Einstellungen unter „Sicherheit und Analyse“ für das Repository oder die Organisation an, in dem bzw. der das benutzerdefinierte Muster erstellt wurde. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Repository oder Definieren eines benutzerdefinierten Musters für eine Organisation oben.
   • Für ein Unternehmen zeigst du unter „Richtlinien“ den Bereich „Erweiterte Sicherheit“ an und klickst dann auf Sicherheitsfeatures. Weitere Informationen findest du unter Definieren eines benutzerdefinierten Musters für ein Unternehmenskonto oben.

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.