semgrep-rules

Willkommen! Dieses Repository enthält die Community-Edition-Regeln von Semgrep.

Zusätzlich zu den Regeln in diesem Repository bietet das Semgrep Registry proprietäre Pro-Regeln, die eine zusätzliche Sprachabdeckung bieten und Crossfile- sowie tiefgehende Datenflussanalysen ermöglichen.

• Regeln finden: Suchen Sie über die Semgrep-Registry-Suche nach Community-Edition- und Pro-Regeln.
• Regeln verwenden: Scannen Sie Ihren Code mit diesen Regeln über die Semgrep AppSec Platform
• Zu Regeln beitragen: Weitere Informationen finden Sie unter Beitragen zu Semgrep-Regeln.

Verwenden des Semgrep-Regeln-Repositorys

Um mit dem Schreiben und Verwenden von Semgrep-Regeln zu beginnen, siehe Semgrep-Syntax lernen und Regeln schreiben. Führen Sie dann vorhandene und benutzerdefinierte Semgrep-Regeln lokal mit der Semgrep-Befehlszeilenschnittstelle (Semgrep CLI) oder kontinuierlich mit Semgrep in CI aus, während Sie die Semgrep AppSec Platform verwenden.

Semgrep-Regeln schreiben

Siehe Regeln schreiben für Informationen zu:

• Pattern-Syntax, die im Detail beschreibt, was Semgrep-Patterns leisten können, sowie Beispiel-Anwendungsfälle des Ellipsen-Operators und von Metavariablen.
• Regel-Syntax, die Semgrep-YAML-Regeldateien beschreibt, die mehrere Patterns, detaillierte Ausgabemeldungen und Autofixes enthalten können. Die Syntax erlaubt die Kombination einzelner Patterns mit booleschen Operatoren.

Sie können das Schreiben von Regeln auch mit dem interaktiven, beispielbasierten Semgrep-Regel-Tutorial erlernen.

Beitragen

Wir freuen uns über Semgrep-Regelbeiträge direkt in diesem Repository! Wenn Sie Ihren Beitrag einreichen, gewähren Sie Semgrep, Inc. eine Lizenz zur Nutzung, Änderung und Verbreitung Ihres Beitrags unter der Semgrep Rules License v. 1.0. Dadurch wird sichergestellt, dass Ihre Regel mit anderen Semgrep-Registry-Nutzern geteilt werden kann.

Um beizutragen, lesen Sie bitte unsere Richtlinien unter Beitragen zu Semgrep-Regeln.

Sie können uns auch unter [email protected] kontaktieren, und wir helfen Ihnen gerne, Ihre Regeln zu importieren, damit andere sie nutzen können!

Zusätzliche Informationen

Hilfe

Treten Sie Slack bei, um die schnellsten Antworten auf Ihre Fragen zu erhalten! Oder kontaktieren Sie das Team unter [email protected].

GitHub-Action zum Ausführen von Tests

Wenn Sie dieses Repository forken oder ein eigenes erstellen, können Sie Ihrem Workflow eine GitHub-Action hinzufügen, die Ihre Regeln automatisch mit der neuesten Version von Semgrep testet. Siehe unser semgrep-rules-test-Beispiel.

Rulesets

Rulesets sind Gruppen von Regeln, die nach Zweck, Sprache oder Framework organisiert sind und aus dem Semgrep Registry stammen. Wenn Sie bestehende Rulesets ändern oder eigene erstellen möchten, kontaktieren Sie uns bitte unter [email protected].