Konfigurieren des Codescanning

Informationen zum code scanning

Code scanning hilft dir dabei, Sicherheitsrisiken im Code in deinem Repository zu erkennen. Mit dem CodeQL-code scanning kannst du unter anderem benutzerdefinierte oder integrierte Abfragesammlungen für die Verwendung in deiner Analyse auswählen, einen bestimmten Überprüfungszeitplan festlegen und die Ereignisse auswählen, die eine Überprüfung auslösen.

Du kannst das code scanning auch mit Tools von Drittanbietern konfigurieren. Weitere Informationen findest du unter Konfigurieren des code scanning mit Drittanbieteraktionen.

Wenn du die Codeüberprüfung mit mehreren Konfigurationen ausführst, kann es passieren, dass eine Warnung mehrere Analyseursprünge aufweist. Wenn eine Warnung mehrere Analyseursprünge hat, kannst du den Status der Warnung für jeden Analyseursprung auf der Warnungsseite einsehen. Weitere Informationen findest du unter Informationen zu Codeüberprüfungswarnungen.

Voraussetzungen

Dein Repository ist für das code scanning geeignet, wenn:

• es von CodeQL unterstützte Sprachen benutzt oder du planst, Codescanningergebnisse mit einem Drittanbietertool zu generieren
• GitHub Actions aktiviert ist.
• GitHub Advanced Security ist aktiviert.

Bevor du das code scanning für ein Repository konfigurierst, stelle sicher, dass mindestens ein selbstgehosteter GitHub Actions-Runner für das Repository verfügbar ist.

Enterprise-Besitzer sowie Organisations- und Repositoryadministratoren können selbstgehostete Runner hinzufügen. Weitere Informationen findest du unter Informationen zu selbstgehosteten Runnern und unter Selbst-gehostete Runner hinzufügen.

Konfigurieren des code scanning mithilfe der CodeQL-Aktion

1. Navigiere auf dein Unternehmen zur Hauptseite des Repositorys.

2. Wähle unter dem Repositorynamen die Option Sicherheit aus. Wenn die Registerkarte „Sicherheit“ nicht angezeigt wird, wähle im Dropdownmenü die Option Sicherheit aus.

3. Wähle rechts neben „Code scanning-Warnungen“ die Option code scanning einrichten aus. Wenn „code scanning-Warnungen“ fehlt, bitte einen Organisationsbesitzerin oder Repositoryadministrator*in, GitHub Advanced Security zu aktivieren. Weitere Informationen findest du unter Verwalten von Sicherheits- und Analyseeinstellungen für deine Organisation oder Verwalten von Sicherheits- und Analyseeinstellungen für dein Repository.

4. Klicke unter „Erste Schritte mit code scanning“ für CodeQL-Analyseworkflow oder einen Drittanbieterworkflow auf Diesen Workflow einrichten.

   Workflows werden nur angezeigt, wenn sie für die im Repository erkannten Programmiersprachen relevant sind. CodeQL-Analyseworkflow wird immer angezeigt. Die Schaltfläche „Diesen Workflow einrichten“ ist jedoch nur aktiviert, wenn die CodeQL-Analyse die im Repository vorhandenen Sprachen unterstützt.

5. Bearbeite den Workflow, wenn du die Codeüberprüfung durch code scanning anpassen möchtest.

   In der Regel kannst du CodeQL-Analyseworkflow ohne Änderungen committen. Viele der Drittanbieterworkflows erfordern jedoch eine zusätzliche Konfiguration. Lies daher vor dem Committen die Kommentare im Workflow.

   Weitere Informationen findest du unter Anpassen Codeüberprüfung und unter CodeQL-Codeüberprüfung für kompilierte Sprachen.

6. Klicke auf Änderungen committen... , um das Formular für Commitänderungen anzuzeigen.

   

7. Gib im Feld „Commitnachricht“ eine Commitnachricht ein.

8. Wähle aus, ob du direkt in den Standardbranch committen möchtest, oder erstelle einen neuen Branch, und starte einen Pull Request.

9. Klicke auf **Commit new file ** (Neue Datei committen) oder Propose new file (Neue Datei vorschlagen).

Im empfohlenen CodeQL-Analyseworkflow wird code scanning so konfiguriert, dass dein Code jedes Mal analysiert wird, wenn du entweder eine Änderung an den Standardbranch oder an geschützte Branches pushst oder einen Pull Request für den Standardbranch auslöst. Daraufhin wird code scanning gestartet.

Die on:pull_request- und on:push-Trigger für Codescans sind jeweils für unterschiedliche Zwecke nützlich. Weitere Informationen findest du unter Anpassen Codeüberprüfung.

Informationen zur Massenaktivierung findest du unter Konfigurieren des Codescanning mit CodeQL im großen Stil.

Nächste Schritte

Nach dem Konfigurieren der code scanning und dem Abschluss der Aktionen kannst du Folgendes tun:

• Anzeigen aller für dieses Repository generierten code scanning-Warnungen. Weitere Informationen findest du unter Verwalten von Codescanwarnungen für dein Repository.
• Anzeigen von Warnungen, die für einen Pull Request generiert wurden, der nach dem Konfigurieren der code scanning übermittelt wurde. Weitere Informationen findest du unter Filtern von Codescanbenachrichtigungen in Pull-Anforderungen.
• Konfigurieren von Benachrichtigungen für abgeschlossene Ausführungen. Weitere Informationen findest du unter Benachrichtigungen konfigurieren.
• Informationen zu code scanning-Ergebnissen für Pull Requests Weitere Informationen findest du unter Filtern von Codescanbenachrichtigungen in Pull-Anforderungen.
• Anzeigen der Protokolle, die bei der code scanning-Analyse generiert wurden. Weitere Informationen findest du unter Anzeigen von Codescanprotokollen.
• Untersuchen von Problemen, die bei der Erstkonfiguration des code scanning auftreten. Weitere Informationen findest du unter Problembehandlung bei der Codeüberprüfung.
• Passe an, wie die code scanning den Code in deinem Repository überprüft. Weitere Informationen findest du unter Anpassen Codeüberprüfung.