secheaders


Namesecheaders JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryScan HTTP security headers
upload_time2024-10-20 22:36:41
maintainerNone
docs_urlNone
authorNone
requires_python>=3.4
licenseThe MIT License (MIT) Copyright (c) 2016-2024 Jussi-Pekka Erkkila Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords web security
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # secheaders
Python script to check HTTP security headers


Same functionality as securityheaders.io but as Python script. Also checks some server/version headers. Written and tested using Python 3.8.

With minor modifications could be used as a library for other projects.

**NOTE**: The project renamed (2024-10-19) from **securityheaders** to **secheaders** to avoid confusion with PyPI package with similar name.

## Installation

The following assumes you have Python  installed and command `python` refers to python version >= 3.8.

### Run without installation

1. Clone into repository
2. Run `python -m secheaders`

### Installation

1. Clone into repository
2. `python -m build`
3. `pip install dist/secheaders-0.1.0-py3-none-any.whl`
4. Run `secheaders --help`



### Usage
```
$ secheaders --help
usage: secheaders [-h] [--max-redirects N] [--insecure] [--verbose] URL

Check HTTP security headers

positional arguments:
  URL                Target URL

options:
  -h, --help         show this help message and exit
  --max-redirects N  Max redirects, set 0 to disable (default: 2)
  --insecure         Do not verify TLS certificate chain (default: False)
  --verbose, -v      Verbose output (default: False)
```


### Example output
```
$ secheaders example.com
Header 'x-frame-options' is missing [ WARN ]
Header 'strict-transport-security' is missing [ WARN ]
Header 'content-security-policy' is missing [ WARN ]
Header 'x-content-type-options' is missing [ WARN ]
Header 'x-xss-protection' is missing  [ OK ]
Header 'referrer-policy' is missing [ WARN ]
Header 'permissions-policy' is missing [ WARN ]
server: ECAcc (nyd/D124) [ WARN ]
HTTPS supported  [ OK ]
HTTPS valid certificate  [ OK ]
HTTP -> HTTPS automatic redirect [ WARN ]
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "secheaders",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": "Jussi-Pekka Erkkil\u00e4 <jp.erkkila@gmail.com>",
    "keywords": "web, security",
    "author": null,
    "author_email": "Jussi-Pekka Erkkil\u00e4 <jp.erkkila@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/bb/6d/55aae65ae6ff642e4daefda63dc16b3db1af86f47a90f2304becc8b4acfd/secheaders-0.1.0.tar.gz",
    "platform": null,
    "description": "# secheaders\nPython script to check HTTP security headers\n\n\nSame functionality as securityheaders.io but as Python script. Also checks some server/version headers. Written and tested using Python 3.8.\n\nWith minor modifications could be used as a library for other projects.\n\n**NOTE**: The project renamed (2024-10-19) from **securityheaders** to **secheaders** to avoid confusion with PyPI package with similar name.\n\n## Installation\n\nThe following assumes you have Python  installed and command `python` refers to python version >= 3.8.\n\n### Run without installation\n\n1. Clone into repository\n2. Run `python -m secheaders`\n\n### Installation\n\n1. Clone into repository\n2. `python -m build`\n3. `pip install dist/secheaders-0.1.0-py3-none-any.whl`\n4. Run `secheaders --help`\n\n\n\n### Usage\n```\n$ secheaders --help\nusage: secheaders [-h] [--max-redirects N] [--insecure] [--verbose] URL\n\nCheck HTTP security headers\n\npositional arguments:\n  URL                Target URL\n\noptions:\n  -h, --help         show this help message and exit\n  --max-redirects N  Max redirects, set 0 to disable (default: 2)\n  --insecure         Do not verify TLS certificate chain (default: False)\n  --verbose, -v      Verbose output (default: False)\n```\n\n\n### Example output\n```\n$ secheaders example.com\nHeader 'x-frame-options' is missing [ WARN ]\nHeader 'strict-transport-security' is missing [ WARN ]\nHeader 'content-security-policy' is missing [ WARN ]\nHeader 'x-content-type-options' is missing [ WARN ]\nHeader 'x-xss-protection' is missing  [ OK ]\nHeader 'referrer-policy' is missing [ WARN ]\nHeader 'permissions-policy' is missing [ WARN ]\nserver: ECAcc (nyd/D124) [ WARN ]\nHTTPS supported  [ OK ]\nHTTPS valid certificate  [ OK ]\nHTTP -> HTTPS automatic redirect [ WARN ]\n```\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2016-2024 Jussi-Pekka Erkkila  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Scan HTTP security headers",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "web",
        " security"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cf8b24368149331ef343b0e15f482602f23a54f40a0ce6b89488738e0fed6e6c",
                "md5": "8c7ce82a1fd07b47b090250de18b6e0f",
                "sha256": "fa867fd27f13ec51b40b5d7b6f351d7e73dbde215ef13564d2513b35b7f22b33"
            },
            "downloads": -1,
            "filename": "secheaders-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8c7ce82a1fd07b47b090250de18b6e0f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 9955,
            "upload_time": "2024-10-20T22:36:40",
            "upload_time_iso_8601": "2024-10-20T22:36:40.850312Z",
            "url": "https://files.pythonhosted.org/packages/cf/8b/24368149331ef343b0e15f482602f23a54f40a0ce6b89488738e0fed6e6c/secheaders-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bb6d55aae65ae6ff642e4daefda63dc16b3db1af86f47a90f2304becc8b4acfd",
                "md5": "2a70daeda482fe5c9fa68c7a36e5e6a9",
                "sha256": "722db8b1c61f5f3e25df20170c4644ddfdf040657f1b233e361e2f3203106788"
            },
            "downloads": -1,
            "filename": "secheaders-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2a70daeda482fe5c9fa68c7a36e5e6a9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 9315,
            "upload_time": "2024-10-20T22:36:41",
            "upload_time_iso_8601": "2024-10-20T22:36:41.748917Z",
            "url": "https://files.pythonhosted.org/packages/bb/6d/55aae65ae6ff642e4daefda63dc16b3db1af86f47a90f2304becc8b4acfd/secheaders-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-20 22:36:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "secheaders"
}
None
Elapsed time: 0.78292s