turbot/gcp_compliance

GitHub

GCP Compliance Mod

Run individual configuration, compliance and security controls or full compliance benchmarks for CIS v1.2.0, CIS v1.3.0, Forseti Security and CFT Scorecard for all your GCP projects.

References

GCP provides on-demand cloud computing platforms and APIs to authenticated customers on a metered pay-as-you-go basis.

CFT Scorecard provides a set of security best-practice checks to detect misconfigurations and violations in Google Cloud resources and projects.

CIS GCP Benchmarks provide a predefined set of compliance and security best-practice checks for GCP projects.

Forseti Security Benchmark provides a set of security best practice checks for GCP projects so that you can take action to secure resources and minimize security risks.

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

Steampipe Mods are collections of named queries, and codified controls that can be used to test current configuration of your cloud resources against a desired configuration.

Documentation

Getting started

Installation

Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install steampipe

Install the GCP plugin with Steampipe:

steampipe plugin install gcp

Clone:

git clone https://github.com/turbot/steampipe-mod-gcp-compliance.git
cd steampipe-mod-gcp-compliance

Usage

Start your dashboard server to get started:

steampipe dashboard

By default, the dashboard interface will then be launched in a new browser window at https://localhost:9194. From here, you can run benchmarks by selecting one or searching for a specific one.

Instead of running benchmarks in a dashboard, you can also run them within your terminal with the steampipe check command:

Run all benchmarks:

steampipe check all

Run a single benchmark:

steampipe check benchmark.cis_v130

Run a specific control:

steampipe check control.cis_v130_2_1

Different output formats are also available, for more information please see Output Formats.

Credentials

This mod uses the credentials configured in the Steampipe GCP plugin.

Configuration

No extra configuration is required.

Common and Tag Dimensions

The benchmark queries use common properties (like connection_name, location and project) and tags that are defined in the form of a default list of strings in the mod.sp file. These properties can be overwritten in several ways:

  • Copy and rename the steampipe.spvars.example file to steampipe.spvars, and then modify the variable values inside that file

  • Pass in a value on the command line:

    steampipe check benchmark.cis_v200 --var 'common_dimensions=["connection_name", "location", "project"]'
    steampipe check benchmark.cis_v200 --var 'tag_dimensions=["environment", "owner"]'
  • Set an environment variable:

    SP_VAR_common_dimensions='["connection_name", "location", "project"]' steampipe check control.cis_v120_6_2_4
    SP_VAR_tag_dimensions='["environment", "owner"]' steampipe check control.cis_v120_6_2_4

Contributing

If you have an idea for additional controls or just want to help maintain and extend this mod (or others) we would love you to join the community and start contributing.

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

Want to help but not sure where to start? Pick up one of the help wanted issues: