Metadata-Version: 1.1
Name: more.jwtauth
Version: 0.7
Summary: JWT Access Auth Identity Policy for Morepath
Home-page: https://github.com/morepath/more.jwtauth
Author: Morepath developers
Author-email: morepath@googlegroups.com
License: BSD
Description: more.jwtauth: JWT Authentication integration for Morepath
        =========================================================
        
        
        Overview
        --------
        
        This is a Morepath_ authentication extension for the JSON Web Token (JWT) Authentication.
        
        For more information about JWT, see:
        
        -  `JSON Web Token draft`_ - the official JWT draft
        -  `Auth with JSON Web Tokens`_ - an interesting blog post by José Padilla
        
        To access resources using JWT Access Authentication, the client must have obtained a JWT to make signed requests to the server.
        The Token can be opaque to client, although, unless it is encrypted, the client can read the claims made in the token.
        
        JWT validates the authenticity of the claimset using the signature.
        
        This plugin uses the `PyJWT library`_ from José Padilla for verifying JWTs.
        
        Introduction
        ------------
        
        The general workflow of JWT Access Authentication:
            * After the client has sent the login form we check if the user exists and if the password is valid.
            * In this case more.jwtauth generates a JWT token including all information in a claim set and send
              it back to the client inside the HTTP authentication header.
            * The client stores it in some local storage and send it back in the authentication header on every request.
            * more.jwtauth validates the authenticity of the claim set using the signature included in the token.
            * The logout should be handled by the client by removing the token and making some cleanup depending on the
              implementation.
        
        You can include all necessary information about the identity in the token so JWT Access Authentication
        can be used by a stateless service e.g. with external password validation.
        
        
        Requirements
        ------------
        
        -  Python (2.7, 3.3, 3.4, 3.5)
        -  morepath (>= 0.15)
        -  PyJWT (1.4.1)
        -  optional: cryptography (1.4)
        
        .. Note::
           If you want to use another algorithm than HMAC (HS*), you need to install
           cryptography.
           On some systems this can be a little tricky. Please follow the instructions
           in https://cryptography.io/en/latest/installation and be sure to install all
           dependencies as referenced.
        
        
        Installation
        ------------
        
        You can use pip for installing more.jwtauth:
        
        * ``pip install -U more.jwtauth[crypto]`` - for installing with cryptography
        * ``pip install -U more.jwtauth`` - installing without cryptography
        
        Alternatively you can use buildout to install more.jwtauth.
        Remember to install cryptography explicitly if you need it.
        
        
        Usage
        -----
        
        For a basic setup just set the necessary settings including a key or key file
        and pass them to JWTIdentityPolicy::
        
            import morepath
            from more.jwtauth import JWTIdentityPolicy
        
        
            class App(morepath.App):
                pass
        
        
            @App.setting_section(section="jwtauth")
            def get_jwtauth_settings():
                return {
                    # Set a key or key file.
                    'master_secret': 'secret',
        
                    # Adjust the settings which you need.
                    'leeway': 10
                }
        
        
            @App.identity_policy()
            def get_identity_policy(settings):
                # Get the jwtauth settings as a dictionary.
                jwtauth_settings = settings.jwtauth.__dict__.copy()
        
                # Pass the settings dictionary to the identity policy.
                return JWTIdentityPolicy(**jwtauth_settings)
        
        
            @App.verify_identity()
            def verify_identity(identity):
                # As we use a token based authentication we can trust the claimed identity.
                return True
        
        The login can be done in the standard Morepath way. You can add extra information about the identity,
        which will be stored in the JWT token and can be accessed through the morepath.Identity object::
        
            class Login(object):
                pass
        
        
            @App.path(model=Login, path='login')
            def get_login():
                return Login()
        
        
            @App.view(model=Login, request_method='POST')
            def login(self, request):
                username = request.POST['username']
                password = request.POST['password']
        
                # Here you get some extra user information.
                fullname = request.POST['fullname']
                email = request.POST['email']
                role = request.POST['role']
        
                # Do the password validation.
                if not user_has_password(username, password):
                    raise HTTPProxyAuthenticationRequired('Invalid username/password')
        
                @request.after
                def remember(response):
                    # We pass the extra info to the identity object.
                    identity = morepath.Identity(username, fullname=fullname, email=email, role=role)
                    request.app.remember_identity(response, request, identity)
        
                return "You're logged in."  # or something more fancy
        
        Don't use reserved claim names as "iss", "aud", "exp", "nbf", "iat", "jti" and
        the user_id_claim (default: "sub", see settings_). They will be silently ignored.
        
        Advanced:
            For testing or if we want to use some methods of the JWTIdentityPolicy class
            directly we can pass the settings as arguments to the class::
        
                identity_policy = JWTIdentityPolicy(
                    master_secret='secret',
                    leeway=10
                )
        
        
        Algorithms
        ----------
        
        The JWT spec supports several algorithms for cryptographic signing. This library
        currently supports:
        
        HS256
           HMAC using SHA-256 hash algorithm (default)
        
        HS384
           HMAC using SHA-384 hash algorithm
        
        HS512
           HMAC using SHA-512 hash algorithm
        
        ES256 [1]_
           ECDSA signature algorithm using SHA-256 hash algorithm
        
        ES384 [1]_
           ECDSA signature algorithm using SHA-384 hash algorithm
        
        ES512 [1]_
           ECDSA signature algorithm using SHA-512 hash algorithm
        
        PS256 [1]_
           RSASSA-PSS signature using SHA-256 and MGF1 padding with SHA-256
        
        PS384 [1]_
           RSASSA-PSS signature using SHA-384 and MGF1 padding with SHA-384
        
        PS512 [1]_
           RSASSA-PSS signature using SHA-512 and MGF1 padding with SHA-512
        
        RS256 [1]_
           RSASSA-PKCS1-v1_5 signature algorithm using SHA-256 hash algorithm
        
        RS384 [1]_
           RSASSA-PKCS1-v1_5 signature algorithm using SHA-384 hash algorithm
        
        RS512 [1]_
           RSASSA-PKCS1-v1_5 signature algorithm using SHA-512 hash algorithm
        
        .. [1] The marked algorithms require more.jwtauth to be installed
               with its ``crypto`` dependencies::
        
                 pip install -U more.jwtauth[crypto]
        
               See Installation_ for details. In case of problems be sure
               to have read the note in the Requirements_ section.
        
        
        Settings
        --------
        
        There are some settings that you can override. Here are all the defaults::
        
            @App.setting_section(section="jwtauth")
            def get_jwtauth_settings():
                return {
                    'master_secret': None,
                    'private_key': None,
                    'private_key_file': None,
                    'public_key': None,
                    'public_key_file': None,
                    'algorithm': "HS256",
                    'expiration_delta': datetime.timedelta(hours=6),
                    'leeway': 0,
                    'verify_expiration': True,
                    'issuer': None,
                    'auth_header_prefix': "JWT",
                    'userid_claim': "sub"
                }
        
        The following settings are available:
        
        master_secret
           A secret known only by the server, used for the default HMAC (HS*) algorithm.
           Default is None.
        
        private_key
           An Elliptic Curve or an RSA private_key used for the EC (EC*) or RSA (PS*/RS*) algorithms.
           Default is None.
        
        private_key_file
           A file holding an Elliptic Curve or an RSA encoded (PEM/DER) private_key.
           Default is None.
        
        public_key
           An Elliptic Curve or an RSA public_key used for the EC (EC*) or RSA (PS*/RS*) algorithms.
           Default is None.
        
        public_key_file
           A file holding an Elliptic Curve or an RSA encoded (PEM/DER) public_key.
           Default is None.
        
        algorithm
           The algorithm used to sign the key.
           Defaults is HS256.
        
        expiration_delta
           Time delta from now until the token will expire. Set to None to disable.
           Default is 6 hours.
        
        leeway
           The leeway, which allows you to validate an expiration time which is in the past, but not very far.
           To use as a datetime.timedelta.
           Defaults is 0.
        
        verify_expiration
           If you set it to False and expiration_delta is not None, you should verify the "exp" claim by yourself
           and if it is expired you can either refresh the token or you must reject it.
           Default is True.
        
        issuer
           This is a string that will be checked against the iss claim of the token.
           You can use this e.g. if you have several related apps with exclusive user audience.
           Default is None (do not check iss on JWT).
        
        auth_header_prefix
           You can modify the Authorization header value prefix that is required to be sent together with the token.
           The default value is JWT. Another common value used for tokens is Bearer.
        
        userid_claim
           The claim, which contains the user id.
           The default claim is 'sub'.
        
        The library takes either a master_secret or private_key/public_key pair.
        In the later case the algorithm must be an EC*, PS* or RS* version.
        
        
        Inspiration
        -----------
        
        This module is inspired by:
        
        -  The `pyramid_jwtauth`_ package from Alex Kavanagh.
        -  The `django-rest-framework-jwt`_ package from José Padilla.
        
        
        .. _Morepath: http://morepath.readthedocs.org
        .. _JSON Web Token draft: http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html
        .. _Auth with JSON Web Tokens: http://jpadilla.com/post/73791304724/auth-with-json-web-tokens
        .. _PyJWT library: http://github.com/progrium/pyjwt
        .. _pyramid_jwtauth: https://github.com/ajkavanagh/pyramid_jwtauth
        .. _django-rest-framework-jwt: https://github.com/GetBlimp/django-rest-framework-jwt
        
        
        CHANGES
        *******
        
        0.7 (2016-07-20)
        ================
        
        - Upgrade to Morepath 0.15.
        - Upgrade to PyJWT 1.4.1 and Cryptography 1.4.
        - Add testenv for Python 3.5 and make it the default test environment.
        - Change author to "Morepath developers".
        - Clean up classifiers.
        
        
        0.6 (2016-05-19)
        ================
        
        - Make Cryptography optional.
        
          **Breaking Change:** For using other algorithms than HMAC you now need
          to install the ``crypto`` dependencies explicitly. Read the note in the
          Requirements section and the new Installation section of README.rst.
        
        - Add an Installation section to the README.
        - Refactor the cryptography test suite.
        
        
        0.5 (2016-04-25)
        ================
        
        - Adding some tests.
        - Increase coverage to 100%.
        - Add travis-ci and tox integration.
        - Some clean-up.
        - Upgrade to Morepath 0.14.
        - Some improvements to the setup and release workflow.
        
        
        
        0.4 (2016-04-13)
        ================
        
        - Upgrade to Morepath 0.13.2 and update the tests.
        - Upgrade PyJWT to 1.3.0 and cryptography to 1.3.1.
        - Make it a PyPI package and release it. Fixes Issue #1.
        
        
        0.3 (2016-04-13)
        ================
        
        - Upgrade PyJWT to 1.4.0 and cryptography to 0.9.1.
        - Python 3.2 is no longer a supported platform. This version of Python is rarely used.
          PyUsers affected by this should upgrade to 3.3+.
        - Some cleanup.
        
        0.2 (2015-06-29)
        ================
        
        - Integrate the set_jwt_auth_header function into the identity policy as remember method.
        
        - Add support for PS256, PS384, and PS512 algorithms.
        
        - Pass settings directly as arguments to the JWTIdentityPolicy class with the possibility
          to override them with Morepath settings using the method introduced in Morepath 0.11.
        
        - Remove JwtApp as now we use JWTIdentityPolicy directly without inherit from JwtApp.
        
        - Add a Introduction and Usage section to README.
        
        - Integrate all functions as methods in the JWTIdentityPolicy Class.
        
        - Refactor the test suite.
        
        
        0.1 (2015-04-15)
        ================
        
        - Initial public release.
        
Keywords: morepath JWT identity authentication
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Environment :: Web Environment
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 5 - Production/Stable
