Class: ForemanOpenscap::ArfReport

Inherits:
Report
  • Object
show all
Includes:
ComplianceStatusScopedSearch, OpenscapProxyExtensions, Taxonomix
Defined in:
app/models/foreman_openscap/arf_report.rb

Constant Summary collapse

METRIC =

attr_accessible :host_id, :reported_at, :status, :metrics

%w[passed othered failed].freeze
BIT_NUM = 
10
MAX = 
(1 << BIT_NUM) - 1

Class Method Summary collapse

Instance Method Summary collapse

Methods included from OpenscapProxyExtensions

#openscap_proxy_api

Class Method Details

.bit_mask(status) ⇒ Object 



67
68
69
 
# File 'app/models/foreman_openscap/arf_report.rb', line 67

def self.bit_mask(status)
  ComplianceStatus.bit_mask(status)
end

.create_arf(host, proxy, params) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'app/models/foreman_openscap/arf_report.rb', line 110

def self.create_arf(host, proxy, params)
  arf_report = nil
  policy = Policy.find_by :id => params[:policy_id]
  return unless policy

  ArfReport.transaction do
    arf_report = ArfReport.create(:host => host,
                                  :reported_at => Time.at(params[:date].to_i),
                                  :status => params[:metrics],
                                  :metrics => params[:metrics],
                                  :openscap_proxy => proxy)
    return arf_report unless arf_report.persisted?
    PolicyArfReport.where(:arf_report_id => arf_report.id, :policy_id => policy.id, :digest => params[:digest]).first_or_create!
    if params[:logs]
      params[:logs].each do |log|
        src = Source.find_or_create_by(value: log[:source])
        msg = nil
        if src.logs.count > 0
          msg = Log.where(:source_id => src.id).order(:id => :desc).first.message
          update_msg_with_changes(msg, log)
        else
          if (msg = Message.find_by(:value => log[:title]))
            msg.attributes = {
              :value => N_(log[:title]),
              :severity => log[:severity],
              :description => newline_to_space(log[:description]),
              :rationale => newline_to_space(log[:rationale]),
              :scap_references => references_links(log[:references]),
              :fixes => fixes(log[:fixes])
            }
          else
            msg = Message.new(:value => N_(log[:title]),
                              :severity => log[:severity],
                              :description => newline_to_space(log[:description]),
                              :rationale => newline_to_space(log[:rationale]),
                              :scap_references => references_links(log[:references]),
                              :fixes => fixes(log[:fixes]))
          end
          msg.save!
        end
        # TODO: log level
        Log.create!(:source_id => src.id,
                    :message_id => msg.id,
                    :level => :info,
                    :result => log[:result],
                    :report => arf_report)
      end
    end
  end
  arf_report
end

.fixes(raw_fixes) ⇒ Object 



230
231
232
233
234
 
# File 'app/models/foreman_openscap/arf_report.rb', line 230

def self.fixes(raw_fixes)
  return if raw_fixes.empty?

  JSON.generate(raw_fixes)
end

.newline_to_space(string) ⇒ Object 



215
216
217
 
# File 'app/models/foreman_openscap/arf_report.rb', line 215

def self.newline_to_space(string)
  string.gsub(/ *\n+/, " ")
end

.references_links(references) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'app/models/foreman_openscap/arf_report.rb', line 219

def self.references_links(references)
  return if references.nil?
  html_links = []
  references.each do |reference|
    next if reference['title'] == 'test_attestation' # A blank url created by OpenSCAP
    reference['html_link'] = "<a href='#{reference['href']}'>#{reference['href']}</a>" if reference['title'].blank?
    html_links << reference['html_link']
  end
  html_links.join(', ')
end

.report_status_column ⇒ Object 



71
72
73
 
# File 'app/models/foreman_openscap/arf_report.rb', line 71

def self.report_status_column
  "status"
end

.update_msg_with_changes(msg, incoming_data) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'app/models/foreman_openscap/arf_report.rb', line 236

def self.update_msg_with_changes(msg, incoming_data)
  msg.severity = incoming_data['severity']
  msg.description = incoming_data['description']
  msg.rationale = incoming_data['rationale']
  msg.scap_references = incoming_data['references']
  msg.value = incoming_data['title']
  msg.fixes = fixes(incoming_data['fixes'])

  return unless msg.changed?
  msg.save
end

Instance Method Details

#assign_locations_organizations ⇒ Object 



162
163
164
165
166
167
 
# File 'app/models/foreman_openscap/arf_report.rb', line 162

def assign_locations_organizations
  if host
    self.location_ids = [host.location_id]
    self.organization_ids = [host.organization_id]
  end
end

#calculator ⇒ Object 



90
91
92
 
# File 'app/models/foreman_openscap/arf_report.rb', line 90

def calculator
  ArfReportStatusCalculator.new(:bit_field => read_attribute(self.class.report_status_column))
end

#destroy_from_proxy ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
 
# File 'app/models/foreman_openscap/arf_report.rb', line 198

def destroy_from_proxy
  if !host
    destroy_from_proxy_warning "host"
  elsif !policy
    destroy_from_proxy_warning "policy"
  elsif !openscap_proxy
    destroy_from_proxy_warning "OpenSCAP proxy"
  else
    openscap_proxy_api.destroy_report(self, ForemanOpenscap::Helper::find_name_or_uuid_by_host(host))
  end
end

#destroy_from_proxy_warning(associated) ⇒ Object 



210
211
212
213
 
# File 'app/models/foreman_openscap/arf_report.rb', line 210

def destroy_from_proxy_warning(associated)
  logger.warn "Skipping deletion of report with id #{id} from proxy, no #{associated} associated with report"
  true
end

#equal?(other) ⇒ Boolean

Returns:

  • (Boolean) 


189
190
191
192
193
194
195
196
 
# File 'app/models/foreman_openscap/arf_report.rb', line 189

def equal?(other)
  results = [logs, other.logs].flatten.group_by(&:source_id).values
  # for each rule, there should be one result from both reports
  return false unless results.map(&:length).all? { |item| item == 2 }
  results.all? { |result| result.first.source_id == result.last.source_id } &&
    host_id == other.host_id &&
    policy.id == other.policy.id
end

#failed ⇒ Object 



98
99
100
 
# File 'app/models/foreman_openscap/arf_report.rb', line 98

def failed
  status_of "failed"
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'app/models/foreman_openscap/arf_report.rb', line 169

def failed?
  failed > 0
end

#othered ⇒ Object 



102
103
104
 
# File 'app/models/foreman_openscap/arf_report.rb', line 102

def othered
  status_of "othered"
end

#othered? ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'app/models/foreman_openscap/arf_report.rb', line 177

def othered?
  !passed? && !failed?
end

#passed ⇒ Object 



94
95
96
 
# File 'app/models/foreman_openscap/arf_report.rb', line 94

def passed
  status_of "passed"
end

#passed? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'app/models/foreman_openscap/arf_report.rb', line 173

def passed?
  passed > 0 && failed == 0 && othered == 0
end

#rules_count ⇒ Object 



106
107
108
 
# File 'app/models/foreman_openscap/arf_report.rb', line 106

def rules_count
  status.values.sum
end

#status=(st) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'app/models/foreman_openscap/arf_report.rb', line 75

def status=(st)
  s = case st
      when Integer
        st
      when Hash, ActionController::Parameters
        ArfReportStatusCalculator.new(:counters => st).calculate
      else
        raise "Unsupported report status format #{st.class}"
      end
  write_attribute(:status, s)
end

#to_bzip ⇒ Object 



185
186
187
 
# File 'app/models/foreman_openscap/arf_report.rb', line 185

def to_bzip
  openscap_proxy_api.arf_report_bzip(self, ForemanOpenscap::Helper::find_name_or_uuid_by_host(host))
end

#to_html ⇒ Object 



181
182
183
 
# File 'app/models/foreman_openscap/arf_report.rb', line 181

def to_html
  openscap_proxy_api.arf_report_html(self, ForemanOpenscap::Helper::find_name_or_uuid_by_host(host))
end