Skip to main content

CLI tool to interact with Tenable's Nessus

Project description

audiness

Helper scripts to interact with Nessus instances. The CLI allows one to perform tasks on a Nessus installation without using the web interface.

Installation

The package is available in the Python Package Index.

$ pip3 install audiness --user

To get the lastest state:

$ pip install git+https://github.com/audiusGmbH/audiness.git

For Nix or NixOS users is a package available in Nixpkgs. Keep in mind that the lastest releases might only be present in the unstable channel.

$ nix-env -iA nixos.audiness

Setup

You have to generate API keys for your users. Click on username in the right upper corner, then select API keys and press the Generate button.

Note the access key and the secrect key somewhere.

If you don't plan to run audiness on the same host as your Nessus instance is running then it could be required that you use port-forwarding to access the Nessus web interface through a tunnel.

$ ssh -L 8834:localhost:8834 -l your_user_name host.with.nessus

Usage

Use --help to get a general overview or COMMAND --help for the detailed help.

$ audiness --help
                                                                                                                                  
 Usage: audiness [OPTIONS] COMMAND [ARGS]...                                                                                      
                                                                                                                                  
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *  --access-key                TEXT  Nessus API access key [env var: ACCESS_KEY] [default: None] [required]                    │
│ *  --secret-key                TEXT  Nessus API secret key [env var: SECRET_KEY] [default: None] [required]                    │
│    --host                      TEXT  URL to Nessus instance [default: https://localhost:8834]                                  │
│    --install-completion              Install completion for the current shell.                                                 │
│    --show-completion                 Show completion for the current shell, to copy it or customize the installation.          │
│    --help                            Show this message and exit.                                                               │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ folders                                                                                                                        │
│ scans                                                                                                                          │
│ server                                                                                                                         │
│ software                                                                                                                       │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

If you don't want to enter the access key and the secrect key then put them in the environment of your shell.

$ export ACCESS_KEY="ae0bf3d57f8f8f6bcd8d01d3aedde60937d08647da4d89a6eb4dba2a9bee5d5d"
$ export SECRET_KEY="5f671a64819221e6b5c2361016af7dcaeb30de359009fee589b3a5d85dea11b4"

License

audiness is licensed under MIT, for more details check the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

audiness-0.5.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

audiness-0.5.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file audiness-0.5.0.tar.gz.

File metadata

  • Download URL: audiness-0.5.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for audiness-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a48c51fc17cc7a93f749b4f6673e522fbfe428d5a7597404a6eda9ce9c54766a
MD5 dc0395efce893b60d3faaf0c3066e388
BLAKE2b-256 f2214536ed392428d12261dbb2baa55eb734efaf6d158e9ac2810a9d39628128

See more details on using hashes here.

Provenance

File details

Details for the file audiness-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: audiness-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.9

File hashes

Hashes for audiness-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa9bc3e9664e22459a2c7f327b2cb85ca1c66ade5e0ddb4e0acf377479dc3ed5
MD5 c8af46fcdd9622d217951fd857f91039
BLAKE2b-256 e1c370db380681e37fcdbd8b847be30134f18f5023a0c9b33636a9badcd69de3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page