Merge pull request #295 from nccgroup/release/5.0.0

Release/5.0.0-beta

.travis.yml

@@ -4,8 +4,6 @@ language: python
 sudo: false
 
 python:
-  - "2.7"
-  - "3.4"
   - "3.5"
   - "3.6"
 
@@ -36,6 +34,7 @@ script:
   #  - 'nosetests tests/test-utils.py'
   #  - '[ "${TRAVIS_SECURE_ENV_VARS}" = "true" ] && nosetests tests/test-utils_sns.py || false'
   - nosetests --with-coverage tests/test-main.py
+  - nosetests --with-coverage tests/test-aws_resources.py
   - nosetests --with-coverage tests/test-rules-ruleset.py
   - nosetests --with-coverage tests/test-rules-processingengine.py
   - nosetests --with-coverage --nocapture tests/test-scoutsuite.py -a "!credential"

CODE_OF_CONDUCT.md

@@ -32,7 +32,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
 

CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing 
+
 ## Table of Contents
  * [Introduction](#introduction)
  * [Getting started](#getting-started)
@@ -32,7 +33,7 @@ So you want to contribute some code, that's great! This project follows the [Git
 
 ## How to report a bug
 
- When filing an issue, make sure to answer these five questions:
+When filing an issue, make sure to answer these five questions:
 
  1. What version of Python are you using?
  2. What operating system and processor architecture are you using?
@@ -46,4 +47,4 @@ If you find yourself wishing for a feature that doesn't exist in Scout Suite, yo
 
 ## Code review process
 
-The pull request are reviewed on a regular basis by the core team. We require a minimum of two reviewers before it is merged. 
+Pull requests are regularly reviewed by the core team. We require a minimum of two reviewers before allowing to merge. 

README.md

@@ -20,6 +20,8 @@ Scout Suite is stable and actively maintained, but a number of features and inte
 with us as we find time to work on, and improve, the tool. Feel free to report a bug with details (please provide
 console output using the `--debug` argument), request a new feature, or send a pull request.
 
+The project team can be contacted at <[email protected]>.
+
 **Note:**
 
 The latest (and final) version of Scout2 can be found in <https://github.com/nccgroup/Scout2/releases> and
@@ -30,8 +32,8 @@ The latest (and final) version of Scout2 can be found in <https://github.com/ncc
 The following cloud providers are currently supported/planned:
 
 -   Amazon Web Services
--   Google Cloud Platform (beta)
--   Azure (alpha)
+-   Google Cloud Platform
+-   Microsoft Azure (beta)
 
 ## Installation
 
@@ -67,7 +69,7 @@ Scout Suite is written in Python and supports the following versions:
 -   3.6
 -   3.7
 
-WARNING: Python 2.7 & 3.4 support will soon be deprecated in the following releases.
+**WARNING**: Python 2.7 & 3.4 support is planned to be deprecated in the following releases.
 
 The required libraries can be found in the
 [requirements.txt](https://github.com/nccgroup/ScoutSuite/blob/master/requirements.txt) file.
@@ -84,7 +86,7 @@ permissions:
 -   `ReadOnlyAccess`
 -   `SecurityAudit`
 
-If the usage of multi-factor authentication (MFA) is enabled, please consult [this page](https://aws.amazon.com/premiumsupport/knowledge-center/authenticate-mfa-cli/) in order to 
+If multi-factor authentication (MFA) is enabled, refer to [the AWS documentation](https://aws.amazon.com/premiumsupport/knowledge-center/authenticate-mfa-cli/) in order to 
 configure MFA authentication through the management of session tokens.
 
 #### Google Cloud Platform
@@ -244,3 +246,5 @@ You can also pass the credentials you want directly with command line arguments.
 interactively:
 
     $ python Scout.py azure --username <USERNAME> --password <PASSWORD>
+
+Additional information can be found in [the wiki](https://github.com/nccgroup/ScoutSuite/wiki).

Scout.py

@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 import sys
-
 from ScoutSuite.__main__ import main
 
 if __name__ == "__main__":
-    sys.exit(main())
+    main()
+    sys.exit()

ScoutSuite/__init__.py

@@ -1,18 +1,16 @@
 # -*- coding: utf-8 -*-
 
 __author__ = 'NCC Group'
-__version__ = '4.3.0'
-
-AWSCONFIG  = 42
-EXCEPTIONS = 4242
-HTMLREPORT = 424242
-AWSRULESET = 42424242
+__version__ = '5.0.0-alpha'
 
 DEFAULT_REPORT_DIR = 'scoutsuite-report'
-AWSCONFIG_FILE = 'scoutsuite-results/scoutsuite_results.js'
-AWSRULESET_FILE = 'scoutsuite-results/scoutsuite_ruleset.js'
-EXCEPTIONS_FILE = 'scoutsuite-results/scoutsuite_exceptions.js'
-HTMLREPORT_FILE = 'report.html'
-GENERATOR_FILE = 'ruleset-generator.html'
+DEFAULT_RESULT_FILE = 'scoutsuite-results/scoutsuite_results.js'
+DEFAULT_RULESET_FILE = 'scoutsuite-results/scoutsuite_ruleset.js'
+DEFAULT_EXCEPTIONS_FILE = 'scoutsuite-results/scoutsuite_exceptions.js'
+DEFAULT_ERRORS_FILE = 'scoutsuite-results/scoutsuite_errors_log.json'
+DEFAULT_HTMLREPORT_FILE = 'report.html'
+DEFAULT_GENERATOR_FILE = 'ruleset-generator.html'
+
+ERRORS_LIST = []
 
-REPORT_TITLE = 'Scout Suite Report'
+DEFAULT_REPORT_TITLE = 'Scout Suite Report'