turbot/net_insights

GitHub

Net Insights Mod

Run individual configuration, compliance and security controls to validate security best practices for DNS records.

References

Net plugin is a set of utility tables for steampipe to query attributes of X.509 certificates associated with websites, DNS records and connectivity to specific network socket addresses.

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

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

Documentation

Getting started

Installation

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

brew tap turbot/tap
brew install steampipe

Install the Net plugin with Steampipe:

steampipe plugin install net

Clone:

git clone https://github.com/turbot/steampipe-mod-net-insights.git
cd steampipe-mod-net-insights

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 view dashboards and reports, and 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.dns_best_practices

Run a specific control:

steampipe check control.dns_ns_name_valid

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

Credentials

No credentials are required.

Configuration

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., controls/dns.sp, but these can be overridden 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.dns_best_practices --var 'dns_domain_names=["github.com", "amazon.com"]'
  • Set an environment variable:

    SP_VAR_dns_domain_names='["github.com", "amazon.com"]' steampipe check control.dns_ns_name_valid
    • 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 dashboards or 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: