#openscap

####Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with openscap
   • What openscap affects
   • Setup requirements
   • Beginning with openscap
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

The openscap module provides the installation procedure for openscap.

##Module Description

The openscap module scan the local installation for known vulnerabilities and report them in a HTML page.

##Setup

###What openscap affects

• openscap package.
• openscap configuration file.
• openscap service configuration.

###Beginning with openscap

include '::openscap' is enough to get you up and running if the parameters point to proper values. If you wish to pass in parameters like which servers to use then you can use:

class { '::openscap':
  profile => 'F14-Desktop',
}

##Usage

All interaction with the openscap module can do be done through the main openscap class. This means you can simply toggle the options in the openscap class to get at the full functionality.

###I just want openscap, what's the minimum I need?

include '::openscap'

##Reference

###Classes

• openscap: Main class, includes all the rest.
• openscap::install: Handles the packages.
• openscap::config: Handles the configuration file.
• openscap::service: Handles the alternative service link.

###Parameters

The following parameters are available in the openscap module

####report

Specify the file and path for the report.

####result

Specify the file and path for the result.

####ovalDefinition

Specify the file and path for the oval definition.

####xccdfDefinition

Specify the file and path for the xccd definition.

####profile

Specify the profile against which the system is checked.

####rootEmail

Specify the email that recieve the reports (not implemented yet).

##Limitations

This module has been built on and tested against Puppet 3.7 and higher.

The module has been tested on:

• RedHat Enterprise Linux 6/7
• Scientific Linux 6/7
• CentOS 6/7

Testing on other platforms has been light and cannot be guaranteed.

##Development

If you like to add or improve this module, feel free to fork the module and send me a merge request with the modification.