| Name | shcheck JSON |
| Version |
1.6.7
JSON |
| download |
| home_page | https://github.com/santoru/shcheck |
| Summary | A basic tool to check security headers of a website |
| upload_time | 2024-05-17 20:33:52 |
| maintainer | None |
| docs_url | None |
| author | santoru |
| requires_python | >=3 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# shcheck - Security Header Check
<p align="center">
<a href="https://pypi.org/project/shcheck/"><img alt="PyPI" src="https://img.shields.io/pypi/v/shcheck"></a>
<a href="https://pypi.org/project/shcheck/"><img alt="Pypi" src="https://img.shields.io/pypi/dm/shcheck"></a>
<a href="#"><img alt="Updated" src="https://img.shields.io/github/last-commit/santoru/shcheck?label=updated"></a>
<img src="screenshot.png" alt="Output on Facebook" />
</p>
## Check security headers on a target website
I did this tool to help me to check which security headers are enabled on certain websites.
The tool is very simple and it's the result of few minutes of coding.
It just check headers and print a report about which are enabled and which not
I think there is a lot to improve, and I will be grateful if somebody wants to help
## How to run:
### Pypi
```bash
pip3 install shcheck
shcheck.py https://insecurity.blog
```
### Docker
First build your docker container using something like this:
`docker build -t shcheck .`
Then simply run your docker container using something like this where you specify which website you want to check headers on:
`docker run -it --rm shcheck https://insecurity.blog`
### From source
```bash
git clone https://github.com/santoru/shcheck && cd shcheck
./shcheck.py https://insecurity.blog
```
### Standalone script
If you want to run shcheck as a standalone script, just grab the `shcheck.py` script from the `shcheck` module/folder and copy it around.
## Usage
```
Usage: ./shcheck.py [options] <target>
Options:
-h, --help show this help message and exit
-p PORT, --port=PORT Set a custom port to connect to
-c COOKIE_STRING, --cookie=COOKIE_STRING
Set cookies for the request
-a HEADER_STRING, --add-header=HEADER_STRING
Add headers for the request e.g. 'Header: value'
-d, --disable-ssl-check
Disable SSL/TLS certificate validation
-g, --use-get-method Use GET method instead HEAD method
-j, --json-output Print the output in JSON format
-i, --information Display information headers
-x, --caching Display caching headers
-k, --deprecated Display deprecated headers
--proxy=PROXY_URL Set a proxy (Ex: http://127.0.0.1:8080)
--hfile=PATH_TO_FILE Load a list of hosts from a flat file
--colours=COLOURS Set up a colour profile [dark/light/none]
--colors=COLOURS Alias for colours for US English
```
Raw data
{
"_id": null,
"home_page": "https://github.com/santoru/shcheck",
"name": "shcheck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": null,
"author": "santoru",
"author_email": "santoru@pm.me",
"download_url": "https://files.pythonhosted.org/packages/5c/6c/e5a6ce1f287dfa3b155f5709f3bc0f95ec64ca1c396c55b04513bca25294/shcheck-1.6.7.tar.gz",
"platform": null,
"description": "# shcheck - Security Header Check\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/shcheck/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/shcheck\"></a>\n <a href=\"https://pypi.org/project/shcheck/\"><img alt=\"Pypi\" src=\"https://img.shields.io/pypi/dm/shcheck\"></a>\n <a href=\"#\"><img alt=\"Updated\" src=\"https://img.shields.io/github/last-commit/santoru/shcheck?label=updated\"></a>\n <img src=\"screenshot.png\" alt=\"Output on Facebook\" />\n</p>\n\n## Check security headers on a target website\n\nI did this tool to help me to check which security headers are enabled on certain websites.\n\nThe tool is very simple and it's the result of few minutes of coding.\n\nIt just check headers and print a report about which are enabled and which not\n\nI think there is a lot to improve, and I will be grateful if somebody wants to help\n\n## How to run:\n\n### Pypi\n```bash\npip3 install shcheck\nshcheck.py https://insecurity.blog\n```\n\n### Docker\nFirst build your docker container using something like this: \n\n`docker build -t shcheck .`\n\nThen simply run your docker container using something like this where you specify which website you want to check headers on: \n\n`docker run -it --rm shcheck https://insecurity.blog`\n\n### From source\n```bash\ngit clone https://github.com/santoru/shcheck && cd shcheck\n./shcheck.py https://insecurity.blog\n```\n\n### Standalone script\nIf you want to run shcheck as a standalone script, just grab the `shcheck.py` script from the `shcheck` module/folder and copy it around.\n\n## Usage\n```\nUsage: ./shcheck.py [options] <target>\n\nOptions:\n -h, --help show this help message and exit\n -p PORT, --port=PORT Set a custom port to connect to\n -c COOKIE_STRING, --cookie=COOKIE_STRING\n Set cookies for the request\n -a HEADER_STRING, --add-header=HEADER_STRING\n Add headers for the request e.g. 'Header: value'\n -d, --disable-ssl-check\n Disable SSL/TLS certificate validation\n -g, --use-get-method Use GET method instead HEAD method\n -j, --json-output Print the output in JSON format\n -i, --information Display information headers\n -x, --caching Display caching headers\n -k, --deprecated Display deprecated headers\n --proxy=PROXY_URL Set a proxy (Ex: http://127.0.0.1:8080)\n --hfile=PATH_TO_FILE Load a list of hosts from a flat file\n --colours=COLOURS Set up a colour profile [dark/light/none]\n --colors=COLOURS Alias for colours for US English\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A basic tool to check security headers of a website",
"version": "1.6.7",
"project_urls": {
"Homepage": "https://github.com/santoru/shcheck"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c46cd42e0c8f1fee9860b007c5c05a177896dedc9a8ca5817e74a68c546b4d42",
"md5": "14b6323b1e81519385adbd70abf6bfc0",
"sha256": "982a80a4fb4d5365017fd53e3a80eef066adfecc158aa76bc384d0648c2dad5a"
},
"downloads": -1,
"filename": "shcheck-1.6.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "14b6323b1e81519385adbd70abf6bfc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 24696,
"upload_time": "2024-05-17T20:33:51",
"upload_time_iso_8601": "2024-05-17T20:33:51.219475Z",
"url": "https://files.pythonhosted.org/packages/c4/6c/d42e0c8f1fee9860b007c5c05a177896dedc9a8ca5817e74a68c546b4d42/shcheck-1.6.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c6ce5a6ce1f287dfa3b155f5709f3bc0f95ec64ca1c396c55b04513bca25294",
"md5": "5c15b1dc72c5a87f765e5e87149b20f0",
"sha256": "7853bcddb809a1d83ceda85cd6e9124d4acdcc1bbf582539990e0b7bfe1be5b2"
},
"downloads": -1,
"filename": "shcheck-1.6.7.tar.gz",
"has_sig": false,
"md5_digest": "5c15b1dc72c5a87f765e5e87149b20f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 19858,
"upload_time": "2024-05-17T20:33:52",
"upload_time_iso_8601": "2024-05-17T20:33:52.340140Z",
"url": "https://files.pythonhosted.org/packages/5c/6c/e5a6ce1f287dfa3b155f5709f3bc0f95ec64ca1c396c55b04513bca25294/shcheck-1.6.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 20:33:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "santoru",
"github_project": "shcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shcheck"
}
