From 491a1adaa5da2285fd7fb7e748687dab851f5f86 Mon Sep 17 00:00:00 2001
From: Aaron Meihm <ameihm@mozilla.com>
Date: Tue, 15 Nov 2016 14:18:51 -0600
Subject: [PATCH 1/4] fix bug with file based targets

---
 runscan/runscan.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/runscan/runscan.py b/runscan/runscan.py
index 4c714fb..b8b4c90 100755
--- a/runscan/runscan.py
+++ b/runscan/runscan.py
@@ -245,7 +245,7 @@ def domain():
                 targets = ','.join([x.strip() for x in fd.readlines() if x[0] != '#'])
         except IOError:
             targets = args.s
-        run_scan(args.s, args.p, follow=args.f, mozdef=args.mozdef)
+        run_scan(targets, args.p, follow=args.f, mozdef=args.mozdef)
     else:
         sys.stdout.write('Must specify something to do\n\n')
         parser.print_help()

From e942a480e300fa4c4c8a6edbe64a1ce41174d03c Mon Sep 17 00:00:00 2001
From: Aaron Meihm <ameihm@mozilla.com>
Date: Tue, 15 Nov 2016 14:35:28 -0600
Subject: [PATCH 2/4] it's possible nessus result does not include host-fqdn

---
 scanapi/scanapi.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scanapi/scanapi.py b/scanapi/scanapi.py
index efebfc8..a693098 100755
--- a/scanapi/scanapi.py
+++ b/scanapi/scanapi.py
@@ -42,7 +42,7 @@ class ScanAPIParser(object):
 
     def _hostinfo_locator(self, entry):
         for x in self._hostinfo:
-            if x['host-fqdn'] == entry['host']:
+            if 'host-fqdn' in x and x['host-fqdn'] == entry['host']:
                 return x
             if x['host-ip'] == entry['host']:
                 return x

From dbe90e24ad821f05adf3c98efc9d9577e706c42a Mon Sep 17 00:00:00 2001
From: Aaron Meihm <ameihm@mozilla.com>
Date: Tue, 15 Nov 2016 14:52:27 -0600
Subject: [PATCH 3/4] add some docs

---
 README.rst | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..af2e616
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,56 @@
+scanapi
+=======
+
+scanapi is a small REST API that exposes functionality of a Nessus server to
+users or applications. This interface can be used to primarily execute scans
+using the Nessus server, and fetch results. The primary intent is provided a
+more limited / restricted interface than is possible communicating directly
+with the Nessus API, and simplify creating scans and fetching results.
+
+.. code
+
+        < users > --------> < scanapi > --------> < nessus >
+
+Installation
+------------
+
+Fetch code
+~~~~~~~~~~
+
+.. code :: bash
+
+        $ git clone https://github.com/mozilla/scanapi.git
+        $ cd scanapi
+        $ virtualenv myenv
+        $ source myenv/bin/active
+        $ pip install -r requirements.txt
+
+Configure scanapi
+~~~~~~~~~~~~~~~~~
+
+Copy scanapi.yml.example and edit it as required.
+
+.. code :: bash
+
+        $ cd scanapi
+        $ cp scanapi.yml.example scanapi.yml
+
+You will need to create a user in your Nessus server that scanapi will authenticate
+to Nessus as, and you need to create API keys for that user. These should be added to
+the scanapi configuration file.
+
+The ``appkeys`` section can be used to specify application keys, one of which
+must be sent in the SCANAPIKEY header to authenticate when making requests to the
+API. If no ``appkeys`` section is present, no authentication against scanapi will
+occur.
+
+Run scanapi
+~~~~~~~~~~~
+
+scanapi can be run directly for testing.
+
+.. code :: bash
+
+        $ ./scanapi.py
+
+For actual use, you would generally configure it with nginx and uwsgi.

From 55424d101717cbabc457a2e98718e8e0ffc370ac Mon Sep 17 00:00:00 2001
From: Aaron Meihm <ameihm@mozilla.com>
Date: Tue, 15 Nov 2016 15:00:55 -0600
Subject: [PATCH 4/4] add some docs

---
 README.rst | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index af2e616..091fbca 100644
--- a/README.rst
+++ b/README.rst
@@ -7,7 +7,7 @@ using the Nessus server, and fetch results. The primary intent is provided a
 more limited / restricted interface than is possible communicating directly
 with the Nessus API, and simplify creating scans and fetching results.
 
-.. code
+::
 
         < users > --------> < scanapi > --------> < nessus >
 
@@ -54,3 +54,40 @@ scanapi can be run directly for testing.
         $ ./scanapi.py
 
 For actual use, you would generally configure it with nginx and uwsgi.
+
+API endpoints
+-------------
+
+/api/v1 (GET)
+~~~~~~~~~~~~~
+
+Return status.
+
+/api/v1/scan/purge (DELETE)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Purge stored scans and results older than specified timeframe.
+
+/api/v1/scan (POST)
+~~~~~~~~~~~~~~~~~~~
+
+Run a new scan with a specified policy against indicated targets.
+
+/api/v1/scan/results (GET)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Fetch the results of a scan, formatted into a JSON document.
+
+/api/v1/scan/policies (GET)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Get a list of policies that can be specified when running a scan.
+
+runscan
+-------
+
+runscan is a command line tool that can be used to talk to scanapi. You need to set
+a couple environment variables.
+
+* SCANAPIURL - Set to URL where scanapi is listening
+* SCANAPIKEY - Set to an API key you configured in scanapi.yml if needed