Against a remote target using ssh with escalated privileges (i.e., InSpec installed on a separate runner host)
# How to run
inspec exec https://github.com/mitre/google-chrome-v2r6-stig-baseline/archive/master.tar.gz -t ssh://TARGET_USERNAME:TARGET_PASSWORD@TARGET_IP:TARGET_PORT --sudo --sudo-password=<SUDO_PASSWORD_IF_REQUIRED> --input-file <path_to_your_input_file/name_of_your_input_file.yml> --reporter=cli json:<path_to_your_output_file/name_of_your_output_file.json>
Against a remote target using a pem key with escalated privileges (i.e., InSpec installed on a separate runner host)
# How to run
inspec exec https://github.com/mitre/google-chrome-v2r6-stig-baseline/archive/master.tar.gz -t ssh://TARGET_USERNAME@TARGET_IP:TARGET_PORT --sudo -i <your_PEM_KEY> --input-file <path_to_your_input_file/name_of_your_input_file.yml> --reporter=cli json:<path_to_your_output_file/name_of_your_output_file.json>
Against a local Red Hat host with escalated privileges (i.e., InSpec installed on the target)
# How to run
sudo inspec exec https://github.com/mitre/google-chrome-v2r6-stig-baseline/archive/master.tar.gz --input-file <path_to_your_input_file/name_of_your_input_file.yml> --reporter=cli json:<path_to_your_output_file/name_of_your_output_file.json>
If your runner is not always expected to have direct access to GitHub, use the following steps to create an archive bundle of this profile and all of its dependent tests:
(Git is required to clone the InSpec profile using the instructions below. Git can be downloaded from the Git site.)
mkdir profiles
cd profiles
git clone https://github.com/mitre/google-chrome-v2r6-stig-baseline.git
inspec archive google-chrome-v2r6-stig-baseline
sudo inspec exec <name of generated archive> --input-file <path_to_your_input_file/name_of_your_input_file.yml> --reporter=cli json:<path_to_your_output_file/name_of_your_output_file.json>
For every successive run, follow these steps to always have the latest version of this baseline and dependent profiles:
cd google-chrome-v2r6-stig-baseline
git pull
cd ..
inspec archive google-chrome-v2r6-stig-baseline --overwrite
sudo inspec exec <name of generated archive> --input-file <path_to_your_input_file/name_of_your_input_file.yml> --reporter=cli json:<path_to_your_output_file/name_of_your_output_file.json>
The JSON results output file can be loaded into heimdall-lite for a user-interactive, graphical view of the InSpec results.
The JSON InSpec results file may also be loaded into a full heimdall server, allowing for additional functionality such as to store and compare multiple profile runs.
- Lockheed Martin
To report a bug or feature request, please open an issue.
This repository uses either Beaker to run tests or the KitchenCI framework to run tests on the various profiles. Please see the documentation below on how to use each of the frameworks.
To run the tests, perform the following actions:
- Have Ruby 2.3.0 or later installed
- Run
bundle install
- Run
rake beaker:suites
If you need to debug your systems, you can run Beaker with a couple of options:
-
Preserve the VM unconditionally
BEAKER_destroy=no rake beaker:suites
-
Preserve the VM unless the tests pass
BEAKER_destroy=onpass rake beaker:suites
You can then access the VM by going to the root level of the repository and
navigating to .vagrant/beaker_vagrant_files/<automatic directory>
.
You should find a Vagrantfile
at that location and can use any standard
Vagrant CLI Commands.
The most useful of these will be vagrant status
and vagrant ssh <vm name>
.
The tests are housed under the spec/acceptance
directory and use the
profiles in spec/fixtures/inspec_profiles
during testing.
- Ruby 2.3.0 or later
- Virtualbox
- Vagrant
-
An installation of ChefDK may generate conflicts when combined with the installed kitchen gems. Recommend NOT installing ChefDK before testing with this repo.
-
If you run into errors when running
bundle install
, use the following commands to install gems:
gem install kitchen-puppet
gem install librarian-puppet
gem install kitchen-vagrant
- If the tests are not found when running
kitchen verify
, open.kitchen.yml
and consultinspec_tests
under thesuites
section.
- You may also experience an error when running
kitchen converge
where a folder is unable to be created due to the length of the path. In this case, you may need to edit a registry key as explained here.
- Clone the repo via
git clone -b dev https://github.com/simp/inspec_profiles.git
- cd to
inspec_profiles
- Run
bundle install
- Run
kitchen list
- you should see the following choice:default-centos-7
- Run
kitchen converge default-centos-7
- Run
kitchen list
- your should see your host with status "converged"
Note: Once the open issues are resolved in InSpec and kitchen-inspec these
steps will not really be needed but for now we have to do a few things a bit
more manually. Once resolved fully, you will only need to run kitchen verify (machine name)
and everything will be taken care of.
- cd
.kitchen/
- vi default-centos-7.yml
- copy the
ssh_key:
value for later - note the mapped port value ( usually
2222
) and use in the next step
-
On the terminal:
export SSH_KEY=(value from before)
-
cd to
inspec_profiles
- (optional) run an
inspec check
, and ensure there are no errors in the baseline.
- (optional) run an
-
run:
inspec exec -i $SSH_KEY -t ssh://[email protected]:2222 ( or the port mapped from step '4' above )
- (optional) `inspec exec controls/V-#####
- -i $SSH_KEY -t ssh://[email protected]:2222` to just test a single control
- (optional)
inspec exec -i $SSH_KEY --controls=V-#####,V-##### -t ssh://[email protected]:2222
to just test a small set of controls
Included in this repository are testing scripts which allow you to run the profile using Vagrant or EC2 VMs. You can choose which environment your VMs are run in by passing the appropriate test-kitchen yml
file to your KITCHEN_LOCAL_YAML
environment variable. All of the commands below use the kitchen.vagrant.yml
file as an example, however a kitchen.ec2.yaml
is also available in the repository and can be substituted below to run the tests in EC2.
-
Making Changes and Testing
- run
CHEF_LICENSE=accept KITCHEN_LOCAL_YAML=kitchen.vagrant.yml kitchen converge (machine name)
- runs any changes to your hardening scripts - run
kitchen verify (machine name)
- runs the inspec tests
- run
-
Starting Clean:
- run
CHEF_LICENSE=accept KITCHEN_LOCAL_YAML=kitchen.vagrant.yml kitchen destroy (machine name)
kitchen will drop your box and you can start clean
- run
-
Going through the entire process ( create, build, configure, verify, destroy )
- run
CHEF_LICENSE=accept KITCHEN_LOCAL_YAML=kitchen.vagrant.yml kitchen test (machine name)
or to test all defined machineskitchen test
- run
-
Just running the validation scripts
- run
CHEF_LICENSE=accept KITCHEN_LOCAL_YAML=kitchen.vagrant.yml kitchen verify (machine name)
- run
-
just run one or more controls in the validation
- edit the .kitchen.yml file in the
controls:
section add thecontrol id(s)
to the list
- edit the .kitchen.yml file in the
© 2018-2022 The MITRE Corporation.
Approved for Public Release; Distribution Unlimited. Case Number 18-3678.
MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the licensed terms provided in the LICENSE.md file included with this project.
This software was produced for the U. S. Government under Contract Number HHSM-500-2012-00008I, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data-General.
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.
For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.
DISA STIGs are published by DISA IASE, see: https://iase.disa.mil/Pages/privacy_policy.aspx