inspec 1.51.25 → 2.0.16

data/docs/resources/auditd_rules.md.erb

@@ -1,116 +0,0 @@
----
-title: About the auditd_rules Resource
----
-
-# auditd_rules
-
-Use the `auditd_rules` InSpec audit resource to test the rules for logging that exist on the system. The `audit.rules` file is typically located under `/etc/audit/` and contains the list of rules that define what is captured in log files. This resource uses `auditctl` to query the run-time `auditd` rules setup, which may be different from `audit.rules`.
-
-<br>
-
-## Syntax
-
-An `auditd_rules` resource block declares one (or more) rules to be tested, and then what that rule should do. The syntax depends on the version of `audit`:
-
-For `audit` >= 2.3:
-
-    describe auditd_rules do
-      its('lines') { should contain_match(rule) }
-    end
-
-For `audit` < 2.3:
-
-    describe audit_daemon_rules do
-      its("LIST_RULES") {
-        rule
-      }
-    end
-
-For example:
-
-    describe auditd_rules do
-      its('LIST_RULES') { should eq [
-        'exit,always syscall=rmdir,unlink',
-        'exit,always auid=1001 (0x3e9) syscall=open',
-        'exit,always watch=/etc/group perm=wa',
-        'exit,always watch=/etc/passwd perm=wa',
-        'exit,always watch=/etc/shadow perm=wa',
-        'exit,always watch=/etc/sudoers perm=wa',
-        'exit,always watch=/etc/secret_directory perm=r',
-      ] }
-    end
-
-or test that individual rules are defined:
-
-    describe auditd_rules do
-      its('LIST_RULES') {
-        should contain_match(/^exit,always watch=\/etc\/group perm=wa key=identity/)
-      }
-      its('LIST_RULES') {
-        should contain_match(/^exit,always watch=\/etc\/passwd perm=wa key=identity/)
-      }
-      its('LIST_RULES') {
-        should contain_match(/^exit,always watch=\/etc\/gshadow perm=wa key=identity/)
-      }
-      its('LIST_RULES') {
-        should contain_match(/^exit,always watch=\/etc\/shadow perm=wa key=identity/)
-      }
-      its('LIST_RULES') {
-        should contain_match(/^exit,always watch=\/etc\/security\/opasswd perm=wa key=identity/)
-      }
-    end
-
-where each test must declare one (or more) rules to be tested.
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if a rule contains a matching element that is identified by a regular expression
-
-For `audit` >= 2.3:
-
-    describe auditd_rules do
-      its('lines') { should contain_match(%r{-w /etc/ssh/sshd_config/}) }
-    end
-
-For `audit` < 2.3:
-
-    describe audit_daemon_rules do
-      its("LIST_RULES") {
-        should contain_match(/^exit,always arch=.*\
-        key=time-change\
-        syscall=adjtimex,settimeofday/)
-      }
-    end
-
-
-### Query the audit daemon status
-
-    describe auditd_rules.status('backlog') do
-      it { should cmp 0 }
-    end
-
-### Query properties of rules targeting specific syscalls or files
-
-    describe auditd_rules.syscall('open').action do
-      it { should eq(['always']) }
-    end
-
-    describe auditd_rules.key('sshd_config') do
-      its('permissions') { should contain_match(/x/) }
-    end
-
-Filters may be chained. For example:
-
-    describe auditd_rules.syscall('open').action('always').list do
-      it { should eq(['exit']) }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/lib/resources/auditd_rules.rb

@@ -1,205 +0,0 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
-
-require 'forwardable'
-require 'utils/filter_array'
-
-module Inspec::Resources
-  class AuditdRulesLegacy
-    def initialize(content)
-      @content = content
-      @opts = {
-        assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
-        multiple_values: true,
-      }
-    end
-
-    def params
-      @params ||= SimpleConfig.new(@content, @opts).params
-    end
-
-    def method_missing(name)
-      params[name.to_s]
-    end
-
-    def status(name)
-      @status_opts = {
-        assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
-        multiple_values: false,
-      }
-      @status_content ||= inspec.command('/sbin/auditctl -s').stdout.chomp
-      @status_params = SimpleConfig.new(@status_content, @status_opts).params
-
-      status = @status_params['AUDIT_STATUS']
-      return nil if status.nil?
-
-      items = Hash[status.scan(/([^=]+)=(\w*)\s*/)]
-      items[name]
-    end
-
-    def to_s
-      'Audit Daemon Rules (for auditd version < 2.3)'
-    end
-  end
-  class AuditDaemonRules < Inspec.resource(1)
-    extend Forwardable
-    attr_accessor :rules, :lines
-
-    name 'auditd_rules'
-    desc 'Use the auditd_rules InSpec audit resource to test the rules for logging that exist on the system. The audit.rules file is typically located under /etc/audit/ and contains the list of rules that define what is captured in log files.'
-    example "
-      # syntax for auditd < 2.3
-      describe auditd_rules do
-        its('LIST_RULES') {should contain_match(/^exit,always arch=.* key=time-change syscall=adjtimex,settimeofday/) }
-        its('LIST_RULES') {should contain_match(/^exit,always arch=.* key=time-change syscall=stime,settimeofday,adjtimex/) }
-        its('LIST_RULES') {should contain_match(/^exit,always arch=.* key=time-change syscall=clock_settime/)}
-        its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/localtime perm=wa key=time-change/)}
-      end
-
-      # syntax for auditd >= 2.3
-      describe auditd_rules.syscall('open').action do
-        it { should eq(['always']) }
-      end
-
-      describe auditd_rules.key('sshd_config') do
-        its('permissions') { should contain_match(/x/) }
-      end
-
-      describe auditd_rules do
-        its('lines') { should contain_match(%r{-w /etc/ssh/sshd_config/}) }
-      end
-    "
-
-    def initialize
-      @content = inspec.command('/sbin/auditctl -l').stdout.chomp
-
-      if @content =~ /^LIST_RULES:/
-        # do not warn on centos 5
-        unless inspec.os[:name] == 'centos' && inspec.os[:release].to_i == 5
-          warn '[WARN] this version of auditd is outdated. Updating it allows for using more precise matchers.'
-        end
-        @legacy = AuditdRulesLegacy.new(@content)
-      else
-        parse_content
-        @legacy = nil
-      end
-
-      warn '[DEPRECATION] The `auditd_rules` resource is deprecated and will be removed in InSpec 2.0. Use the `auditd` resource instead.'
-    end
-
-    # non-legacy instances are not asked for `its('LIST_RULES')`
-    # rubocop:disable Style/MethodName
-    def LIST_RULES
-      return @legacy.LIST_RULES if @legacy
-      raise 'Using legacy auditd_rules LIST_RULES interface with non-legacy audit package. Please use the new syntax.'
-    end
-
-    def status(name = nil)
-      return @legacy.status(name) if @legacy
-
-      @status_content ||= inspec.command('/sbin/auditctl -s').stdout.chomp
-      @status_params ||= Hash[@status_content.scan(/^([^ ]+) (.*)$/)]
-
-      return @status_params[name] if name
-      @status_params
-    end
-
-    def parse_content
-      @rules = {
-        syscalls: [],
-        files: [],
-      }
-      @lines = @content.lines.map(&:chomp)
-
-      lines.each do |line|
-        if is_syscall?(line)
-          syscalls = get_syscalls line
-          action, list = get_action_list line
-          fields, opts = get_fields line
-
-          # create a 'flatter' structure because sanity
-          syscalls.each do |s|
-            @rules[:syscalls] << { syscall: s, list: list, action: action, fields: fields }.merge(opts)
-          end
-        elsif is_file?(line)
-          file = get_file line
-          perms = get_permissions line
-          key = get_key line
-
-          @rules[:files] << { file: file, key: key, permissions: perms }
-        end
-      end
-    end
-
-    def syscall(name)
-      select_name(:syscall, name)
-    end
-
-    def file(name)
-      select_name(:file, name)
-    end
-
-    # both files and syscalls have `key` identifiers
-    def key(name)
-      res = rules.values.flatten.find_all { |rule| rule[:key] == name }
-      FilterArray.new(res)
-    end
-
-    def to_s
-      'Audit Daemon Rules'
-    end
-
-    private
-
-    def select_name(key, name)
-      plural = "#{key}s".to_sym
-      res = rules[plural].find_all { |rule| rule[key] == name }
-      FilterArray.new(res)
-    end
-
-    def is_syscall?(line)
-      line.match(/\ -S /)
-    end
-
-    def is_file?(line)
-      line.match(/-w /)
-    end
-
-    def get_syscalls(line)
-      line.scan(/-S ([^ ]+) /).flatten.first.split(',')
-    end
-
-    def get_action_list(line)
-      line.scan(/-a ([^,]+),([^ ]+)/).flatten
-    end
-
-    # NB only in file lines
-    def get_key(line)
-      line.match(/-k ([^ ]+)/)[1] if line.include?('-k ')
-    end
-
-    # NOTE there are NO precautions wrt. filenames containing spaces in auditctl
-    # `auditctl -w /foo\ bar` gives the following line: `-w /foo bar -p rwxa`
-    def get_file(line)
-      line.match(/-w (.+) -p/)[1]
-    end
-
-    def get_permissions(line)
-      line.match(/-p ([^ ]+)/)[1]
-    end
-
-    def get_fields(line)
-      fields = line.gsub(/-[aS] [^ ]+ /, '').split('-F ').map { |l| l.split(' ') }.flatten
-
-      opts = {}
-      fields.find_all { |x| x.match(/[a-z]+=.*/) }.each do |kv|
-        k, v = kv.split('=')
-        opts[k.to_sym] = v
-      end
-
-      [fields, opts]
-    end
-  end
-end