Class: Compliance::API

Inherits:
Object
  • Object
show all
Extended by:
Login
Defined in:
lib/bundles/inspec-compliance/api.rb,
lib/bundles/inspec-compliance/api/login.rb

Overview

API Implementation does not hold any state by itself, everything will be stored in local Configuration store

Defined Under Namespace

Modules: Login

Class Method Summary collapse

Methods included from Login

login

Class Method Details

.determine_server_type(url, insecure) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/bundles/inspec-compliance/api.rb', line 253

def self.determine_server_type(url, insecure)
  if target_is_automate_server?(url, insecure)
    :automate
  elsif target_is_compliance_server?(url, insecure)
    :compliance
  else
    Inspec::Log.debug('Could not determine server type using known endpoints')
    nil
  end
end

.exist?(config, profile) ⇒ Boolean

verifies that a profile

Returns:

  • (Boolean) 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/bundles/inspec-compliance/api.rb', line 90

def self.exist?(config, profile)
  owner, id, ver = profile_split(profile)

  # ensure that we do not manipulate the configuration object
  user_config = config.dup
  user_config['owner'] = owner
  _msg, profiles = Compliance::API.profiles(user_config)

  if !profiles.empty?
    profiles.any? do |p|
      p['owner_id'] == owner &&
        p['name'] == id &&
        (ver.nil? || p['version'] == ver)
    end
  else
    false
  end
end

.get_headers(config) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/bundles/inspec-compliance/api.rb', line 174

def self.get_headers(config)
  token = get_token(config)
  if is_automate_server?(config)
    headers = { 'chef-delivery-enterprise' => config['automate']['ent'] }
    if config['automate']['token_type'] == 'dctoken'
      headers['x-data-collector-token'] = token
    else
      headers['chef-delivery-user'] = config['user']
      headers['chef-delivery-token'] = token
    end
  else
    headers = { 'Authorization' => "Bearer #{token}" }
  end
  headers
end

.get_token(config) ⇒ Object 



190
191
192
193
194
 
# File 'lib/bundles/inspec-compliance/api.rb', line 190

def self.get_token(config)
  return config['token'] unless config['refresh_token']
  _success, _msg, token = get_token_via_refresh_token(config['server'], config['refresh_token'], config['insecure'])
  token
end

.get_token_via_password(url, username, password, insecure) ⇒ Object

Use username and password to get an API access token



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/bundles/inspec-compliance/api.rb', line 154

def self.get_token_via_password(url, username, password, insecure)
  uri = URI.parse("#{url}/login")
  req = Net::HTTP::Post.new(uri.path)
  req.body = { userid: username, password: password }.to_json
  access_token = nil
  response = Compliance::HTTP.send_request(uri, req, insecure)
  data = response.body
  if response.code == '200'
    access_token = data
    msg = 'Successfully fetched an API access token valid for 12 hours'
    success = true
  else
    success = false
    msg = "Failed to authenticate to #{url} \n\
  Response code: #{response.code}\n  Body: #{response.body}"
  end

  [success, msg, access_token]
end

.get_token_via_refresh_token(url, refresh_token, insecure) ⇒ Object

Use username and refresh_token to get an API access token



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
 
# File 'lib/bundles/inspec-compliance/api.rb', line 127

def self.get_token_via_refresh_token(url, refresh_token, insecure)
  uri = URI.parse("#{url}/login")
  req = Net::HTTP::Post.new(uri.path)
  req.body = { token: refresh_token }.to_json
  access_token = nil
  response = Compliance::HTTP.send_request(uri, req, insecure)
  data = response.body
  if response.code == '200'
    begin
      tokendata = JSON.parse(data)
      access_token = tokendata['access_token']
      msg = 'Successfully fetched API access token'
      success = true
    rescue JSON::ParserError => e
      success = false
      msg = e.message
    end
  else
    success = false
    msg = "Failed to authenticate to #{url} \n\
  Response code: #{response.code}\n  Body: #{response.body}"
  end

  [success, msg, access_token]
end

.is_automate_server?(config) ⇒ Boolean

Returns:

  • (Boolean) 


241
242
243
 
# File 'lib/bundles/inspec-compliance/api.rb', line 241

def self.is_automate_server?(config)
  config['server_type'] == 'automate'
end

.is_automate_server_080_and_later?(config) ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
237
238
239
 
# File 'lib/bundles/inspec-compliance/api.rb', line 234

def self.is_automate_server_080_and_later?(config)
  # Automate versions 0.8.x and later will have a "version" key in the config
  # that is properly parsed out via server_version_from_config below
  return false unless config['server_type'] == 'automate'
  !server_version_from_config(config).nil?
end

.is_automate_server_pre_080?(config) ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
231
232
 
# File 'lib/bundles/inspec-compliance/api.rb', line 228

def self.is_automate_server_pre_080?(config)
  # Automate versions before 0.8.x do not have a valid version in the config
  return false unless config['server_type'] == 'automate'
  server_version_from_config(config).nil?
end

.is_compliance_server?(config) ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/bundles/inspec-compliance/api.rb', line 224

def self.is_compliance_server?(config)
  config['server_type'] == 'compliance'
end

.profile_split(profile) ⇒ Object 



208
209
210
211
212
 
# File 'lib/bundles/inspec-compliance/api.rb', line 208

def self.profile_split(profile)
  owner, id = profile.split('/')
  id, version = id.split('#')
  [owner, id, version]
end

.profiles(config) ⇒ Object

return all compliance profiles available for the user the user is either specified in the options hash or by default the username of the account is used that is logged in



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/bundles/inspec-compliance/api.rb', line 21

def self.profiles(config)
  owner = config['owner'] || config['user']

  # Chef Compliance
  if is_compliance_server?(config)
    url = "#{config['server']}/user/compliance"
  # Chef Automate
  elsif is_automate_server?(config)
    url = "#{config['server']}/profiles/#{owner}"
  else
    raise ServerConfigurationMissing
  end

  headers = get_headers(config)
  response = Compliance::HTTP.get(url, headers, config['insecure'])
  data = response.body
  response_code = response.code
  case response_code
  when '200'
    msg = 'success'
    profiles = JSON.parse(data)
    # iterate over profiles
    if is_compliance_server?(config)
      mapped_profiles = []
      profiles.values.each { |org|
        mapped_profiles += org.values
      }
    # Chef Automate pre 0.8.0
    elsif is_automate_server_pre_080?(config)
      mapped_profiles = profiles.values.flatten
    else
      mapped_profiles = profiles.map { |e|
        e['owner_id'] = owner
        e
      }
    end
    return msg, mapped_profiles
  when '401'
    msg = '401 Unauthorized. Please check your token.'
    return msg, []
  else
    msg = "An unexpected error occurred (HTTP #{response_code}): #{response.message}"
    return msg, []
  end
end

.sanitize_profile_name(profile) ⇒ Object

returns a parsed url for ‘admin/profile` or `compliance://admin/profile`



215
216
217
218
219
220
221
222
 
# File 'lib/bundles/inspec-compliance/api.rb', line 215

def self.sanitize_profile_name(profile)
  if URI(profile).scheme == 'compliance'
    uri = URI(profile)
  else
    uri = URI("compliance://#{profile}")
  end
  uri.to_s.sub(%r{^compliance:\/\/}, '')
end

.server_version_from_config(config) ⇒ Object 



245
246
247
248
249
250
251
 
# File 'lib/bundles/inspec-compliance/api.rb', line 245

def self.server_version_from_config(config)
  # Automate versions 0.8.x and later will have a "version" key in the config
  # that looks like: "version":{"api":"compliance","version":"0.8.24"}
  return nil unless config.key?('version')
  return nil unless config['version'].is_a?(Hash)
  config['version']['version']
end

.target_is_automate_server?(url, insecure) ⇒ Boolean

Returns:

  • (Boolean) 


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/bundles/inspec-compliance/api.rb', line 264

def self.target_is_automate_server?(url, insecure)
  automate_endpoint = '/compliance/version'
  response = Compliance::HTTP.get(url + automate_endpoint, nil, insecure)
  case response.code
  when '401'
    Inspec::Log.debug(
      "Received 401 from #{url}#{automate_endpoint} - " \
      'assuming target is a Chef Automate instance',
    )
    true
  when '200'
    # Chef Automate currently returns 401 for `/compliance/version` but some
    # versions of OpsWorks Chef Automate return 200 and a Chef Manage page
    # when unauthenticated requests are received.
    if response.body.include?('Are You Looking For the Chef Server?')
      Inspec::Log.debug(
        "Received 200 from #{url}#{automate_endpoint} - " \
        'assuming target is an OpsWorks Chef Automate instance',
      )
      true
    else
      Inspec::Log.debug(
        "Received 200 from #{url}#{automate_endpoint} " \
        'but did not receive the Chef Manage page - ' \
        'assuming target is not a Chef Automate instance',
      )
      false
    end
  else
    Inspec::Log.debug(
      "Received unexpected status code #{response.code} " \
      "from #{url}#{automate_endpoint} - " \
      'assuming target is not a Chef Automate instance',
    )
    false
  end
end

.target_is_compliance_server?(url, insecure) ⇒ Boolean

Returns:

  • (Boolean) 


302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/bundles/inspec-compliance/api.rb', line 302

def self.target_is_compliance_server?(url, insecure)
  # All versions of Chef Compliance return 200 for `/api/version`
  compliance_endpoint = '/api/version'

  response = Compliance::HTTP.get(url + compliance_endpoint, nil, insecure)
  return false unless response.code == '200'

  Inspec::Log.debug(
    "Received 200 from #{url}#{compliance_endpoint} - " \
    'assuming target is a Compliance server',
  )
  true
end

.target_url(config, profile) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/bundles/inspec-compliance/api.rb', line 196

def self.target_url(config, profile)
  owner, id, ver = profile_split(profile)

  return "#{config['server']}/owners/#{owner}/compliance/#{id}/tar" unless is_automate_server?(config)

  if ver.nil?
    "#{config['server']}/profiles/#{owner}/#{id}/tar"
  else
    "#{config['server']}/profiles/#{owner}/#{id}/version/#{ver}/tar"
  end
end

.upload(config, owner, profile_name, archive_path) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/bundles/inspec-compliance/api.rb', line 109

def self.upload(config, owner, profile_name, archive_path)
  # Chef Compliance
  if is_compliance_server?(config)
    url = "#{config['server']}/owners/#{owner}/compliance/#{profile_name}/tar"
  # Chef Automate pre 0.8.0
  elsif is_automate_server_pre_080?(config)
    url = "#{config['server']}/#{owner}"
  # Chef Automate
  else
    url = "#{config['server']}/profiles/#{owner}"
  end

  headers = get_headers(config)
  res = Compliance::HTTP.post_file(url, headers, archive_path, config['insecure'])
  [res.is_a?(Net::HTTPSuccess), res.body]
end

.version(config) ⇒ Object

return the server api version NB this method does not use Compliance::Configuration to allow for using it before we know the version (e.g. oidc or not)

Raises:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/bundles/inspec-compliance/api.rb', line 70

def self.version(config)
  url = config['server']
  insecure = config['insecure']

  raise ServerConfigurationMissing if url.nil?

  headers = get_headers(config)
  response = Compliance::HTTP.get(url+'/version', headers, insecure)
  return {} if response.code == '404'

  data = response.body
  return {} if data.nil? || data.empty?

  parsed = JSON.parse(data)
  return {} unless parsed.key?('version') && !parsed['version'].empty?

  parsed
end