inspec 2.1.0 → 2.1.10

data/lib/resources/postgres.rb

@@ -1,130 +1,130 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-module Inspec::Resources
-  class Postgres < Inspec.resource(1)
-    name 'postgres'
-    supports platform: 'unix'
-
-    attr_reader :service, :data_dir, :conf_dir, :conf_path, :version, :cluster
-    def initialize
-      if inspec.os.debian?
-        #
-        # https://wiki.debian.org/PostgreSql
-        #
-        # Debian allows multiple versions of postgresql to be
-        # installed as well as multiple "clusters" to be configured.
-        #
-        @version = version_from_psql || version_from_dir('/etc/postgresql')
-        @cluster = cluster_from_dir("/etc/postgresql/#{@version}")
-        @conf_dir = "/etc/postgresql/#{@version}/#{@cluster}"
-        @data_dir = "/var/lib/postgresql/#{@version}/#{@cluster}"
-      else
-        @version = version_from_psql
-        if @version.nil?
-          if inspec.directory('/var/lib/pgsql/data').exist?
-            warn 'Unable to determine PostgreSQL version: psql did not return
-             a version number and unversioned data directories were found.'
-            nil
-          else
-            @version = version_from_dir('/var/lib/pgsql')
-          end
-        end
-        @data_dir = locate_data_dir_location_by_version(@version)
-      end
-
-      @service = 'postgresql'
-      @service += "-#{@version}" if @version.to_f >= 9.4
-      @conf_dir ||= @data_dir
-
-      verify_dirs
-      if !@version.nil? && !@conf_dir.empty?
-        @conf_path = File.join @conf_dir, 'postgresql.conf'
-      else
-        @conf_path = nil
-        return skip_resource 'Seems like PostgreSQL is not installed on your system'
-      end
-    end
-
-    def to_s
-      'PostgreSQL'
-    end
-
-    private
-
-    def verify_dirs
-      warn "Default postgresql configuration directory: #{@conf_dir} does not exist. " \
-        "Postgresql may not be installed or we've misidentified the configuration " \
-        'directory.' unless inspec.directory(@conf_dir).exist?
-
-      warn "Default postgresql data directory: #{@data_dir} does not exist. " \
-        "Postgresql may not be installed or we've misidentified the data " \
-        'directory.' unless inspec.directory(@data_dir).exist?
-    end
-
-    def version_from_psql
-      return unless inspec.command('psql').exist?
-      inspec.command("psql --version | awk '{ print $NF }' | awk -F. '{ print $1\".\"$2 }'").stdout.strip
-    end
-
-    def locate_data_dir_location_by_version(ver = @version)
-      data_dir_loc = nil
-      dir_list = [
-        "/var/lib/pgsql/#{ver}/data",
-        '/var/lib/pgsql/data',
-        '/var/lib/postgres/data',
-        '/var/lib/postgresql/data',
-      ]
-
-      dir_list.each do |dir|
-        data_dir_loc = dir if inspec.directory(dir).exist?
-        break
-      end
-
-      if data_dir_loc.nil?
-        warn 'Unable to find the PostgreSQL data_dir in expected location(s), please
-        execute "psql -t -A -p <port> -h <host> -c "show hba_file";" as the PostgreSQL
-        DBA to find the non-standard data_dir location.'
-      end
-      data_dir_loc
-    end
-
-    def version_from_dir(dir)
-      dirs = inspec.command("ls -d #{dir}/*/").stdout
-      entries = dirs.lines.count
-      case entries
-      when 0
-        warn "Could not determine version of installed postgresql by inspecting #{dir}"
-        nil
-      when 1
-        warn "Using #{dirs}: #{dir_to_version(dirs)}"
-        dir_to_version(dirs)
-      else
-        warn "Multiple versions of postgresql installed or incorrect base dir #{dir}"
-        first = dir_to_version(dirs.lines.first)
-        warn "Using the first version found: #{first}"
-        first
-      end
-    end
-
-    def dir_to_version(dir)
-      dir.chomp.split('/').last
-    end
-
-    def cluster_from_dir(dir)
-      # Main is the default cluster name on debian use it if it
-      # exists.
-      if inspec.directory("#{dir}/main").exist?
-        'main'
-      else
-        dirs = inspec.command("ls -d #{dir}/*/").stdout.lines
-        first = dirs.first.chomp.split('/').last
-        if dirs.count > 1
-          warn "Multiple postgresql clusters configured or incorrect base dir #{dir}"
-          warn "Using the first directory found: #{first}"
-        end
-        first
-      end
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+module Inspec::Resources
+  class Postgres < Inspec.resource(1)
+    name 'postgres'
+    supports platform: 'unix'
+
+    attr_reader :service, :data_dir, :conf_dir, :conf_path, :version, :cluster
+    def initialize
+      if inspec.os.debian?
+        #
+        # https://wiki.debian.org/PostgreSql
+        #
+        # Debian allows multiple versions of postgresql to be
+        # installed as well as multiple "clusters" to be configured.
+        #
+        @version = version_from_psql || version_from_dir('/etc/postgresql')
+        @cluster = cluster_from_dir("/etc/postgresql/#{@version}")
+        @conf_dir = "/etc/postgresql/#{@version}/#{@cluster}"
+        @data_dir = "/var/lib/postgresql/#{@version}/#{@cluster}"
+      else
+        @version = version_from_psql
+        if @version.nil?
+          if inspec.directory('/var/lib/pgsql/data').exist?
+            warn 'Unable to determine PostgreSQL version: psql did not return
+             a version number and unversioned data directories were found.'
+            nil
+          else
+            @version = version_from_dir('/var/lib/pgsql')
+          end
+        end
+        @data_dir = locate_data_dir_location_by_version(@version)
+      end
+
+      @service = 'postgresql'
+      @service += "-#{@version}" if @version.to_f >= 9.4
+      @conf_dir ||= @data_dir
+
+      verify_dirs
+      if !@version.nil? && !@conf_dir.empty?
+        @conf_path = File.join @conf_dir, 'postgresql.conf'
+      else
+        @conf_path = nil
+        return skip_resource 'Seems like PostgreSQL is not installed on your system'
+      end
+    end
+
+    def to_s
+      'PostgreSQL'
+    end
+
+    private
+
+    def verify_dirs
+      warn "Default postgresql configuration directory: #{@conf_dir} does not exist. " \
+        "Postgresql may not be installed or we've misidentified the configuration " \
+        'directory.' unless inspec.directory(@conf_dir).exist?
+
+      warn "Default postgresql data directory: #{@data_dir} does not exist. " \
+        "Postgresql may not be installed or we've misidentified the data " \
+        'directory.' unless inspec.directory(@data_dir).exist?
+    end
+
+    def version_from_psql
+      return unless inspec.command('psql').exist?
+      inspec.command("psql --version | awk '{ print $NF }' | awk -F. '{ print $1\".\"$2 }'").stdout.strip
+    end
+
+    def locate_data_dir_location_by_version(ver = @version)
+      data_dir_loc = nil
+      dir_list = [
+        "/var/lib/pgsql/#{ver}/data",
+        '/var/lib/pgsql/data',
+        '/var/lib/postgres/data',
+        '/var/lib/postgresql/data',
+      ]
+
+      dir_list.each do |dir|
+        data_dir_loc = dir if inspec.directory(dir).exist?
+        break
+      end
+
+      if data_dir_loc.nil?
+        warn 'Unable to find the PostgreSQL data_dir in expected location(s), please
+        execute "psql -t -A -p <port> -h <host> -c "show hba_file";" as the PostgreSQL
+        DBA to find the non-standard data_dir location.'
+      end
+      data_dir_loc
+    end
+
+    def version_from_dir(dir)
+      dirs = inspec.command("ls -d #{dir}/*/").stdout
+      entries = dirs.lines.count
+      case entries
+      when 0
+        warn "Could not determine version of installed postgresql by inspecting #{dir}"
+        nil
+      when 1
+        warn "Using #{dirs}: #{dir_to_version(dirs)}"
+        dir_to_version(dirs)
+      else
+        warn "Multiple versions of postgresql installed or incorrect base dir #{dir}"
+        first = dir_to_version(dirs.lines.first)
+        warn "Using the first version found: #{first}"
+        first
+      end
+    end
+
+    def dir_to_version(dir)
+      dir.chomp.split('/').last
+    end
+
+    def cluster_from_dir(dir)
+      # Main is the default cluster name on debian use it if it
+      # exists.
+      if inspec.directory("#{dir}/main").exist?
+        'main'
+      else
+        dirs = inspec.command("ls -d #{dir}/*/").stdout.lines
+        first = dirs.first.chomp.split('/').last
+        if dirs.count > 1
+          warn "Multiple postgresql clusters configured or incorrect base dir #{dir}"
+          warn "Using the first directory found: #{first}"
+        end
+        first
+      end
+    end
+  end
+end

data/lib/resources/postgres_conf.rb

@@ -1,121 +1,114 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-require 'utils/simpleconfig'
-require 'utils/find_files'
-require 'resources/postgres'
-
-module Inspec::Resources
-  class PostgresConf < Inspec.resource(1)
-    name 'postgres_conf'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the postgres_conf InSpec audit resource to test the contents of the configuration file for PostgreSQL, typically located at /etc/postgresql/<version>/main/postgresql.conf or /var/lib/postgres/data/postgresql.conf, depending on the platform.'
-    example "
-      describe postgres_conf do
-        its('max_connections') { should eq '5' }
-      end
-    "
-
-    include FindFiles
-    include ObjectTraverser
-
-    def initialize(conf_path = nil)
-      @conf_path = conf_path || inspec.postgres.conf_path
-      if @conf_path.nil?
-        return skip_resource 'PostgreSQL conf path is not set'
-      end
-      @conf_dir = File.expand_path(File.dirname(@conf_path))
-      @files_contents = {}
-      @content = nil
-      @params = nil
-      read_content
-    end
-
-    def content
-      @content ||= read_content
-    end
-
-    def params(*opts)
-      @params || read_content
-      res = @params
-      opts.each do |opt|
-        res = res[opt] unless res.nil?
-      end
-      res
-    end
-
-    def value(key)
-      extract_value(key, @params)
-    end
-
-    def method_missing(*keys)
-      keys.shift if keys.is_a?(Array) && keys[0] == :[]
-      param = value(keys)
-      return nil if param.nil?
-      # extract first value if we have only one value in array
-      return param[0] if param.length == 1
-      param
-    end
-
-    def to_s
-      'PostgreSQL Configuration'
-    end
-
-    private
-
-    def read_content
-      @content = ''
-      @params = {}
-
-      # skip if the main configuration file doesn't exist
-      if !inspec.file(@conf_path).file?
-        return skip_resource "Can't find file \"#{@conf_path}\""
-      end
-      raw_conf = read_file(@conf_path)
-      if raw_conf.empty? && !inspec.file(@conf_path).empty?
-        return skip_resource("Can't read file \"#{@conf_path}\"")
-      end
-
-      to_read = [@conf_path]
-      until to_read.empty?
-        base_dir = File.dirname(to_read[0])
-        raw_conf = read_file(to_read[0])
-        @content += raw_conf
-
-        opts = {
-          assignment_regex: /^\s*([^=]*?)\s*=\s*[']?\s*(.*?)\s*[']?\s*$/,
-        }
-        params = SimpleConfig.new(raw_conf, opts).params
-        @params.merge!(params)
-
-        to_read = to_read.drop(1)
-        # see if there is more config files to include
-
-        to_read += include_files(params, base_dir).find_all do |fp|
-          not @files_contents.key? fp
-        end
-      end
-      @content
-    end
-
-    def include_files(params, base_dir)
-      include_files = Array(params['include']) || []
-      include_files += Array(params['include_if_exists']) || []
-      include_files.map! do |f|
-        Pathname.new(f).absolute? ? f : File.join(base_dir, f)
-      end
-
-      dirs = Array(params['include_dir']) || []
-      dirs.each do |dir|
-        dir = File.join(base_dir, dir) if dir[0] != '/'
-        include_files += find_files(dir, depth: 1, type: 'file')
-      end
-      include_files
-    end
-
-    def read_file(path)
-      @files_contents[path] ||= inspec.file(path).content
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+require 'utils/simpleconfig'
+require 'utils/find_files'
+require 'utils/file_reader'
+require 'resources/postgres'
+
+module Inspec::Resources
+  class PostgresConf < Inspec.resource(1)
+    name 'postgres_conf'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    desc 'Use the postgres_conf InSpec audit resource to test the contents of the configuration file for PostgreSQL, typically located at /etc/postgresql/<version>/main/postgresql.conf or /var/lib/postgres/data/postgresql.conf, depending on the platform.'
+    example "
+      describe postgres_conf do
+        its('max_connections') { should eq '5' }
+      end
+    "
+
+    include FindFiles
+    include FileReader
+    include ObjectTraverser
+
+    def initialize(conf_path = nil)
+      @conf_path = conf_path || inspec.postgres.conf_path
+      if @conf_path.nil?
+        return skip_resource 'PostgreSQL conf path is not set'
+      end
+      @conf_dir = File.expand_path(File.dirname(@conf_path))
+      @files_contents = {}
+      @content = nil
+      @params = nil
+      read_content
+    end
+
+    def content
+      @content ||= read_content
+    end
+
+    def params(*opts)
+      @params || read_content
+      res = @params
+      opts.each do |opt|
+        res = res[opt] unless res.nil?
+      end
+      res
+    end
+
+    def value(key)
+      extract_value(key, @params)
+    end
+
+    def method_missing(*keys)
+      keys.shift if keys.is_a?(Array) && keys[0] == :[]
+      param = value(keys)
+      return nil if param.nil?
+      # extract first value if we have only one value in array
+      return param[0] if param.length == 1
+      param
+    end
+
+    def to_s
+      'PostgreSQL Configuration'
+    end
+
+    private
+
+    def read_content
+      @content = ''
+      @params = {}
+
+      to_read = [@conf_path]
+      until to_read.empty?
+        base_dir = File.dirname(to_read[0])
+        raw_conf = read_file(to_read[0])
+        @content += raw_conf
+
+        opts = {
+          assignment_regex: /^\s*([^=]*?)\s*=\s*[']?\s*(.*?)\s*[']?\s*$/,
+        }
+        params = SimpleConfig.new(raw_conf, opts).params
+        @params.merge!(params)
+
+        to_read = to_read.drop(1)
+        # see if there is more config files to include
+
+        to_read += include_files(params, base_dir).find_all do |fp|
+          not @files_contents.key? fp
+        end
+      end
+      @content
+    end
+
+    def include_files(params, base_dir)
+      include_files = Array(params['include']) || []
+      include_files += Array(params['include_if_exists']) || []
+      include_files.map! do |f|
+        Pathname.new(f).absolute? ? f : File.join(base_dir, f)
+      end
+
+      dirs = Array(params['include_dir']) || []
+      dirs.each do |dir|
+        dir = File.join(base_dir, dir) if dir[0] != '/'
+        include_files += find_files(dir, depth: 1, type: 'file')
+      end
+      include_files
+    end
+
+    def read_file(path)
+      @files_contents[path] ||= read_file_content(path)
+    end
+  end
+end