Version information
This version is compatible with:
- Puppet Enterprise >=3.2.0 <3.4.0
- Puppet >=3.0.0 <4.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'adamcrews-nessus', '0.3.2'
Learn more about managing modules with a PuppetfileDocumentation
#nessus
####Table of Contents
- Overview
- Setup - The basics
- Usage - Configuration options and examples
- Reference - Class, parameter, and fact documentation
- Limitations
- ToDo
- Contributors
##Overview
The nessus module installs, configures, and manages the nessus vulnerability scanner software.
##Setup
include ::nessus
is sufficient to get nessus installed and running with default settings. If you wish to activate an update feed, then you can specify an activation_code like this:
class { '::nessus':
activation_code => 'XXXX-XXXX-XXXX-XXXX'
}
##Usage
All interaction with the nessus module can be done through the main nessus class.
You can simply toggle the optios in ::nessus
to have complete functionality.
###Bare minimum setup
include '::nessus'
###Install the professional feed
class { '::nessus':
activation_code => 'XXXX-XXXX-XXXX-XXXX'
}
###Create a user
nessus::user { 'admin':
password => '1adam12_1adam12',
admin => true,
}
##Reference
###Classes
####Public Classes
- nessus: Main class, includes all other classes.
####Private Classes
- nessus::install: Handles installing the package. It must be available in wherever your system pulls packages from.
- nessus::config: Activate and configure nessus.
- nessus::service: Handles the service.
###Parameters
The following parameters are available in the nessus module:
####activation_code
The code used to download nessus plugin updates.
####package_name
The name of the nessus package being installed, defaults to 'Nessus'.
####package_ensure
Determines what to do with the package, valid options are present/installed, latest, or absent.
####security_center
Configure nessus to be connected to Security Center.
####service_name
The service name for nessusd.
####service_ensure
Determines the state of the service, valid options are running or stopped.
####service_manage
Selects wether puppet should manage the service.
##Facts
nessus_activation_code
is set to the code that is active on the node, or undefined if no code is active.
##Limitations
This module has some tests in place, but not many yet. Additionally, it is not possible to completely test the activation portion of nessus, since each activation is unique, and you would need a new activation code from nessus every time you try to activate.
##ToDo
- Manage nessus config items.
- More spec tests are needed.
- Expand supported platforms. So far only Nessus 5.2.7 and Nessus 6 on CentOS6 has been tested.
###Contributors
Many thanks to PuppetLabs and their ntp module for the template to work off of. Individual contributors can be found at: https://github.com/adamcrews/puppet-nessus/graphs/contributors
2016-01-29 16:23:28 -0800 Adam Crews
* Fix travis notifications and bump version for release (HEAD -> fix_tests)
2016-01-29 16:08:40 -0800 Adam Crews
* travis updates (origin/fix_tests)
2016-01-29 15:30:50 -0800 Adam Crews
* Removed deprecated 'types' from metadata.json'
2016-01-29 15:23:17 -0800 Adam Crews
* Updating spec framework
2016-01-29 11:32:03 -0500 Mason Malone
* Fix dependency error in nessus::config
2015-01-10 15:39:03 -0800 Adam Crews
* New release to remove the files directory from management (tag: v0.3.1)
2015-01-06 14:39:05 -0500 Adam Stephens
* don't test for removed files directory
2015-01-06 09:43:02 -0500 Adam Stephens
* don't create files directory
2014-12-17 11:57:32 -0800 Adam Crews
* Fix a couple lint warnings and cut a new release (origin/release)
2014-12-17 14:19:36 -0500 Adam Stephens
* activation code fact needs sbin for nessuscli
2014-12-17 14:16:45 -0500 Adam Stephens
* user changes need a service restart
2014-12-17 14:06:20 -0500 Adam Stephens
* fix activate nessus check
2014-12-17 14:03:52 -0500 Adam Stephens
* document security_center
2014-12-17 14:00:19 -0500 Adam Stephens
* add simple spec for security_center
2014-12-17 13:56:04 -0500 Adam Stephens
* add support for security center setup
2014-12-17 13:41:11 -0500 Adam Stephens
* nessuscli is in /opt/nessus/sbin
2014-12-02 11:58:23 -0800 Adam Crews
* Add forge badge
2014-11-13 12:48:50 -0800 Adam Crews
* Bumped a new release to support Nessus 6
2014-11-13 14:10:58 -0600 root
* adding support for nessus 6, nessus_fetch has been merged into a nessuscli command
2014-08-27 12:52:31 -0700 Adam Crews
* Cut new forge release
2014-08-27 12:45:01 -0700 Adam Crews
* Cleanup some spec tests, added coverage report
2014-08-26 16:49:17 -0700 Adam Crews
* Ignore local .ruby-version
2014-08-26 16:46:25 -0700 Adam Crews
* Fix a couple typos from copy/paste
2014-07-14 10:23:28 -0700 Adam Crews
* Minor cleanup of metadata (tag: v0.1.1)
2014-07-14 10:08:25 -0700 Adam Crews
* Fix forge metadata
2014-07-14 09:42:04 -0700 Adam Crews
* Pin rspec to > 3 to avoid warnings until rspec-puppet is updated
2014-07-14 09:15:52 -0700 Adam Crews
* Lots of tests added
2014-07-12 00:25:19 -0700 Adam Crews
* Add build image to Readme
2014-07-12 00:23:20 -0700 Adam Crews
* Remove old puppet version
2014-07-12 00:17:00 -0700 Adam Crews
* Fix some test options
2014-07-12 00:06:08 -0700 Adam Crews
* Lots of tests and various cleanup
2014-07-11 14:19:36 -0700 Adam Crews
* Add rules file
2014-07-11 14:00:59 -0700 Adam Crews
* Fix user to use a password hash, generated from the nessus-chpasswd command
2014-07-11 13:24:44 -0700 Adam Crews
* Add require
2014-07-11 13:19:04 -0700 Adam Crews
* Fix define declaration for user type
2014-07-11 13:16:39 -0700 Adam Crews
* Fix some file names
2014-07-11 13:12:10 -0700 Adam Crews
* Fixing default service and program names
2014-07-11 12:56:40 -0700 Adam Crews
* Add more management to nessus
2014-07-11 10:29:30 -0700 Adam Crews
* Initial commit
Dependencies
- puppetlabs/stdlib (>= 3.2.1 <5.0.0)