LimberDuck TNSCM
LimberDuck TNSCM a CLI Manager for Tenable Nessus which enables you to perform certain actions on Nessus by (C) Tenable, Inc. via Nessus API.
Main features
Initial version of TNSCM lets you perform actions like:
- plugin
- family list
- details for given plugin id
- policy
- list
- compare two policies (all or only different settings)
- download (export) as .nessus files
- delete
- scan
- list (optionally per folder)
- list with history (per folder, last N days)
- folder list
- download results (last N days, per folder, exact scan / history run)
- compare findings of two scan runs (new, fixed, severity changed)
- server info
- status
- licensed IPs
- version
- advanced settings
- list
- get selected
- edit
- add custom setting
- delete / reset to default
- user list
To filter data to specific values you can use JMESPath.
Installation
Note: It's advisable to use python virtual environment for below instructions. Read more about python virtual environment in The Hitchhiker’s Guide to Python!
Read about virtualenvwrapper in The Hitchhiker’s Guide to Python!: virtualenvwrapper provides a set of commands which makes working with virtual environments much more pleasant.
-
Install TNSCM
pip install tnscmTo upgrade to newer version run:
pip install -U tnscm -
Run TNSCM
tnscm
Commands
| option / command | plugin |
policy |
scan |
server |
settings |
user |
|---|---|---|---|---|---|---|
--help |
yes | yes | yes | yes | yes | yes |
--list |
yes | yes | yes | yes | ||
--family-list |
yes | |||||
--plugin-id |
yes | |||||
--plugin-file |
yes | |||||
--depends-on |
yes | |||||
--required-by |
yes | |||||
--depth |
yes | |||||
--max-plugins |
yes | |||||
--list-history |
yes | |||||
--list-folders |
yes | |||||
--download |
yes | yes | ||||
--policy-id |
yes | |||||
--upload |
yes | |||||
--diff |
yes | yes | ||||
--edit |
yes | |||||
--add |
yes | |||||
--get |
yes | |||||
--delete |
yes | yes | ||||
--compare |
yes | yes | ||||
--filter |
yes | yes | yes | yes | yes | |
--format |
yes | yes | yes | yes | yes | |
--limit |
yes | |||||
--folder |
yes | |||||
--scan-id |
yes | |||||
--history-id |
yes | |||||
--runs |
yes | |||||
--output-dir |
yes | yes | ||||
--file-format |
yes | |||||
--overwrite |
yes | yes | ||||
--no-progress |
yes | |||||
--yes |
yes | |||||
--filter-options |
yes | yes | yes | yes | yes | |
--status |
yes | |||||
--ips |
yes | |||||
--health |
yes | |||||
--license |
yes | |||||
--warn-days |
yes | |||||
--feed-max-age |
yes | |||||
--version |
yes | |||||
--insecure, -k |
yes | yes | yes | yes | yes | yes |
--ca-cert |
yes | yes | yes | yes | yes | yes |
--hide-banner |
yes | yes | yes | yes | yes | yes |
--hide-address |
yes | yes | yes | yes | yes | yes |
--no-keyring |
yes | yes | yes | yes | yes | yes |
Pipelines
By default password is read from and saved in OS credential manager (macOS Keychain, Windows Credential Manager)
using keyring. Pipeline agents usually don't have one,
so use --no-keyring with --password, keyring is then not used at all:
tnscm scan -a 127.0.0.1 --port 8834 -u user -p "$NESSUS_PASSWORD" --no-keyring --download --limit 1d --hide-banner
Server health and licence
Scanner health alerts (e.g. slow DNS lookups, not enough memory) and statistics (CPU, memory, disk space),
exit code 1 when any alert is critical:
tnscm server -a 127.0.0.1 --port 8834 --health
License and plugin feed status, exit code 1 when any check is warning
(e.g. plugin feed download failed, license expires soon, plugin set is too old):
tnscm server -a 127.0.0.1 --port 8834 --license --warn-days 30 --feed-max-age 2d
Use it in a monitoring job:
tnscm server -a 127.0.0.1 --port 8834 -u user -p "$NESSUS_PASSWORD" --no-keyring --license --warn-days 30 --feed-max-age 2d --hide-banner || echo "check Nessus!"
Certificate verification
Nessus uses its own certificate authority (CA), which is not trusted by default, so connection fails with
SSL certificate of <address> can't be verified. You can:
-
trust the Nessus CA with
--ca-cert(certificate has to be valid for the address you connect to):curl -sk https://127.0.0.1:8834/getcert -o nessus-ca.pemtnscm server -a 127.0.0.1 --port 8834 --status --ca-cert nessus-ca.pem -
or skip verification with
-k/--insecure:tnscm server -a 127.0.0.1 --port 8834 --status -k
Clean output
Use --hide-banner to skip tool name and version, and --hide-address to skip Nessus address, e.g. to use output in scripts:
tnscm settings -a 127.0.0.1 --port 8834 --get max_hosts -f "[0].value" --format json --hide-banner --hide-address
Example filters
To check possible keys and values by returning only first entry (works with every command, runs -f "[0]" --format json):
--filter-options
To get only name and id columns:
--filter "[].{id: id, name: name}"
To sort by id column:
--filter "sort_by([], &id)[].{id: id, name: name}"
To filter returned data to these items which name contain exampl:
--filter "[? contains(name, 'exampl')].{id: id, name: name}"
To filter returned data to these items which name contain exampl1 or exampl2:
--filter "[? contains(name, 'exampl1') || contains(name, 'exampl2')].{id: id, name: name}"
To filter returned data to item which id is equal to number 10:
--filter '[?id==`10`].{id: id, name: name}'
To filter returned data to item which name is equal to string test name:
--filter "[?name == 'test name'].{id: id, name: name}"
To filter returned data to items which name is different than string test name:
--filter "[?name != 'test name'].{id: id, name: name}"
Policy management
Policy download
Download (export) all policies, or selected ones, as .nessus files.
File name contains policy id, name and last modification time, so changed policy is saved to a new file
and unchanged one is skipped, use --overwrite to download it again:
tnscm policy -a 127.0.0.1 --port 8834 --download --output-dir ./policies
tnscm policy -a 127.0.0.1 --port 8834 --download --policy-id 19 --policy-id 22
Policy upload
Upload (import) policies from .nessus files, e.g. downloaded with --download from another Nessus:
tnscm policy -a 127.0.0.1 --port 8834 --upload ./policies/127.0.0.1_19_My_policy_20261024-142541.nessus
If a policy with the same name exists, Nessus adds a suffix to the name, e.g. My policy_01.
Policy comparison
Compare all settings, plugin families and individual plugins of two policies (ids from tnscm policy --list).
Each row shows both values and result: same, different or only in <policy>:
tnscm policy -a 127.0.0.1 --port 8834 --compare 19 20
Show only differences:
tnscm policy -a 127.0.0.1 --port 8834 --compare 19 20 --diff
Show only differences in plugins:
tnscm policy -a 127.0.0.1 --port 8834 --compare 19 20 --diff --filter "[?section=='plugins']"
Plugin management
Plugin details
Show all details of given plugin:
tnscm plugin -a 127.0.0.1 --port 8834 --plugin-id 156860
Compare selected details of several plugins (attributes which occur many times, like cve or xref, are lists):
tnscm plugin -a 127.0.0.1 --port 8834 --plugin-id 156860 --plugin-id 19506 --filter "[].{id: id, name: name, risk_factor: risk_factor, cvss3: cvss3_base_score, cve: cve}" --format json
Show details of plugins by their file name, e.g. taken from dependency attribute (comma separated list is accepted):
tnscm plugin -a 127.0.0.1 --port 8834 --plugin-file "nessus_product_setup.nasl, patches_summary.nbin" --filter "[].{id: id, name: name, fname: fname}"
Plugin dependencies
Show tree of plugins on which given plugin depends (--depends-on) and plugins which depend on it (--required-by).
By default only direct dependencies and dependents are shown (--depth 1), use --depth 0 for all levels.
Plugins of one level are listed only if there are at most --max-plugins of them (default 100, 0 for no limit).
tnscm plugin -a 127.0.0.1 --port 8834 --plugin-id 57399 --required-by
tnscm plugin -a 127.0.0.1 --port 8834 --plugin-id 19506 --depends-on --depth 4
[19506] [Nessus Scan Information] [scan_info.nasl] depends on
├── [83955] [Nessus Product Information] [nessus_product_setup.nasl]
└── [66334] [Patch Report] [patches_summary.nbin]
└── [64294] [Patch Management Windows Auditing Conflicts] [patch_management_auditing.nasl]
├── [38153] [Microsoft Windows Summary of Missing Patches] [smb_missing_msft_patches.nasl]
│ ├── [13855] [Microsoft Windows Installed Hotfixes] [smb_hotfixes.nasl] - depends on 2 more, use --depth INTEGER
│ └── [57033] [Microsoft Patch Bulletin Feasibility Check] [ms_bulletin_checks_possible.nasl] - depends on 8 more, use --depth INTEGER
└── [67099] [Post-Scan Rules Application] [pluginrules.nbin]
verified 8 plugins in 1m 24s, 10.5s per plugin
Each lookup by file name takes a few seconds on Nessus side, so summary at the bottom shows how many plugins were verified, how long it took and average time per plugin.
Scan management
Scan runs comparison
Compare findings per host of two scan runs given as SCAN_ID:HISTORY_ID (from tnscm scan --list-history).
Runs can belong to the same or different scans, older run is always treated as first.
Each finding (host + plugin) is marked as new, fixed, severity changed or same:
tnscm scan -a 127.0.0.1 --port 8834 --compare 12:13 12:14
Show only changes:
tnscm scan -a 127.0.0.1 --port 8834 --compare 12:13 12:14 --diff
Show only new critical and high findings:
tnscm scan -a 127.0.0.1 --port 8834 --compare 12:13 12:14 --diff --filter "[?result=='new' && contains(['critical', 'high'], \"12:14\")]"
Scan results download
Each scan run (history entry) is saved as a separate file named
<address>_<scan id>_<history id>_<scan name>_<run start>.nessus.
Only runs with status completed or imported are downloaded, others are reported as skipped.
Files which already exist are skipped, use --overwrite to download them again.
List folders to know their ids and names:
tnscm scan -a 127.0.0.1 --port 8834 --list-folders
List scans with history in given folder from last 30 days:
tnscm scan -a 127.0.0.1 --port 8834 --list-history --folder "My Scans" --limit 30d
Preview newest run of each scan, the same runs --download --runs latest would download:
tnscm scan -a 127.0.0.1 --port 8834 --list-history --runs latest
Download all scan runs from last 7 days in given folder to ./reports:
tnscm scan -a 127.0.0.1 --port 8834 --download --limit 7d --folder "My Scans" --output-dir ./reports
--limit takes number with unit d (days), h (hours), m (minutes) or s (seconds), units can be combined (here: last 30 hours):
tnscm scan -a 127.0.0.1 --port 8834 --download --limit 1d6h
Download only the newest run of each scan from last 7 days:
tnscm scan -a 127.0.0.1 --port 8834 --download --limit 7d --runs latest
Download the newest completed run of given scan, or all its runs:
tnscm scan -a 127.0.0.1 --port 8834 --download --scan-id 12
tnscm scan -a 127.0.0.1 --port 8834 --download --scan-id 12 --runs all
Download exact scan run:
tnscm scan -a 127.0.0.1 --port 8834 --download --scan-id 12 --history-id 13
Progress bar is shown in terminal only. In pipelines (or with --no-progress) one line per scan run is printed
and a summary downloaded X, skipped Y, failed Z. Exit code is 1 if any download failed.
tnscm scan -a 127.0.0.1 --port 8834 --download --limit 1d --no-progress --file-format csv
Note: Nessus doesn't allow exports in trial mode, such server responds with
403.
Advanced settings
Get value of selected settings (use --filter "[0].value" to print value only):
tnscm settings -a 127.0.0.1 --port 8834 --get max_hosts --get max_checks
Change existing settings (planned changes are shown and confirmed first):
tnscm settings -a 127.0.0.1 --port 8834 --edit max_hosts=128 --edit max_checks=4
Add new custom setting:
tnscm settings -a 127.0.0.1 --port 8834 --add my_custom_setting=value
Delete custom setting, or reset built-in setting to its default value:
tnscm settings -a 127.0.0.1 --port 8834 --delete my_custom_setting
Note: Nessus hides a built-in setting reset to default from the list, so it can't be changed with
--editanymore. Use--addto set it again, e.g.--add max_hosts=256.
Use --yes to apply without confirmation, e.g. in pipelines.
--edit and --delete accept only listed names and --add only names which are not listed, use --list to check current names and values.
Meta
Change log
See CHANGELOG.
Licence
MIT: LICENSE.
Authors
Damian Krawczyk created LimberDuck TNSCM
Metadata
Release files for tnscm 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tnscm-0.1.0.tar.gz | 36.9 kB | Without provenance | Details for tnscm-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tnscm-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for tnscm-0.1.0-py3-none-any.whl |
Total release size: 69.4 kB
Release files / tnscm-0.1.0.tar.gz
| Download URL | tnscm-0.1.0.tar.gz |
|---|---|
| Size | 36.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bfa0d028fe51220b399ac0a26007333660fcafd0524e3f42974f3d85f80fa5b2
|
|
BLAKE2b-256 checksum How to use checksums |
807700f7278abe53ec7705ceee6acb6f70107473e3664e0bf7e4dd599ff3fe78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / tnscm-0.1.0-py3-none-any.whl
| Download URL | tnscm-0.1.0-py3-none-any.whl |
|---|---|
| Size | 32.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3351842f08e9f52c4250eb89529aad067e412e745295292d88eeec5cafd82904
|
|
BLAKE2b-256 checksum How to use checksums |
72472d232a67c452498a5c23231d95204a2c13fa299e55ba6d20fccf372710a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for tnscm 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.