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.1'
Learn more about managing modules with a PuppetfileDocumentation
nessus_transformer
Table of Contents
- Description
- Setup - The basics of getting started with nessus_transformer
- Overview of Modes
- Usage
- Scheduling
- Tested operating systems
Description
The nessus_transformer module can be used to read data from your Tenable Nessus Vulnerability Scanner and send to to your Puppet Enterprise Instance.
Setup
Setup Requirements
Patching Entitlement is required within PE to avail of this functionality.
We recommend that any sensitive parameter used is node encrypted before being encrypted via hiera-eyaml. Hence node encrypt and hiera-eyaml need to be available before starting.
The transformer can run on any node with network access to Puppet Enterprise and the Tenable Nessus Instance.
node_encrypt
If the node_encrypt module is not available, please install puppetlabs-node_encrypt to be used on your CA or any compile server. See node_encrypt for further info.
hiera-eyaml
Create hiera-eyaml keys if not already generated on your PE Instance. See hiera-eyaml and hiera for further info.
These are the module sensitive parameters;
- pe_token
- scan_reports_source_access_key
- scan_reports_source_secret_key
- scan_reports_source_ca_certificate
pe_token
A PE Token is always required and can be generated via your puppet enterprise console. See https://www.puppet.com/docs/pe/2025.0/rbac_token_auth_intro#rbac-token-auth-generate-token-console
scan_reports_source_access_key and scan_reports_source_access_secret
Nessus Access Key and Secret Key also maybe required depending on mode of operation. If required, they can be generated on your Tenable Nessus Instance. See nessus for further info.
scan_reports_source_ca_certificate
A CA certificate can also optionally be provided.
Overview of Modes
There are two main modes of operation.
Requesting Data from Nessus
For this mode, scan_reports_source_access_key and scan_reports_source_access_secret must be provided. A request is made to Tenable Nessus and the latest scan data is downloaded
Reading Data from file path
For this mode, the user manually downloads the Nessus Scan Data and specifies the file path in scan_reports_source_filepath
Hence either scan_reports_source_address/access_key/access_secret or scan_reports_source_filepath must be provided.
Both cannot be specified at the same time.
Usage
Example walkthrough when Requesting data from Nessus
Classify the Nessus Transformer node and include required non sensitive data using the puppet docs with the following details:
- class name - "nessus_transformer"
- scan_name
- scan_reports_source_address
Node and Hiera Encrypt PE Token
# puppet node encrypt -t nessus-transformer.puppet.net my-pe-token > token
# eyaml encrypt --file token --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
ENC[PKCS7,MIIS……A==]
Node and Hiera Encrypt Nessus Access Key
# puppet node encrypt -t nessus-transformer.puppet.net my-nessus-key > key
# eyaml encrypt --file key --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
ENC[PKCS7,MIIS……B==]
Node and Hiera Encrypt Nessus Secret Key
# puppet node encrypt -t nessus-transformer.puppet.net my-nessus-secret > secret
# eyaml encrypt --file secret --output=string --pkcs7-public-key=/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
ENC[PKCS7,MIIS……C==]
Add Encrypted yaml data to eyaml (PE Token, Nessus Access Key, and Nessus Secret Key)
# vi /etc/puppetlabs/code/environments/production/data/nodes/nessus-transformer.puppet.net.eyaml
nessus_transformer::pe_token: ENC[PKCS7,MIIS……A==]
nessus_transformer::scan_reports_source_access_key: ENC[PKCS7,MIIS……B==]
nessus_transformer::scan_reports_source_access_secret: ENC[PKCS7,MIIS……C==]
Configure Hiera to use the encrypted data
# vi /etc/puppetlabs/code/environments/production/hiera.yaml
---
version: 5
defaults:
datadir: data
hierarchy:
- name: User Data
paths:
- nodes/%{trusted.certname}.eyaml
lookup_key: eyaml_lookup_key
options:
pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem
pkcs7_public_key: /etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem
Run Puppet on Nessus Transformer node
[root@nessus-transformer ~]# puppet agent -t Info: Using environment 'production'
Info: Retrieving pluginfacts
Info: Retrieving plugin
Info: Loading facts
Notice: Requesting catalog from nessus.puppet.net:8140 (10.16.114.35)
Notice: Catalog compiled by nessus.puppet.net
Info: Caching catalog for nessus-transformer.puppet.net
Info: Applying configuration version '1736432610'
Notice: /Stage[main]/Epel/File[/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-8]/ensure: defined content as '{sha256}cd1db21a863185127f2e3b264c97fb1c6c44c316385707999041ea475c110d1c'
Notice: /Stage[main]/Nessus_transformer/File[/opt/puppetlabs/nessus-transformer]/ensure: created
.
.
.
Notice: /Stage[main]/Nessus_transformer/Systemd::Timer[nessus-transformer.timer]/Systemd::Unit_file[nessus-transformer.timer]/Service[nessus-transformer.timer]/ensure: ensure changed 'stopped' to 'running'
Info: /Stage[main]/Nessus_transformer/Systemd::Timer[nessus-transformer.timer]/Systemd::Unit_file[nessus-transformer.timer]/Service[nessus-transformer.timer]: Unscheduling refresh on Service[nessus-transformer.timer]
Notice: Applied catalog in 31.79 seconds
[root@nessus-transformer ~]#
Run Nessus Transformer task
# bolt task run nessus_transformer::run_nessus_transformer --targets nessus-transformer.puppet.net
Started on nessus-transformer.puppet.net...
Finished on nessus-transformer.puppet.net:
{
"status": "-- Logs begin at Thu 2025-01-09 04:42:06 PST, end at Thu 2025-01-09 06:29:08 PST. --nJan 09 06:28:37 nessus-transformer python3[8714]: Max retries: 3, retry interval: 10\nJan 09 06:28:37 nessus-transformer python3[8714]: API call to /vrs/v1/command/register-transformer/3997ed5f-7768-5457-bb9d-6291354e786a returned status: 201\nJan 09 06:28:37 nessus-transformer python3[8714]: Registration pending with status 201. Retrying in 10 seconds.\nJan 09 06:28:48 nessus-transformer python3[8714]: API call to /vrs/v1/command/register-transformer/3997ed5f-7768-5457-bb9d-6291354e786a returned status: 202\nJan 09 06:28:48 nessus-transformer python3[8714]: Registration pending with status 202. Retrying in 10 seconds.\nJan 09 06:28:58 nessus-transformer python3[8714]: API call to /vrs/v1/command/register-transformer/3997ed5f-7768-5457-bb9d-6291354e786a returned status: 202\nJan 09 06:28:58 nessus-transformer python3[8714]: Registration pending with status 202. Retrying in 10 seconds.\nJan 09 06:29:08 nessus-transformer python3[8714]: Registration successful. Transformer is pending activation.\nJan 09 06:29:08 nessus-transformer systemd[1]: nessus-transformer.service: Succeeded.\nJan 09 06:29:08 nessus-transformer systemd[1]: Started nessus-transformer.service."
}
Successful on 1 target: nessus-transformer.puppet.net
Accept Registration
In the Puppet Enterprise Console, On the Patching -> Vulnerabilies page (https://pe.puppet.net/#/vulnerabilities), Accept
the Nessus Registration.
Rerun Nessus Transformer task
# bolt task run nessus_transformer::run_nessus_transformer --targets nessus-transformer.puppet.net
Started on nessus-transformer.puppet.net...
Finished on nessus-transformer.puppet.net:
{
"status": "-- Logs begin at Thu 2025-01-09 04:43:08 PST, end at Thu 2025-01-09 06:40:59 PST. --\nJan 09 06:40:48 nesssus-transformer python3[8887]: API call to /scans/8/export/1387764080/status returned status: 200\nJan 09 06:40:48 nesssus-transformer python3[8887]: Export status: loading. Waiting for 10 seconds.\nJan 09 06:40:58 nesssus-transformer python3[8887]: API call to /scans/8/export/1387764080/status returned status: 200\nJan 09 06:40:58 nesssus-transformer python3[8887]: API call to /scans/8/export/1387764080/download returned status: 200\nJan 09 06:40:58 nesssus-transformer python3[8887]: Scan downloaded successfully\nJan 09 06:40:58 nesssus-transformer python3[8887]: Adding results for transformer 3997ed5f-7768-5457-bb9d-6291354e786a with scan date 2024-09-03T04:23:22Z\nJan 09 06:40:59 nesssus-transformer python3[8887]: API call to /vrs/v1/command/add-results/3997ed5f-7768-5457-bb9d-6291354e786a?scan_date=2024-09-03T04:23:22Z returned status: 201\nJan 09 06:40:59 nesssus-transformer python3[8887]: Results added successfully\nJan 09 06:40:59 nesssus-transformer systemd[1]: nessus-transformer.service: Succeeded.\nJan 09 06:40:59 nesssus-transformer systemd[1]: Started nessus-transformer.service."
}
Successful on 1 target: nesssus-transformer.delivery.puppetlabs.net
Vulnerabilities are now displayed in Puppet Enterprise Console. These can be refreshed at any stage by running the above task. The task is also configured to run daily. This is the default value but cadence can be updated. See section below.
Scheduling
To update how often vulnerabilities are refreshed with Puppet Enterprise, module parameter sync_schedule
can be updated. The parameter must be configured in OnCalendar Format. Some examples are listed below;
Explanation Systemd timer
Every 1 hour *-*-* *:00:00
Every 12 hour *-*-* */12:00:00
Between certain hours *-*-* 9-17:00:00
Daily *-*-* 00:00:00
Every 7 days * *-*-* 00:00:00
monthly * *-*-01 00:00:00
Every quarter * *-01,04,07,10-01 00:00:00
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.
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
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.