inspec/lib/vulcano/plugins/backend_file_common.rb

# encoding: utf-8
# author: Dominik Richter
# author: Christoph Hartmann

class Vulcano::Plugins::Backend
  class FileCommon
    autoload :Stat, 'vulcano/plugins/backend_stat'

    # interface methods: these fields should be implemented by every
    # backend File
    %w{
      exist? mode owner group link_target link_path content mtime size
      selinux_label product_version file_version path
    }.each do |m|
      define_method m.to_sym do
        fail NotImplementedError, "File must implement the #{m}() method."
      end
    end

    def type
      :unknown
    end

    # The following methods can be overwritten by a derived class
    # if desired, to e.g. achieve optimizations.

    def md5sum
      res = Digest::MD5.new
      res.update(content)
      res.hexdigest
    rescue TypeError => _
      nil
    end

    def sha256sum
      res = Digest::SHA256.new
      res.update(content)
      res.hexdigest
    rescue TypeError => _
      nil
    end

    # Additional methods for convenience

    def file?
      target_type == :file
    end

    def block_device?
      target_type == :block_device
    end

    def character_device?
      target_type == :character_device
    end

    def socket?
      target_type == :socket
    end

    def directory?
      target_type == :directory
    end

    def symlink?
      type == :symlink
    end

    def pipe?
      target_type == :pipe
    end

    def mode?(sth)
      mode == sth
    end

    def owned_by?(sth)
      owner == sth
    end

    def grouped_into?(sth)
      group == sth
    end

    def linked_to?(dst)
      link_path == dst
    end

    def version?(version)
      product_version == version or
        file_version == version
    end

    # helper methods provided to any implementing class

    private

    def target_type
      # Just return the type unless this is a symlink
      return type unless type == :symlink
      # Get the link's target type, i.e. the real destination's type
      return link_target.type unless link_target.nil?
      # Return unknown if we don't know where this is pointing to
      :unknown
    end

    UNIX_MODE_OWNERS = {
      owner: 00700,
      group: 00070,
      other: 00007,
    }

    UNIX_MODE_TYPES = {
      r: 00444,
      w: 00222,
      x: 00111,
    }

    def unix_mode_mask(owner, type)
      o = UNIX_MODE_OWNERS[owner.to_sym]
      return nil if o.nil?

      t = UNIX_MODE_TYPES[type.to_sym]
      return nil if t.nil?

      t & o
    end
  end
end