# 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](https://pypi.org/project/audiness/).
```bash
$ pip3 install audiness --user
```
To get the lastest state:
```bash
$ pip install git+https://github.com/audiusGmbH/audiness.git
```
For Nix or NixOS users is a [package](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=audiness)
available in Nixpkgs. Keep in mind that the lastest releases might only
be present in the ``unstable`` channel.
```bash
$ 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.
```bash
$ 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.
```bash
$ 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.
```bash
$ export ACCESS_KEY="ae0bf3d57f8f8f6bcd8d01d3aedde60937d08647da4d89a6eb4dba2a9bee5d5d"
$ export SECRET_KEY="5f671a64819221e6b5c2361016af7dcaeb30de359009fee589b3a5d85dea11b4"
```
## License
`audiness` is licensed under MIT, for more details check the LICENSE file.
Raw data
{
"_id": null,
"home_page": "https://github.com/audiusGmbH/audiness",
"name": "audiness",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "vulnerabilites, nessus",
"author": "Fabian Affolter",
"author_email": "fabian-affolter@audius.de",
"download_url": "https://files.pythonhosted.org/packages/f2/21/4536ed392428d12261dbb2baa55eb734efaf6d158e9ac2810a9d39628128/audiness-0.5.0.tar.gz",
"platform": null,
"description": "# audiness\n\nHelper scripts to interact with Nessus instances. The CLI allows one to perform tasks on a \nNessus installation without using the web interface.\n\n## Installation\n\nThe package is available in the [Python Package Index](https://pypi.org/project/audiness/).\n\n```bash\n$ pip3 install audiness --user\n```\n\nTo get the lastest state:\n\n```bash\n$ pip install git+https://github.com/audiusGmbH/audiness.git\n```\n\nFor Nix or NixOS users is a [package](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=audiness)\navailable in Nixpkgs. Keep in mind that the lastest releases might only\nbe present in the ``unstable`` channel.\n\n```bash\n$ nix-env -iA nixos.audiness\n```\n\n## Setup\n\nYou have to generate API keys for your users. Click on username in the right upper corner, then\nselect ``API keys`` and press the ``Generate`` button.\n\nNote the access key and the secrect key somewhere.\n\nIf you don't plan to run `audiness` on the same host as your Nessus instance is running then it\ncould be required that you use port-forwarding to access the Nessus web interface through a tunnel.\n\n```bash\n$ ssh -L 8834:localhost:8834 -l your_user_name host.with.nessus\n```\n\n## Usage\n\nUse `--help` to get a general overview or `COMMAND --help` for the detailed help.\n\n```bash\n$ audiness --help\n \n Usage: audiness [OPTIONS] COMMAND [ARGS]... \n \n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --access-key TEXT Nessus API access key [env var: ACCESS_KEY] [default: None] [required] \u2502\n\u2502 * --secret-key TEXT Nessus API secret key [env var: SECRET_KEY] [default: None] [required] \u2502\n\u2502 --host TEXT URL to Nessus instance [default: https://localhost:8834] \u2502\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 folders \u2502\n\u2502 scans \u2502\n\u2502 server \u2502\n\u2502 software \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\nIf you don't want to enter the access key and the secrect key then put them in the\nenvironment of your shell.\n\n```bash\n$ export ACCESS_KEY=\"ae0bf3d57f8f8f6bcd8d01d3aedde60937d08647da4d89a6eb4dba2a9bee5d5d\"\n$ export SECRET_KEY=\"5f671a64819221e6b5c2361016af7dcaeb30de359009fee589b3a5d85dea11b4\"\n```\n\n## License\n\n`audiness` is licensed under MIT, for more details check the LICENSE file.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI tool to interact with Tenable's Nessus",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/audiusGmbH/audiness",
"Repository": "https://github.com/audiusGmbH/audiness"
},
"split_keywords": [
"vulnerabilites",
" nessus"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1c370db380681e37fcdbd8b847be30134f18f5023a0c9b33636a9badcd69de3",
"md5": "c8af46fcdd9622d217951fd857f91039",
"sha256": "fa9bc3e9664e22459a2c7f327b2cb85ca1c66ade5e0ddb4e0acf377479dc3ed5"
},
"downloads": -1,
"filename": "audiness-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8af46fcdd9622d217951fd857f91039",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 8671,
"upload_time": "2024-05-31T09:54:32",
"upload_time_iso_8601": "2024-05-31T09:54:32.869036Z",
"url": "https://files.pythonhosted.org/packages/e1/c3/70db380681e37fcdbd8b847be30134f18f5023a0c9b33636a9badcd69de3/audiness-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2214536ed392428d12261dbb2baa55eb734efaf6d158e9ac2810a9d39628128",
"md5": "dc0395efce893b60d3faaf0c3066e388",
"sha256": "a48c51fc17cc7a93f749b4f6673e522fbfe428d5a7597404a6eda9ce9c54766a"
},
"downloads": -1,
"filename": "audiness-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "dc0395efce893b60d3faaf0c3066e388",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 6856,
"upload_time": "2024-05-31T09:54:33",
"upload_time_iso_8601": "2024-05-31T09:54:33.904127Z",
"url": "https://files.pythonhosted.org/packages/f2/21/4536ed392428d12261dbb2baa55eb734efaf6d158e9ac2810a9d39628128/audiness-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 09:54:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "audiusGmbH",
"github_project": "audiness",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "audiness"
}
JSON
