1. Overview

Most vendors' registries comply with the Docker Registry version 2 API, including Docker Hub. To scan a Docker Registry v2 repository, create a new registry scan rule.

For Docker Hub repositories:

  • To specify an official Docker Hub repository, enter library/, followed by the short string used to designate the repo. For example, to scan the images in the official Alpine Linux repository, enter library/alpine.

  • To specify non-official repositories, enter the user name or organization name, followed by a slash, followed by the name of the repo. For example, to specify the alpine repository in onescience’s account, enter onescience/alpine.

  • To scan all repos from a user or organization, simply enter the user or organization name, followed by a wildcard (*). For example, to scan all repos created by onescience, enter onescience*.

Scanning insecure registries (http) is not supported.

Prerequisites: You have installed a Defender somewhere in your environment.

  1. Open Console, and then go to Defend > Vulnerabilities > Registry.

  2. Click Add registry settings.

  3. In the dialog, enter the following information:

    1. In the Version drop-down list, select Docker Registry v2.

    2. Leave the Registry field blank. An empty field specifies Docker Hub (hub.docker.com).

    3. In Repository name, enter the name of the repo to scan. For example, enter library/alpine to scan the official Alpine image. If the repo is part of an organization, use the organization/repository format. For example, bitnami/nginx.

    4. In Credential, select the credentials to use.

      If you are scanning a public repository, leave this field blank.

      If you are scanning a private repository, and Console doesn’t have your credentials yet, click Add New. Select either Basic authentication or Certificate-based authentication, and fill out the rest of the fields. For certificate-based authentication, provide a client certificate with private key, and an optional CA certificate.

    5. In OS type, specify whether the repo holds Linux or Windows images.

    6. In Scanner, select Automatic.

      Console automatically selects an available Defender to execute the scan job. Alternatively, you can explicitly select a Defender from the drop-down list. Defenders are listed according to the hosts where they run. For more information, see deployment patterns.

    7. In Number of scanners, enter the number of Defenders across which scan jobs can be distributed.

    8. Set Cap to the number of most recent images to scan. Leaving Cap set to the default value of 5 will scan the most recent 5 images. Setting this field to 0 will scan all images.

    9. Click Add.

  4. Click the yellow save button.

    save button
  5. Verify that the images in the repository are being scanned.

    1. Go to Monitor > Vulnerabilities > Images > Registries.

      A progress indicator at the top right of the window shows the status of the current scan. As the scan of each image is completed, its findings are added to the results table.

    2. To get details about the vulnerabilities in an image, click on it.

      To force a specific repository to be scanned again, select Scan from the top right of the results table, then click on the specific registry to rescan.