https://github.com/simp/pupmod-simp-openscap
The SIMP openscap Puppet Module
https://github.com/simp/pupmod-simp-openscap
Last synced: about 1 year ago
JSON representation
The SIMP openscap Puppet Module
- Host: GitHub
- URL: https://github.com/simp/pupmod-simp-openscap
- Owner: simp
- License: other
- Created: 2015-05-19T09:49:39.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T19:53:29.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T05:53:22.963Z (about 1 year ago)
- Language: Ruby
- Size: 584 KB
- Stars: 7
- Watchers: 16
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0.html)
[](https://bestpractices.coreinfrastructure.org/projects/73)
[](https://forge.puppetlabs.com/simp/openscap)
[](https://forge.puppetlabs.com/simp/openscap)
[](https://travis-ci.org/simp/pupmod-simp-openscap)
#### Table of Contents
* [This is a SIMP module](#this-is-a-simp-module)
* [Module Description](#module-description)
* [Setup](#setup)
* [What simp openscap affects](#what-simp-openscap-affects)
* [Setup Requirements](#setup-requirements)
* [Beginning with openscap](#beginning-with-openscap)
* [Usage](#usage)
* [I want to install openscap with default logging](#i-want-to-install-openscap-with-default-logging)
* [I have a particular SCAP profile I want to use](#i-have-a-particular-scap-profile-i-want-to-use)
* [I want to log daily at a set time](#i-want-to-log-daily-at-a-set-time)
* [I want to log on the first and fifteenth day of the month](#i-want-to-log-on-the-first-and-fifteenth-day-of-the-month)
* [I want to log to a different directory](#i-want-to-log-to-a-different-directory)
* [Reference](#reference)
* [Limitations](#limitations)
* [Development](#development)
## This is a SIMP module
This module is a component of the
[System Integrity Management Platform](https://simp-project.com),
a compliance-management framework built on Puppet.
If you find any issues, they can be submitted to our
[JIRA](https://simp-project.atlassian.net/).
This module is optimally designed for use within a larger SIMP ecosystem, but it
can be used independently:
* When included within the SIMP ecosystem, security compliance settings will be
managed from the Puppet server.
* In the future, all SIMP-managed security subsystems will be disabled by
default and must be explicitly opted into by administrators. Please review
*simp/simp_options* for details.
## Module Description
This module sets up [openscap](https://www.open-scap.org/) and allows you to
schedule and log openscap runs.
## Setup
### What simp openscap affects
`simp/openscap` will manage:
* openscap-utils and scap-security-guide packages
`simp/openscap::schedule` will manage:
* A cron job for openscap runs
* A logging directory for openscap (Default: /var/log/openscap)
### Setup Requirements
The module can support logrotate if *simp/logrotate* is used. Otherwise, no
additional setup is required.
### Beginning with openscap
You can install openscap by:
```puppet
include 'openscap'
```
## Usage
### I want to install openscap with default logging
The following will run a cron job on Monday at 1:30 AM and log to
/var/log/openscap:
```puppet
class { 'openscap':
enable_schedule => true,
}
```
OR
```puppet
include 'openscap::schedule'
```
### I have a particular SCAP profile I want to use
```puppet
class { 'openscap::schedule':
scap_profile => 'xccdf_org.ssgproject.content_profile_stig-rhel7-server-upstream',
}
```
### I want to log daily at a set time
```puppet
class { 'openscap::schedule':
minute => 00,
hour => 22,
weekday => '*',
}
```
### I want to log on the first and fifteenth day of the month
```puppet
class { 'openscap::schedule':
monthday => '1,15',
}
```
### I want to log to a different directory
```puppet
class { 'openscap::schedule':
logdir => '/opt/scaplogs',
}
```
## Reference
Please see the [REFERENCE.md](./REFERENCE.md).
## Limitations
This module is designed to work in RHEL-compatible environments.
# Development
Please read our [Contribution Guide](https://simp.readthedocs.io/en/stable/contributors_guide/index.html).