Warum benutzerdefinierte Muster wichtig sind

Während AI Diff Review mit eingebauten Mustern für gängige Geheimnisse kommt, kann Ihre Codebasis benutzerdefinierte Formate verwenden, die nicht von Standardwerten abgedeckt sind. Das Erstellen benutzerdefinierter Redaktionsmuster stellt sicher, dass alle Ihre Geheimnisse geschützt sind, unabhängig von ihrem Format.

Musterformat verstehen

Redaktionsmuster verwenden reguläre Ausdrücke (Regex), was Ihnen leistungsstarke Matching-Fähigkeiten gibt. Ein gutes Muster sollte:

  • Ihr Geheimnisformat genau treffen
  • Nicht mit Nicht-Geheimnis-Werten übereinstimmen (falsche Positive vermeiden)
  • Spezifisch genug sein, um Variationen zu erfassen
  • Nicht zu breit sein (zu viel Redaktion vermeiden)

Häufige Musterbeispiele

API-Schlüssel mit Präfixen

API_KEY\s*[:=]\s*['"]?[A-Za-z0-9]{32,}['"]?

Trifft API-Schlüssel in verschiedenen Zuweisungsformaten mit 32+ Zeichen langen Schlüsseln.

JWT-Token

eyJ[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{20,}

Trifft JWT-Token (drei base64-kodierte Teile, durch Punkte getrennt).

Datenbankverbindungszeichenfolgen

(?:jdbc:|mongodb\+srv://|postgresql://)[^\s'"]+

Trifft verschiedene Datenbankverbindungszeichenfolgen.

OAuth-Token

oauth[_-]?token\s*[:=]\s*['"]?[A-Za-z0-9_-]{20,}['"]?

Trifft OAuth-Token in verschiedenen Formaten.

Benutzerdefinierte Muster erstellen

Um ein benutzerdefiniertes Muster hinzuzufügen:

  1. Gehen Sie zu Einstellungen → Tools → AI Diff Review
  2. Navigieren Sie zum Abschnitt Geheimnis-Redaktion
  3. Klicken Sie auf "Muster hinzufügen"
  4. Geben Sie Ihr Regex-Muster ein
  5. Das Muster wird sofort validiert
  6. Ungültige Muster zeigen eine Fehlermeldung

Mustervalidierung

AI Diff Review validiert Muster, wenn Sie sie hinzufügen oder bearbeiten:

  • Ungültige Regex-Syntax wird sofort erkannt
  • Fehlermeldungen erklären, was falsch ist
  • Sie können keine ungültigen Muster speichern
  • Dies verhindert Frustration durch defekte Muster

Musterverwaltung

Muster anzeigen

Sie können alle Muster (eingebaute und benutzerdefinierte) in den Einstellungen sehen. Eingebaute Muster sind markiert und können nicht gelöscht werden, aber Sie können sie bei Bedarf deaktivieren.

Muster bearbeiten

Benutzerdefinierte Muster können jederzeit bearbeitet werden. Klicken Sie auf ein Muster, um es zu ändern, und die Validierung erfolgt sofort.

Muster entfernen

Sie können benutzerdefinierte Muster entfernen, die Sie nicht mehr benötigen. Eingebaute Muster können nicht entfernt, aber deaktiviert werden.

Muster neu ordnen

Muster werden in Reihenfolge angewendet, daher ist die Neuordnung wichtig. Spezifischere Muster sollten vor allgemeinen kommen, um korrektes Matching sicherzustellen.

Import und Export

Sie können Ihren Mustersatz in eine Textdatei exportieren (ein Regex pro Zeile) und auf anderen Maschinen importieren. Dies ist nützlich für:

  • Muster mit Teammitgliedern teilen
  • Sichern Ihrer Konfiguration
  • Verwenden derselben Muster über Projekte hinweg
  • Versionskontrolle Ihrer Muster

Muster testen

Nach dem Erstellen eines Musters testen Sie es:

  1. Erstellen Sie einen Test-Commit mit Beispiel-Geheimnissen
  2. Führen Sie eine Analyse aus
  3. Überprüfen Sie, dass Geheimnisse korrekt redigiert werden
  4. Überprüfen Sie, dass es keine falschen Positive gibt (Nicht-Geheimnisse werden redigiert)
  5. Passen Sie das Muster bei Bedarf an

Best Practices

Spezifisch beginnen

Erstellen Sie zuerst spezifische Muster, dann fügen Sie bei Bedarf allgemeinere hinzu. Spezifische Muster verursachen weniger wahrscheinlich falsche Positive.

Gründlich testen

Testen Sie Muster mit echten Beispielen aus Ihrer Codebasis, um sicherzustellen, dass sie korrekt funktionieren.

Muster dokumentieren

Erwägen Sie, zu dokumentieren, was jedes benutzerdefinierte Muster trifft, besonders wenn Sie viele Muster haben.

Regelmäßig überprüfen

Überprüfen Sie Ihre Muster periodisch, um sicherzustellen, dass sie noch relevant sind und keine Probleme verursachen.

Reihenfolge ist wichtig

Platzieren Sie spezifischere Muster vor allgemeinen. Der erste Treffer gewinnt, daher beeinflusst die Reihenfolge, was redigiert wird.

Häufige Fallstricke

Zu breit

Vermeiden Sie Muster, die zu viel treffen. Redigieren Sie beispielsweise nicht alle Zeichenfolgen—seien Sie spezifisch darüber, was ein Geheimnis ausmacht.

Zu eng

Stellen Sie sicher, dass Muster Variationen erfassen. Wenn Ihre Geheimnisse in verschiedenen Formaten erscheinen können, berücksichtigen Sie das.

Nicht testen

Testen Sie Muster immer, bevor Sie sich darauf verlassen. Ein Muster, das korrekt aussieht, funktioniert möglicherweise nicht wie erwartet.

Fazit

Benutzerdefinierte Geheimnis-Redaktionsmuster ermöglichen es Ihnen, Ihre spezifischen Geheimnisformate zu schützen und so umfassenden Schutz für Ihre Codebasis zu gewährleisten. Durch das Verstehen von Regex und das Befolgen von Best Practices können Sie effektive Muster erstellen, die Ihre Geheimnisse sicher halten.

Denken Sie daran, Muster zu testen, sie korrekt zu ordnen und sie regelmäßig zu überprüfen. Mit ordnungsgemäßer Musterverwaltung können Sie starke Sicherheit aufrechterhalten, während Sie AI-Code-Überprüfung verwenden.

Bereit, Ihren Schutz anzupassen? Installieren Sie AI Diff Review und beginnen Sie mit dem Erstellen benutzerdefinierter Redaktionsmuster für Ihre Codebasis.