Scan OS packages manually

Scan OS packages manually

This quickstart shows you how to pull a container image, manually scan it for operating system vulnerabilities with the On-Demand Scanning API, and retrieve identified vulnerabilities. To follow this quickstart you will use Cloud Shell and an example Ubuntu image.

Before you begin

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 API.

   Enable the API

5. 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

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

7. Enable the On-Demand Scanning API.

   Enable the API

Download and scan an image

1. Open a Cloud Shell in your project.

   Open Cloud Shell

   This opens a terminal with all the required tools to follow this guide.

2. Use docker to pull the latest Ubuntu image.

   docker pull ubuntu:latest
   

3. Run the scan.

   gcloud artifacts docker images scan ubuntu:latest
   

   This triggers that scanning process and returns the scan name when finished:

   ✓ 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/1a6fd941-b997-4e5f-ba4f-6351f30e7dad]
   Done.
   
   done: true
   metadata:
     '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesMetadata
     createTime: '2021-01-26T13:43:53.112123Z'
     resourceUri: ubuntu:latest
   name: projects/my-project/locations/us/operations/1a6fd941-b99f-4eaf-ba4f-6e5af30e7dad
   response:
     '@type': type.googleapis.com/google.cloud.ondemandscanning.v1.AnalyzePackagesResponse
     scan: projects/my-project/locations/us/scans/893c91ce-7fe6-4f1a-a69a-d6ca1b465160
   

4. Use the scan name, the value of scan from the output, to fetch the scan results.

   gcloud artifacts docker images list-vulnerabilities \
   projects/my-project/locations/us/scans/893c91ce-7fe6-4f1a-a69a-d6ca1b465160
   

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

If you created a new project for this guide, you can now delete the project.

What's next

• Explore all the On-Demand Scanning API options.
• Enable automated scanning.
• Understand container scanning concepts.