inspec 0.35.0 → 1.0.0.beta2

data/lib/inspec/shell.rb

@@ -15,18 +15,13 @@ module Inspec
     end
 
     def start
-      # Create an in-memory empty runner so that we can add tests to it later.
-      # This context lasts for the duration of this "start" method call/pry
-      # session.
-      @ctx = @runner.create_context
-      configure_pry
-
       # This will hold a single evaluation binding context as opened within
       # the instance_eval context of the anonymous class that the profile
       # context creates to evaluate each individual test file. We want to
       # pretend like we are constantly appending to the same file and want
       # to capture the local variable context from inside said class.
-      @ctx_binding = @ctx.load('binding')
+      @ctx_binding = @runner.eval_with_virtual_profile('binding')
+      configure_pry
       @ctx_binding.pry
     end
 
@@ -51,26 +46,20 @@ module Inspec
 
       # Track the rules currently registered and what their merge count is.
       Pry.hooks.add_hook(:before_eval, 'inspec_before_eval') do
-        @current_eval_rules = @ctx.rules.each_with_object({}) do |(rule_id, rule), h|
-          h[rule_id] = Inspec::Rule.merge_count(rule)
-        end
         @runner.reset
       end
 
       # After pry has evaluated a commanding within the binding context of a
       # test file, register all the rules it discovered.
       Pry.hooks.add_hook(:after_eval, 'inspec_after_eval') do
-        @current_eval_new_tests =
-          @runner.register_rules(@ctx) do |rule_id, rule|
-            @current_eval_rules[rule_id] != Inspec::Rule.merge_count(rule)
-          end
-        @runner.run if @current_eval_new_tests
+        @runner.load
+        @runner.run_tests if !@runner.all_rules.empty?
       end
 
       # Don't print out control class inspection when the user uses DSL methods.
       # Instead produce a result of evaluating their control.
       Pry.config.print = proc do |_output_, value, pry|
-        next if @current_eval_new_tests
+        next if !@runner.all_rules.empty?
         pry.pager.open do |pager|
           pager.print pry.config.output_prefix
           Pry::ColorPrinter.pp(value, pager, Pry::Terminal.width! - 1)

data/lib/inspec/version.rb

@@ -4,5 +4,5 @@
 # author: Christoph Hartmann
 
 module Inspec
-  VERSION = '0.35.0'.freeze
+  VERSION = '1.0.0.beta2'.freeze
 end

data/lib/resources/apache_conf.rb

@@ -105,7 +105,7 @@ module Inspec::Resources
 
       includes = []
       (include_files + include_files_optional).each do |f|
-        id = File.join(@conf_dir, f)
+        id    = Pathname.new(f).absolute? ? f : File.join(@conf_dir, f)
         files = find_files(id, depth: 1, type: 'file')
 
         includes.push(files) if files

data/lib/resources/gem.rb

@@ -9,6 +9,7 @@ module Inspec::Resources
     example "
       describe gem('rubocop') do
         it { should be_installed }
+        its('version') { should eq '0.33.0' }
       end
     "
 

data/lib/resources/oneget.rb

@@ -16,6 +16,7 @@ module Inspec::Resources
     example "
       describe oneget('zoomit') do
         it { should be_installed }
+        its('version') { should eq '1.2.3' }
       end
     "
 

data/lib/resources/os.rb

@@ -7,7 +7,7 @@ module Inspec::Resources
     name 'os'
     desc 'Use the os InSpec audit resource to test the platform on which the system is running.'
     example "
-      describe os.family do
+      describe os[:family] do
         it { should eq 'redhat' }
       end
 

data/lib/resources/package.rb

@@ -91,9 +91,11 @@ module Inspec::Resources
         assignment_re: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
         multiple_values: false,
       ).params
+      # If the package is removed and not purged, Status is "deinstall ok config-files" with exit_status 0
+      # If the package is purged cmd fails with non-zero exit status
       {
         name: params['Package'],
-        installed: true,
+        installed: params['Status'].split(' ').first == 'install',
         version: params['Version'],
         type: 'deb',
       }

data/lib/resources/pip.rb

@@ -49,7 +49,7 @@ module Inspec::Resources
     end
 
     def to_s
-      "Pip Package  #{@package_name}"
+      "Pip Package #{@package_name}"
     end
 
     private

data/lib/resources/ssl.rb

@@ -44,18 +44,16 @@ class SSL < Inspec.resource(1)
   attr_reader :host, :port
 
   def initialize(opts = {})
-    @host = opts[:host] ||
-            inspec.backend.instance_variable_get(:@hostname)
-    # FIXME: This can be removed when/if @hostname is available as a property for 'Train::Transports::WinRM::Connection'
-    # Train enhancement request for this here: https://github.com/chef/train/issues/128
-    if @host.nil? && inspec.backend.class.to_s == 'Train::Transports::WinRM::Connection'
-      @host = URI.parse(inspec.backend.instance_variable_get(:@options)[:endpoint]).hostname
-    end
-    if @host.nil? && inspec.backend.class.to_s == 'Train::Transports::Local::Connection'
-      @host = 'localhost'
-    end
+    @host = opts[:host]
     if @host.nil?
-      fail 'Cannot determine host for SSL test. Please specify it or use a different target.'
+      # Transports like SSH and WinRM will provide a hostname
+      if inspec.backend.respond_to?('hostname')
+        @host = inspec.backend.hostname
+      elsif inspec.backend.class.to_s == 'Train::Transports::Local::Connection'
+        @host = 'localhost'
+      else
+        fail 'Cannot determine host for SSL test. Please specify it or use a different target.'
+      end
     end
     @port = opts[:port] || 443
     @timeout = opts[:timeout]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.19.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.19.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -224,17 +224,17 @@ files:
 - README.md
 - Rakefile
 - bin/inspec
+- docs/README.md
 - docs/cli.rst
-- docs/dsl_inspec.rst
-- docs/dsl_resource.rst
-- docs/inspec_and_friends.rst
-- docs/matchers.rst
-- docs/profiles.rst
-- docs/readme.rst
+- docs/dsl_inspec.md
+- docs/dsl_resource.md
+- docs/inspec_and_friends.md
+- docs/matchers.md
+- docs/plugin_kitchen_inspec.html.md
+- docs/profiles.md
 - docs/resources.rst
 - docs/ruby_usage.rst
-- docs/shell.rst
-- docs/template.rst
+- docs/shell.md
 - examples/README.md
 - examples/inheritance/README.md
 - examples/inheritance/controls/example.rb
@@ -313,11 +313,11 @@ files:
 - lib/inspec/completions/bash.sh.erb
 - lib/inspec/completions/zsh.sh.erb
 - lib/inspec/control_eval_context.rb
+- lib/inspec/dependencies/cache.rb
 - lib/inspec/dependencies/dependency_set.rb
 - lib/inspec/dependencies/lockfile.rb
 - lib/inspec/dependencies/requirement.rb
 - lib/inspec/dependencies/resolver.rb
-- lib/inspec/dependencies/vendor_index.rb
 - lib/inspec/describe.rb
 - lib/inspec/dsl.rb
 - lib/inspec/dsl_shared.rb
@@ -452,9 +452,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6

data/docs/dsl_inspec.rst

@@ -1,259 +0,0 @@
-=====================================================
-InSpec DSL
-=====================================================
-
-|inspec| is a run-time framework and rule language used to specify compliance, security, and policy requirements. It includes a collection of resources that help you write auditing controls quickly and easily. The syntax used by both open source and |chef compliance| auditing is the same. The open source |inspec resource| framework is compatible with |chef compliance|.
-
-The InSpec DSL is a Ruby DSL for writing audit controls, which includes audit resources that you can invoke.
-
-The following sections describe the syntax and show some simple examples of using the |inspec resources| to define
-
-Syntax
-=====================================================
-
-The following resource tests |ssh| server configuration. For example, a simple control may described as:
-
-.. code-block:: ruby
-
-  describe sshd_config do
-    its('Port') { should eq('22') }
-  end
-
-In various use cases like implementing IT compliance across different departments, it becomes handy to extend the control with metadata. Each control may define an additional ``impact``, ``title`` or ``desc``. An example looks like:
-
-.. code-block:: ruby
-
-   control 'sshd-8' do
-     impact 0.6
-     title 'Server: Configure the service port'
-     desc '
-       Always specify which port the SSH server should listen to.
-       Prevent unexpected settings.
-     '
-     tag 'ssh','sshd','openssh-server'
-     tag cce: 'CCE-27072-8'
-     ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
-
-     describe sshd_config do
-       its('Port') { should eq('22') }
-     end
-   end
-
-
-where
-
-* ``'sshd-8'`` is the name of the control
-* ``impact``, ``title``, and ``desc`` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description
-* ``impact`` is an float that measures the importance of the compliance results and must be a value between ``0.0`` and ``1.0``.
-* ``tag`` is optional meta-information with with key or key-value pairs
-* ``ref`` is a reference to an external document
-* ``describe`` is a block that contains at least one test. A ``control`` block must contain at least one ``describe`` block, but may contain as many as required
-* ``sshd_config`` is an |inspec| resource. For the full list of InSpec resources, see |inspec| resource documentation
-* ``its('Port')`` is the matcher; ``{ should eq('22') }`` is the test. A ``describe`` block must contain at least one matcher, but may contain as many as required
-
-
-Advanced concepts
-=====================================================
-
-With inspec it is possible to check if at least one of a collection of checks is true. For example: If a setting is configured in two different locations, you may want to test if either configuration A or configuration B have been set. This is accomplished via ``describe.one``. It defines a block of tests with at least one valid check.
-
-.. code-block:: ruby
-
-   describe.one do
-     describe ConfigurationA do
-       its('setting_1') { should eq true }
-     end
-
-     describe ConfigurationB do
-       its('setting_2') { should eq true }
-     end
-   end
-
-Examples
-=====================================================
-The following examples show simple compliance tests using a single ``control`` block.
-
-Test System Event Log
------------------------------------------------------
-The following test shows how to audit machines running |windows| 2012 R2 that pwassword complexity is enabled:
-
-.. code-block:: ruby
-
-  control 'windows-account-102' do
-    impact 1.0
-    title 'Windows Password Complexity is Enabled'
-    desc 'Password must meet complexity requirement'
-    describe security_policy do
-      its('PasswordComplexity') { should eq 1 }
-    end
-  end
-
-Are PosgtreSQL passwords empty?
------------------------------------------------------
-The following test shows how to audit machines running |postgresql| to ensure that passwords are not empty.
-
-.. code-block:: ruby
-
-   control 'postgres-7' do
-     impact 1.0
-     title 'Don't allow empty passwords'
-     describe postgres_session('user', 'pass').query("SELECT * FROM pg_shadow WHERE passwd IS NULL;") do
-       its('output') { should eq('') }
-     end
-   end
-
-
-Are MySQL passwords in ENV?
------------------------------------------------------
-The following test shows how to audit machines running |mysql| to ensure that passwords are not stored in ``ENV``:
-
-.. code-block:: ruby
-
-   control 'mysql-3' do
-     impact 1.0
-     title 'Do not store your MySQL password in your ENV'
-     desc '
-       Storing credentials in your ENV may easily expose
-       them to an attacker. Prevent this at all costs.
-     '
-     describe command('env') do
-       its('stdout') { should_not match(/^MYSQL_PWD=/) }
-     end
-   end
-
-Is /etc/ssh a Directory?
------------------------------------------------------
-The following test shows how to audit machines to ensure that ``/etc/ssh`` is a directory:
-
-.. code-block:: ruby
-
-   control 'basic-1' do
-     impact 1.0
-     title '/etc/ssh should be a directory'
-     desc '
-       In order for OpenSSH to function correctly, its
-       configuration path must be a folder.
-     '
-     describe file('/etc/ssh') do
-       it { should be_directory }
-     end
-   end
-
-Is Apache running?
------------------------------------------------------
-The following test shows how to audit machines to ensure that |apache| is enabled and running:
-
-.. code-block:: ruby
-
-   control 'apache-1' do
-     impact 0.3
-     title 'Apache2 should be configured and running'
-     describe service(apache.service) do
-       it { should be_enabled }
-       it { should be_running }
-     end
-   end
-
-Are insecure packages installed ?
------------------------------------------------------
-The following test shows how to audit machines for insecure packages:
-
-.. code-block:: ruby
-
-  control 'cis-os-services-5.1.3' do
-    impact 0.7
-    title '5.1.3 Ensure rsh client is not installed'
-
-    describe package('rsh') do
-      it { should_not be_installed }
-    end
-
-    describe package('rsh-redone-client') do
-      it { should_not be_installed }
-    end
-  end
-
-
-Test Windows Registry Keys
------------------------------------------------------
-The following test shows how to audit machines to ensure Safe DLL Seach Mode is enabled:
-
-.. code-block:: ruby
-
-  control 'windows-base-101' do
-    impact 1.0
-    title 'Safe DLL Search Mode is Enabled'
-    desc '
-      @link: https://msdn.microsoft.com/en-us/library/ms682586(v=vs.85).aspx
-    '
-    describe registry_key('HKLM\\System\\CurrentControlSet\\Control\\Session Manager') do
-      it { should exist }
-      it { should_not have_property_value('SafeDllSearchMode', :type_dword, '0') }
-    end
-  end
-
-Exclude specific test
------------------------------------------------------
-This shows how to allow skipping certain tests if conditions are not met, by using ``only_if``.
-In this example the test will not be performed if ``redis-cli`` command does not exist, because for example package on remote host was not installed.
-
-.. code-block:: ruby
-
-  control 'nutcracker-connect-redis-001' do
-    impact 1.0
-    title 'Check if nutcracker can pass commands to redis'
-    desc 'execute redis-cli set key command, to check connectivity of the service'
-
-    only_if do
-      command('redis-cli').exist?
-    end
-
-    describe command('redis-cli SET test_inspec "HELLO"') do
-      its(:stdout) { should match(/OK/) }
-    end
-  end
-
-Mixing this with other conditionals (like checking existence of the files etc.) can help to test different test paths using inspec. This way you can skip certain tests which would 100% fail due to the way servers are prepared, but you know that the same test suites are reused later in different circumstances by different teams.
-
-Additional metadata for controls
------------------------------------------------------
-
-The following example illustrates various ways to add tags and references to `control`
-
-.. code-block:: ruby
-
-  control 'ssh-1' do
-      impact 1.0
-
-      title 'Allow only SSH Protocol 2'
-      desc 'Only SSH protocol version 2 connections should be permitted.
-            The default setting in /etc/ssh/sshd_config is correct, and can be
-            verified by ensuring that the following line appears: Protocol 2'
-
-      tag 'production','development'
-      tag 'ssh','sshd','openssh-server'
-
-      tag cce: 'CCE-27072-8'
-      tag disa: 'RHEL-06-000227'
-
-      tag remediation: 'stig_rhel6/recipes/sshd-config.rb'
-      tag remediation: 'https://supermarket.chef.io/cookbooks/ssh-hardening'
-
-      ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
-      ref 'http://people.redhat.com/swells/scap-security-guide/RHEL/6/output/ssg-centos6-guide-C2S.html'
-
-      describe ssh_config do
-          its ('Protocol') { should eq '2'}
-      end
-   end`
-
-
-
-.. |inspec| replace:: InSpec
-.. |inspec resource| replace:: InSpec Resource
-.. |chef compliance| replace:: Chef Compliance
-.. |ruby| replace:: Ruby
-.. |ssh| replace:: SSH
-.. |windows| replace:: Microsoft Windows
-.. |postgresql| replace:: PostgreSQL
-.. |apache| replace:: Apache