nessus_transformer
Version information
This version is compatible with:
- Puppet Enterprise 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
- Puppet >= 7.24 < 9.0.0
- , , , ,
Tasks:
- run_nessus_transformer
Start using this module
You must be logged in to access this content
Add this module to your Puppetfile:
mod 'puppetlabs-nessus_transformer', '1.0.2'Learn more about managing modules with a PuppetfileDocumentation
nessus_transformer
Table of Contents
Description
This module retrieves scan data from Tenable Nessus™, transforms the data, and uploads it to Puppet Enterprise for integration with the Vulnerability Remediation feature.
Setup
Setup Requirements
- Vulnerability Remediation is part of Puppet Enterprise Advanced. Access to this module requires a Puppet Forge Key.
- The module should be included in your
Puppetfileand deployed using Code Manager. - Tokens required for API interactions with Nessus and Puppet Enterprise must be securely stored. Use encryption tools such as hiera-eyaml or another key management system.
- Install and configure node_encrypt to prevent sensitive information from appearing in logs or reports.
- The transformer node requires network access to:
- The Puppet Enterprise primary server on port TCP/8146
- The Nessus instance.
Hiera Configuration
The module expects the following sensitive keys in Hiera:
nessus_transformer::pe_tokennessus_transformer::scan_reports_source_access_keynessus_transformer::scan_reports_source_secret_key
To ensure secret data is always treated as sensitive, use the following lookup_options in your Hiera data (e.g., common.yaml, or nodes/transformer.mydomain.com.yaml):
lookup_options:
nessus_transformer::scan_reports_source_access_key:
convert_to: 'Sensitive'
nessus_transformer::scan_reports_source_secret_key:
convert_to: 'Sensitive'
nessus_transformer::pe_token:
convert_to: 'Sensitive'
Puppet Enterprise Access Token
Generate a Puppet Enterprise token via the Puppet Enterprise console.
Nessus CA Certificate
It is likely your Nessus instance is running SSL, this may be a self-signed certificate or a real SSL certificate. If your instance is using a self-signed certificate, you can download the CA file onto transformer.mydomain.com and put the path into the hiera key
nessus_transformer::scan_reports_source_ca_certificate:
You may be able to download the Nessus CA from this API endpoint : https://nessus.mydomain.com:8834/getcert
This step is only required if you are running a self-signed certificate.
Nessus Access Keys
Depending on the operation mode, Nessus API access keys might be necessary. Generate them following Nessus documentation.
Overview of Modes
The transformer module supports two modes (mutually exclusive):
1. Requesting Data via Nessus API:
Downloads data directly from Nessus. Requires:
scan_reports_source_access_keyscan_reports_source_secret_key
2. Reading Data from File Path:
Uses Nessus scan data manually uploaded to the transformer node. Requires:
scan_reports_source_filepath
Usage
Step 1: Classify the Transformer Node
Classify your node using node classification in Puppet Enterprise. Example placeholders:
| Placeholder | Description |
|---|---|
puppet.mydomain.com |
Puppet Enterprise primary server |
nessus.mydomain.com |
Nessus scanner instance |
transformer.mydomain.com |
Transformer node (can be dedicated or shared) |
puppet-token |
Generated Puppet Enterprise token file |
nessus-key |
Nessus API key |
nessus-secret |
Nessus secret key |
Example Puppet class:
class { 'nessus_transformer':
scan_name => 'My Scan',
scan_reports_source_address => 'nessus.mydomain.com',
}
Step 2: Encrypt and Store Tokens
Encrypt sensitive data using node_encrypt and hiera-eyaml.
When you use hiera-eyaml to encrypt data, you will see a long string of data starting with ENC[PKCS7,. This is the encrypted string that needs to be added to the right location in your hiera files to be picked up by transformer.mydomain.com.
The next step will have you generate eyaml strings for the puppet-token, nessus-key, and nessus-secret. Each of those strings needs to be added to hiera and the code needs to be promoted to the relevant environment(s).
Encrypt Puppet Enterprise Token:
puppet node encrypt -t transformer.mydomain.com puppet-token > token
eyaml encrypt --file token --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
Store the encrypted token in Hiera:
nessus_transformer::pe_token: ENC[PKCS7,...]
Encrypt Nessus key:
puppet node encrypt -t transformer.mydomain.com nessus-key > key
eyaml encrypt --file key --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
Store the encrypted token in Hiera:
nessus_transformer::scan_reports_source_access_key: ENC[PKCS7,...]
Encrypt Nessus secret:
puppet node encrypt -t transformer.mydomain.com nessus-secret > secret
eyaml encrypt --file secret --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
Store the encrypted token in Hiera:
nessus_transformer::scan_reports_source_secret_key: ENC[PKCS7,...]
Step 3: Run Puppet on the Transformer Node
Ensure the code has been deployed to the relevant environment(s), then run:
puppet agent -t
Step 4: Run Initial Nessus Sync Task
puppet task run nessus_transformer::run_nessus_transformer --targets transformer.mydomain.com
The task should include the output:
Registration successful. Transformer is pending activation.
Step 5: Accept the Registration
Navigate to the vulnerabilities page https://puppet.mydomain.com/#/vulnerabilities and click Accept to activate the transformer.
Step 6: Re-run the Transformer Task
To download scan results:
puppet task run nessus_transformer::run_nessus_transformer --targets transformer.mydomain.com
After completion, any vulnerabilities discovered will appear in the Puppet Enterprise console.
Scheduling
The default schedule for the transformer to run is daily. You can adjust how often transformer data synchronization runs by configuring the module parameter sync_schedule (systemd OnCalendar format):
| Description | Systemd Timer Schedule |
|---|---|
| Every hour | *-*-* *:00:00 |
| Every 12 hours | *-*-* */12:00:00 |
| Working hours (9–5) | *-*-* 9-17:00:00 |
| Daily | *-*-* 00:00:00 |
| Weekly | * *-*-* 00:00:00 |
| Monthly | * *-*-01 00:00:00 |
| Quarterly | * *-01,04,07,10-01 00:00:00 |
Explanation of the OnCalendar format
Tested operating systems
We have confirmed the ingestion of vulnerability and package data on the following operating systems:
- Red Hat Enterprise Linux 7
- Ubuntu 18
- Debian 10
- Suse 12
- Rocky 8
- Windows 2019
- Windows 2022
This list will be updated within future releases as we continue to test.
Reference
Table of Contents
Classes
nessus_transformer: Installs the transformer.
Tasks
run_nessus_transformer: Run the Nessus Transformer
Classes
nessus_transformer
Installs the transformer.
Examples
Use defaults
include nessus_transformer
Basic example
class { 'nessus_transformer':
manage_python => false
}
Parameters
The following parameters are available in the nessus_transformer class:
manage_pythonrun_in_venvsync_schedulepython_versionscan_reports_source_addressscan_reports_source_portscan_reports_source_ca_certificatescan_reports_source_access_keyscan_reports_source_secret_keyscan_reports_source_filepathpe_tokenscan_namepost_body_filepath
manage_python
Data type: Boolean
Determines if this module should manage the installation of python
Default value: true
run_in_venv
Data type: Boolean
Run the transformer within a python virtual environment
Default value: true
sync_schedule
Data type: String
Schedule string in Systemd Timer format
Default value: 'daily'
python_version
Data type: String
Specify a version of python that will be installed rather than using OS package Default
Default value: ''
scan_reports_source_address
Data type: Optional[String]
FQDN/IP address used by Nessus
Default value: undef
scan_reports_source_port
Data type: Integer
Port Number used by Nessus
Default value: 8834
scan_reports_source_ca_certificate
Data type: Optional[Sensitive[String]]
Optional CA Cert for Nessus
Default value: undef
scan_reports_source_access_key
Data type: Optional[Sensitive[String]]
Authentication access_key for the scanner endpoint Required when using scan_reports_source_token, and scan_reports_source_token not specified
Default value: undef
scan_reports_source_secret_key
Data type: Optional[Sensitive[String]]
Authentication secret_key for the scanner endpoint Required when using scan_reports_source_token, and scan_reports_source_token not specified
Default value: undef
scan_reports_source_filepath
Data type: Optional[String]
Path to the scanner report export directory Required if not using scan_reports_source_address
Default value: undef
pe_token
Data type: Sensitive[String[1]]
Puppet Enterprise authentication token with permission to push data to VRS service
scan_name
Data type: String
Name of a specific scan that we will use from Nessus
Default value: ''
post_body_filepath
Data type: String
If set, the json body of the PE Vulnerability Request will be stored at provided path
Default value: ''
Tasks
run_nessus_transformer
Run the Nessus Transformer
Supports noop? false
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
Changelog
1.0.2 (2025-04-09)
Implemented enhancements:
- PE-41081 update README #39 (albatrossflavour)
Fixed bugs:
- (PE-41054) Correct variable reassignment #43 (seamymckenna)
- Fix use correct enum #42 (AkashChikanep4)
- (PE-41082) Remove sensitive logs #37 (AkashChikanep4)
v1.0.1 (2025-04-02)
Fixed bugs:
- (PE-41081) Remove tmp directory and use tempfile for nessus exports API integration #35 (AkashChikanep4)
v1.0.0 (2025-03-27)
Implemented enhancements:
- (PE-39535) Release 1.0.0 #33 (seamymckenna)
v0.1.0 (2025-03-26)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet-python (>= 7.3.0 <= 7.4.0)
- puppet/systemd (>= 4.0.0 <= 8.1.0)
- puppetlabs/node_encrypt (>= 3.0.0 <= 3.1.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.