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.

Documentation

Benchmarks and controls →
Named queries →

Getting Started

Installation

Install Powerpipe (https://powerpipe.io/downloads), or use Brew:

brew install turbot/tap/powerpipe

This mod also requires Steampipe with the Github plugin as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:

brew install turbot/tap/steampipe
steampipe plugin install github

Finally, install the mod:

mkdir dashboards
cd dashboards
powerpipe mod init
powerpipe mod install github.com/turbot/steampipe-mod-github-compliance

Browsing Dashboards

Start Steampipe as the data source:

steampipe service start

Start the dashboard server:

powerpipe server

Browse and view your dashboards at http://localhost:9033.

Running Checks in Your Terminal

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

List available benchmarks:

powerpipe benchmark list

Run a benchmark:

powerpipe benchmark run github_compliance.benchmark.cis_supply_chain_v100

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

Configure Variables

Several 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:

It's easiest to setup your vars file, starting with the sample:

cp powerpipe.ppvars.example powerpipe.ppvars
vi powerpipe.ppvars

Alternatively you can pass variables on the command line:

powerpipe benchmark run github_compliance.benchmark.cis_supply_chain_v100 --var 'trusted_repo_admins=["user_1", "user_2"]'

Or through environment variables:

export PP_VAR_trusted_repo_admins='["user_1", "user_2"]'
powerpipe benchmark run github_compliance.benchmark.cis_supply_chain_v100

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

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Steampipe and Powerpipe are products produced from this open source software, exclusively by Turbot HQ, Inc. They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #powerpipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues: