L'API On-Demand Scanning vous permet d'analyser les images stockées localement sur votre ordinateur ou à distance dans Artifact Registry ou Container Registry. Cela vous permet de contrôler précisément les conteneurs que vous souhaitez analyser pour détecter les failles. Vous pouvez utiliser On-Demand Scanning pour analyser les images de votre pipeline CI/CD avant de décider de les stocker ou non dans un registre. Pour en savoir plus sur la tarification, consultez la page Tarifs.
Cette page explique comment analyser manuellement des images de conteneur avec l'analyse à la demande.
Avant de commencer
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the On-Demand Scanning API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the On-Demand Scanning API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Ajoutez le composant local-extract à votre installation Google Cloud CLI.
Utiliser le gestionnaire de composants Google Cloud CLI
Le gestionnaire de composants vous invite à installer les composants requis la première fois que vous exécutez la commande d'analyse.
Utiliser votre gestionnaire de paquets système
-
Pour Debian/Ubuntu :
sudo apt install google-cloud-sdk-local-extract
-
Pour Red Hat/Fedora/CentOS :
sudo dnf install google-cloud-sdk-local-extract
Vous pouvez également remplacer
dnf
paryum
dans la commande précédente.
-
Pour Debian/Ubuntu :
- Attribuez le rôle IAM Administrateur de l'analyse à la demande à l'utilisateur ou au compte de service que vous allez utiliser avec l'analyse à la demande. Si vous utilisez le compte de propriétaire du projet pour exécuter les analyses, vous pouvez ignorer cette étape.
Analyse locale :
gcloud artifacts docker images scan IMAGE_URI \ [--location=(us,europe,asia)] [--async]
Pour une image locale, utilisez l'un des formats suivants pour IMAGE_URI :
REPOSITORY:TAG
REPOSITORY
Analyse à distance :
gcloud artifacts docker images scan IMAGE_URI \ --remote [--location=(us,europe,asia)] [--async]
Pour une image distante, utilisez l'un des formats suivants pour IMAGE_URI :
HOSTNAME/PROJECT_ID/REPOSITORY_ID/IMAGE_ID@sha256:HASH
HOSTNAME/PROJECT_ID/REPOSITORY_ID/IMAGE_ID:HASH
HOSTNAME/PROJECT_ID/REPOSITORY_ID/IMAGE_ID
HOSTNAME/PROJECT_ID/IMAGE_ID@sha256:HASH
HOSTNAME/PROJECT_ID/IMAGE_ID:HASH
HOSTNAME/PROJECT_ID/IMAGE_ID
Pour les images dans Artifact Registry, IMAGE_URI doit inclure
REPOSITORY_ID
.--location
est un indicateur permettant de sélectionner manuellement l'emplacement multirégional où l'analyse est effectuée. Choisir une multirégion plus proche de votre emplacement physique permet de réduire la latence. Les emplacements disponibles sont les suivants :us
,europe
etasia
. L'emplacement par défaut estus
.--async
est un indicateur permettant d'exécuter le processus d'analyse de manière asynchrone. Si vous omettez cet indicateur, votre terminal sera bloqué jusqu'à la fin du processus d'analyse.- SCAN_NAME est le nom de l'analyse. Vous le trouverez en bas de la sortie lorsque vous interrogerez l'opération de longue durée, une fois l'analyse terminée.
--limit=X
est une option facultative qui limite le nombre d'occurrences affichées dans le résultat.X
est une valeur numérique.- Utilisez l'API On-Demand Scanning dans votre pipeline Cloud Build.
- Utilisez Artifact Analysis pour analyser les images stockées dans Artifact Registry et mettre à jour en permanence les informations sur les failles.
Analyser une image de conteneur
Pour les analyses locales et à distance, vous pouvez utiliser les options facultatives suivantes :
Analyse synchrone
L'exemple suivant montre le résultat d'une analyse synchrone, sans l'indicateur --async
:
$ gcloud artifacts docker images scan ubuntu:latest ✓ Scanning container image ✓ Locally extracting packages and versions from local container image ✓ Remotely initiating analysis of packages and versions ✓ Waiting for analysis operation to complete [projects/my-project/locations/us/operations/87d2e137-1d1c-4790-8e5e-daf6c96ae7d7] Done. done: true metadata: '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesMetadata createTime: '2021-01-05T23:03:04.185261Z' resourceUri: ubuntu:latest name: projects/my-project/locations/us/operations/87d2e137-1d1c-4790-8e5e-daf6c96ae7d7 response: '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesResponse scan: projects/my-project/locations/us/scans/2fe2bfb8-f0c5-4dd6-a8c8-38961869767a
Utilisez le nom de l'analyse pour récupérer les résultats de l'analyse des failles.
Le nom de l'analyse correspond à la valeur de scan
dans la dernière ligne du message de résultat.
Analyse asynchrone
L'exemple suivant montre le résultat d'une analyse asynchrone :
$ gcloud artifacts docker images scan ubuntu:latest --async ✓ Scanning container image ✓ Locally extracting packages and versions from local container image ✓ Remotely initiating analysis of packages and versions Done. Check operation [projects/cloud-project/locations/us/operations/2e1a6b1f-16e5-4427-ac86-72c998a3dd16] for status. metadata: '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesMetadata createTime: '2021-01-05T23:04:54.393510Z' resourceUri: ubuntu:latest name: projects/my-project/locations/us/operations/2e1a6b1f-16e5-4427-ac86-72c998a3dd16
Cette commande lance une opération de longue durée et renvoie son ID sans bloquer votre terminal. Utilisez l'ID d'opération, la valeur de name
dans la dernière ligne du message de sortie, pour interroger l'opération.
Interroger l'opération de longue durée
Utilisez l'ID d'opération, issu du résultat de la commande d'analyse asynchrone, pour vérifier l'état de l'opération.
gcloud artifacts docker images get-operation LRO_ID
où LRO_ID est l'ID de l'opération de longue durée.
En reprenant l'exemple de la section Analyse asynchrone, pour vérifier l'état de l'opération :
$ gcloud artifacts docker images get-operation \ projects/cloud-project/locations/us/operations/2e1a6b1f-16e5-4427-ac86-72c998a3dd16 done: true metadata: '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesMetadata createTime: '2021-01-05T23:04:54.393510Z' resourceUri: ubuntu:latest name: projects/my-project/locations/us/operations/2e1a6b1f-16e5-4427-ac86-72c998a3dd16 response: '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesResponse scan: projects/my-project/locations/us/scans/2fe2bfb8-f0c5-4dd6-a8c8-38961869767a
Si le résultat inclut la ligne done: true
, l'opération d'analyse est terminée. Utilisez le nom de l'analyse pour récupérer les résultats de l'analyse des failles. Le nom correspond à la valeur de scan
sur la dernière ligne du message de résultat.
Récupérer les résultats de l'analyse
Pour récupérer les résultats de l'analyse une fois l'opération terminée, utilisez la commande suivante :
gcloud artifacts docker images list-vulnerabilities SCAN_NAME [--limit=X]
Où :
Exemple :
gcloud artifacts docker images list-vulnerabilities \ projects/my-project/locations/us/scans/2fe2bfb8-f0c5-4dd6-a8c8-38961869767a createTime: '2021-01-05T23:05:42.956227Z' kind: VULNERABILITY name: projects/my-project/locations/us/occurrences/f82a1efd-a261-4973-acbd-f9854d8b8135 noteName: projects/goog-vulnz/notes/CVE-2018-1000654 resourceUri: ubuntu:latest updateTime: '2021-01-05T23:05:42.956227Z' vulnerability: cvssScore: 7.1 cvssv3: attackComplexity: ATTACK_COMPLEXITY_LOW attackVector: ATTACK_VECTOR_NETWORK availabilityImpact: IMPACT_HIGH baseScore: 7.2 confidentialityImpact: IMPACT_HIGH exploitabilityScore: 1.2 impactScore: 5.9 integrityImpact: IMPACT_HIGH privilegesRequired: PRIVILEGES_REQUIRED_HIGH scope: SCOPE_UNCHANGED userInteraction: USER_INTERACTION_NONE effectiveSeverity: MEDIUM
Le résultat de cette commande est une liste des occurrences au format Grafeas. Dans ce cas, une faille de gravité moyenne détectée dans l'image est affichée.
Les résultats de l'analyse sont disponibles pendant 48 heures après la fin de l'opération.