/saf-training-lab-environment

Primary LanguageShellOtherNOASSERTION

saf-training-lab-environment

The InSpec Assessor Lab is a GitHub environment that makes it quick and easy for you to start learning and working on executing your own InSpec profiles.

It is also a great, quick, and easy way to test and demonstrate what you have learned or collaborate with others to get help with what you are working on.

Overview of the Lab

The repository is setup to be very low overhead, we use a simple setup.sh script to quickly add the tools you need to get started easily, along with two containers to act as testing targets.

Lab Components

Using the Lab

To use the lab:

  1. Make sure you've signed in to your GitHub Account
  2. On the SAF Training repo, click the green 'Use this template' dropdown button and select 'Create a new repository'

green button with the words 'use this template' in white text

green dropdown with 2 options, the first one says 'create a new repository' and is highlighted with a red box. the second option says 'open in a codespace'

  1. Check to make sure your username is the owner of the new repository and enter a name for your repository. We recommend to name it saf-training-lab-environment for ease. Additionally, feel free to make your repository public, if it isn't already.

  2. Click the 'Create repository from template' button at the bottom green button that says 'create repository from template'

  • if the button is greyed out, check to make sure you've selected your username as the owner, and named the repository.

  1. Wait for your repository to open up, then click the 'Code' drop down button green button that says 'code'

  2. After clicking the 'Code' button, a drop down menu should display, with a 'Local' and a 'Codespace' option. Select the 'Codespace' tab, then click the button that says 'Create codespace on main'

  • Note: please make sure to read the Codespace section of this README, as GitHub has updated their policy about Codespaces. codespaces menu

  1. A new tab in your browser should open up with your Codespace. It should open up the README.md file, with a terminal at the bottom. view of codespace when it first opens up

  2. We will then install three extensions - Click the extensions box on the left-hand bar.

image of extensions button in github codespaces Search and install these three extensions:

  • Ruby
  • Docker
  • Prettier
  1. In the terminal, run the lab-setup.sh script
source ./lab-setup.sh

Once this has finished, your terminal should display something like this, right before your username and the path to your codespace. image of terminal after running the lab-setup command

You should have InSpec installed in your environment, the MITRE SAF CLI and two running docker containers - tagged as nginx and redhat8.

  1. Once complete, you can verify the setup in your environment with the verify-lab.sh script:
./verify-lab.sh

Which should return something like:

MITRE SAF version: 
@mitre/saf/1.1.6 darwin-arm64 node-v18.2.0
InSpec version: 
5.14.0
Docker is running the container(s): 
CONTAINER ID   IMAGE          COMMAND                  CREATED        STATUS         PORTS                NAMES
4f0ceb9b5974   nginx:latest   "/docker-entrypoint.…"   2 months ago   Up 6 minutes   0.0.0.0:80->80/tcp   nginx

screenshot of terminal after running the verify-lab command

Codespaces

Note:

Previously, the SAF Training courses utilized GitHub Codespaces as a way for users to learn and work on executing InSpec profiles. GitHub has updated their policy so that Codespaces can be used for a certain amount of time before the user gets billed. If you have a free GitHub account, you're given 120 core hours per month. This means that if you use a 2-core machine, and your codespace runs for 8 hours, you've used up 16 (2 mulitplied by 8 = 16) core hours out of the 120. You can read more about it here:

Additionally, all active Codespaces can be found here:

From the above link, you can access all of your codespaces, and stop the codespace as well. image of codespace options

Docker Container Restart May be Needed

Occasionally, you may have to restart your Docker containers again. To do this:

  1. Run: docker ps
  2. If your containers are not running, then just run: lab-setup.sh
  3. Run: docker ps again to verify that your containers are again running in your environment.

Adding Services and Software

Your repository is yours to command, you have full sudo access and can install any software or services you like, run databases, web-servers, etc. and expose any ports that you might need to do your work.

Creating a Pull Request

Go for it and if for some reason you break your environment, just start a new one.

NOTICE

© 2018-2022 The MITRE Corporation.

Approved for Public Release; Distribution Unlimited. Case Number 18-3678.

NOTICE

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.

NOTICE

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.