inspec 0.35.0 → 1.0.0.beta2

data/docs/dsl_resource.rst

@@ -1,90 +0,0 @@
-=====================================================
-Resource DSL
-=====================================================
-
-InSpec provides a mechanism for defining custom resources. These become available with their respective names and provide easy functionality to profiles.
-
-Resource location
------------------------------------------------------
-
-Resources may be added to profiles in the `libraries` folder:
-
-.. code-block:: bash
-
-  $ tree examples/profile
-  examples/profile
-  ...
-  ├── libraries
-  │   └── gordon_config.rb
-
-
-Resource structure
------------------------------------------------------
-
-The smallest possible resource takes this form:
-
-.. code-block:: ruby
-
-  class Tiny < Inspec.resource(1)
-    name 'tiny'
-  end
-
-Resources are written as a regular Ruby `class` which inherits from `Inspec.resource`. The number (`1`) specifies the version this resource plugin targets. As InSpec evolves, this interface may change and may require a higher version.
-
-The following attributes can be configured:
-
-* `name` - Identifier of the resource (required)
-* `desc` - Description of the resource (optional)
-* `example` - Example usage of the resource (optional)
-
-The following methods are available to the resource:
-
-* `inspec` - Contains a registry of all other resources to interact with the operating system or target in general.
-* `skip_resource` - A resource may call this method to indicate, that requirements aren't met. All tests that use this resource will be marked as `skipped`.
-
-The following example shows a full resource using attributes and methods to provide simple access to a configuration file:
-
-.. code-block:: ruby
-
-  class GordonConfig < Inspec.resource(1)
-    name 'gordon_config'
-
-    desc '
-      Resource description ...
-    '
-
-    example '
-      describe gordon_config do
-        its("signal") { should eq "on" }
-      end
-    '
-
-    # Load the configuration file on initialization
-    def initialize(path = nil)
-      @path = path || '/etc/gordon.conf'
-      @params = SimpleConfig.new( read_content )
-    end
-
-    # Expose all parameters of the configuration file.
-    def method_missing(name)
-      @params[name]
-    end
-
-    private
-
-    def read_content
-      f = inspec.file(@path)
-      # Test if the path exist and that it's a file
-      if f.file?
-        # Retrieve the file's contents
-        f.content
-      else
-        # If the file doesn't exist, skip all tests that use gordon_config
-        skip_resource "Can't read config from #{@path}."
-      end
-    end
-  end
-
-For a full example, see our `example resource`_.
-
-.. _example resource: ../examples/profile/libraries/gordon_config.rb

data/docs/inspec_and_friends.rst

@@ -1,85 +0,0 @@
-=====================================================
-InSpec and friends
-=====================================================
-
-RSpec
-=====================================================
-
-RSpec is an awesome framework that is widely used to test Ruby code. It enables test-driven development (TDD) and helps developers to write better code every day.
-
-InSpec is built on top of RSpec and uses it as the underlying foundation to execute tests. It uses the key strengths of RSpec, easily execute tests and a DSL to write tests, but extends the functionality for use as compliance audits. InSpec ships with custom audit resources that make it easy to write audit checks and with the ability to run those checks on remote servers. These audit resources provided know the differences between operating systems and help you abstract from the local operating system, similar to other resources you might use in your Chef recipes.
-
-A complete InSpec rule looks like:
-
-.. code-block:: ruby
-
-  control "sshd-11" do
-    impact 1.0
-    title "Server: Set protocol version to SSHv2"
-    desc "Set the SSH protocol version to 2. Don't use legacy
-          insecure SSHv1 connections anymore."
-    tag security: "level-1"
-    tag "openssh-server"
-    ref "Server Security Guide v.1.0", url: "http://..."
-
-    describe sshd_config do
-      its('Protocol') { should eq('2') }
-    end
-  end
-
-
-
-Serverspec
-=====================================================
-
-Serverspec can be credited as the first extension of RSpec that enabled users to run RSpec tests on servers to verify deployed artifacts. It was created in March 2013 by Gosuke Miyashita and has been widely adopted. It is also one of the core test frameworks within test-kitchen and has been widely used within the Chef ecosystem.  InSpec takes lessons learned implementing and using Serverspec and builds on them to make auditing and compliance easier.
-
-Lessons learned from Serverspec include:
-
-* IT, compliance, and security professional require metadata beyond what Serverspec offers, such as criticality, to fully describe controls.
-
-* Setting up and running the same tests across multiple machines must be easy.
-
-* It must be easy to locate, debug, and extend operating system-dependent code.
-
-* It must be easy to extend the language and create custom resources.
-
-* It must run multiple tests simultaneously.
-
-* Support for Windows is a first-class requirement.
-
-* A command line interface (CLI) is required for faster iteration of test code.
-
-
-How is InSpec different than Serverspec
------------------------------------------------------
-
-One of the key differences is that InSpec targets more user groups. It is optimized for DevOps, Security, and Compliance professionals. Additional metadata, such as impact, title, and description, make it easier to fully describe the controls which makes it easier to share the controls with other departments. This enables Security departments to prioritize rules. DevOps teams use this information to focus on the most critical issues to remediate.
-
-.. code-block:: ruby
-
-  control "sshd-11" do
-    impact 1.0
-    title "Server: Set protocol version to SSHv2"
-    desc "Set the SSH protocol version to 2. Don't use legacy
-          insecure SSHv1 connections anymore."
-    tag security: "level-1"
-    tag "openssh-server"
-    ref "Server Security Guide v.1.0" url: "http://..."
-
-    describe sshd_config do
-      its('Protocol') { should cmp 2 }
-    end
-  end
-
-**Why not fork Serverspec?**
-
-InSpec started as an extension of Serverspec. As the extension grew, it became clear that a new library was required.  Creating and maintaining a fork was not practical so a new project was born.
-
-**Will InSpec only work on machines managed by Chef?**
-
-No, InSpec can be used on any machine.  It doesn’t matter if that machine was configured by Chef or configured lovingly by the hands of your local System Administrator.
-
-**Is InSpec a replacement of Serverspec?**
-
-InSpec is intended to be a drop-in replacement of Serverspec. Popular Serverspec resources have been ported to InSpec. It changed some behaviour as documented in our migration guide.

data/docs/matchers.rst

@@ -1,137 +0,0 @@
-=====================================================
-InSpec Matchers Reference
-=====================================================
-
-
-Inspec uses matchers to help compare resource values to expectations. The following matchers are available:
-
-* `be`
-* `cmp`
-* `eq`
-* `include`
-* `match`
-
-
-be
-=====================================================
-
-This matcher can be followed by many different comparison operators. Always make sure to use numbers, not strings, for these comparisons.
-
-.. code-block:: ruby
-
-  describe file('/proc/cpuinfo') do
-    its('size') { should be >= 10 }
-    its('size') { should be < 1000 }
-  end
-
-cmp
-=====================================================
-
-Unlike ``eq``, cmp is a matcher for less-restrictive comparisons. It will try to fit the actual value to the type you are comparing it to. This is meant to relieve the user from having to write type-casts and resolutions.
-
-.. code-block:: ruby
-
-  describe sshd_config do
-    its('Protocol') { should cmp 2 }
-  end
-
-  describe passwd.uid(0) do
-    its('users') { should cmp 'root' }
-  end
-
-``cmp`` behaves in the following way:
-
-* Compare strings to numbers
-
-  .. code-block:: ruby
-
-    describe sshd_config do
-      its('Protocol') { should eq '2' }
-
-      its('Protocol') { should cmp '2' }
-      its('Protocol') { should cmp 2 }
-    end
-
-* String comparisons are not case-sensitive
-
-  .. code-block:: ruby
-
-    describe auditd_conf do
-      its('log_format') { should cmp 'raw' }
-      its('log_format') { should cmp 'RAW' }
-    end
-
-* Compare arrays with only one entry to a value
-
-  .. code-block:: ruby
-
-    describe passwd.uids(0) do
-      its('users') { should cmp 'root' }
-      its('users') { should cmp ['root'] }
-    end
-
-* Single-value arrays of strings may also be compared to a regex
-
-  .. code-block:: ruby
-
-    describe auditd_conf do
-      its('log_format') { should cmp /raw/i }
-    end
-
-* Improved printing of octal comparisons
-
-  .. code-block:: ruby
-
-    describe file('/proc/cpuinfo') do
-      its('mode') { should cmp '0345' }
-    end
-
-    expected: 0345
-    got: 0444
-
-eq
-=====================================================
-
-Test for exact equality of two values.
-
-.. code-block:: ruby
-
-  describe sshd_config do
-    its('RSAAuthentication') { should_not eq 'no' }
-    its('Protocol') { should eq '2' }
-  end
-
-It fails if types don't match. Please keep this in mind, when comparing configuration
-entries that are numbers:
-
-.. code-block:: ruby
-
-  its('Port') { should eq '22' } # ok
-
-  its('Port') { should eq 22 }
-  # fails: '2' != 2 (string vs int)
-
-For less restrictive comparisons, please use ``cmp``.
-
-include
-=====================================================
-
-Verifies if a value is included in a list.
-
-.. code-block:: ruby
-
-  describe passwd do
-    its('users') { should include 'my_user' }
-  end
-
-
-match
-=====================================================
-
-Check if a string matches a regular expression.
-
-.. code-block:: ruby
-
-  describe sshd_config do
-    its('Ciphers') { should_not match /cbc/ }
-  end

data/docs/profiles.rst

@@ -1,169 +0,0 @@
-=====================================================
-InSpec Profiles
-=====================================================
-
-InSpec supports the creation of complex test and compliance profiles, which organize controls to support dependency management and code re-use. These profiles are standalone structures with their own distribution and execution flow.
-
-InSpec profile structure
------------------------------------------------------
-
-To create a new profile just place the files according to the following structure:
-
-.. code-block:: bash
-
-  $ tree examples/profile
-  examples/profile
-  ├── README.md
-  ├── controls
-  │   ├── example.rb
-  │   └── gordon.rb
-  ├── libraries
-  │   └── gordon_config.rb
-  └── inspec.yml
-
-
- * `inspec.yml` - includes the profile description (required)
- * `controls` - a folder which contains  all tests (required)
- * `libraries` - a folder which contains InSpec resource extensions (optional)
- * `README.md` - a best-practice readme to each explain the profile and its scope
-
-For a full example, see our `example profile`_.
-
-.. _example profile: ../examples/profile
-
-InSpec profile manifest
------------------------------------------------------
-
-Each profile has a manifest file `inspec.yml`. It looks as follows
-
-.. code-block:: yaml
-
-  name: ssh
-  title: Basic SSH
-  maintainer: Chef Software, Inc.
-  copyright: Chef Software, Inc.
-  copyright_email: support@chef.io
-  license: Proprietary, All rights reserved
-  summary: Verify that SSH Server and SSH Client are configured securely
-  version: 1.0.0
-  supports:
-    - os-family: linux
-
-
-A manifest description may contain the following values:
-
- * `name` - Identifier of the profile (required)
- * `title` - Human-readable name of the profile (optional)
- * `maintainer` - Name of the profile maintainer (optional)
- * `copyright` - Copyright holder (optional)
- * `copyright_email` - Support contact for profile (optional)
- * `license` - License of the profile (optional)
- * `summary` - One-line summary of the profile (optional)
- * `description` - Description of the profile (optional)
- * `version` - Version of the profile (optional)
- * `supports` - A list of supported targets (optional)
-
-Supported targets
------------------------------------------------------
-
-The manifest contains the `supports` flag, which specifies operating systems or even cloud systems that the profile is targeting.
-
-This list can contain simple names, names and versions, or detailed flags for the targeted system. These can freely be combined:
-
-.. code-block:: yaml
-
-  name: ssh
-  supports:
-    // Runs on any version of Debian Linux
-    - os-name: debian
-
-    // Only runs on Ubuntu 14.04
-    - os-name: ubuntu
-      release: 14.04
-
-    // Targets RedHat, CentOS, Oracle Linux ...
-    - os-family: redhat
-
-    // Or even broader
-    - platform: aws
-
-
-InSpec profile verification
------------------------------------------------------
-
-InSpec ships with a verification command that verifies the implementation of a profile:
-
-.. code-block:: bash
-
-  $ inspec check examples/profile
-
-
-InSpec profile archive
------------------------------------------------------
-
-Profiles are composed of multiple files. This hinders easy distribution of a profile. InSpec solves the problem by offering to collect all files in one archive.
-
-The InSpec profile archive format aims for flexibility and reuse of standard and common technologies:
-
- * tar and gzip (default)
- * zip
- * HTTP
-
-This should enable third-parties to easily build InSpec profile archives:
-
- * InSpec archives MUST be named with the stanard suffix
- * InSpec archives MUST be a tar.gz or zip formatted file
- * InSpec archives MUST have no duplicate entries
- * InSpec archives MAY be compressed with gzip, bzip2, or xz.
-
-InSpec is able to create profile archive for you. By default it generates a tar-file on Unix and zip on Windows or Mac.
-
-.. code-block:: bash
-
-  # will generate a example-profile.tar.gz
-  $ inspec archive examples/profile
-
-  # will generate a example-profile.zip
-  $ inspec archive examples/profile --zip
-
-
-Profile inheritance
------------------------------------------------------
-
-**Include controls of existing profile**
-
-The `include_controls` keyword allows you to import all rules from an existing profile. This can be easily extended with additional rules.
-
-.. code-block:: bash
-
-  include_controls 'cis-level-1' do
-
-    control "cis-fs-2.7" do
-      impact 1.0
-    ...
-
-  end
-
-**Inherit from a profile, but skip some rules**
-
-Sometimes, not all requirements can be fulfilled for a legacy application. To manage the derivation, you can skip certain controls with `skip_control`.
-
-.. code-block:: bash
-
-  include_controls 'cis-level-1' do
-
-    skip_control "cis-fs-2.1"
-    skip_control "cis-fs-2.2"
-
-  end
-
-**Load specific controls from another profile**
-
-.. code-block:: bash
-
-  require_controls 'cis-level-1' do
-
-    control "cis-fs-2.1"
-    control "cis-fs-2.2"
-
-  end