aiohttp-security/aiohttp_security/api.py

110 lines
3.7 KiB
Python

import asyncio
import functools
from aiohttp import web
from aiohttp_security.abc import (AbstractIdentityPolicy,
AbstractAuthorizationPolicy)
IDENTITY_KEY = 'aiohttp_security_identity_policy'
AUTZ_KEY = 'aiohttp_security_autz_policy'
def authorize(required=True):
def wrapper(f):
@asyncio.coroutine
@functools.wraps(f)
def wrapped(**kwargs):
assert 'request' in kwargs
if asyncio.iscoroutinefunction(f):
coro = f
else:
coro = asyncio.coroutine(f)
identity = yield from get_user_identity(kwargs['request'])
if not identity and not required:
raise web.HTTPForbidden()
return (yield from coro(identity=identity, **kwargs))
return wrapped
return wrapper
@asyncio.coroutine
def remember(request, response, identity, **kwargs):
"""Remember identity into response.
The action is performed by identity_policy.remember()
Usually the idenity is stored in user cookies homehow but may be
pushed into custom header also.
"""
assert isinstance(identity, str), identity
assert identity
identity_policy = request.app.get(IDENTITY_KEY)
if identity_policy is None:
text = ("Security subsystem is not initialized, "
"call aiohttp_security.setup(...) first")
# in order to see meaningful exception message both: on console
# output and rendered page we add same message to *reason* and
# *text* arguments.
raise web.HTTPInternalServerError(reason=text, text=text)
yield from identity_policy.remember(request, response, identity, **kwargs)
@asyncio.coroutine
def forget(request, response):
"""Forget previously remembered identity.
Usually it clears cookie or server-side storage to forget user
session.
"""
identity_policy = request.app.get(IDENTITY_KEY)
if identity_policy is None:
text = ("Security subsystem is not initialized, "
"call aiohttp_security.setup(...) first")
# in order to see meaningful exception message both: on console
# output and rendered page we add same message to *reason* and
# *text* arguments.
raise web.HTTPInternalServerError(reason=text, text=text)
yield from identity_policy.forget(request, response)
@asyncio.coroutine
def get_user_identity(request):
identity_policy = request.app.get(IDENTITY_KEY)
if identity_policy is None:
return None
identity = yield from identity_policy.identify(request)
return identity
authorized_userid method in AbstractAuthorizationPolicy required?
'''
@asyncio.coroutine
def authorized_userid(request):
identity_policy = request.app.get(IDENTITY_KEY)
autz_policy = request.app.get(AUTZ_KEY)
if identity_policy is None or autz_policy is None:
return None
identity = yield from identity_policy.identify(request)
if identity is None:
return None # non-registered user has None user_id
user_id = yield from autz_policy.authorized_userid(identity)
return user_id
'''
@asyncio.coroutine
def permits(request, permission, context=None):
assert isinstance(permission, str), permission
assert permission
autz_policy = request.app.get(AUTZ_KEY)
identity = yield from get_user_identity(request)
access = yield from autz_policy.permits(identity, permission, context)
return access
def setup(app, identity_policy, autz_policy):
assert isinstance(identity_policy, AbstractIdentityPolicy), identity_policy
assert isinstance(autz_policy, AbstractAuthorizationPolicy), autz_policy
app[IDENTITY_KEY] = identity_policy
app[AUTZ_KEY] = autz_policy