Skip to content

Latest commit

 

History

History
123 lines (78 loc) · 5.08 KB

index.md

File metadata and controls

123 lines (78 loc) · 5.08 KB
Raw
repository

GitHub Compliance Mod

Run security controls across all your GitHub organizations and repositories to look for branch protection rules, organization member privileges, security settings, and more.

References

GitHub is a provider of Internet hosting for software development and version control using Git.

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 GitHub plugin with Steampipe:

steampipe plugin install github

Clone:

git clone https://github.com/turbot/steampipe-mod-github-compliance.git
cd steampipe-mod-github-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_supply_chain_v100

Run a specific control:

steampipe check control.cis_supply_chain_v100_1_1_3

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

Credentials

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

Configuration

Few benchmarks have input variables that can be configured to better match your environment and requirements. Each variable has a default defined in its source file, e.g., cis_supply_chain_v100/section_1.sp, but these 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 control.cis_supply_chain_v100_1_2_3 --var='trusted_repo_admins=["user_1", "user_2"]'

  • Set an environment variable:

    SP_VAR_trusted_repo_admins='["user_1", "user_2"]' steampipe check control.cis_supply_chain_v100_1_2_3
    • Note: When using environment variables, if the variable is defined in steampipe.spvars or passed in through the command line, either of those will take precedence over the environment variable value. For more information on variable definition precedence, please see the link below.

These are only some of the ways you can set variables. For a full list, please see Passing Input Variables.

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: