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] [required]                             │
│ *  --secret-key                TEXT  Nessus API secret key [env var: SECRET_KEY] [required]                             │
│    --url                       TEXT  URL to Nessus instance [env var: URL] [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                                                                                                                 │
│ policies                                                                                                                │
│ scans                                                                                                                   │
│ server                                                                                                                  │
│ software                                                                                                                │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

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

$ exoprt URL="https://localhost:8838"
$ 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-1.0.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: audiness-1.0.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for audiness-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a7627b3874c8ed50c1b2e884560b4edef1629f7874e6026871d32f7fdb79e940
MD5 fef3272222336ed430e0a7e4c67a45e7
BLAKE2b-256 e5f60f4807b849fec6dd7c3c8ebf7c2d353ee8c181dc170c015df536cecb234b

See more details on using hashes here.

Provenance

The following attestation bundles were made for audiness-1.0.1.tar.gz:

Publisher: publish-to-pypi.yml on audius/audiness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: audiness-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for audiness-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7329be5952bdbbc6c9d21361ea60fa9d72d73cefa2118099dc184cec46956b97
MD5 6dd419936d1b8fd7bb0e32e053417a81
BLAKE2b-256 a4920718a20f31fcff49d359b87469f43d97abf639726cfbc11c4c27a17c6493

See more details on using hashes here.

Provenance

The following attestation bundles were made for audiness-1.0.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on audius/audiness

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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