On-Demand-Scan in Ihrer Cloud Build-Pipeline verwenden

---

Wenn Sie On-Demand-Scans als Teil Ihrer Cloud Build-Pipeline verwenden, können Sie Builds blockieren, wenn das Container-Image Sicherheitslücken mit einem Schweregrad aufweist, der einem vordefinierten Level entspricht.

In dieser Anleitung erfahren Sie, wie Sie mit Cloud Build ein Container-Image aus dem Quellcode erstellen, es auf Sicherheitslücken prüfen, den Schweregrad der Sicherheitslücken prüfen und das Image in die Artifact Registry pushen, wenn keine Sicherheitslücken mit einem bestimmten Schweregrad vorhanden sind.

Wir empfehlen, für diese Anleitung ein neues Google Cloud-Projekt zu erstellen und die Schritte in einer isolierten Umgebung auszuführen.

Lernziele

• Erstellen Sie mit Cloud Build ein Image.
• Scannen Sie das erstellte Image mit On-Demand-Scanning.
• Akzeptable Sicherheitslücken bewerten
• Speichern Sie das Image in Artifact Registry.

Kosten

In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:

• On-Demand Scanning
• Cloud Build
• Artifact Registry

Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen. Neuen Google Cloud-Nutzern steht möglicherweise eine kostenlose Testversion zur Verfügung.

Nach Abschluss der in diesem Dokument beschriebenen Aufgaben können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.

Hinweis

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the On-Demand Scanning, Cloud Build, and Artifact Registry APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the On-Demand Scanning, Cloud Build, and Artifact Registry APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

Erforderliche Rollen

Das Dienstkonto, das Sie mit Cloud Build verwenden, benötigt die folgenden Rollen:

• Administrator für On-Demand-Scanning (roles/ondemandscanning.admin)

• Artifact Registry-Writer (roles/artifactregistry.writer)

Das Cloud Build-Standarddienstkonto hat die erforderlichen Berechtigungen für Artifact Registry-Repositories im selben Projekt. Wenn sich Ihre Repositories im selben Projekt befinden, das Sie für Cloud Build verwenden, müssen Sie nur die Rolle „Administrator für On-Demand-Scans“ gewähren.

Wenn Sie ein von Nutzern bereitgestelltes Dienstkonto für Cloud Build verwenden, müssen Sie beide Rollen gewähren.

Hinweis: In dieser Anleitung wird davon ausgegangen, dass sich alle Dienste im selben Projekt befinden.

Quelldatei vorbereiten

In dieser Anleitung erstellen Sie ein Image aus einem Dockerfile. Ein Dockerfile ist eine Quelldatei, die Anweisungen für das Erstellen eines Images durch Docker enthält.

1. Öffnen Sie ein Terminal, erstellen Sie ein neues Verzeichnis mit dem Namen ods-tutorial und wechseln Sie zu diesem Verzeichnis:

   mkdir ods-tutorial && cd ods-tutorial
   

2. Erstellen Sie eine Datei mit dem Namen Dockerfile und mit folgendem Inhalt:

   # Debian10 image
   FROM gcr.io/google-appengine/debian10:latest
   
   # Ensures that the built image is always unique
   RUN apt-get update && apt-get -y install uuid-runtime && uuidgen > /IAMUNIQUE
   

Artifact Registry-Repository erstellen

1. Legen Sie als Projekt-ID das Projekt fest, in dem Sie die APIs aktiviert haben:

   gcloud config set project PROJECT_ID
   

2. Erstellen Sie am Speicherort us-central1 ein Docker-Repository namens ods-build-repo:

   gcloud artifacts repositories create ods-build-repo --repository-format=docker \
   --location=us-central1 --description="Repository for scan and build"
   

3. Prüfen Sie, ob das Repository erstellt wurde:

   gcloud artifacts repositories list
   

Erstellen und scannen

In diesem Abschnitt führen Sie Ihre Build-Pipeline mit einer Build-Konfigurationsdatei aus. Eine Build-Konfigurationsdatei weist Cloud Build an, mehrere Aufgaben gemäß Ihren Spezifikationen auszuführen.

1. Erstellen Sie im Ordner ods-tutorial/ die Datei cloudbuild.yaml mit folgendem Inhalt:

   steps:
      - id: build
        name: gcr.io/cloud-builders/docker
        entrypoint: /bin/bash
        args:
        - -c
        - |
          docker build -t us-central1-docker.pkg.dev/$_PROJECT_ID/ods-build-repo/ods-test:latest -f ./Dockerfile . &&
          docker image inspect us-central1-docker.pkg.dev/$_PROJECT_ID/ods-build-repo/ods-test:latest --format \
          '{{index .RepoTags 0}}@{{.Id}}' > /workspace/image-digest.txt &&
          cat image-digest.txt
      - id: scan
        name: gcr.io/google.com/cloudsdktool/cloud-sdk
        entrypoint: /bin/bash
        args:
        - -c
        - |
          gcloud artifacts docker images scan us-central1-docker.pkg.dev/$_PROJECT_ID/ods-build-repo/ods-test:latest \
          --format='value(response.scan)' > /workspace/scan_id.txt
      - id: severity check
        name: gcr.io/google.com/cloudsdktool/cloud-sdk
        entrypoint: /bin/bash
        args:
        - -c
        - |
          gcloud artifacts docker images list-vulnerabilities $(cat /workspace/scan_id.txt) \
          --format='value(vulnerability.effectiveSeverity)' | if grep -Exq $_SEVERITY; \
          then echo 'Failed vulnerability check' && exit 1; else exit 0; fi
      - id: push
        name: gcr.io/cloud-builders/docker
        entrypoint: /bin/bash
        args:
        - -c
        - |
          docker push us-central1-docker.pkg.dev/$_PROJECT_ID/ods-build-repo/ods-test:latest
   images: ['us-central1-docker.pkg.dev/$_PROJECT_ID/ods-build-repo/ods-test:latest']
   
   

   Diese Datei enthält den Speicherort und das Repository, die zuvor in Artifact Registry erstellt wurden. Wenn Sie andere Werte verwenden möchten, ändern Sie die Datei cloudbuild.yaml entsprechend. Die Werte für PROJECT_ID und SEVERITY werden im Build-Befehl an das Script übergeben.

2. Geben Sie die SEVERITY-Ebenen für Sicherheitslücken an, die Sie blockieren möchten, und starten Sie den Build.

   Achtung: Mit dieser Pipelinekonfiguration werden Builds nur basierend auf den von Ihnen explizit definierten Schweregraden blockiert. Wenn Sie nur einen Schweregrad angeben, können in Ihrem Image weiterhin Sicherheitslücken mit einer höheren Klassifizierung vorhanden sein, die Ihren Build nicht blockieren.

   Sie können die folgenden Werte für SEVERITY verwenden:

   • CRITICAL
   • HIGH
   • MEDIUM
   • LOW

   Sie können mehrere Schweregrade angeben, indem Sie einen regulären Ausdruck verwenden.

   Im folgenden Beispiel geben Sie sowohl den Wert für die Schwere CRITICAL als auch HIGH an. Dadurch wird Cloud Build angewiesen, nach Sicherheitslücken zu suchen, die dem Schweregrad HIGH oder höher zugeordnet sind.

   gcloud builds submit --substitutions=_PROJECT_ID=PROJECT_ID,_SEVERITY='"CRITICAL|HIGH"' \
   --config cloudbuild.yaml
   

   Dabei gilt:

   • PROJECT_ID ist die Projekt-ID.
   • Mit SEVERITY können Sie die Wichtigkeitsstufen festlegen, die blockiert werden sollen. Wenn beim On-Demand-Scannen Sicherheitslücken gefunden werden, die einem der angegebenen Schweregrade entsprechen, schlägt der Build fehl.

Ergebnisse verstehen

Wenn Sie den Wert für SEVERITY auf CRITICAL|HIGH festlegen, wird nach dem On-Demand-Scanning nach Sicherheitslücken auf der HIGH-Ebene und der schärferen CRITICAL-Ebene gesucht. Wenn in Ihrem Image keine übereinstimmenden Sicherheitslücken gefunden werden, ist der Build erfolgreich und Cloud Build sendet das Image an Artifact Registry.

Die Ausgabe sieht in etwa so aus:

DONE
--------------------------------------------------------------------------------------------------------------------------------------------

ID                                    CREATE_TIME                DURATION  SOURCE                                                                                         IMAGES                                                                        STATUS
abb3ce73-6ae8-41d1-9080-7d74a7ecd7bc  2021-03-15T06:50:32+00:00  1M48S     gs://ods-tests_cloudbuild/source/1615791031.906807-a648d10faf4a46d695c163186a6208d5.tgz  us-central1-docker.pkg.dev/ods-tests/ods-build-repo/ods-test (+1 more)  SUCCESS

Wenn beim On-Demand-Scanning HIGH- oder CRITICAL-Sicherheitslücken in Ihrem Image gefunden werden, schlägt der scan-Build-Schritt fehl, nachfolgende Build-Schritte werden nicht gestartet und Cloud Build überträgt kein Image an Artifact Registry.

Die Ausgabe sieht in etwa so aus:

Step #2 - "severity check": Failed vulnerability check
Finished Step #2 - "severity check"
ERROR
ERROR: build step 2 "gcr.io/cloud-builders/gcloud" failed: step exited with non-zero status: 1

In dieser Anleitung können Ihre Ergebnisse abweichen, da der Beispiel-Quellcode eine öffentlich verfügbare Linux-Distribution ist, debian10:latest. Linux-Distributionen und zugehörige Sicherheitslückendaten werden laufend aktualisiert.

Weitere Informationen zu zusätzlichen Google Cloud-Tools und Best Practices zum Schutz Ihrer Softwarelieferkette finden Sie unter Sicherheit der Softwarelieferkette.

Weitere Informationen zu Best Practices für die Verwaltung von Linux-Sicherheitslücken finden Sie in den kostenlosen Onlineschulungen der Linux Foundation. Weitere Informationen finden Sie unter Sichere Software entwickeln.

Bereinigen

Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, löschen Sie entweder das Projekt, das die Ressourcen enthält, oder Sie behalten das Projekt und löschen die einzelnen Ressourcen.

Projekt löschen

Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für die Aufgaben in diesem Dokument ein bereits bestehendes Projekt verwendet haben und dieses löschen, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID nutzen, z. B. eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, statt das gesamte Projekt.

Wenn Sie mehrere Architekturen, Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Einzelne Ressourcen löschen

Prüfen Sie vor dem Entfernen des Repositorys, ob alle Images, die Sie beibehalten möchten, an einem anderen Speicherort verfügbar sind.

So löschen Sie das Repository:

Console

1. Öffnen Sie in der Cloud Console die Seite Repositories.

   Zur Seite „Repositories“

2. Wählen Sie in der Repository-Liste das Repository ods-build-repo aus.

3. Klicken Sie auf Löschen.

gcloud

Führen Sie den folgenden Befehl aus, um das Repository ods-build-repo zu löschen:

gcloud artifacts repositories delete ods-build-repo --location=us-central1

Nächste Schritte

• Images mit dem On-Demand-Scan prüfen und Informationen zu Sicherheitslücken aufrufen
• Bilder in der Registry automatisch scannen
• Container-Images mit Kritis Signer und Binärautorisierung signieren