Metadata-Version: 2.1
Name: secure
Version: 0.1.7
Summary: A lightweight package that adds optional security headers and cookie attributes for Python web frameworks.
Home-page: https://github.com/cakinney/secure
Author: Caleb Kinney
Author-email: cakinney@gmail.com
License: MIT
Description: 
        # Secure
        
        Secure 🔒 is a lightweight package that adds optional security headers and cookie attributes for Python web frameworks.
        
        ### Supported Python web frameworks:
        [aiohttp](https://docs.aiohttp.org), [Bottle](https://bottlepy.org), [CherryPy](https://cherrypy.org), [Falcon](https://falconframework.org), [hug](http://www.hug.rest), [Pyramid](https://trypyramid.com), [Quart](https://pgjones.gitlab.io/quart/), [Responder](https://python-responder.org), [Sanic](https://sanicframework.org), [Starlette](https://www.starlette.io/), [Tornado](https://www.tornadoweb.org/) 
        
        Please see [flask-talisman](https://github.com/GoogleCloudPlatform/flask-talisman) for Flask support and [django-security](https://github.com/sdelements/django-security/) for Django support. 
        
        
        ## Install
        **pip**:
        
        ```console
        $ pip install secure
        ```
        
        **Pipenv**:
        
        ```console
        $ pipenv install secure
        ```
        
        After installing secure:
        
        ```Python
        from secure import SecureHeaders, SecureCookie
        ```
        
        ## Security Headers
        
        Security Headers are HTTP response headers that, when set, can enhance the security of your web application by enabling browser security policies. 
        
        You can assess the security of your HTTP response headers at [securityheaders.com](https://securityheaders.com)
        
        *Recommendations used by Secure 🔒 and more information regarding security headers can be found at the [OWASP Secure Headers Project](https://www.owasp.org/index.php/OWASP_Secure_Headers_Project).*
         
        ## Headers  
        
        #### Server
        Contain information about server software   
        **Default Value:** `NULL` *(obfuscate server information, not included by default)*
        
        #### Strict-Transport-Security (HSTS)
        Ensure application communication is sent over HTTPS   
        **Default Value:** `max-age=63072000; includeSubdomains`  
         
        #### X-Frame-Options (XFO)
        Disable framing from different origins (clickjacking defense)  
        **Default Value:** `SAMEORIGIN`  
        
        #### X-XSS-Protection
        Enable browser cross-site scripting filters  
        **Default Value:** `X-XSS-Protection", "1; mode=block`  
        
        #### X-Content-Type-Options
        Prevent MIME-sniffing  
        **Default Value:** `nosniff`  
        
        #### Content-Security-Policy (CSP)
        Prevent cross-site injections  
        **Default Value:** `script-src 'self'; object-src 'self'`  *(not included by default)**
        
        #### Referrer-Policy
        Enable full referrer if same origin, remove path for cross origin and disable referrer in unsupported browsers  
        **Default Value:** `no-referrer, strict-origin-when-cross-origin`
        
        #### Cache-control / Pragma
        Prevent cacheable HTTPS response  
        **Default Value:** `no-cache, no-store, must-revalidate` / `no-cache`
        
        #### Feature-Policy
        Disable browser features and APIs  
        **Default Value:** `accelerometer 'none'; ambient-light-sensor 'none'; autoplay 'none'; camera 'none'; encrypted-media 'none'; fullscreen 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none'; payment 'none'; picture-in-picture 'none'; speaker 'none'; sync-xhr 'none'; usb 'none'; vr 'none';",` *(not included by default)*
        
         **The Content-Security-Policy (CSP) header can break functionality and can (and should) be carefully constructed, use the `csp=True` option to enable default values.*
         
         ### Example
        `SecureHeaders.framework(response)`
        
         **Default HTTP response headers:** 
         
        ```HTTP
        Strict-Transport-Security: max-age=63072000; includeSubdomains
        X-Frame-Options: SAMEORIGIN
        X-XSS-Protection: 1; mode=block
        X-Content-Type-Options: nosniff
        Referrer-Policy: no-referrer, strict-origin-when-cross-origin
        Cache-control: no-cache, no-store, must-revalidate
        Pragma: no-cache
        ```
        
        ### Options
        
        You can toggle the setting of headers with default values by passing `True` or `False` and override default values by passing a string to the following options:   
        
        - `server` - set the Server header, e.g. `Server=“Secure”` *(string / bool, default=False)*
        - `hsts` - set the Strict-Transport-Security header *(string / bool, default=True)*  
        - `xfo` - set the X-Frame-Options header *(string / bool, default=True)*  
        - `xss` - set the X-XSS-Protection header *(string / bool, default=True)*  
        - `content` - set the X-Content-Type-Options header *(string / bool, default=True)*  
        - `csp` - set the Content-Security-Policy *(string / bool, default=False)* *  
        - `referrer` - set the Referrer-Policy header *(string / bool, default=True)*  
        - `cache` - set the Cache-control and Pragma headers *(string / bool, default=True)*  
        - `feature` - set the Feature-Policy header *(string / bool, default=False)*  
        
        ####  Example
        
        ```Python
        from secure import SecureHeaders
        
        . . . 
        
        SecureHeaders.framework(response, hsts=False, csp=True, xfo="DENY")
        ```
        
        ## Cookies
        #### Path
        The Path directive instructs the browser to only send the cookie if provided path exists in the URL. 
        
        #### Secure
        The Secure flag instructs the browser to only send the cookie via HTTPS.
        
        #### HttpOnly
        The HttpOnly flag instructs the browser to not allow any client side code to access the cookie's contents.
        
        #### SameSite
        The SameSite flag directs the browser not to include cookies on certain cross-site requests. There are two values that can be set for the same-site attribute, lax or strict. The lax value allows the cookie to be sent via certain cross-site GET requests, but disallows the cookie on all POST requests. For example cookies are still sent on links `<a href=“x”>`, prerendering `<link rel=“prerender” href=“x”` and forms sent by GET requests `<form-method=“get”...`, but cookies will not be sent via POST requests `<form-method=“post”...`, images `<img src=“x”>` or iframes `<iframe src=“x”>`. The strict value prevents the cookie from being sent cross-site in any context. Strict offers greater security but may impede functionality. This approach makes authenticated CSRF attacks impossible with the strict flag and only possible via state changing GET requests with the lax flag.
        
        #### Expires
        The Expires attribute sets an expiration date for persistent cookies.
        
        ### Example
        
        ```Python
        SecureCookie.framework(response, name="framework", value="ABC123")
        ```
        
        *Default Set-Cookie HTTP response header:*   
        
        ```HTTP
        Set-Cookie: framework=ABC123; Path=/; secure; HttpOnly; SameSite=lax
        ```
        
        ### Options
        
        You can modify default cookie attribute values by passing the following options:   
        
        - `name`  - set the cookie name *(string, No default value)*
        - `value`  - set the cookie value *(string, No default value)*
        - `path`  - set the Path attribute, e.g.`path=“/secure”` *(string, default="/")*
        - `secure` - set the Secure flag *(bool, default=True)*
        - `httponly` - set the HttpOnly flag *(bool, default=True)*
        - `samesite` - set the SameSite attribute, e.g. `SecureCookie.SameSite.lax` *(bool / enum, options: `SecureCookie.SameSite.lax`, `SecureCookie.SameSite.lax` or `False`, default=SecureCookie.SameSite.lax)**
        - `expires` - set the Expires attribute with the cookie expiration in hours, e.g.`expires=1` *(number / bool, default=False)*
        
        *You can also import the SameSite options enum from Secure, `from secure import SecureCookie, SameSite`*
        
        #### Example
        ```Python
        from secure import SecureCookie
        
        SecureCookie.framework(
                response,
                name="framework",
                value="ABC123",
                expires=1,
                samesite=SecureCookie.SameSite.strict,
            )
        ```
        
        # Framework Agnostic
        Return Dictionary of Headers:  
        `SecureHeaders.headers()`
        
        ##### Example
        ```Python
        SecureHeaders.headers(csp=True, feature=True)
        ```
        
        Return Value:  
        
        `{'Strict-Transport-Security': 'max-age=63072000; includeSubdomains', 'X-Frame-Options': 'SAMEORIGIN', 'X-XSS-Protection': '1; mode=block', 'X-Content-Type-Options': 'nosniff', 'Content-Security-Policy': "script-src 'self'; object-src 'self'", 'Referrer-Policy': 'no-referrer, strict-origin-when-cross-origin', 'Cache-control': 'no-cache, no-store, must-revalidate', 'Pragma': 'no-cache', 'Feature-Policy': "accelerometer 'none'; ambient-light-sensor 'none'; autoplay 'none'; camera 'none'; encrypted-media 'none';fullscreen 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; midi 'none';payment 'none'; picture-in-picture 'none'; speaker 'none'; sync-xhr 'none'; usb 'none'; vr 'none';"}`
        
        # Supported Frameworks
        
        ## aiohttp
        
        #### Headers
        `SecureHeaders.aiohttp(resp)`
        
        ##### Example
        ```Python
        from aiohttp import web
        from aiohttp.web import middleware
        from secure import SecureHeaders
        
        . . . 
        
        @middleware
        async def set_secure_headers(request, handler):
            resp = await handler(request)
            SecureHeaders.aiohttp(resp)
            return resp
            
        . . . 
        
        app = web.Application(middlewares=[set_secure_headers])
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.aiohttp(resp, name="aiohttp", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from aiohttp import web
        from secure import SecureCookie
        
        . . . 
        
        @routes.get("/secure")
        async def set_secure_cookie(request):
            resp = web.Response(text="Secure")
            SecureCookie.aiohttp(resp, name="aiohttp", value="ABC123")
            return resp
            
        . . . 
        ```
        
        
        ## Bottle
        
        #### Headers
        `SecureHeaders.bottle(response)`
        
        ##### Example
        ```Python
        from bottle import route, run, response, hook
        from secure import SecureHeaders
        
        . . . 
        
        @hook("after_request")
        def set_secure_headers():
            SecureHeaders.bottle(response)
            
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.bottle(response, name="bottle", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from bottle import route, run, response, hook
        from secure import SecureCookie
        
        . . . 
        
        @route("/secure")
        def set_secure_cookie():
            SecureCookie.bottle(response, name="bottle", value="ABC123")
            return "Secure"
            
        . . . 
        ```
        
        ## CherryPy
        
        #### Headers
        `'tools.response_headers.headers': SecureHeaders.cherrypy()`
        
        ##### Example
        CherryPy [Application Configuration](http://docs.cherrypy.org/en/latest/config.html#application-config):
        
        ```Python
        import cherrypy
        from secure import SecureHeaders
        
        . . . 
        
        config = {
            '/': {
                'tools.response_headers.on': True,
                'tools.response_headers.headers': SecureHeaders.cherrypy(),
            }
        }
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        response_headers = cherrypy.response.headers
        SecureCookie.cherrypy(response_headers, name="cherrypy", value="ABC123")
        ```
        
        ##### Example
        ```Python
        import cherrypy
        from secure import SecureCookie
        
        . . . 
        
        class SetSecureCookie(object):
            @cherrypy.expose
            def set_secure_cookie(self):
                response_headers = cherrypy.response.headers
                SecureCookie.cherrypy(response_headers, name="cherrypy", value="ABC123")
                return "Secure"
            
        . . . 
        ```
        
        
        ## Falcon
        
        #### Headers
        `SecureHeaders.falcon(resp)`
        
        ##### Example
        ```Python
        import falcon
        from secure import SecureHeaders
        
        . . . 
        
        class SetSecureHeaders(object):
            def process_request(self, req, resp):
                SecureHeaders.falcon(resp)
        
        . . . 
        
        app = api = falcon.API(middleware=[SetSecureHeaders()])
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.falcon(resp, name="falcon", value="ABC123")
        ```
        
        ##### Example
        ```Python
        import falcon
        from secure import SecureCookie
        
        . . . 
        
        class SetSecureCookie(object):
            def on_get(self, req, resp):
                resp.body = "Secure"
                SecureCookie.falcon(resp, name="falcon", value="ABC123")
                
        . . . 
        ```
        
        ## hug
        
        #### Headers
        `SecureHeaders.hug(response)`
        
        ##### Example
        ```Python
        import hug
        from secure import SecureHeaders
        
        . . . 
        
        @hug.response_middleware()
        def set_secure_headers(request, response, resource):
              SecureHeaders.hug(response)
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.hug(response, name="hug", value="ABC123")
        ```
        
        ##### Example
        ```Python
        import hug
        from secure import SecureCookie
        
        . . . 
        
        @hug.get('/secure')
        def set_secure_cookie(response=None):
            SecureCookie.hug(response, name="hug", value="ABC123")
            return "Secure"
                
        . . . 
        ```
        
        
        ## Pyramid
        
        #### Headers
        Pyramid [Tween](https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/hooks.html#registering-tweens):
        
        ```Python
        def set_secure_headers(handler, registry):
            def tween(request):
                response = handler(request)
                SecureHeaders.pyramid(response)
                return response
        ```
        
        ##### Example
        ```Python
        from pyramid.config import Configurator
        from pyramid.response import Response
        from secure import SecureHeaders
        
        . . . 
        
        def set_secure_headers(handler, registry):
            def tween(request):
                response = handler(request)
                SecureHeaders.pyramid(response)
                return response
        
            return tween
        
        . . . 
        
        config.add_tween(".set_secure_headers")
        
        . . . 
        ```
        
        
        #### Cookies
        ```Python
        response = Response("Secure")
        SecureCookie.pyramid(response, name="pyramid", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from pyramid.config import Configurator
        from pyramid.response import Response
        from secure import SecureCookie
        
        . . . 
        
        def set_secure_cookie(request):
            response = Response("Secure")
            SecureCookie.pyramid(response, name="pyramid", value="ABC123")
            return response
            
        . . . 
        ```
        
        ## Quart
        
        #### Headers
        `SecureHeaders.quart(response)`
        
        ##### Example
        ```Python
        from quart import Quart, Response
        from secure import SecureHeaders, SecureCookie
        
        app = Quart(__name__)
        
        . . . 
        
        @app.after_request
        async def set_secure_headers(response):
            SecureHeaders.quart(response)
            return response
        
        . . . 
        ```
        
        
        #### Cookies
        ```Python
        SecureCookie.quart(resp, name="quart", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from quart import Quart, Response
        from secure import SecureHeaders, SecureCookie
        
        app = Quart(__name__)
        
        . . . 
        
        @app.route('/secure')
        async def set_secure_cookie():
            resp = Response("Secure")
            SecureCookie.quart(resp, name="quart", value="ABC123")
            return resp
            
        . . . 
        ```
        
        ## Responder
        
        #### Headers
        `SecureHeaders.responder(resp)`
        
        ##### Example
        ```Python
        import responder
        from secure import SecureHeaders
        
        api = responder.API()
        
        . . . 
        
        @api.route(before_request=True)
        def set_secure_headers(req, resp):
            SecureHeaders.responder(resp)
        
        . . . 
        ```
        
        You should use Responder's [built in HSTS](https://python-responder.org/en/latest/tour.html#hsts-redirect-to-https) and pass the `hsts=False` option. 
        
        
        #### Cookies
        ```Python
        SecureCookie.responder(resp, name="reponder", value="ABC123")
        ```
        
        ##### Example
        ```Python
        import responder
        from secure import SecureCookie
        
        api = responder.API(cors=True)
        
        . . . 
        
        @api.route("/secure")
        async def set_secure_cookie(req, resp):
            resp.text = "Secure"
            SecureCookie.responder(resp, name="reponder", value="ABC123")
            
        . . . 
        ```
        
        
        ## Sanic
        
        #### Headers
        `SecureHeaders.sanic(response)`
        
        ##### Example
        ```Python
        from sanic import Sanic
        from secure import SecureHeaders
        
        app = Sanic()
        
        . . . 
        
        @app.middleware('response')
        async def set_secure_headers(request, response):
            SecureHeaders.sanic(response)
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.sanic(response, name="sanic", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from sanic import Sanic
        from sanic.response import text
        from secure import SecureCookie
        
        app = Sanic()
        
        . . . 
        
        @app.route("/secure")
        async def set_secure_cookie(request):
            response = text("Secure")
            SecureCookie.sanic(response, name="sanic", value="ABC123")
            return response
            
        . . . 
        ```
        
        *To set  Cross Origin Resource Sharing (CORS) headers, please see [sanic-cors](https://github.com/ashleysommer/sanic-cors).*
        
        ## Starlette
        
        #### Headers
        `SecureHeaders.starlette(response)`
        
        ##### Example
        ```Python
        from starlette.applications import Starlette
        from starlette.responses import PlainTextResponse
        import uvicorn
        from secure import SecureHeaders, SecureCookie
        
        app = Starlette()
        
        . . . 
        
        @app.middleware("http")
        async def set_secure_headers(request, call_next):
            response = await call_next(request)
            SecureHeaders.starlette(response)
            return response
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.starlette(response, name="starlette", value="ABC123")
        ```
        
        ##### Example
        ```Python
        from starlette.applications import Starlette
        from starlette.responses import PlainTextResponse
        import uvicorn
        from secure import SecureHeaders, SecureCookie
        
        app = Starlette()
        
        . . . 
        
        @app.route("/secure")
        async def set_secure_cookie(request):
            response = PlainTextResponse("Secure")
            SecureCookie.starlette(response, name="starlette", value="ABC123")
            return response
            
        . . . 
        ```
        
        ## Tornado
        
        #### Headers
        `SecureHeaders.tornado(self)`
        
        ##### Example
        ```Python
        import tornado.ioloop
        import tornado.web
        from secure import SecureHeaders
        
        . . . 
        
        class BaseHandler(tornado.web.RequestHandler):
            def set_default_headers(self):
                SecureHeaders.tornado(self)
        
        . . . 
        ```
        
        #### Cookies
        ```Python
        SecureCookie.tornado(self, name="tornado", value="ABC123")
        ```
        
        ##### Example
        ```Python
        import tornado.ioloop
        import tornado.web
        from secure import SecureCookie
        
        . . . 
        
        class SetSecureCookie(BaseHandler):
            def get(self):
                SecureCookie.tornado(self, name="tornado", value="ABC123")
                self.write("Secure")
            
        . . . 
        ```
        
        
        
        ## Attribution/References
        
        #### Frameworks
        - [aiohttp](https://github.com/aio-libs/aiohttp) - Asynchronous HTTP client/server framework for asyncio and Python
        - [Bottle](https://github.com/bottlepy/bottle) - A fast and simple micro-framework for python web-applications.
        - [CherryPy](https://github.com/cherrypy/cherrypy) - A pythonic, object-oriented HTTP framework.
        - [Falcon](https://github.com/falconry/falcon) - A bare-metal Python web API framework for building high-performance microservices, app backends, and higher-level frameworks.
        - [hug](https://github.com/timothycrosley/hug) - Embrace the APIs of the future. Hug aims to make developing APIs as simple as possible, but no simpler.
        - [Pyramid](https://github.com/Pylons/pyramid) - A Python web framework
        - [Quart](https://gitlab.com/pgjones/quart) - A Python ASGI web microframework.
        - [Responder](https://github.com/kennethreitz/responder) - A familiar HTTP Service Framework
        - [Sanic](https://github.com/huge-success/sanic) - An Async Python 3.5+ web server that's written to go fast
        - [Starlette](https://github.com/encode/starlette) - The little ASGI framework that shines. ✨
        - [Tornado](https://github.com/tornadoweb/tornado) - A Python web framework and asynchronous networking library, originally developed at FriendFeed.
        
        #### Resources
        - [kennethreitz/setup.py: 📦 A Human’s Ultimate Guide to setup.py.](https://github.com/kennethreitz/setup.py)
        - [OWASP - Secure Headers Project](https://www.owasp.org/index.php/OWASP_Secure_Headers_Project)
        - [OWASP - Session Management Cheat Sheet](https://www.owasp.org/index.php/Session_Management_Cheat_Sheet#Cookies)
        - [Mozilla Web Security](https://infosec.mozilla.org/guidelines/web_security)
        - [securityheaders.com](https://securityheaders.com)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3
Description-Content-Type: text/markdown
