Merge pull request #133 from Santandersecurityresearch/develop

CLI option changes from Develop to Master

.gitignore

@@ -64,6 +64,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_static/*
+!docs/_static/.keep
 
 # PyBuilder
 target/
@@ -105,4 +107,4 @@ ENV/
 .idea/
 
 # junit reports folder
-reports
+reports

CODE_OF_CONDUCT.md

@@ -1,76 +1,128 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at amias.channer@gruposantander.com. 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.
+reported to the community leaders responsible for enforcement at amias.channer@gruposantander.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
 
-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.
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -9,29 +9,28 @@
 
 # Welcome to drHEADer
 
-There are a number of HTTP headers which enhance the security of a website when used. Often ignored, or unknown, these HTTP security headers help prevent common web application vulnerabilities when used. 
+There are a number of HTTP headers which enhance the security of a website when used. Often ignored, or unknown, these HTTP security headers help prevent common web application vulnerabilities when used.
 
-DrHEADer helps with the audit of security headers received in response to a single request or a list of requests. 
+DrHEADer helps with the audit of security headers received in response to a single request or a list of requests.
 
-When combined with the OWASP [Application Security Verification Standard](https://github.com/OWASP/ASVS/blob/master/4.0/en/0x22-V14-Config.md) (ASVS) 4.0, it is a useful tool to include as part of an automated CI/CD pipeline which checks for missing HTTP headers. 
+When combined with the OWASP [Application Security Verification Standard](https://github.com/OWASP/ASVS/blob/master/4.0/en/0x22-V14-Config.md) (ASVS) 4.0, it is a useful tool to include as part of an automated CI/CD pipeline which checks for missing HTTP headers.
 
-# How Do I Install It?
+## How Do I Install It?
 
-This project was developed with Python 3.7.4.  
+This project was developed with Python 3.7.4.
 Whilst it works with Python 2.x, End of Life (EOL) is coming so if possible, use 3.x. The easiest way to install drHEADer is to clone this repository and via a terminal window, run the following command:
 
-
-``` console
+```sh
 $ python3 setup.py install --user
 ```
-This will install all the pre-requisites and you'll end up with a drheader executable.
 
+This will install all the pre-requisites and you'll end up with a drheader executable.
 
-# How Do I Use It?
+## How Do I Use It?
 
 There are two ways you could use drHEADer, depending on what you want to achieve. The easiest way is using the CLI.
 
-## CLI
+### CLI
 
 drHEADer can perform a single scan against a target and report back which headers are present, like so:
 
@@ -42,21 +41,21 @@ $ drheader scan single https://santander.co.uk
 
 If you wish to scan multiple sites, you'll need the targets in a JSON format, or a txt file, like so:
 
-``` 
-          [
-            {
-              "url": "https://example.com",
-              "params": {
-                  "example_parameter_key": "example_parameter_value"
-              }
-            },
-            ...
-          ]
+```json
+  [
+    {
+      "url": "https://example.com",
+      "params": {
+          "example_parameter_key": "example_parameter_value"
+      }
+    },
+    ...
+  ]
 ```
 
 For txt files, use the following command:
 
-``` console
+```sh
 $ drheader scan bulk -ff targets.txt
 ```
 
@@ -74,71 +73,79 @@ There are a number of parameters you can specify during bulk scans, these are:
 
 To save scan results, you can use the --json parameter and pipe it to [jq](https://stedolan.github.io/jq/), which is a lightweight and flexible command-line JSON processor,like so:
 
-``` console
+```sh
 $ drheader scan single https://santander.co.uk --json | jq '.'
 ```
+
 ![singlescan](assets/img/drheaderscansinglejson.png)
 
-## In a Project
+### In a Project
 
 It is also possible to call drHEADer from within an existing project, and this is achieved like so:
-
-    from drheader import Drheader
-
-    # create drheader instance
-    drheader_instance = Drheader(headers={'X-XSS-Protection': '1; mode=block'}, status_code=200)
-
-    report = drheader_instance.analyze()
-    print(report)
 
-### Customize HTTP method and headers
+```python
+from drheader import Drheader
 
-By default, the tool uses **GET** method when making a request, but you can change that by supplying the ```method``` argument like this:
+# create drheader instance
+drheader_instance = Drheader(headers={'X-XSS-Protection': '1; mode=block'}, status_code=200)
 
-    # create drheader instance
-    drheader_instance = Drheader(url="http://test.com", method="POST")
+report = drheader_instance.analyze()
+print(report)
+```
 
-Remember you can use any method supported by ```requests``` such as POST, PUT, GET and DELETE.
+#### Customize HTTP method and headers
 
-At the same time, you can customize the headers sent by the request. For that, you just have to use the ```request_headers``` argument:
+By default, the tool uses **GET** method when making a request, but you can change that by supplying the `method` argument like this:
 
-    # create drheader instance
-    custom_headers = {"token": "1234aerhga"}
-    drheader_instance = Drheader(url="http://test.com", request_headers=custom_headers)
+```python
+# create drheader instance
+drheader_instance = Drheader(url="http://test.com", method="POST")
+```
+
+Remember you can use any method supported by `requests` such as POST, PUT, GET and DELETE.
 
-As we continue development on drHEADer, we will further enhance this functionality. 
+At the same time, you can customize the headers sent by the request. For that, you just have to use the `request_headers` argument:
 
-#### Other `requests` arguments
+```python
+# create drheader instance
+custom_headers = {"token": "1234aerhga"}
+drheader_instance = Drheader(url="http://test.com", request_headers=custom_headers)
+```
 
-The _verify_ argument supported by ```requests``` can be included. The default value is set to `True`.
+As we continue development on drHEADer, we will further enhance this functionality.
 
-    # create drheader instance
-    drheader_instance = Drheader(url="http://test.com", verify=False)
+##### Other `requests` arguments
 
-Other arguments may be included in the future such as _timeout_, _allow_redirects_ or _proxies_.
+The _verify_ argument supported by `requests` can be included. The default value is set to `True`.
 
-# How Do I Customise drHEADer Rules?
+```python
+# create drheader instance
+drheader_instance = Drheader(url="http://test.com", verify=False)
+```
 
-DrHEADer relies on a yaml file that defines the policy it will use when auditing security headers. The file is located at `./drheader/rules.yml`, and you can customise it to fit your particular needs. Please follow this [link](RULES.md) if you want to know more.  
+Other arguments may be included in the future such as _timeout_, *allow_redirects* or _proxies_.
 
-# Notes
+## How Do I Customise drHEADer Rules?
+
+DrHEADer relies on a yaml file that defines the policy it will use when auditing security headers. The file is located at `./drheader/rules.yml`, and you can customise it to fit your particular needs. Please follow this [link](RULES.md) if you want to know more.
+
+## Notes
 
 * On ubuntu systems you may need to install libyaml-dev to avoid errors related to a missing yaml.h.
 
-## Roadmap
+### Roadmap
 
 We have a lot of ideas for drHEADer, and will push often as a result. Some of the things you'll see shortly are:
 
-* Building on the Python library to make it easier to embed in your own projects. 
+* Building on the Python library to make it easier to embed in your own projects.
 * Releasing the API, which is seperate from the core library - the API allows you to hit URLs or endpoints at scale
-* Better integration into MiTM proxies. 
+* Better integration into MiTM proxies.
 
-# Who Is Behind It?
+## Who Is Behind It?
 
 DrHEADer was developed by the Santander UK Security Engineering team, who are:
 
 * David Albone
 * [Javier Domínguez Ruiz](https://github.com/javixeneize)
 * Fernando Cabrerizo
 * [James Morris](https://github.com/actuallyjamez)
-

docs/conf.py

@@ -37,7 +37,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'm2r2']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/contributing.rst

@@ -1 +1,4 @@
-.. include:: ../CONTRIBUTING.rst
+Contributing
+============
+
+.. mdinclude:: ../CONTRIBUTING.md