Skip to main content

An interface to the Nessus 6 REST API

Project description

# ness6rest.py - a REST interface to Nessus 6
[![Build Status](https://travis-ci.org/tenable/nessrest.svg?branch=master)](https://travis-ci.org/tenable/nessrest)
### Dependencies:

* Nessus 6.0.1
* Python 2.7+ or 3.3+
* requests module (install via pip)
* The dependencies can be satisfied via `pip install -r requirements.txt`

### Features:

* Logins

```python
scan = nessrest.Scanner(url="https://nessusscanner:8834", login="username", password="password")

creds = [credentials.WindowsPassword(username="administrator", password="foobar"),
credentials.WindowsPassword(username="administrator", password="barfoo"),
credentials.SshPassword(username="nessususer", password="foobar")]

scan.policy_add_creds(credentials=creds)
```
* Build policies

```python
scan.upload(upload_file="file.audit")
scan._policy_add_audit(category="Windows", filename="file.audit")
scan.policy_add(name="Scripted Scan", plugins="21156")
```

* Launch scans

```python
scan.scan_add(targets="192.168.0.1")
scan.scan_run()
```

* Parse scan results

```python
scan.scan_results()
```

* Download KB for target

```python
kbs = scan.download_kbs()

for hostname in kbs.keys():
f = open(hostname, "w")
f.write(kbs[hostname])
f.close()
```

* Output for ticketing/wiki format

### Feature Requests:

* Deleting of scan/schedule/policy
* Ability to change "tag" from CLI via config/CLI arg
* Enforce supported versions of Nessus

### Notes:
* Proxies are not supported, although transparent proxies should work... transparently

# nessrest - an example client

### Dependencies:
* argparse module (install via pip)

### Suggested installation:

* Find the path to your "site-packages" with: `python -c "import sys; print(sys.path)"`
* Symlink `ness6rest.py` in the Git repo in the "site-packages" or "dist-packages" directory.
* Test by issuing `import ness6rest` inside the Python interactive
interperter.

### InsecureRequestWarning

If you're running Nessus with a self-signed certificate, and you wish to squelch the InsecureRequestWarnings that the requests library uses, you can add the following line after the import requests line in ness6rest.py:
`requests.packages.urllib3.disable_warnings()`

This will disable invalid cerficate warnings and should be used with caution.

### Configuration file:

* Copy `ness_rest.conf.example` to `ness_rest.conf` and configure for your scanner.
* There are several valid paths for the location of the config file(in order):
* The path passed from the CLI with `--config`
* A permanent config file is searched for in the following locations:
* `$HOME/.ness_rest.conf`
* `$HOME/.ness_rest/ness_rest.conf`
* `/etc/ness_rest.conf`
* `/etc/ness_rest/ness_rest.conf`
* `$PWD/ness_rest.conf`

### Building modules:

* To build a package to install via `pip` or `easy_install`, execute:
* `python setup.py sdist`
* The resulting build will be in `$PWD/dist/ness6rest-<version>.tar.gz`

### Changelog:
* 2014-10-31: Support added for Nessus 6.0.1

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

nessrest-0.12.tar.gz (23.6 kB view details)

Uploaded Source

File details

Details for the file nessrest-0.12.tar.gz.

File metadata

  • Download URL: nessrest-0.12.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nessrest-0.12.tar.gz
Algorithm Hash digest
SHA256 7563d833063b133d2c0fa5a4be402d3da8073dee3346876b8d0887046eeaf661
MD5 e577f1233d9a0b0bc605384bcec126b7
BLAKE2b-256 75ad341484877cb9b9790a1bd3a9003cee1cdca01e13a41a5717378810439cf1

See more details on using hashes here.

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