Integrate a new Google Artifact Registry source

info

This integration leads to an automatic full scan of your monitored repositories. This implies an initial download of your Docker images, which may incur bandwidth costs with your Cloud Provider. To reduce these costs, while minimizing the risk of false positives, we recommend you to take advantage of the Filepath exclusion feature by adding this suggestion of filepaths to exclude from scanning.

Setting up and configuring this integration is limited to users with an Owner or Manager access level. Google Artifact Registry installation is only open to workspaces under the Business plan. However, you can install and test secret detection in Google Artifact Registry with a 30-day trial. Any secret incidents detected during the trial will remain accessible in your incident dashboard.

GitGuardian integrates natively with Google Artifact Registry via a Service Account that you can create from your Google Artifact Registry instance. Note that GitGuardian only has read access to your repositories.

Setup your Google Artifact Registry integration

You can install GitGuardian on multiple Google Artifact Registry instances to monitor your repositories.

1. Make sure you're logged as an administrator in your Google Cloud Console

2. Click Select a project and select the project you want to integrate

3. Open the menu and go to the Project settings

4. Go to the Service Accounts section

5. Click CREATE SERVICE ACCOUNT

6. Type a Service account name and click CREATE AND CONTINUE

7. Select Artifact Registry Reader as a role and click CONTINUE

8. You can skip the 3rd step and click DONE

9. Click the menu next to the new service account and select Manage keys

10. Click the ADD KEY menu and select Create new key

11. Select JSON as a key type and click CREATE This will create your new key and download it locally in a JSON file

12. In the GitGuardian platform, navigate to the Sources integration page

13. Click Install next to Google Artifact Registry in the Container registries section

14. Click Install on the Google Artifact Registry integration page

15. Type your Region (e.g.: us-west2)

16. Paste your Service Account Key in JSON format

17. Click Add

18. Customize your monitored perimeter:

    • Monitor specific Google Artifact Registry repositories (Recommended)
      • No repositories are monitored by default, you will have to select them manually.
      • Newly created repositories will not be monitored by default. You can adjust this setting at any time.
      • Recommended to optimize your bandwidth costs.
    • Monitor the entire Google Artifact Registry instance
      • All repositories are monitored by default with a full historical scan automatically triggered.
      • Newly created repositories will be monitored by default. You can adjust this setting at any time.

    

That's it! Your Google Artifact Registry instance is now installed, and GitGuardian is monitoring all Docker images of your selected repositories for secrets.

Customize your monitored perimeter

To customize the monitored repositories, navigate to your Google Artifact Registry settings.

1. Select/Unselect repositories to include or exclude them from monitoring
2. Confirm by clicking Update monitored perimeter

Automatic repository monitoring

You can enable or disable the automatic addition of newly created repositories to your monitored perimeter by switching the option in your Google Artifact Registry settings.

Uninstall your Google Artifact Registry instance

To uninstall a Google Artifact Registry instance:

1. In the GitGuardian platform, navigate to the Sources integration page
2. Click Edit next to Google Artifact Registry in the Container registries section
3. Click the bin icon next to the Google Artifact Registry instance to uninstall
4. Confirm by clicking Yes, uninstall in the confirmation modal

That's it! Your Google Artifact Registry instance is now uninstalled.

Excluded paths

GitGuardian automatically excludes files from scanning if their paths contain any of these regular expressions:

/__pypackages__/
/\.venv/
/\.tox/
/site-packages/
/venv/
distutils/command/register.py
python.*/awscli/examples/
python.*/dulwich/(tests|contrib/test_)
python.*/hgext/bugzilla.py
python.*/mercurial/util.py
python.*/test/certdata/
python.*/urllib/request\.py
python.*/pygments/lexers/
/cryptography.+/tests/.+(fixtures|test)_.+.py
/python.+pygpgme.+/tests/
botocore/data/.+/(examples|service)-.+.json
usr(/local)?/lib/python.+/dist-packages
/libevent.+/info/test/test/
/conda-.+-py.+/info/test/tests.+/test_.+\.py
/python[^/]+/test/
/man/man5/kdc\.conf\.5
erlang.*(inets|ssl).*/examples/
/gems/.*httpclient.*/(test|sample)/
/gems/.*faraday.*/
/vendor/bundle/
/\.gem/
/(g|G)o/src/cmd/go/internal/.*_test.go
/(g|G)o/src/cmd/go/internal/.*/testdata/
/(g|G)o/src/cmd/go/testdata/
/(g|G)o/src/crypto/x509/platform_root_key.pem
/(G|g)o/src/crypto/tls/.*_test.go
/(g|G)o/src/net/(url|http)/.*_test.go
src/github.com/DataDog/datadog-agent/.*test.*.go
google/internal/.*_test.go
golang.org.*oauth2@.*/.*.go
/flutter/.*/packages/flutter_tools/test/data/
/flutter/.*/examples/image_list/lib
/\.pub-cache
etc/ssl/private/ssl-cert-snakeoil\.key
perl.*Cwd.pm
ansible/.*/tests/(integration|unit)/
ansible/.*/test/awx
ansible/collections/ansible_collections/.*/plugins/
/curl/.*/(tests|docs|lib/url.c)
/doc/wget.+/NEWS
dist/awscli/examples/
usr(/local)?/lib/aws-cli/examples/
/google-cloud-sdk/(lib|platform)/
\.git/modules/third[-_]?party/
\.git/modules/external/
/\.npm/_cacache
/node_modules/
/\.parcel-cache/
/\.yarn/cache/
/\.m2/
/\.ivy2/cache/
/\.mix/
/\.hex/
/composer/cache/
/\.nuget/packages/
/libgpg-error/errorref\.txt
/Homebrew/Library/Taps/
/tcl[^/]+/http-.+.tm

Limitations

This integration is currently in beta and has the following limitations:

• Scan Frequency: Scans occur once a day. It may take several hours to detect newly leaked secrets.
  For GitGuardian Self-Hosted instances, scan frequency can be configured in the Admin Area.
  • Time interval unit: seconds
  • Default value: 86400 (1 day)
  • Minimum value: 1800 (30 minutes)
• Team Perimeter: Customization of a team perimeter with Google Artifact Registry repositories is not supported. Users must be in All-incidents team to view and access Google Artifact Registry incidents.
• Source Visibility: The visibility of repositories is not determined. All repositories are considered private in both the UI and API.
• Presence Check: The presence check feature is not supported. All occurrences are considered present in both the UI and API.
• Occurrence Previews: Previews of occurrences are not supported.

Privacy

Country-specific laws and regulations may require you to inform your users that your repositories are being scanned for secrets. Here is a suggestion for a message you may want to use:

As part of our internal information security process, the company scans its repositories for potential secrets leaks using GitGuardian. All data collected will be processed for the purpose of detecting potential leaks. To find out more about how we manage your personal data and to exercise your rights, please refer to our employee/partner privacy notice. Please note that only repositories relating to the company’s activity and business may be monitored and that users shall refrain from sharing personal or sensitive data not relevant to the repository’s purpose.