aiohttp-security/docs/example.rst

.. _aiohttp-security-example:

===============================================
How to Make a Simple Server With Authorization
===============================================


Simple example::

    from aiohttp import web
    from aiohttp_session import SimpleCookieStorage, session_middleware
    from aiohttp_security import check_permission, \
        is_anonymous, remember, forget, \
        setup as setup_security, SessionIdentityPolicy
    from aiohttp_security.abc import AbstractAuthorizationPolicy


    # Demo authorization policy for only one user.
    # User 'jack' has only 'listen' permission.
    # For more complicated authorization policies see examples
    # in the 'demo' directory.
    class SimpleJack_AuthorizationPolicy(AbstractAuthorizationPolicy):
        async def authorized_userid(self, identity):
            """Retrieve authorized user id.
            Return the user_id of the user identified by the identity
            or 'None' if no user exists related to the identity.
            """
            if identity == 'jack':
                return identity

        async def permits(self, identity, permission, context=None):
            """Check user permissions.
            Return True if the identity is allowed the permission
            in the current context, else return False.
            """
            return identity == 'jack' and permission in ('listen',)


    async def handler_root(request):
        is_logged = not await is_anonymous(request)
        return web.Response(text='''<html><head></head><body>
                Hello, I'm Jack, I'm {logged} logged in.<br /><br />
                <a href="/login">Log me in</a><br />
                <a href="/logout">Log me out</a><br /><br />
                Check my permissions,
                when i'm logged in and logged out.<br />
                <a href="/listen">Can I listen?</a><br />
                <a href="/speak">Can I speak?</a><br />
            </body></html>'''.format(
                logged='' if is_logged else 'NOT',
            ), content_type='text/html')


    async def handler_login_jack(request):
        redirect_response = web.HTTPFound('/')
        await remember(request, redirect_response, 'jack')
        raise redirect_response


    async def handler_logout(request):
        redirect_response = web.HTTPFound('/')
        await forget(request, redirect_response)
        raise redirect_response


    async def handler_listen(request):
        await check_permission(request, 'listen')
        return web.Response(body="I can listen!")


    async def handler_speak(request):
        await check_permission(request, 'speak')
        return web.Response(body="I can speak!")


    async def make_app():
        #
        # WARNING!!!
        # Never use SimpleCookieStorage on production!!!
        # It’s highly insecure!!!
        #

        # make app
        middleware = session_middleware(SimpleCookieStorage())
        app = web.Application(middlewares=[middleware])

        # add the routes
        app.add_routes([
            web.get('/', handler_root),
            web.get('/login', handler_login_jack),
            web.get('/logout', handler_logout),
            web.get('/listen', handler_listen),
            web.get('/speak', handler_speak)])

        # set up policies
        policy = SessionIdentityPolicy()
        setup_security(app, policy, SimpleJack_AuthorizationPolicy())

        return app


    if __name__ == '__main__':
        web.run_app(make_app(), port=9000)
-												Create working demo (#5)

* Add docs example and update demo source code

* Fail with debug

* Fix tests

* Update sql scripts

* Update docs

* Add checking for the password

* Update documentation with launch/usage example

* Launch flake8 instead of pep8 and pyflakes

											
										
										
											2016-08-30 17:38:59 +00:00
+								.. _aiohttp-security-example:
 								===============================================
-												Initial commit

											
										
										
											2015-07-08 17:30:24 +00:00
+								How to Make a Simple Server With Authorization
-												Create working demo (#5)

* Add docs example and update demo source code

* Fail with debug

* Fix tests

* Update sql scripts

* Update docs

* Add checking for the password

* Update documentation with launch/usage example

* Launch flake8 instead of pep8 and pyflakes

											
										
										
											2016-08-30 17:38:59 +00:00
+								===============================================
-												Initial commit

											
										
										
											2015-07-08 17:30:24 +00:00
-												Create working demo (#5)

* Add docs example and update demo source code

* Fail with debug

* Fix tests

* Update sql scripts

* Update docs

* Add checking for the password

* Update documentation with launch/usage example

* Launch flake8 instead of pep8 and pyflakes

											
										
										
											2016-08-30 17:38:59 +00:00
+								Simple example::
-												Initial commit

											
										
										
											2015-07-08 17:30:24 +00:00
 								    from aiohttp import web
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
+								    from aiohttp_session import SimpleCookieStorage, session_middleware
-												Update to 0.3.0

											
										
										
											2018-09-06 10:06:55 +00:00
+								    from aiohttp_security import check_permission, \
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
+								        is_anonymous, remember, forget, \
 								        setup as setup_security, SessionIdentityPolicy
 								    from aiohttp_security.abc import AbstractAuthorizationPolicy
-												Initial commit

											
										
										
											2015-07-08 17:30:24 +00:00
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
 								    # Demo authorization policy for only one user.
 								    # User 'jack' has only 'listen' permission.
 								    # For more complicated authorization policies see examples
 								    # in the 'demo' directory.
 								    class SimpleJack_AuthorizationPolicy(AbstractAuthorizationPolicy):
 								        async def authorized_userid(self, identity):
 								            """Retrieve authorized user id.
 								            Return the user_id of the user identified by the identity
 								            or 'None' if no user exists related to the identity.
 								            """
 								            if identity == 'jack':
 								                return identity
 								        async def permits(self, identity, permission, context=None):
 								            """Check user permissions.
 								            Return True if the identity is allowed the permission
 								            in the current context, else return False.
 								            """
 								            return identity == 'jack' and permission in ('listen',)
 								    async def handler_root(request):
 								        is_logged = not await is_anonymous(request)
 								        return web.Response(text='''<html><head></head><body>
 								                Hello, I'm Jack, I'm {logged} logged in.<br /><br />
 								                <a href="/login">Log me in</a><br />
 								                <a href="/logout">Log me out</a><br /><br />
 								                Check my permissions,
 								                when i'm logged in and logged out.<br />
 								                <a href="/listen">Can I listen?</a><br />
 								                <a href="/speak">Can I speak?</a><br />
 								            </body></html>'''.format(
 								                logged='' if is_logged else 'NOT',
 								            ), content_type='text/html')
 								    async def handler_login_jack(request):
 								        redirect_response = web.HTTPFound('/')
 								        await remember(request, redirect_response, 'jack')
 								        raise redirect_response
 								    async def handler_logout(request):
 								        redirect_response = web.HTTPFound('/')
 								        await forget(request, redirect_response)
 								        raise redirect_response
 								    async def handler_listen(request):
-												Update to 0.3.0

											
										
										
											2018-09-06 10:06:55 +00:00
+								        await check_permission(request, 'listen')
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
+								        return web.Response(body="I can listen!")
 								    async def handler_speak(request):
-												Update to 0.3.0

											
										
										
											2018-09-06 10:06:55 +00:00
+								        await check_permission(request, 'speak')
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
+								        return web.Response(body="I can speak!")
 								    async def make_app():
 								        #
 								        # WARNING!!!
 								        # Never use SimpleCookieStorage on production!!!
 								        # It’s highly insecure!!!
 								        #
 								        # make app
 								        middleware = session_middleware(SimpleCookieStorage())
 								        app = web.Application(middlewares=[middleware])
-												Initial commit

											
										
										
											2015-07-08 17:30:24 +00:00
 								        # add the routes
-												Update to 0.3.0

											
										
										
											2018-09-06 10:06:55 +00:00
+								        app.add_routes([
 								            web.get('/', handler_root),
 								            web.get('/login', handler_login_jack),
 								            web.get('/logout', handler_logout),
 								            web.get('/listen', handler_listen),
 								            web.get('/speak', handler_speak)])
-												Rewrite 'simple example' in docs, added it to demo dir (#154)


											
										
										
											2018-04-26 09:15:12 +00:00
 								        # set up policies
 								        policy = SessionIdentityPolicy()
 								        setup_security(app, policy, SimpleJack_AuthorizationPolicy())
 								        return app
 								    if __name__ == '__main__':
 								        web.run_app(make_app(), port=9000)