Class: Chef::Compliance::Reporter::Automate

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/compliance/reporter/automate.rb

Overview

Used to send inspec reports to Chef Automate via the data_collector service

Direct Known Subclasses

ChefServerAutomate

Constant Summary collapse

CONTROL_RESULT_SORT_ORDER = 
%w{ failed skipped passed }.freeze
SEEN_PROFILE_UNNECESSARY_FIELDS =

Profile ‘name’ is a required property. By not sending it in the report, we make it clear to the ingestion backend that the profile metadata has been stripped from this profile in the report. Profile ‘title’ and ‘version’ are still kept for troubleshooting purposes in the backend.

%i{ copyright copyright_email groups license maintainer name summary supports}.freeze
SEEN_PROFILE_UNNECESSARY_CONTROL_FIELDS = 
%i{ code desc descriptions impact refs source_location tags title }.freeze

Instance Method Summary collapse

Constructor Details

#initialize(opts) ⇒ Automate

Returns a new instance of Automate.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/chef/compliance/reporter/automate.rb', line 8

def initialize(opts)
  @entity_uuid           = opts[:entity_uuid]
  @run_id                = opts[:run_id]
  @node_name             = opts[:node_info][:node]
  @environment           = opts[:node_info][:environment]
  @roles                 = opts[:node_info][:roles]
  @recipes               = opts[:node_info][:recipes]
  @insecure              = opts[:insecure]
  @chef_tags             = opts[:node_info][:chef_tags]
  @policy_group          = opts[:node_info][:policy_group]
  @policy_name           = opts[:node_info][:policy_name]
  @source_fqdn           = opts[:node_info][:source_fqdn]
  @organization_name     = opts[:node_info][:organization_name]
  @ipaddress             = opts[:node_info][:ipaddress]
  @fqdn                  = opts[:node_info][:fqdn]
  @run_time_limit        = opts[:run_time_limit]
  @control_results_limit = opts[:control_results_limit]
  @timestamp             = opts.fetch(:timestamp) { Time.now }

  @url = Chef::Config[:data_collector][:server_url]
  @token = Chef::Config[:data_collector][:token]
end

Instance Method Details

#enriched_report(final_report) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/chef/compliance/reporter/automate.rb', line 96

def enriched_report(final_report)
  final_report[:profiles].compact!

  # Label this content as an inspec_report
  final_report[:type] = "inspec_report"

  final_report[:node_name]         = @node_name
  final_report[:end_time]          = @timestamp.utc.strftime("%FT%TZ")
  final_report[:node_uuid]         = @entity_uuid
  final_report[:environment]       = @environment
  final_report[:roles]             = @roles
  final_report[:recipes]           = @recipes
  final_report[:report_uuid]       = @run_id
  final_report[:source_fqdn]       = @source_fqdn
  final_report[:organization_name] = @organization_name
  final_report[:policy_group]      = @policy_group
  final_report[:policy_name]       = @policy_name
  final_report[:chef_tags]         = @chef_tags
  final_report[:ipaddress]         = @ipaddress
  final_report[:fqdn]              = @fqdn

  final_report
end

#http_client(url = @url) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/chef/compliance/reporter/automate.rb', line 88

def http_client(url = @url)
  if @insecure
    Chef::HTTP.new(url, ssl_verify_mode: :verify_none)
  else
    Chef::HTTP.new(url)
  end
end

#missing_automate_profiles(headers, report_shas) ⇒ Object

Contacts the metasearch Automate API to check which of the inspec profile sha256 ids passed in via ‘report_shas` are missing from the Automate profiles metadata database.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/chef/compliance/reporter/automate.rb', line 159

def missing_automate_profiles(headers, report_shas)
  Chef::Log.debug "Checking the #{ChefUtils::Dist::Automate::PRODUCT} profiles metadata for: #{report_shas}"
  meta_url = URI(@url)
  meta_url.path = "/compliance/profiles/metasearch"
  response_str = http_client(meta_url.to_s).post(nil, "{\"sha256\": #{report_shas}}", headers)
  missing_shas = Chef::JSONCompat.parse(response_str)["missing_sha256"]
  unless missing_shas.empty?
    Chef::Log.info "#{ChefUtils::Dist::Automate::PRODUCT} is missing metadata for the following profile ids: #{missing_shas}"
  end
  missing_shas
rescue => e
  Chef::Log.error "missing_automate_profiles error: #{e.message}"
  # If we get an error it's safer to assume none of the profile shas exist in Automate
  report_shas
end

#send_report(report) ⇒ Object

Method used in order to send the inspec report to the data_collector server



52
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
 
# File 'lib/chef/compliance/reporter/automate.rb', line 52

def send_report(report)
  headers = {
    "Content-Type" => "application/json",
    "x-data-collector-auth" => "version=1.0",
    "x-data-collector-token" => @token,
  }

  all_report_shas = report[:profiles].map { |p| p[:sha256] }
  missing_report_shas = missing_automate_profiles(headers, all_report_shas)

  full_report = truncate_controls_results(enriched_report(report), @control_results_limit)
  full_report = strip_profiles_meta(full_report, missing_report_shas, @run_time_limit)
  json_report = Chef::JSONCompat.to_json(full_report, validate_utf8: false)

  # Automate GRPC currently has a message limit of ~4MB
  # https://github.com/chef/automate/issues/1417#issuecomment-541908157
  if json_report.bytesize > 4 * 1024 * 1024
    Chef::Log.warn "Generated report size is #{(json_report.bytesize / (1024 * 1024.0)).round(2)} MB. #{ChefUtils::Dist::Automate::PRODUCT} has an internal 4MB limit that is not currently configurable."
  end

  unless json_report
    Chef::Log.warn "Something went wrong, report can't be nil"
    return false
  end

  begin
    Chef::Log.info "Report to #{ChefUtils::Dist::Automate::PRODUCT}: #{@url}"
    Chef::Log.debug "Compliance Phase report: #{json_report}"
    http_client.post(nil, json_report, headers)
    true
  rescue => e
    Chef::Log.error "send_report: POST to #{@url} returned: #{e.message}"
    false
  end
end

#strip_profiles_meta(report, missing_report_shas, run_time_limit) ⇒ Object

TODO: This mutates the report and probably doesn’t need to.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/chef/compliance/reporter/automate.rb', line 183

def strip_profiles_meta(report, missing_report_shas, run_time_limit)
  report[:profiles].each do |p|
    next if missing_report_shas.include?(p[:sha256])

    p.delete_if { |f| SEEN_PROFILE_UNNECESSARY_FIELDS.include?(f) }

    next unless p[:controls].is_a?(Array)

    p[:controls].each do |c|
      c.delete_if { |f| SEEN_PROFILE_UNNECESSARY_CONTROL_FIELDS.include?(f) }
      c.delete(:waiver_data) if c[:waiver_data] == {}

      next unless c[:results].is_a?(Array)

      c[:results].each do |r|
        if r[:run_time].is_a?(Float) && r[:run_time] < run_time_limit
          r.delete(:start_time)
          r.delete(:run_time)
        end
      end
    end
  end
  report[:run_time_limit] = run_time_limit
  report
end

#truncate_controls_results(report, max_results) ⇒ Object

Truncates the number of results per control in the report when they exceed max_results. The truncation prioritizes failed and skipped results over passed ones. Controls where results have been truncated will get a new object ‘removed_results_counts’ with the status counts of the truncated results



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
 
# File 'lib/chef/compliance/reporter/automate.rb', line 126

def truncate_controls_results(report, max_results)
  return report unless max_results.is_a?(Integer) && max_results > 0

  report.fetch(:profiles, []).each do |profile|
    profile.fetch(:controls, []).each do |control|
      # Only bother with truncation if the number of results exceed max_results
      next unless control[:results].length > max_results

      res = control[:results]
      res.sort_by! { |r| CONTROL_RESULT_SORT_ORDER.index(r[:status]) }

      # Count the results that will be truncated
      truncated = { failed: 0, skipped: 0, passed: 0 }
      (max_results..res.length - 1).each do |i|
        case res[i][:status]
        when "failed"
          truncated[:failed] += 1
        when "skipped"
          truncated[:skipped] += 1
        when "passed"
          truncated[:passed] += 1
        end
      end
      # Truncate the results array now
      control[:results] = res[0..max_results - 1]
      control[:removed_results_counts] = truncated
    end
  end
  report
end

#validate_config! ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/chef/compliance/reporter/automate.rb', line 31

def validate_config!
  unless @entity_uuid
    # TODO - this is a weird leakage of naming from the parent class
    # but entity_uuid is never an attribute that the user can see;
    # it is sourced from chef_guid, which we don't technically know about in this class -
    # but telling the operator about a missing chef_guid is more helpful than telling
    # them about a missing field they've never heard of. Better would be a dock link
    # that described how to fix this situation.
    raise "CMPL004: automate_reporter: chef_guid is not available and must be provided. Aborting because we cannot report the scan."
  end

  unless @run_id
    raise "CMPL005: automate_reporter: run_id is not available, aborting because we cannot report the scan."
  end

  unless @url && @token
    raise "CMPL006: data_collector.token and data_collector.server_url must be configured in client.rb! Further information: https://docs.chef.io/automate/data_collection/#configure-your-chef-infra-client-to-send-data-to-chef-automate-without-chef-infra-server"
  end
end