Metadata-Version: 1.1
Name: flaskhmac
Version: 0.0.1
Summary: Provides easy integration of the HMAC signatures for your REST Flask Applications.
Home-page: https://github.com/thisissoon/Flask-HMAC
Author: SOON_
Author-email: dorks@thisissoon.com
License: Public Domain
Description: Flask-HMAC
        ==========
        
        This module provides three functions to authenticate calls to a Flask route. The
        intended use case is for use with REST APIs. It's simply designed to check that a
        client is entitled to access a particular route in a Flask application, based on
        the fact that it must possess a copy of the secret key.
        
        
        Usage
        -----
        
        Server
        ~~~~~~
        
        .. sourcecode:: python
        
            app = Flask(__name__)
            app.config['HMAC_KEY'] = 's3cr3tk3y'  # define the secret key in an app config
        
        
            @app.route("/no_auth_view")
            def no_auth_view():
                return "no_auth_view"
        
        
            @app.route("/hmac_auth_view")
            @hmac.auth  # decorate view
            def hmac_auth_view():
                return "hmac_auth_view"
        
        
        Call without payload
        ~~~~~~~~~~~~~~~~~~~~
        
        .. sourcecode:: python
        
            sig = hmac.make_hmac()  # generate signature
            response = requests.get(
                '/hmac_auth_view',
                headers={hmac.header: sig}
            )
        
        
        Call with payload
        ~~~~~~~~~~~~~~~~~
        
        Request payload has to be used as a data for HMAC generation.
        
        .. sourcecode:: python
        
            data = json.dumps({'foo': 'boo'})
        
            sig = hmac.make_hmac(data)  # generate signature
            response = requests.post(
                '/hmac_auth_view',
                data=data,
                headers={hmac.header: sig}
            )
        
        Change Log
        ----------
        
        0.0.1
        ~~~~~~~~~
        - Initial release including the core feature set
        
Keywords: Flask,HMAC,REST,Views
Platform: UNKNOWN
Classifier: Framework :: Flask
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: License :: Public Domain
