mirror of https://github.com/inspec/inspec synced 2024-11-15 09:27:20 +00:00

History

Adam Leff dda24b9f98 Fix compliance uploads when version is not present The Compliance::API.version method could potentially return a hash containing no "version" key but would return an empty hash upon any expected failure. Downstream callers of the Compliance::API.version method were looking for a "version" key to always be present when, in some cases, it would not be. This change ensures that if a version is not available, there is no "version" key in the hash, and downstream callers of this method have been changed to check for nil instead of empty. Signed-off-by: Adam Leff <adam@leff.co>		2017-06-06 14:49:25 +02:00
..
images	update readme for bundles	2016-06-29 08:14:36 +02:00
test/integration/default	give accurate information for inspec compliance login --help	2016-08-18 20:00:27 +02:00
.kitchen.yml	fix integration tests for Chef Compliance	2016-08-17 13:51:26 +02:00
api.rb	Fix compliance uploads when version is not present	2017-06-06 14:49:25 +02:00
bootstrap.sh	use bundler instead of gem, to speed up integration testing for different versions	2016-08-18 16:32:45 +02:00
cli.rb	Fix version method call	2017-05-31 10:44:14 -05:00
configuration.rb	support new automate 0.8.0	2017-05-17 15:02:08 +02:00
http.rb	bugfix: non-url servers with compliance login	2017-05-30 12:04:21 -04:00
README.md	harmonize compliance profiles view with supermarket views (#1654 )	2017-04-13 11:24:17 -04:00
support.rb	add integration tests for compliance plugin	2016-04-29 01:12:53 +02:00
target.rb	Raise exception if profile target URL cannot be parsed	2017-05-26 14:30:37 -05:00

README.md

InSpec Extension for Chef Compliance

This extensions offers the following features:

list available profiles in Chef Compliance
execute profiles directly from Chef Compliance locally
upload a local profile to Chef Compliance

To use the CLI, this InSpec add-on adds the following commands:

$ inspec compliance login - authentication of the API token against Chef Compliance
$ inspec compliance login_automate - authentication of the API token against Chef Automate
$ inspec compliance profiles - list all available Chef Compliance profiles
$ inspec exec compliance://profile - runs a Chef Compliance profile
$ inspec compliance upload path/to/local/profile - uploads a local profile to Chef Compliance
$ inspec compliance logout - logout of Chef Compliance

Compliance profiles can be executed in two mays:

via compliance exec: inspec compliance exec profile
via compliance scheme: inspec exec compliance://profile

Usage

Command options

$ inspec compliance
Commands:
  inspec compliance download PROFILE  # downloads a profile from Chef Compliance
  inspec compliance exec PROFILE      # executes a Chef Compliance profile
  inspec compliance help [COMMAND]    # Describe subcommands or one specific subcommand
  inspec compliance login SERVER      # Log in to a Chef Compliance SERVER
  inspec compliance login_automate SERVER   # Log in to an Automate SERVER
  inspec compliance logout            # user logout from Chef Compliance
  inspec compliance profiles          # list all available profiles in Chef Compliance
  inspec compliance upload PATH       # uploads a local profile to Chef Compliance
  inspec compliance version           # displays the version of the Chef Compliance server

You need a Chef Automate server up and running. Compliance features need to be activated, too.

Now, you need a user token. You can retrieve that via UI or CLI.

inspec compliance login_automate https://automate.compliance.test --insecure --user 'admin' --ent 'brewinc' --usertoken 'zuop..._KzE'

Before you start using the compliance plugin, you need a running Chef Compliance server. Please login and gather the access token:

You can choose the access token (--token) or the refresh token (--refresh_token)

# login to chef compliance server
$ inspec compliance login https://compliance.test --user admin --insecure --token '...'

# display the chef compliance server version
$ inspec compliance version
Chef Compliance version: 1.0.11

List available profiles via Chef Compliance / Automate

$ inspec compliance profiles
Available profiles:
-------------------
 * base/apache
 * base/linux
 * base/mysql
 * base/postgres
 * base/ssh
 * base/windows
 * cis/cis-centos6-level1
 * cis/cis-centos6-level2
 * cis/cis-centos7-level1
 * cis/cis-centos7-level2
 * cis/cis-rhel7-level1
 * cis/cis-rhel7-level2
 * cis/cis-ubuntu12.04lts-level1
 * cis/cis-ubuntu12.04lts-level2
 * cis/cis-ubuntu14.04lts-level1
 * cis/cis-ubuntu14.04lts-level2

Upload a profile to Chef Compliance / Automate

$ inspec compliance version
Chef Compliance version: 1.0.11
➜  inspec git:(chris-rock/cc-error-not-loggedin) ✗ b inspec compliance upload examples/profile
I, [2016-05-06T14:27:20.907547 #37592]  INFO -- : Checking profile in examples/profile
I, [2016-05-06T14:27:20.907668 #37592]  INFO -- : Metadata OK.
I, [2016-05-06T14:27:20.968584 #37592]  INFO -- : Found 4 controls.
I, [2016-05-06T14:27:20.968638 #37592]  INFO -- : Control definitions OK.
Profile is valid
Generate temporary profile archive at /var/folders/jy/2bnrfb4s36jbjtzllvhhyqhw0000gn/T/profile20160506-37592-1tf326f.tar.gz
I, [2016-05-06T14:27:21.020017 #37592]  INFO -- : Generate archive /var/folders/jy/2bnrfb4s36jbjtzllvhhyqhw0000gn/T/profile20160506-37592-1tf326f.tar.gz.
I, [2016-05-06T14:27:21.024837 #37592]  INFO -- : Finished archive generation.
Start upload to admin/profile
Uploading to Chef Compliance
Successfully uploaded profile

# display all profiles
$ inspec compliance profiles
Available profiles:
-------------------
 * admin/profile
 * base/apache
 * base/linux
 * base/mysql
 * base/postgres
 * base/ssh
 * base/windows
 * cis/cis-centos6-level1
 * cis/cis-centos6-level2
 * cis/cis-centos7-level1
 * cis/cis-centos7-level2
 * cis/cis-rhel7-level1
 * cis/cis-rhel7-level2
 * cis/cis-ubuntu12.04lts-level1
 * cis/cis-ubuntu12.04lts-level2
 * cis/cis-ubuntu14.04lts-level1
 * cis/cis-ubuntu14.04lts-level2

Run a profile from Chef Compliance / Automate on Workstation

$ inspec exec compliance://admin/profile
.*...

Pending: (Failures listed here are expected and do not affect your suite's status)

  1) gordon_config Can't find file "/tmp/gordon/config.yaml"
     # Not yet implemented
     # ./lib/inspec/runner.rb:157


Finished in 0.02862 seconds (files took 0.62628 seconds to load)
5 examples, 0 failures, 1 pending

To Logout from Chef Compliance

$ inspec compliance logout
Successfully logged out

Integration Tests

At this point of time, InSpec is not able to pick up the token directly, therefore the integration test is semi-automatic at this point of time:

run kitchen converge
open https://192.168.251.2 and log in with user admin and password admin
click on user->about and obtain the access token and the refresh token
run kitchen verify with the required env variables:

# both token need to be set, since the test suite runs for each token type
export COMPLIANCE_ACCESSTOKEN='mycompliancetoken'
export COMPLIANCE_REFRESHTOKEN='myrefreshtoken'
kitchen verify
-----> Starting Kitchen (v1.7.3)
-----> Verifying <default-ubuntu-1404>...
       Search `/Users/chartmann/Development/compliance/inspec/lib/bundles/inspec-compliance/test/integration/default` for tests
..................................

Finished in 6.35 seconds (files took 0.40949 seconds to load)
34 examples, 0 failures

       Finished verifying <default-ubuntu-1404> (0m6.62s).
-----> Kitchen is finished. (0m7.02s)
zlib(finalizer): the stream was freed prematurely.