Skip to content

Commit

Permalink
Cleaned up README and bumped pyndiff version
Browse files Browse the repository at this point in the history
  • Loading branch information
derpadoo committed Apr 15, 2021
1 parent b9baf6a commit 186c06d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@
## Overview

Scantron is a distributed nmap and masscan scanner comprised of two components. The first is a console node that
consists of a web front end used for scheduling scans and storing nmap scan targets and results. The second component
is an engine that pulls scan jobs from the console and conducts the actual nmap scanning. A majority of the
application's logic is purposely placed on the console to make the engine(s) as "dumb" as possible. All scan target
files and scan results reside on the console and are shared through a network file share (NFS) leveraging SSH tunnels.
The engines call back to the console periodically using a REST API to check for scan tasks and provide scan status
updates. There is also an option to generate have nmap scan diffs emailed to you using the
[pyndiff](https://github.com/rackerlabs/pyndiff) library.
consists of a web front end used for scheduling scans and storing scan targets and results. The second component is an
engine that pulls scan jobs from the console and conducts the actual scanning. A majority of the application's logic is
purposely placed on the console to make the engine(s) as "dumb" as possible. All scan target files and scan results
reside on the console and are shared through a network file share (NFS) leveraging SSH tunnels. The engines call back
to the console periodically using a REST API to check for scan tasks and provide scan status updates. There is also an
option to generate nmap scan diffs emailed to you using the [pyndiff](https://github.com/rackerlabs/pyndiff) library.

Checkout the Python [Scantron API client](https://github.com/rackerlabs/scantron/tree/master/scantron_api_client) for
interacting with the Scantron API and driving automated workflows.
Expand Down Expand Up @@ -413,7 +412,7 @@ crontab -l -u root
### Test Engine API

If you need to test the API without running the engine, ensure there is a "pending" scan set to start earlier than the
current date and time. The server only returns scan jobs that have a 'pending' status and start datetime earlier than
current date and time. The server only returns scan jobs that have a "pending" status and start datetime earlier than
the current datetime.

```bash
Expand Down Expand Up @@ -577,6 +576,7 @@ the 1st or 9th ports.
![create_site](./img/create_site.png)
4. Create scan
* Select start time
* Add start date
* Add recurrence rules (if applicable)
Expand Down Expand Up @@ -605,9 +605,6 @@ the 1st or 9th ports.
`/home/scantron/console/scan_results/complete` - Completed scan files from engines are stored here before being
processed by `nmap_to_csv.py`
The `scantron` user executes a cron job (`nmap_to_csv.sh` which calls `nmap_to_csv.py`) every 5 minutes that will
process the `.xml` scan results found in the `complete` directory and move them to the `processed` directory.
`/home/scantron/console/scan_results/processed` - nmap scan files already processed by `nmap_to_csv.py` reside here.
`/home/scantron/console/for_bigdata_analytics` - .csv files for big data analytics ingestion if applicable
Expand Down
2 changes: 1 addition & 1 deletion console/requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ fqdn==1.5.1
ipython

# Generate human-readable ndiff output when comparing 2 nmap XML scan files.
pyndiff==1.0.1
pyndiff==1.0.2

# Python-PostgreSQL Database Adapter
psycopg2-binary==2.8.6
Expand Down
2 changes: 1 addition & 1 deletion scantron_api_client/scantron_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ def retrieve_scan_results(self, scan_id, file_type, write_to_disk=False, **kwarg
return scan_results

# ENGINES
########
#########
# Engines - CRUD functions.
def create_engine(self):
"""Create a scan command."""
Expand Down

0 comments on commit 186c06d

Please sign in to comment.