Ruby HTML JavaScript HCL CSS TypeScript Other
Switch branches/tags
Clone or download
jquick Update hab plan for hab 0.56+ (#3241)
Signed-off-by: Jared Quick <jquick@chef.io>
Latest commit b8b9a37 Jul 20, 2018
Permalink
Failed to load latest commit information.
.expeditor Add inspec-core gem to expeditor. (#3018) May 3, 2018
.github Update CODEOWNERS file (#2398) Dec 15, 2017
bin Add a CODE_OF_CONDUCT.md (#3212) Jul 17, 2018
ci Updated omnibus `postinst` script to symlink to appbundle created bin… Feb 28, 2018
docs Update docs for registry keys with period characters (#3216) Jul 19, 2018
examples Allow custom resources to access all other resources (#3108) Jun 6, 2018
habitat Update hab plan for hab 0.56+ (#3241) Jul 20, 2018
lib Bump version to 2.2.41 by Chef Expeditor Jul 19, 2018
omnibus Add train GCP transport. (#3046) May 16, 2018
support/ci Add rake task for flushing Fastly cache Apr 28, 2017
tasks Document exit codes for 'inspec exec' and add --no-distinct-exit opti… Jun 29, 2018
test Add Alpine package provider (#3215) Jul 19, 2018
www Fix node dependency issue for website build (#3049) May 16, 2018
.gitignore Refactors Terraform plan to break out steps (#2996) Apr 29, 2018
.kitchen.chef.yml Change Atlas to VagrantCloud (#2372) Dec 5, 2017
.kitchen.ec2.yml call ssh cookbook from prepare cookbook Jan 3, 2017
.kitchen.vagrant.yml Add wildcard support to `Utils::FindFiles` (#2159) Sep 23, 2017
.kitchen.yml update chef version for openssl cookbook May 31, 2017
.rubocop.yml move /tutorial to /demo (#2700) Feb 20, 2018
.travis.yml Fix tests for ruby 2.5 (#3125) Jun 11, 2018
Berksfile Add train GCP transport. (#3046) May 16, 2018
CHANGELOG.md Update CHANGELOG.md to reflect the promotion of 2.2.41 Jul 20, 2018
CODE_OF_CONDUCT.md Add a CODE_OF_CONDUCT.md (#3212) Jul 17, 2018
CONTRIBUTING.md Add a CODE_OF_CONDUCT.md (#3212) Jul 17, 2018
Dockerfile Update CHANGELOG.md to reflect the promotion of 2.2.41 Jul 20, 2018
Gemfile Add train GCP transport. (#3046) May 16, 2018
ISSUE_TEMPLATE.md Add a CODE_OF_CONDUCT.md (#3212) Jul 17, 2018
LICENSE license belongs in LICENSE Nov 3, 2015
MAINTAINERS.md Update maintainers file. (#2728) Feb 22, 2018
MAINTAINERS.toml Update maintainers file. (#2728) Feb 22, 2018
README.md Add a CODE_OF_CONDUCT.md (#3212) Jul 17, 2018
Rakefile Split inspec into a core gem. (#3008) May 3, 2018
VERSION Bump version to 2.2.41 by Chef Expeditor Jul 19, 2018
appveyor.yml Fix tests for ruby 2.5 (#3125) Jun 11, 2018
inspec-core.gemspec Bump train version for inspec. (#3147) Jun 14, 2018
inspec.gemspec Bump train version for inspec. (#3147) Jun 14, 2018
netlify.toml move /tutorial to /demo (#2700) Feb 20, 2018

README.md

InSpec: Inspect Your Infrastructure

Slack Build Status Master Build Status Master

InSpec is an open-source testing framework for infrastructure with a human- and machine-readable language for specifying compliance, security and policy requirements.

# Disallow insecure protocols by testing

describe package('telnetd') do
  it { should_not be_installed }
end

describe inetd_conf do
  its("telnet") { should eq nil }
end

InSpec makes it easy to run your tests wherever you need. More options are found in our CLI docs.

# run test locally
inspec exec test.rb

# run test on remote host on SSH
inspec exec test.rb -t ssh://user@hostname -i /path/to/key

# run test on remote host using SSH agent private key authentication. Requires InSpec 1.7.1
inspec exec test.rb -t ssh://user@hostname

# run test on remote windows host on WinRM
inspec exec test.rb -t winrm://Administrator@windowshost --password 'your-password'

# run test on docker container
inspec exec test.rb -t docker://container_id

Features

  • Built-in Compliance: Compliance no longer occurs at the end of the release cycle
  • Targeted Tests: InSpec writes tests that specifically target compliance issues
  • Metadata: Includes the metadata required by security and compliance pros
  • Easy Testing: Includes a command-line interface to run tests quickly

Installation

InSpec requires Ruby ( >2.2 ).

Install as package

The InSpec package is available for MacOS, RedHat, Ubuntu and Windows. Download the latest package at InSpec Downloads or install InSpec via script:

# RedHat, Ubuntu, and macOS
curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -P inspec

# Windows
. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -project inspec

Install it via rubygems.org

When installing from source, gem dependencies may require ruby build tools to be installed.

For CentOS/RedHat/Fedora:

yum -y install ruby ruby-devel make gcc gcc-c++

For Ubuntu:

apt-get -y install ruby ruby-dev gcc g++ make

To install inspec from rubygems:

gem install inspec

Usage via Docker

Download the image and define a function for convenience:

For Linux:

docker pull chef/inspec
function inspec { docker run -it --rm -v $(pwd):/share chef/inspec "$@"; }

For Windows (PowerShell):

docker pull chef/inspec
function inspec { docker run -it --rm -v "$(pwd):/share" chef/inspec $args; }

If you call inspec from your shell, it automatically mounts the current directory into the Docker container. Therefore you can easily use local tests and key files. Note: Only files in the current directory and sub-directories are available within the container.

$ ls -1
vagrant
test.rb

$ inspec exec test.rb -t ssh://root@192.168.64.2:11022 -i vagrant
..

Finished in 0.04321 seconds (files took 0.54917 seconds to load)
2 examples, 0 failures

Install it from source

That requires bundler:

bundle install
bundle exec bin/inspec help

To install it as a gem locally, run:

gem build inspec.gemspec
gem install inspec-*.gem

On Windows, you need to install Ruby with Ruby Development Kit to build dependencies with its native extensions.

Install via Habitat

Currently, this method of installation only supports Linux. See the Habitat site for more information.

Download the hab binary from the Habitat site.

hab pkg install chef/inspec
export PATH="$(hab pkg path core/ruby)/bin:$(hab pkg path chef/inspec)/bin:$PATH"

inspec

Run InSpec

You should now be able to run:

$ inspec --help
Commands:
  inspec archive PATH                # archive a profile to tar.gz (default) ...
  inspec check PATH                  # verify all tests at the specified PATH
  inspec compliance SUBCOMMAND ...   # Chef Compliance commands
  inspec detect                      # detect the target OS
  inspec exec PATH(S)                # run all test files at the specified PATH.
  inspec help [COMMAND]              # Describe available commands or one spe...
  inspec init TEMPLATE ...           # Scaffolds a new project
  inspec json PATH                   # read all tests in PATH and generate a ...
  inspec shell                       # open an interactive debugging shell
  inspec supermarket SUBCOMMAND ...  # Supermarket commands
  inspec version                     # prints the version of this tool

Options:
  [--diagnose], [--no-diagnose]  # Show diagnostics (versions, configurations)

Examples

  • Only accept requests on secure ports - This test ensures that a web server is only listening on well-secured ports.
describe port(80) do
  it { should_not be_listening }
end

describe port(443) do
  it { should be_listening }
  its('protocols') {should include 'tcp'}
end
  • Use approved strong ciphers - This test ensures that only enterprise-compliant ciphers are used for SSH servers.
describe sshd_config do
   its('Ciphers') { should eq('chacha20-poly1305@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr') }
end
  • Test your kitchen.yml file to verify that only Vagrant is configured as the driver. The %w() formatting will pass rubocop linting and allow you to access nested mappings.
describe yaml('.kitchen.yml') do
  its(%w(driver name)) { should eq('vagrant') }
end

Also have a look at our examples for:

Or tests: Testing for a OR b

  • Using describe.one, you can test for a or b. The control will be marked as passing if EITHER condition is met.
control 'or-test' do
  impact 1.0
  title 'This is a OR test'
  describe.one do
    describe ssh_config do
      its('Protocol') { should eq('3') }
    end
    describe ssh_config do
      its('Protocol') { should eq('2') }
    end
  end
end

Command Line Usage

exec

Run tests against different targets:

# run test locally
inspec exec test.rb

# run test on remote host on SSH
inspec exec test.rb -t ssh://user@hostname

# run test on remote windows host on WinRM
inspec exec test.rb -t winrm://Administrator@windowshost --password 'your-password'

# run test on docker container
inspec exec test.rb -t docker://container_id

# run with sudo
inspec exec test.rb --sudo [--sudo-password ...] [--sudo-options ...] [--sudo_command ...]

# run in a subshell
inspec exec test.rb --shell [--shell-options ...] [--shell-command ...]

# run a profile targeting AWS using env vars
inspec exec test.rb -t aws://

# or store your AWS credentials in your ~/.aws/credentials profiles file
inspec exec test.rb -t aws://us-east-2/my-profile

# run a profile targeting Azure using env vars
inspec exec test.rb -t azure://

# or store your Azure credentials in your ~/.azure/credentials profiles file
inspec exec test.rb -t azure://subscription_id

detect

Verify your configuration and detect

id=$( docker run -dti ubuntu:14.04 /bin/bash )
inspec detect -t docker://$id

Which will provide you with:

{"family":"ubuntu","release":"14.04","arch":null}

Supported OS

Remote Targets

Platform Versions Architectures
AIX 6.1, 7.1, 7.2 ppc64
CentOS 5, 6, 7 i386, x86_64
Debian 7, 8 i386, x86_64
FreeBSD 9, 10 i386, amd64
Mac OS X 10.9, 10.10, 10.11 x86_64
Oracle Enterprise Linux 5, 6, 7 i386, x86_64
Red Hat Enterprise Linux 5, 6, 7 i386, x86_64
Solaris 10, 11 sparc, x86
Windows* 7, 8, 8.1, 10, 2008, 2008R2 , 2012, 2012R2, 2016 x86, x86_64
Ubuntu Linux x86, x86_64
SUSE Linux Enterprise Server 11, 12 x86_64
Scientific Linux 5.x, 6.x and 7.x i386, x86_64
Fedora x86_64
OpenSUSE 13.1/13.2/42.1 x86_64
OmniOS x86_64
Gentoo Linux x86_64
Arch Linux x86_64
HP-UX 11.31 ia64

*For Windows, PowerShell 5.0 or above is required.

In addition, runtime support is provided for:

Platform Versions
Debian 8
RHEL 6, 7
Ubuntu 12.04+
Windows 7+
Windows 2012+

Documentation

Documentation

Tutorials/Blogs/Podcasts:

Relationship to other tools (RSpec, Serverspec):

Share your Profiles

You may share your InSpec Profiles in the Tools & Plugins section of the Chef Supermarket. Sign in and add the details of your profile.

You may also browse the Supermarket for shared Compliance Profiles.

Kudos

InSpec is inspired by the wonderful Serverspec project. Kudos to mizzy and all contributors!

The AWS resources were inspired by inspec-aws from arothian.

Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

The InSpec community and maintainers are very active and helpful. This project benefits greatly from this activity.

If you'd like to chat with the community and maintainers directly join us in the #inspec channel on the Chef Community Slack.

As a reminder, all participants are expected to follow the Code of Conduct.

Slack

Testing InSpec

We offer unit, integration, and aws tests.

  • unit tests ensure the intended behaviour of the implementation
  • integration tests run against Docker-based VMs via test-kitchen and kitchen-inspec
  • aws tests exercise the AWS resources against real AWS accounts

Unit tests

bundle exec rake test

If you like to run only one test file:

bundle exec m test/unit/resources/user_test.rb

You may also run a single test within a file by line number:

bundle exec m test/unit/resources/user_test.rb -l 123

Integration tests

These tests download various virtual machines, to ensure InSpec is working as expected across different operating systems.

These tests require the following gems:

  • test-kitchen
  • kitchen-dokken
  • kitchen-inspec

These gems are provided via the integration group in the project's Gemfile.

In addition, these test require Docker to be available on your machine or a remote Docker machine configured via the standard Docker environment variables.

Running Integration tests

List the various test instances available:

bundle exec kitchen list

The platforms and test suites are configured in the .kitchen.yml file. Once you know which instance you wish to test, test that instance:

bundle exec kitchen test <INSTANCE_NAME>

You may test all instances in parallel with:

bundle exec kitchen test -c

AWS Tests

Use the rake task bundle exec rake test:aws to test the AWS resources against a pair of real AWS accounts.

Please see TESTING_AGAINST_AWS.md for details on how to setup the needed AWS accounts to perform testing.

Azure Tests

Use the rake task bundle exec rake test:azure to test the Azure resources against an Azure account.

Please see TESTING_AGAINST_AZURE.md for details on how to setup the needed Azure accounts to perform testing.

License

Author: Dominik Richter (drichter@chef.io)
Author: Christoph Hartmann (chartmann@chef.io)
Copyright: Copyright (c) 2015 Vulcano Security GmbH.
Copyright: Copyright (c) 2017 Chef Software Inc.
License: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.