Contents

require "yaml"

module Secrets
  class YAML < Inspec.secrets(1)
    name "yaml"

    attr_reader :inputs

    def self.resolve(target)
      unless target.is_a?(String) && File.file?(target) && [".yml", ".yaml"].include?(File.extname(target).downcase)
        return nil
      end

      new(target)
    end

    # array of yaml file paths
    def initialize(target)
      # Ruby 3.1 treats YAML load as a dangerous operation by default, requiring us to declare date and time classes as permitted
      # It's not a valid option in 3.0.x
      if Gem.ruby_version >= Gem::Version.new("3.1.0")
        @inputs = ::YAML.load_file(target, permitted_classes: [Date, Time])
      else
        @inputs = ::YAML.load_file(target)
      end

      # In case of empty yaml file raise the warning else raise the parsing error.
      if !@inputs || @inputs.empty?
        Inspec::Log.warn("Unable to parse #{target}: YAML file is empty.")
        @inputs = nil
      elsif !@inputs.is_a?(Hash)
        # Exits with usage error.
        Inspec::Log.error("Unable to parse #{target}: invalid YAML or contents is not a Hash")
        Inspec::UI.new.exit(:usage_error)
      end
    rescue => e
      # Any other error related to Yaml parsing will be raised here.
      raise "Error reading YAML file #{target}: #{e}"
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
inspec-core-6.8.11	lib/inspec/secrets/yaml.rb
inspec-core-6.8.1	lib/inspec/secrets/yaml.rb
inspec-core-6.6.0	lib/inspec/secrets/yaml.rb