Aktivieren von Pull Request-Anmerkungen in GitHub und Azure DevOps

Artikel
08/08/2024

DevOps-Sicherheit macht Sicherheitsergebnisse als Anmerkungen in Pull Requests (PR) verfügbar. Sicherheitsoperatoren können PR-Anmerkungen in Microsoft Defender for Cloud aktivieren. Alle verfügbar gemachten Probleme können von Entwickler*innen behoben werden. Dadurch können potenzielle Sicherheitsrisiken und Fehlkonfigurationen verhindert und behoben werden, bevor sie in das Produktionsstadium gelangen. DevOps-Sicherheit erstellt Anmerkungen nicht für alle Sicherheitsrisiken, die in der gesamten Datei erkannt wurden, sondern nur für Sicherheitsrisiken innerhalb der Unterschiede, die durch den Pull Request eingeführt wurden. Entwickler können Anmerkungen in ihren Quellcodeverwaltungssystemen und Sicherheitsoperatoren und nicht gelöste Ergebnisse in Microsoft Defender for Cloud sehen.

Mit Microsoft Defender for Cloud können Sie PR-Anmerkungen in Azure DevOps konfigurieren. Sie können PR-Anmerkungen in GitHub erhalten, wenn Sie ein GitHub Advanced Security-Kunde sind.

Erläuterung von Pull Request-Anmerkungen

Pull Request-Anmerkungen sind Kommentare, die einem Pull Request in GitHub oder Azure DevOps hinzugefügt werden. Diese Anmerkungen geben Feedback zu den im Pull Request vorgenommenen Codeänderungen und identifizierten Sicherheitsproblemen. Sie helfen Reviewern, die vorgenommenen Änderungen zu verstehen.

Anmerkungen können von einem Benutzer mit Zugriff auf das Repository hinzugefügt und verwendet werden, um Änderungen vorzuschlagen, Fragen zu stellen oder Feedback zum Code zu geben. Anmerkungen können auch verwendet werden, um Probleme und Fehler nachzuverfolgen, die behoben werden müssen, bevor der Code mit dem Mainbranch zusammengeführt wird. DevOps-Sicherheit in Defender for Cloud verwendet Anmerkungen, um Sicherheitsergebnisse verfügbar zu machen.

Voraussetzungen

Für GitHub:

Ein Azure-Konto. Wenn Sie noch kein Azure-Konto haben, können Sie heute Ihr kostenloses Azure-Konto erstellen.
Werden Sie ein GitHub Advanced Security-Kunde.
Stellen Sie eine Verbindung zwischen Ihren GitHub-Repositorys und Microsoft Defender for Cloud her.
Konfigurieren Sie die GitHub-Aktion von Microsoft Security DevOps.

Für Azure DevOps:

Ein Azure-Konto. Wenn Sie noch nicht über ein Azure-Konto verfügen, können Sie noch heute Ihr kostenloses Azure-Konto erstellen.
Sie verfügen über Schreibzugriff (Besitzer/Mitwirkender) auf das Azure-Abonnement.
Stellen Sie eine Verbindung zwischen Ihren Azure DevOps-Repositorys und Microsoft Defender for Cloud her.
Konfiguration der Azure DevOps-Erweiterung von Microsoft Security DevOps.

Aktivieren von Pull Request-Anmerkungen in GitHub

Durch Aktivieren von PR-Anmerkungen in GitHub erhalten Ihre Entwickler die Möglichkeit, Sicherheitsprobleme zu sehen, wenn sie ihre Pull Requests direkt im Mainbranch erstellen.

So aktivieren Sie Pull Request-Anmerkungen in GitHub:

Navigieren Sie zu GitHub, und melden Sie sich an.
Wählen Sie ein Repository aus, das Sie in Defender for Cloud integriert haben.
Navigieren Sie zu Your repository's home page>.github/workflows.
Wählen Sie die Datei msdevopssec.yml aus, die in den Voraussetzungen erstellt wurde.
Wählen Sie Edit (Bearbeiten) aus.
Suchen Sie den Triggerabschnitt, und aktualisieren Sie ihn mit folgendem Inhalt:
```
# Triggers the workflow on push or pull request events but only for the main branch
pull_request:
  branches: ["main"]
```
Sie können auch ein Beispielrepository anzeigen.

(Optional) Sie können auswählen, welche Branches ausgeführt werden sollen, indem Sie die Branches im Triggerabschnitt eingeben. Um alle Branches einzuschließen, entfernen Sie die Zeilen mit der Branchliste. 
Klicken Sie auf Start commit (Commit starten).
Wählen Sie Commit changes (Änderungen committen) aus.

Alle Probleme, die vom Scanner erkannt werden, können im Abschnitt „Geänderte Dateien“ Ihres Pull Requests angezeigt werden.
- Used in tests (Wird in Tests verwendet): Die Warnung ist nicht im Produktionscode vorhanden.

Aktivieren von Pull Request-Anmerkungen in Azure DevOps

Durch Aktivieren von PR-Anmerkungen in Azure DevOps erhalten Ihre Entwickler die Möglichkeit, Sicherheitsprobleme zu sehen, wenn sie ihre PR direkt im Mainbranch erstellen.

Aktivieren der Buildüberprüfungsrichtlinie für den CI-Build

Damit Sie Pull Request-Anmerkungen aktivieren können, muss im Mainbranch die Buildüberprüfungsrichtlinie für den CI-Build aktiviert sein.

So aktivieren Sie die Buildüberprüfungsrichtlinie für den CI-Build:

Melden Sie sich bei Ihrem Azure DevOps-Projekt an.
Navigieren Sie zu Project settings>Repositories (Projekteinstellungen > Repositorys).
Wählen Sie das Repository aus, für das Pull Requests aktiviert werden sollen.
Wählen Sie Richtlinien aus.
Navigieren Sie zu Branchrichtlinien>Mainbranch.
Navigieren Sie zum Abschnitt „Buildvalidierung“.
Stellen Sie sicher, dass die Buildüberprüfung für Ihr Repository auf Ein umgeschaltet ist.
Wählen Sie Speichern aus.

Nachdem Sie diese Schritte abgeschlossen haben, können Sie die zuvor erstellte Buildpipeline auswählen und die Einstellungen Ihren Anforderungen entsprechend anpassen.

Aktivieren von Pull Request-Anmerkungen

So aktivieren Sie Pull Request-Anmerkungen in Azure DevOps:

Melden Sie sich beim Azure-Portal an.
Navigieren Sie zu Defender for Cloud>DevOps-Sicherheit.
Wählen Sie alle relevanten Repositorys aus, für die Pull Request-Anmerkungen aktiviert werden sollen.
Wählen Sie Ressourcen verwalten aus.
Legen Sie Pull Request-Anmerkungen auf Ein fest.
(Optional) Wählen Sie eine Kategorie im Dropdownmenü aus.

Hinweis

Derzeit werden nur Ergebnisse von Infrastructure-as-Code-Fehlkonfigurationen (ARM, Bicep, Terraform, CloudFormation, Dockerfiles, Helm Charts usw.) unterstützt.
(Optional) Wählen Sie im Dropdownmenü einen Schweregrad aus.
Wählen Sie Speichern aus.

Alle Anmerkungen zu Ihren Pull Requests werden ab jetzt basierend auf Ihren Konfigurationen mit der relevanten Codezeile angezeigt.

So aktivieren Sie Pull Request-Anmerkungen für eigene Projekte und Organisationen in Azure DevOps:

Dies ist programmgesteuert durch Aufrufen der API zum Aktualisieren von Azure DevOps-Ressourcen möglich, die Microsoft bereitgestellt wird. „Microsoft.Security“ verfügbar gemacht wird.

API-Informationen

HTTP-Methode: PATCH URLs:

Azure DevOps-Projektaktualisierung: https://management.azure.com/subscriptions/<subId>/resourcegroups/<resourceGroupName>/providers/Microsoft.Security/securityConnectors/<connectorName>/devops/default/azureDevOpsOrgs/<adoOrgName>/projects/<adoProjectName>?api-version=2023-09-01-preview
Azure DevOps-Organisationsaktualisierung: https://management.azure.com/subscriptions/<subId>/resourcegroups/<resourceGroupName>/providers/Microsoft.Security/securityConnectors/<connectorName>/devops/default/azureDevOpsOrgs/<adoOrgName>?api-version=2023-09-01-preview

Anforderungstext:

{
   "properties": {
"actionableRemediation": {
              "state": <ActionableRemediationState>,
              "categoryConfigurations":[
                    {"category": <Category>,"minimumSeverityLevel": <Severity>}
               ]
           }
    }
}

Verfügbare Parameter/Optionen

<ActionableRemediationState>Beschreibung: Zustand der PR-Anmerkungskonfiguration Optionen: Aktiviert | Deaktiviert

<Category>Beschreibung: Kategorie der Ergebnisse, die in Pull Requests mit Anmerkungen versehen werden. Optionen: IaC | Code | Artefakte | Abhängigkeiten | Container Hinweis: Derzeit wird nur IaC unterstützt.

<Severity>Beschreibung: Der Mindestschweregrad eines Ergebnisses, der bei der Erstellung von PR-Anmerkungen berücksichtigt wird. Optionen: Hoch | Mittel | Niedrig

Beispiel für die Aktivierung der PR-Anmerkungen einer Azure DevOps-Organisation für die Kategorie „IaC“ mit dem Mindestschweregrad „Mittel“ über das CLI-Tools „az“.

Aktualisieren einer Organisation:

az --method patch --uri https://management.azure.com/subscriptions/4383331f-878a-426f-822d-530fb00e440e/resourcegroups/myrg/providers/Microsoft.Security/securityConnectors/myconnector/devops/default/azureDevOpsOrgs/testOrg?api-version=2023-09-01-preview --body "{'properties':{'actionableRemediation':{'state':'Enabled','categoryConfigurations':[{'category':'IaC','minimumSeverityLevel':'Medium'}]}}}

Beispiel für die Aktivierung der PR-Anmerkungen eines Azure DevOps-Projekts für die Kategorie „IaC“ mit dem Mindestschweregrad „Hoch“ über das CLI-Tools „az“.

Aktualisieren eines Projekts:

az --method patch --uri https://management.azure.com/subscriptions/4383331f-878a-426f-822d-530fb00e440e/resourcegroups/myrg/providers/Microsoft.Security/securityConnectors/myconnector/devops/default/azureDevOpsOrgs/testOrg/projects/testProject?api-version=2023-09-01-preview --body "{'properties':{'actionableRemediation':{'state':'Enabled','categoryConfigurations':[{'category':'IaC','minimumSeverityLevel':'High'}]}}}"

Weitere Informationen

Nächste Schritte

Nun können Sie sich ausführlicher mit DevOps-Sicherheit vertraut machen.

Freigeben über