Class: Inspec::Resources::ApacheConf

Inherits:
Object
  • Object
show all
Includes:
FileReader, FindFiles
Defined in:
lib/inspec/resources/apache_conf.rb

Constant Summary

Constants included from FindFiles

FindFiles::TYPES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FileReader

#read_file_content

Methods included from FindFiles

#find_files, #find_files_or_warn

Constructor Details

#initialize(conf_path = nil) ⇒ ApacheConf

Returns a new instance of ApacheConf.



24
25
26
27
28
29
30
31
 
# File 'lib/inspec/resources/apache_conf.rb', line 24

def initialize(conf_path = nil)
  @conf_path = conf_path || default_conf_path
  @files_contents = {}
  @content = nil
  @params = nil

  read_content
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name) ⇒ Object 



45
46
47
 
# File 'lib/inspec/resources/apache_conf.rb', line 45

def method_missing(name)
  @params[name.to_s]
end

Instance Attribute Details

#conf_path ⇒ Object (readonly)

Returns the value of attribute conf_path.



22
23
24
 
# File 'lib/inspec/resources/apache_conf.rb', line 22

def conf_path
  @conf_path
end

Instance Method Details

#conf_dir ⇒ Object 



122
123
124
125
 
# File 'lib/inspec/resources/apache_conf.rb', line 122

def conf_dir
  # apparently apache conf keys are case insensitive
  @params["ServerRoot"] || @params["serverroot"]
end

#content ⇒ Object 



33
34
35
 
# File 'lib/inspec/resources/apache_conf.rb', line 33

def content
  @content ||= read_content
end

#filter_comments(data) ⇒ Object 



49
50
51
 
# File 'lib/inspec/resources/apache_conf.rb', line 49

def filter_comments(data)
  data.lines.grep_v(/^\s*#/).join
end

#include_files(params) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/inspec/resources/apache_conf.rb', line 98

def include_files(params)
  # see if there is more config files to include
  include_files = params["Include"] || []
  include_files_optional = params["IncludeOptional"] || []

  includes = []
  unless conf_dir.nil?
    (include_files + include_files_optional).each do |f|
      id    = Pathname.new(f).absolute? ? f : File.join(conf_dir, f)
      files = find_files(id, depth: 1, type: "file")
      files += find_files(id, depth: 1, type: "link")

      includes.push(files) if files
    end
  end

  # [].flatten! == nil
  includes.flatten! || []
end

#params(*opts) ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/inspec/resources/apache_conf.rb', line 37

def params(*opts)
  res = @params
  opts.each do |opt|
    res = res[opt] unless res.nil?
  end
  res
end

#read_content ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inspec/resources/apache_conf.rb', line 53

def read_content
  @content = ""
  @params = {}

  read_file_content(conf_path)

  to_read = [conf_path]
  until to_read.empty?
    raw_conf = read_file(to_read[0])
    @content += raw_conf

    # An explaination of the below regular expression.
    # Creates two capture groups.
    # The first group captures the first group of non-whitespace character
    # surrounded whitespace characters.
    # The second group contains a conditional with a positive lookahead
    # (does the line end with one or more spaces?). If the lookahead succeeds
    # a non-greedy capture takes place, if it fails then a greedy capture takes place.
    # The regex is terminated by an expression that matches zero or more spaces.
    params = SimpleConfig.new(
      raw_conf,
      assignment_regex: /^\s*(\S+)\s+['"]*((?=.*\s+$).*?|.*?)['"]*\s*$/,
      multiple_values: true
    ).params

    # Capture any characters between quotes that are not escaped in values
    params.values.each do |value|
      value.map! do |sub_value|
        sub_value[/(?<=["|'])(?:\\.|[^"'\\])*(?=["|'])/] || sub_value
      end
    end

    @params.merge!(params) { |key, current_val, new_val| [*current_val].to_a + [*new_val].to_a }

    to_read = to_read.drop(1)
    to_read += include_files(params).find_all do |fp|
      not @files_contents.key? fp
    end
  end

  # fiter comments
  @content = filter_comments @content
  @content
end

#read_file(path) ⇒ Object 



118
119
120
 
# File 'lib/inspec/resources/apache_conf.rb', line 118

def read_file(path)
  @files_contents[path] ||= read_file_content(path, true)
end

#resource_id ⇒ Object 



127
128
129
 
# File 'lib/inspec/resources/apache_conf.rb', line 127

def resource_id
  @conf_path || "apache_conf"
end

#to_s ⇒ Object 



131
132
133
 
# File 'lib/inspec/resources/apache_conf.rb', line 131

def to_s
  "Apache Config #{conf_path}"
end