Update ci.yaml

Bumps [aiohttp](https://github.com/aio-libs/aiohttp) from 3.7.2 to 3.7.3.
- [Release notes](https://github.com/aio-libs/aiohttp/releases)
- [Changelog](https://github.com/aio-libs/aiohttp/blob/master/CHANGES.rst)
- [Commits](https://github.com/aio-libs/aiohttp/compare/v3.7.2...v3.7.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: Test
+
+on: pull_request
+
+jobs:
+  mypy:
+    name: Check annotations with Mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install aiohttp mypy
+      - run: mypy
+
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install codecov
+    - name: Run tests
+      run: |
+        make coverage
+    - name: Upload coverage to Codecov
+      run: |
+        codecov

.gitignore

@@ -55,4 +55,5 @@ docs/_build/
 # PyBuilder
 target/
 
-coverage
+coverage
+.pytest_cache

.mypy.ini

@@ -0,0 +1,37 @@
+[mypy]
+files = aiohttp_security, demo, tests
+check_untyped_defs = True
+follow_imports_for_stubs = True
+disallow_any_decorated = True
+disallow_any_generics = True
+disallow_incomplete_defs = True
+disallow_subclassing_any = True
+disallow_untyped_calls = True
+disallow_untyped_decorators = True
+disallow_untyped_defs = True
+implicit_reexport = False
+no_implicit_optional = True
+show_error_codes = True
+strict_equality = True
+warn_incomplete_stub = True
+warn_redundant_casts = True
+warn_unreachable = True
+warn_unused_ignores = True
+disallow_any_unimported = True
+warn_return_any = True
+
+[mypy-aiohttp_security.abc.*]
+disallow_any_decorated = False
+
+[mypy-tests.*]
+disallow_any_decorated = False
+disallow_untyped_defs = False
+
+[mypy-aiopg.*]
+ignore_missing_imports = True
+
+[mypy-aioredis.*]
+ignore_missing_imports = True
+
+[mypy-passlib.*]
+ignore_missing_imports = True

.travis.yml

@@ -1,38 +0,0 @@
-language: python
-python:
-  - 3.5
-  - 3.6
-  - 3.7-dev
-  - nightly
-
-matrix:
-  allow_failures:
-  - python: 3.7-dev
-  - python: nightly
-
-install:
-- pip install --upgrade pip
-- pip install -r requirements-dev.txt
-- pip install codecov
-
-script:
-- make coverage
-
-after_success:
-- codecov
-
-env:
-  matrix:
-  - PYTHONASYNCIODEBUG=x
-  - PYTHONASYNCIODEBUG=
-
-deploy:
-  provider: pypi
-  user: andrew.svetlov
-  password:
-    secure: "JdBvuOBA/198ognVDOY/qZpIKGXfCx47725kyJo/SpQ3nP+x0GLZb3PMQkR0jfSWWkx6Sisk3vOCYsoWclPyPzp+o4ZpfM8yAjHNFmtbr+k+XJdUEApEiWb6/Y3g7DCyY2Qa/L8IYlyABPWrrJI/nld2sKm5kmhFpR/z3HfeFtINP6Ivp34dUOkeRP6kOvCi9d6GyWnvTRnhlybAnk/Ngrroh8XrbKHdDv0zkQkshF8+pmxVzwao4C6S5ld5cFXIYZHLBA9lNC3zgvOMuFeGPUEN9vab3q77MvaiMIuTC9QjcgIhfw3gabH2u7knqfFzqqzXMaVptx5z8o1JtsxMyYt5NVBqS4NPIljpZjaoS/CASHJlRxniJiYfjvjOtFEcfGMNtZj8ZYsGR0nuP2jwzgpEHHWIs4qL0Y8h9t7pGirxCuQcnY10sr+Y+JKaZNJsugNLgbqE2aaZUye5gjDcEj9WY8kKNZXucLP7c0McJuwPqplDEO4CQouMttcKSYkA0QoETmpAFqaXCaMs3p/glOoU2ZyHSH9mXWir69yo84ymb2NlGPMTAstXlv/g/oLmLMSq7lbl6cSUnO1/wxBGlyfv5AAq/75YUaqsgYofzN5CjUgA3m6NedvbWxLUJaxVQ7nduYGEQKDvGEBmzCNv6CdVRCjQ9J1xX3XzkVheQGc="
-  distributions: "sdist bdist_wheel"
-  on:
-    tags: true
-    all_branches: true
-    python: 3.6

CHANGES.txt

@@ -1,10 +1,31 @@
 Changes
 =======
 
+0.4.0 (2018-09-27)
+------------------
+
+- Bump minimal supported ``aiohttp`` version to 3.2
+
+- Use ``request.config_dict`` for accessing ``jinja2`` environment. It
+  allows to reuse jinja rendering engine from parent application.
+
+0.3.0 (2018-09-06)
+------------------
+
+- Deprecate ``login_required`` and ``has_permission`` decorators.
+  Use ``check_authorized`` and ``check_permission`` helper functions instead.
+
+- Bump supported ``aiohttp`` version to 3.0+
+
+- Enable strong warnings mode for test suite, clean-up all deprecation
+  warnings.
+
+- Polish documentation
+
 0.2.0 (2017-11-17)
 ------------------
 
-- Add `is_anonymous`, `login_required`, `has_permission` helpers (#114)
+- Add ``is_anonymous``, ``login_required``, ``has_permission`` helpers (#114)
 
 0.1.2 (2017-10-17)
 ------------------

README.rst

@@ -1,7 +1,7 @@
 aiohttp_security
 ================
-.. image:: https://travis-ci.org/aio-libs/aiohttp-security.svg?branch=master
-    :target: https://travis-ci.org/aio-libs/aiohttp-security
+.. image:: https://travis-ci.com/aio-libs/aiohttp-security.svg?branch=master
+    :target: https://travis-ci.com/aio-libs/aiohttp-security
 .. image:: https://codecov.io/github/aio-libs/aiohttp-security/coverage.svg?branch=master
     :target: https://codecov.io/github/aio-libs/aiohttp-security
 .. image:: https://readthedocs.org/projects/aiohttp-security/badge/?version=latest
@@ -46,7 +46,7 @@ https://aiohttp-security.readthedocs.io/
 Develop
 -------
 
-``pip install -r requirements-dev``
+``pip install -r requirements-dev.txt``
 
 
 License

aiohttp_security/__init__.py

@@ -1,14 +1,18 @@
 from .abc import AbstractAuthorizationPolicy, AbstractIdentityPolicy
-from .api import (authorized_userid, forget, has_permission, is_anonymous,
-                  login_required, permits, remember, setup)
+from .api import (authorized_userid, forget, has_permission,
+                  is_anonymous, login_required, permits, remember,
+                  setup, check_authorized, check_permission)
 from .cookies_identity import CookiesIdentityPolicy
 from .session_identity import SessionIdentityPolicy
+from .jwt_identity import JWTIdentityPolicy
 
-__version__ = '0.2.0'
+__version__ = '0.4.0'
 
 
 __all__ = ('AbstractIdentityPolicy', 'AbstractAuthorizationPolicy',
            'CookiesIdentityPolicy', 'SessionIdentityPolicy',
+           'JWTIdentityPolicy',
            'remember', 'forget', 'authorized_userid',
            'permits', 'setup', 'is_anonymous',
-           'login_required', 'has_permission')
+           'login_required', 'has_permission',
+           'check_authorized', 'check_permission')

aiohttp_security/abc.py

@@ -1,4 +1,8 @@
 import abc
+from enum import Enum
+from typing import Any, Optional, Union
+
+from aiohttp import web
 
 # see http://plope.com/pyramid_auth_design_api_postmortem
 
@@ -6,13 +10,14 @@ import abc
 class AbstractIdentityPolicy(metaclass=abc.ABCMeta):
 
     @abc.abstractmethod
-    async def identify(self, request):
+    async def identify(self, request: web.Request) -> Optional[str]:
         """Return the claimed identity of the user associated request or
         ``None`` if no identity can be found associated with the request."""
         pass
 
     @abc.abstractmethod
-    async def remember(self, request, response, identity, **kwargs):
+    async def remember(self, request: web.Request, response: web.StreamResponse,
+                       identity: str, **kwargs: Any) -> None:
         """Remember identity.
 
         Modify response object by filling it's headers with remembered user.
@@ -23,7 +28,7 @@ class AbstractIdentityPolicy(metaclass=abc.ABCMeta):
         pass
 
     @abc.abstractmethod
-    async def forget(self, request, response):
+    async def forget(self, request: web.Request, response: web.StreamResponse) -> None:
         """ Modify response which can be used to 'forget' the
         current identity on subsequent requests."""
         pass
@@ -32,7 +37,8 @@ class AbstractIdentityPolicy(metaclass=abc.ABCMeta):
 class AbstractAuthorizationPolicy(metaclass=abc.ABCMeta):
 
     @abc.abstractmethod
-    async def permits(self, identity, permission, context=None):
+    async def permits(self, identity: str, permission: Union[str, Enum],
+                      context: Any = None) -> bool:
         """Check user permissions.
 
         Return True if the identity is allowed the permission in the
@@ -41,7 +47,7 @@ class AbstractAuthorizationPolicy(metaclass=abc.ABCMeta):
         pass
 
     @abc.abstractmethod
-    async def authorized_userid(self, identity):
+    async def authorized_userid(self, identity: str) -> Optional[str]:
         """Retrieve authorized user id.
 
         Return the user_id of the user identified by the identity

aiohttp_security/api.py

@@ -1,14 +1,23 @@
 import enum
-from aiohttp import web
-from aiohttp_security.abc import (AbstractIdentityPolicy,
-                                  AbstractAuthorizationPolicy)
+import warnings
 from functools import wraps
+from typing import Any, Callable, Optional, TypeVar, Union
+
+from aiohttp import web
+from aiohttp_security.abc import AbstractAuthorizationPolicy, AbstractIdentityPolicy
 
 IDENTITY_KEY = 'aiohttp_security_identity_policy'
 AUTZ_KEY = 'aiohttp_security_autz_policy'
 
+# _AIP/_AAP are shorthand for Optional[policy] when we retrieve from request.
+_AAP = Optional[AbstractAuthorizationPolicy]
+_AIP = Optional[AbstractIdentityPolicy]
+_Handler = TypeVar('_Handler', bound=Union[Callable[[web.Request], Any],
+                                           Callable[[object, web.Request], Any]])
 
-async def remember(request, response, identity, **kwargs):
+
+async def remember(request: web.Request, response: web.StreamResponse,
+                   identity: str, **kwargs: Any) -> None:
     """Remember identity into response.
 
     The action is performed by identity_policy.remember()
@@ -18,7 +27,7 @@ async def remember(request, response, identity, **kwargs):
     """
     assert isinstance(identity, str), identity
     assert identity
-    identity_policy = request.app.get(IDENTITY_KEY)
+    identity_policy = request.config_dict.get(IDENTITY_KEY)
     if identity_policy is None:
         text = ("Security subsystem is not initialized, "
                 "call aiohttp_security.setup(...) first")
@@ -29,13 +38,13 @@ async def remember(request, response, identity, **kwargs):
     await identity_policy.remember(request, response, identity, **kwargs)
 
 
-async def forget(request, response):
+async def forget(request: web.Request, response: web.StreamResponse) -> None:
     """Forget previously remembered identity.
 
     Usually it clears cookie or server-side storage to forget user
     session.
     """
-    identity_policy = request.app.get(IDENTITY_KEY)
+    identity_policy = request.config_dict.get(IDENTITY_KEY)
     if identity_policy is None:
         text = ("Security subsystem is not initialized, "
                 "call aiohttp_security.setup(...) first")
@@ -46,9 +55,9 @@ async def forget(request, response):
     await identity_policy.forget(request, response)
 
 
-async def authorized_userid(request):
-    identity_policy = request.app.get(IDENTITY_KEY)
-    autz_policy = request.app.get(AUTZ_KEY)
+async def authorized_userid(request: web.Request) -> Optional[str]:
+    identity_policy: _AIP = request.config_dict.get(IDENTITY_KEY)
+    autz_policy: _AAP = request.config_dict.get(AUTZ_KEY)
     if identity_policy is None or autz_policy is None:
         return None
     identity = await identity_policy.identify(request)
@@ -58,26 +67,27 @@ async def authorized_userid(request):
     return user_id
 
 
-async def permits(request, permission, context=None):
+async def permits(request: web.Request, permission: Union[str, enum.Enum],
+                  context: Any = None) -> bool:
     assert isinstance(permission, (str, enum.Enum)), permission
     assert permission
-    identity_policy = request.app.get(IDENTITY_KEY)
-    autz_policy = request.app.get(AUTZ_KEY)
+    identity_policy: _AIP = request.config_dict.get(IDENTITY_KEY)
+    autz_policy: _AAP = request.config_dict.get(AUTZ_KEY)
     if identity_policy is None or autz_policy is None:
         return True
     identity = await identity_policy.identify(request)
-    # non-registered user still may has some permissions
+    # non-registered user still may have some permissions
     access = await autz_policy.permits(identity, permission, context)
     return access
 
 
-async def is_anonymous(request):
+async def is_anonymous(request: web.Request) -> bool:
     """Check if user is anonymous.
 
     User is considered anonymous if there is not identity
     in request.
     """
-    identity_policy = request.app.get(IDENTITY_KEY)
+    identity_policy = request.config_dict.get(IDENTITY_KEY)
     if identity_policy is None:
         return True
     identity = await identity_policy.identify(request)
@@ -86,68 +96,85 @@ async def is_anonymous(request):
     return False
 
 
-def login_required(fn):
+async def check_authorized(request: web.Request) -> str:
+    """Checker that raises HTTPUnauthorized for anonymous users.
+    """
+    userid = await authorized_userid(request)
+    if userid is None:
+        raise web.HTTPUnauthorized()
+    return userid
+
+
+def login_required(fn: _Handler) -> _Handler:
     """Decorator that restrict access only for authorized users.
 
     User is considered authorized if authorized_userid
     returns some value.
     """
     @wraps(fn)
-    async def wrapped(*args, **kwargs):
+    async def wrapped(*args: Union[object, web.Request]) -> Any:
         request = args[-1]
-        if not isinstance(request, web.BaseRequest):
+        if not isinstance(request, web.Request):
             msg = ("Incorrect decorator usage. "
                    "Expecting `def handler(request)` "
                    "or `def handler(self, request)`.")
             raise RuntimeError(msg)
 
-        userid = await authorized_userid(request)
-        if userid is None:
-            raise web.HTTPUnauthorized
+        await check_authorized(request)
+        return await fn(*args)  # type: ignore[arg-type]
 
-        ret = await fn(*args, **kwargs)
-        return ret
-
-    return wrapped
+    warnings.warn("login_required decorator is deprecated, "
+                  "use check_authorized instead",
+                  DeprecationWarning)
+    return wrapped  # type: ignore[return-value]
 
 
-def has_permission(
-    permission,
-    context=None,
-):
-    """Decorator that restrict access only for authorized users
+async def check_permission(request: web.Request, permission: Union[str, enum.Enum],
+                           context: Any = None) -> None:
+    """Checker that passes only to authoraised users with given permission.
+
+    If user is not authorized - raises HTTPUnauthorized,
+    if user is authorized and does not have permission -
+    raises HTTPForbidden.
+    """
+
+    await check_authorized(request)
+    allowed = await permits(request, permission, context)
+    if not allowed:
+        raise web.HTTPForbidden()
+
+
+def has_permission(permission: Union[str, enum.Enum], context: Any = None):  # type: ignore
+    """Decorator that restricts access only for authorized users
     with correct permissions.
 
     If user is not authorized - raises HTTPUnauthorized,
     if user is authorized and does not have permission -
     raises HTTPForbidden.
     """
-    def wrapper(fn):
+    def wrapper(fn):  # type: ignore
         @wraps(fn)
-        async def wrapped(*args, **kwargs):
+        async def wrapped(*args, **kwargs):  # type: ignore
             request = args[-1]
-            if not isinstance(request, web.BaseRequest):
+            if not isinstance(request, web.Request):
                 msg = ("Incorrect decorator usage. "
                        "Expecting `def handler(request)` "
                        "or `def handler(self, request)`.")
                 raise RuntimeError(msg)
 
-            userid = await authorized_userid(request)
-            if userid is None:
-                raise web.HTTPUnauthorized
-
-            allowed = await permits(request, permission, context)
-            if not allowed:
-                raise web.HTTPForbidden
-            ret = await fn(*args, **kwargs)
-            return ret
+            await check_permission(request, permission, context)
+            return await fn(*args, **kwargs)
 
         return wrapped
 
+    warnings.warn("has_permission decorator is deprecated, "
+                  "use check_permission instead",
+                  DeprecationWarning)
     return wrapper
 
 
-def setup(app, identity_policy, autz_policy):
+def setup(app: web.Application, identity_policy: AbstractIdentityPolicy,
+          autz_policy: AbstractAuthorizationPolicy) -> None:
     assert isinstance(identity_policy, AbstractIdentityPolicy), identity_policy
     assert isinstance(autz_policy, AbstractAuthorizationPolicy), autz_policy
 

aiohttp_security/cookies_identity.py

@@ -5,28 +5,32 @@ more handy.
 
 """
 
+from aiohttp import web
+from typing import Any, NewType, Optional, Union, cast
+
 from .abc import AbstractIdentityPolicy
 
-
-sentinel = object()
+_Sentinel = NewType('_Sentinel', object)
+sentinel = _Sentinel(object())
 
 
 class CookiesIdentityPolicy(AbstractIdentityPolicy):
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._cookie_name = 'AIOHTTP_SECURITY'
         self._max_age = 30 * 24 * 3600
 
-    async def identify(self, request):
-        identity = request.cookies.get(self._cookie_name)
-        return identity
+    async def identify(self, request: web.Request) -> Optional[str]:
+        return request.cookies.get(self._cookie_name)
 
-    async def remember(self, request, response, identity, max_age=sentinel,
-                       **kwargs):
+    async def remember(self, request: web.Request, response: web.StreamResponse,
+                       identity: str, max_age: Union[_Sentinel, Optional[int]] = sentinel,
+                       **kwargs: Any) -> None:
         if max_age is sentinel:
             max_age = self._max_age
+        max_age = cast(Optional[int], max_age)
         response.set_cookie(self._cookie_name, identity,
                             max_age=max_age, **kwargs)
 
-    async def forget(self, request, response):
+    async def forget(self, request: web.Request, response: web.StreamResponse) -> None:
         response.del_cookie(self._cookie_name)

aiohttp_security/jwt_identity.py

@@ -0,0 +1,51 @@
+"""Identity policy for storing info in the jwt token.
+
+"""
+
+from typing import Optional
+
+from aiohttp import web
+
+from .abc import AbstractIdentityPolicy
+
+try:
+    import jwt
+    HAS_JWT = True
+except ImportError:  # pragma: no cover
+    HAS_JWT = False
+
+
+AUTH_HEADER_NAME = 'Authorization'
+AUTH_SCHEME = 'Bearer '
+
+
+class JWTIdentityPolicy(AbstractIdentityPolicy):
+    def __init__(self, secret: str, algorithm: str = 'HS256'):
+        if not HAS_JWT:
+            raise RuntimeError('Please install `PyJWT`')
+        self.secret = secret
+        self.algorithm = algorithm
+
+    async def identify(self, request: web.Request) -> Optional[str]:
+        header_identity = request.headers.get(AUTH_HEADER_NAME)
+
+        if header_identity is None:
+            return None
+
+        if not header_identity.startswith(AUTH_SCHEME):
+            raise ValueError('Invalid authorization scheme. ' +
+                             'Should be `{}<token>`'.format(AUTH_SCHEME))
+
+        token = header_identity.split(' ')[1].strip()
+
+        identity = jwt.decode(token,
+                              self.secret,
+                              algorithms=[self.algorithm])
+        return identity
+
+    async def remember(self, request: web.Request, response: web.StreamResponse,
+                       identity: str, **kwargs: None) -> None:
+        pass
+
+    async def forget(self, request: web.Request, response: web.StreamResponse) -> None:
+        pass

aiohttp_security/session_identity.py

@@ -4,6 +4,7 @@ aiohttp_session.setup() should be called on application initialization
 to configure aiohttp_session properly.
 """
 
+from aiohttp import web
 try:
     from aiohttp_session import get_session
     HAS_AIOHTTP_SESSION = True
@@ -15,21 +16,22 @@ from .abc import AbstractIdentityPolicy
 
 class SessionIdentityPolicy(AbstractIdentityPolicy):
 
-    def __init__(self, session_key='AIOHTTP_SECURITY'):
+    def __init__(self, session_key: str = 'AIOHTTP_SECURITY'):
         self._session_key = session_key
 
         if not HAS_AIOHTTP_SESSION:  # pragma: no cover
             raise ImportError(
                 'SessionIdentityPolicy requires `aiohttp_session`')
 
-    async def identify(self, request):
+    async def identify(self, request: web.Request) -> str:
         session = await get_session(request)
         return session.get(self._session_key)
 
-    async def remember(self, request, response, identity, **kwargs):
+    async def remember(self, request: web.Request, response: web.StreamResponse,
+                       identity: str, **kwargs: None) -> None:
         session = await get_session(request)
         session[self._session_key] = identity
 
-    async def forget(self, request, response):
+    async def forget(self, request: web.Request, response: web.StreamResponse) -> None:
         session = await get_session(request)
         session.pop(self._session_key, None)

demo/database_auth/db_auth.py

@@ -1,5 +1,7 @@
-import sqlalchemy as sa
+from enum import Enum
+from typing import Any, Optional, Union
 
+import sqlalchemy as sa
 from aiohttp_security.abc import AbstractAuthorizationPolicy
 from passlib.hash import sha256_crypt
 
@@ -7,13 +9,13 @@ from . import db
 
 
 class DBAuthorizationPolicy(AbstractAuthorizationPolicy):
-    def __init__(self, dbengine):
+    def __init__(self, dbengine: Any):
         self.dbengine = dbengine
 
-    async def authorized_userid(self, identity):
-        async with self.dbengine as conn:
+    async def authorized_userid(self, identity: str) -> Optional[str]:
+        async with self.dbengine.acquire() as conn:
             where = sa.and_(db.users.c.login == identity,
-                            sa.not_(db.users.c.disabled))
+                            sa.not_(db.users.c.disabled))  # type: ignore[no-untyped-call]
             query = db.users.count().where(where)
             ret = await conn.scalar(query)
             if ret:
@@ -21,13 +23,11 @@ class DBAuthorizationPolicy(AbstractAuthorizationPolicy):
             else:
                 return None
 
-    async def permits(self, identity, permission, context=None):
-        if identity is None:
-            return False
-
-        async with self.dbengine as conn:
+    async def permits(self, identity: str, permission: Union[str, Enum],
+                      context: None = None) -> bool:
+        async with self.dbengine.acquire() as conn:
             where = sa.and_(db.users.c.login == identity,
-                            sa.not_(db.users.c.disabled))
+                            sa.not_(db.users.c.disabled))  # type: ignore[no-untyped-call]
             query = db.users.select().where(where)
             ret = await conn.execute(query)
             user = await ret.fetchone()
@@ -49,14 +49,14 @@ class DBAuthorizationPolicy(AbstractAuthorizationPolicy):
             return False
 
 
-async def check_credentials(db_engine, username, password):
-    async with db_engine as conn:
+async def check_credentials(db_engine: Any, username: str, password: str) -> bool:
+    async with db_engine.acquire() as conn:
         where = sa.and_(db.users.c.login == username,
-                        sa.not_(db.users.c.disabled))
+                        sa.not_(db.users.c.disabled))  # type: ignore[no-untyped-call]
         query = db.users.select().where(where)
         ret = await conn.execute(query)
         user = await ret.fetchone()
         if user is not None:
-            hash = user[2]
-            return sha256_crypt.verify(password, hash)
+            hashed = user[2]
+            return sha256_crypt.verify(password, hashed)  # type: ignore[no-any-return]
     return False

demo/database_auth/handlers.py

@@ -1,10 +1,11 @@
 from textwrap import dedent
+from typing import NoReturn
 
 from aiohttp import web
 
 from aiohttp_security import (
     remember, forget, authorized_userid,
-    has_permission, login_required,
+    check_permission, check_authorized,
 )
 
 from .db_auth import check_credentials
@@ -27,7 +28,7 @@ class Web(object):
             </body>
     """)
 
-    async def index(self, request):
+    async def index(self, request: web.Request) -> web.Response:
         username = await authorized_userid(request)
         if username:
             template = self.index_template.format(
@@ -37,37 +38,41 @@ class Web(object):
         response = web.Response(body=template.encode())
         return response
 
-    async def login(self, request):
-        response = web.HTTPFound('/')
+    async def login(self, request: web.Request) -> NoReturn:
+        invalid_resp = web.HTTPUnauthorized(body=b'Invalid username/password combination')
         form = await request.post()
         login = form.get('login')
         password = form.get('password')
-        db_engine = request.app.db_engine
+        db_engine = request.app['db_engine']
+
+        if not (isinstance(login, str) and isinstance(password, str)):
+            raise invalid_resp
+
         if await check_credentials(db_engine, login, password):
+            response = web.HTTPFound('/')
             await remember(request, response, login)
-            return response
+            raise response
 
-        return web.HTTPUnauthorized(
-            body=b'Invalid username/password combination')
+        raise invalid_resp
 
-    @login_required
-    async def logout(self, request):
+    async def logout(self, request: web.Request) -> web.Response:
+        await check_authorized(request)
         response = web.Response(body=b'You have been logged out')
         await forget(request, response)
         return response
 
-    @has_permission('public')
-    async def internal_page(self, request):
+    async def internal_page(self, request: web.Request) -> web.Response:
+        await check_permission(request, 'public')
         response = web.Response(
             body=b'This page is visible for all registered users')
         return response
 
-    @has_permission('protected')
-    async def protected_page(self, request):
+    async def protected_page(self, request: web.Request) -> web.Response:
+        await check_permission(request, 'protected')
         response = web.Response(body=b'You are on protected page')
         return response
 
-    def configure(self, app):
+    def configure(self, app: web.Application) -> None:
         router = app.router
         router.add_route('GET', '/', self.index, name='index')
         router.add_route('POST', '/login', self.login, name='login')

demo/database_auth/main.py

@@ -1,4 +1,5 @@
 import asyncio
+from typing import Any, Tuple
 
 from aiohttp import web
 from aiohttp_session import setup as setup_session
@@ -13,14 +14,14 @@ from demo.database_auth.db_auth import DBAuthorizationPolicy
 from demo.database_auth.handlers import Web
 
 
-async def init(loop):
+async def init(loop: asyncio.AbstractEventLoop) -> Tuple[Any, ...]:
     redis_pool = await create_pool(('localhost', 6379))
     db_engine = await create_engine(user='aiohttp_security',
                                     password='aiohttp_security',
                                     database='aiohttp_security',
                                     host='127.0.0.1')
-    app = web.Application(loop=loop)
-    app.db_engine = db_engine
+    app = web.Application()
+    app['db_engine'] = db_engine
     setup_session(app, RedisStorage(redis_pool))
     setup_security(app,
                    SessionIdentityPolicy(),
@@ -35,7 +36,7 @@ async def init(loop):
     return srv, app, handler
 
 
-async def finalize(srv, app, handler):
+async def finalize(srv: Any, app: Any, handler: Any) -> None:
     sock = srv.sockets[0]
     app.loop.remove_reader(sock.fileno())
     sock.close()
@@ -46,7 +47,7 @@ async def finalize(srv, app, handler):
     await app.finish()
 
 
-def main():
+def main() -> None:
     loop = asyncio.get_event_loop()
     srv, app, handler = loop.run_until_complete(init(loop))
     try:

demo/dictionary_auth/authz.py

@@ -1,20 +1,25 @@
+from enum import Enum
+from typing import Dict, Optional, Union
+
 from aiohttp_security.abc import AbstractAuthorizationPolicy
 
+from .users import User
+
 
 class DictionaryAuthorizationPolicy(AbstractAuthorizationPolicy):
-    def __init__(self, user_map):
+    def __init__(self, user_map: Dict[str, User]):
         super().__init__()
         self.user_map = user_map
 
-    async def authorized_userid(self, identity):
+    async def authorized_userid(self, identity: str) -> Optional[str]:
         """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 in self.user_map:
-            return identity
+        return identity if identity in self.user_map else None
 
-    async def permits(self, identity, permission, context=None):
+    async def permits(self, identity: str, permission: Union[str, Enum],
+                      context: None = None) -> bool:
         """Check user permissions.
         Return True if the identity is allowed the permission in the
         current context, else return False.
@@ -26,7 +31,7 @@ class DictionaryAuthorizationPolicy(AbstractAuthorizationPolicy):
         return permission in user.permissions
 
 
-async def check_credentials(user_map, username, password):
+async def check_credentials(user_map: Dict[str, User], username: str, password: str) -> bool:
     user = user_map.get(username)
     if not user:
         return False

demo/dictionary_auth/handlers.py

@@ -1,13 +1,15 @@
 from textwrap import dedent
+from typing import Dict, NoReturn
 
 from aiohttp import web
 
 from aiohttp_security import (
     remember, forget, authorized_userid,
-    has_permission, login_required,
+    check_permission, check_authorized,
 )
 
 from .authz import check_credentials
+from .users import User
 
 
 index_template = dedent("""
@@ -27,7 +29,7 @@ index_template = dedent("""
 """)
 
 
-async def index(request):
+async def index(request: web.Request) -> web.Response:
     username = await authorized_userid(request)
     if username:
         template = index_template.format(
@@ -40,23 +42,27 @@ async def index(request):
     )
 
 
-async def login(request):
-    response = web.HTTPFound('/')
+async def login(request: web.Request) -> NoReturn:
+    user_map: Dict[str, User] = request.app['user_map']
+    invalid_response = web.HTTPUnauthorized(body='Invalid username / password combination')
     form = await request.post()
     username = form.get('username')
     password = form.get('password')
 
-    verified = await check_credentials(
-        request.app.user_map, username, password)
+    if not (isinstance(username, str) and isinstance(password, str)):
+        raise invalid_response
+
+    verified = await check_credentials(user_map, username, password)
     if verified:
+        response = web.HTTPFound('/')
         await remember(request, response, username)
-        return response
+        raise response
 
-    return web.HTTPUnauthorized(body='Invalid username / password combination')
+    raise invalid_response
 
 
-@login_required
-async def logout(request):
+async def logout(request: web.Request) -> web.Response:
+    await check_authorized(request)
     response = web.Response(
         text='You have been logged out',
         content_type='text/html',
@@ -65,9 +71,8 @@ async def logout(request):
     return response
 
 
-@has_permission('public')
-async def internal_page(request):
-    # pylint: disable=unused-argument
+async def internal_page(request: web.Request) -> web.Response:
+    await check_permission(request, 'public')
     response = web.Response(
         text='This page is visible for all registered users',
         content_type='text/html',
@@ -75,9 +80,8 @@ async def internal_page(request):
     return response
 
 
-@has_permission('protected')
-async def protected_page(request):
-    # pylint: disable=unused-argument
+async def protected_page(request: web.Request) -> web.Response:
+    await check_permission(request, 'protected')
     response = web.Response(
         text='You are on protected page',
         content_type='text/html',
@@ -85,7 +89,7 @@ async def protected_page(request):
     return response
 
 
-def configure_handlers(app):
+def configure_handlers(app: web.Application) -> None:
     router = app.router
     router.add_get('/', index, name='index')
     router.add_post('/login', login, name='login')

demo/dictionary_auth/main.py

@@ -11,9 +11,9 @@ from demo.dictionary_auth.handlers import configure_handlers
 from demo.dictionary_auth.users import user_map
 
 
-def make_app():
+def make_app() -> web.Application:
     app = web.Application()
-    app.user_map = user_map
+    app['user_map'] = user_map
     configure_handlers(app)
 
     # secret_key must be 32 url-safe base64-encoded bytes

demo/dictionary_auth/users.py

@@ -1,6 +1,11 @@
-from collections import namedtuple
+from typing import NamedTuple, Tuple
+
+
+class User(NamedTuple):
+    username: str
+    password: str
+    permissions: Tuple[str, ...]
 
-User = namedtuple('User', ['username', 'password', 'permissions'])
 
 user_map = {
     user.username: user for user in [

demo/simple_example_auth.py

@@ -0,0 +1,96 @@
+from enum import Enum
+from typing import NoReturn, Optional, Union
+
+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: str) -> Optional[str]:
+        """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.
+        """
+        return identity if identity == 'jack' else None
+
+    async def permits(self, identity: str, permission: Union[str, Enum],
+                      context: None = None) -> bool:
+        """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: web.Request) -> web.Response:
+    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: web.Request) -> NoReturn:
+    redirect_response = web.HTTPFound('/')
+    await remember(request, redirect_response, 'jack')
+    raise redirect_response
+
+
+async def handler_logout(request: web.Request) -> NoReturn:
+    redirect_response = web.HTTPFound('/')
+    await forget(request, redirect_response)
+    raise redirect_response
+
+
+async def handler_listen(request: web.Request) -> web.Response:
+    await check_permission(request, 'listen')
+    return web.Response(body="I can listen!")
+
+
+async def handler_speak(request: web.Request) -> web.Response:
+    await check_permission(request, 'speak')
+    return web.Response(body="I can speak!")
+
+
+async def make_app() -> web.Application:
+    #
+    # 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.router.add_route('GET', '/', handler_root)
+    app.router.add_route('GET', '/login', handler_login_jack)
+    app.router.add_route('GET', '/logout', handler_logout)
+    app.router.add_route('GET', '/listen', handler_listen)
+    app.router.add_route('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)

docs/example.rst

@@ -7,63 +7,97 @@ How to Make a Simple Server With Authorization
 
 Simple example::
 
-    import asyncio
     from aiohttp import web
-
-    async def root_handler(request):
-        text = "Alive and kicking!"
-        return web.Response(body=text.encode('utf-8'))
-
-    # option 2: auth at a higher level?
-    # set user_id and allowed in the wsgi handler
-    @protect('view_user')
-    async def user_handler(request):
-        name = request.match_info.get('name', "Anonymous")
-        text = "Hello, " + name
-        return web.Response(body=text.encode('utf-8'))
+    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
 
 
-    # option 3: super low
-    # wsgi doesn't do anything
-    async def user_update_handler(request):
-        # identity, asked_permission
-        user_id = await identity_policy.identify(request)
-        identity = await auth_policy.authorized_userid(user_id)
-        allowed = await request.auth_policy.permits(
-            identity, asked_permission)
-        if not allowed:
-            # how is this pluggable as well?
-            # ? return NotAllowedStream()
-            raise NotAllowedResponse()
+    # 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
 
-        update_user()
+        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 init(loop):
-        # set up identity and auth
-        auth_policy = DictionaryAuthorizationPolicy({'me': ('view_user',),
-                                                     'you': ('view_user',
-                                                             'edit_user',)})
-        identity_policy = CookieIdentityPolicy()
-        auth = authorization_middleware(auth_policy, identity_policy)
 
-        # wsgi app
-        app = web.Application(loop=loop, middlewares=*auth)
+    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.router.add_route('GET', '/', root_handler)
-        app.router.add_route('GET', '/{user}', user_handler)
-        app.router.add_route('GET', '/{user}/edit', user_update_handler)
+        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)])
 
-        # get it started
-        srv = await loop.create_server(app.make_handler(),
-                                       '127.0.0.1', 8080)
-        print("Server started at http://127.0.0.1:8080")
-        return srv
+        # set up policies
+        policy = SessionIdentityPolicy()
+        setup_security(app, policy, SimpleJack_AuthorizationPolicy())
+
+        return app
 
 
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(init(loop))
-    try:
-        loop.run_forever()
-    except KeyboardInterrupt:
-        pass  # TODO put handler cleanup here
+    if __name__ == '__main__':
+        web.run_app(make_app(), port=9000)

docs/example_db_auth.rst

@@ -53,7 +53,7 @@ Now you have two tables:
 +-----------------+
 | user_id         |
 +-----------------+
-| permission_name |
+| perm_name       |
 +-----------------+
 
 
@@ -133,7 +133,7 @@ Once we have all the code in place we can install it for our application::
                                        password='aiohttp_security',
                                        database='aiohttp_security',
                                        host='127.0.0.1')
-        app = web.Application(loop=loop)
+        app = web.Application()
         setup_session(app, RedisStorage(redis_pool))
         setup_security(app,
                        SessionIdentityPolicy(),
@@ -142,23 +142,23 @@ Once we have all the code in place we can install it for our application::
 
 
 Now we have authorization and can decorate every other view with access rights
-based on permissions. There are already implemented two decorators::
+based on permissions. There are already implemented two helpers::
 
-    from aiohttp_security import has_permission, login_required
+    from aiohttp_security import check_authorized, check_permission
 
 For each view you need to protect - just apply the decorator on it::
 
     class Web:
-        @has_permission('protected')
         async def protected_page(self, request):
+            await check_permission(request, 'protected')
             response = web.Response(body=b'You are on protected page')
             return response
 
 or::
 
     class Web:
-        @login_required
         async def logout(self, request):
+            await check_authorized(request)
             response = web.Response(body=b'You have been logged out')
             await forget(request, response)
             return response

docs/index.rst

@@ -3,6 +3,7 @@ aiohttp_security
 
 The library provides security for :ref:`aiohttp.web<aiohttp-web>`.
 
+The current version is |version|
 
 Contents
 --------

docs/reference.rst

@@ -13,6 +13,19 @@
 Public API functions
 ====================
 
+.. function:: setup(app, identity_policy, autz_policy)
+
+   Setup :mod:`aiohttp` application with security policies.
+
+   :param app: aiohttp :class:`aiohttp.web.Application` instance.
+
+   :param identity_policy: indentification policy, an
+                           :class:`AbstractIdentityPolicy` instance.
+
+   :param autz_policy: authorization policy, an
+                           :class:`AbstractAuthorizationPolicy` instance.
+
+
 .. coroutinefunction:: remember(request, response, identity, **kwargs)
 
    Remember *identity* in *response*, e.g. by storing a cookie or
@@ -50,6 +63,41 @@ Public API functions
                     descendants like :class:`aiohttp.web.Response`.
 
 
+.. coroutinefunction:: check_authorized(request)
+
+   Checker that doesn't pass if user is not authorized by *request*.
+
+   :param request:  :class:`aiohttp.web.Request` object.
+
+   :return str: authorized user ID if success
+
+   :raise: :class:`aiohttp.web.HTTPUnauthorized` for anonymous users.
+
+   Usage::
+
+      async def handler(request):
+          await check_authorized(request)
+          # this line is never executed for anonymous users
+
+
+.. coroutinefunction:: check_permission(request, permission)
+
+   Checker that doesn't pass if user has no requested permission.
+
+   :param request:  :class:`aiohttp.web.Request` object.
+
+   :raise: :class:`aiohttp.web.HTTPUnauthorized` for anonymous users.
+
+   :raise: :class:`aiohttp.web.HTTPForbidden` if user is
+           authorized but has no access rights.
+
+   Usage::
+
+      async def handler(request):
+          await check_permission(request, 'read')
+          # this line is never executed if a user has no read permission
+
+
 .. coroutinefunction:: authorized_userid(request)
 
    Retrieve :term:`userid`.
@@ -78,7 +126,8 @@ Public API functions
 
    :param request: :class:`aiohttp.web.Request` object.
 
-   :param permission: Requested :term:`permission`. :class:`str` or :class:`enum.Enum` object.
+   :param permission: Requested :term:`permission`. :class:`str` or
+                      :class:`enum.Enum` object.
 
    :param context: additional object may be passed into
                    :meth:`AbstractAuthorizationPolicy.permission`
@@ -92,7 +141,8 @@ Public API functions
 
    Checks if user is anonymous user.
 
-   Return ``True`` if user is not remembered in request, otherwise returns ``False``.
+   Return ``True`` if user is not remembered in request, otherwise
+   returns ``False``.
 
    :param request: :class:`aiohttp.web.Request` object.
 
@@ -103,29 +153,27 @@ Public API functions
 
    Raises :class:`aiohttp.web.HTTPUnauthorized` if user is not authorized.
 
+   .. deprecated:: 0.3
+
+      Use :func:`check_authorized` async function.
+
 
 .. decorator:: has_permission(permission)
 
    Decorator for handlers that checks if user is authorized
    and has correct permission.
 
-   Raises :class:`aiohttp.web.HTTPUnauthorized` if user is not authorized.
-   Raises :class:`aiohttp.web.HTTPForbidden` if user is authorized but has no access rights.
+   Raises :class:`aiohttp.web.HTTPUnauthorized` if user is not
+   authorized.
+
+   Raises :class:`aiohttp.web.HTTPForbidden` if user is
+   authorized but has no access rights.
 
    :param str permission: requested :term:`permission`.
 
+   .. deprecated:: 0.3
 
-.. function:: setup(app, identity_policy, autz_policy)
-
-   Setup :mod:`aiohttp` application with security policies.
-
-   :param app: aiohttp :class:`aiohttp.web.Application` instance.
-
-   :param identity_policy: indentification policy, an
-                           :class:`AbstractIdentityPolicy` instance.
-
-   :param autz_policy: authorization policy, an
-                           :class:`AbstractAuthorizationPolicy` instance.
+      Use :func:`check_authorized` async function.
 
 
 Abstract policies

docs/usage.rst

@@ -11,39 +11,132 @@
 
 First of all, what is *aiohttp_security* about?
 
-It is a set of public API functions and standard for implementation details.
+*aiohttp-security* is a set of public API functions as well as a
+reference standard for implementation details for securing access to
+assets served by a wsgi server.
+
+Assets are secured using authentication and authorization as explained
+below.  *aiohttp-security* is part of the
+`aio-libs <https://github.com/aio-libs>`_ project which takes advantage
+of asynchronous processing using Python's asyncio library.
 
 
 Public API
 ==========
 
-API is implementation agnostic, all client code should not call policy
-code (see below) directly but use API only.
+The API is agnostic to the low level implementation details such that
+all client code only needs to implement the endpoints as provided by
+the API (instead of calling policy code directly (see explanation
+below)).
+
+Via the API an application can:
+
+(i) remember a user in a local session (:func:`remember`),
+(ii) forget a user in a local session (:func:`forget`),
+(iii) retrieve the :term:`userid` (:func:`authorized_userid`) of a
+      remembered user from an :term:`identity` (discussed below), and
+(iv) check the :term:`permission` of a remembered user (:func:`permits`).
+
+The library internals are built on top of two concepts:
+
+1) :term:`authentication`, and
+2) :term:`authorization`.
+
+There are  abstract base  classes for  both types  as well  as several
+pre-built implementations that are  shipped with the library. However,
+the end user is free to build their own implementations.
+
+The library comes with two pre-built identity policies; one that uses
+cookies, and one that uses sessions [#f1]_.  It is envisioned that in
+most use cases developers will use one of the provided identity
+policies (Cookie or Session) and implement their own authorization
+policy.
+
+The workflow is as follows:
+
+1) User is authenticated.  This has to be implemented by the developer.
+2) Once user is authenticated an identity string has to be created for
+   that user.  This has to be implemented by the developer.
+3) The identity string is passed to the Identity Policy's remember
+   method and the user is now remembered (Cookie or Session if using
+   built-in).  *Only once a user is remembered can the other API
+   methods:* :func:`permits`, :func:`forget`, *and*
+   :func:`authorized_userid` *be invoked* .
+4) If the user tries to access a restricted asset the :func:`permits`
+   method is called.  Usually assets are protected using the
+   :func:`check_permission` helper.  This should return True if
+   permission is granted.
+
+The :func:`permits` method is implemented by the developer as part of
+the :class:`AbstractAuthorizationPolicy` and passed to the
+application at runtime via setup.
+
+In addition a :func:`check_authorized` also
+exists that requires no permissions (i.e. doesn't call :func:`permits`
+method) but only requires that the user is remembered
+(i.e. authenticated/logged in).
 
-Via API application can remember/forget user in local session
-(:func:`remember`/:func:`forget`), retrieve :term:`userid`
-(:func:`authorized_userid`) and check :term:`permission` for
-remembered user (:func:`permits`).
 
-The library internals are built on top of two policies:
-:term:`authentication` and :term:`authorization`. There are abstract
-base classes for both concepts as well as several implementations
-shipped with the library. End user is free to build own implemetations
-if needed.
 
 
 Authentication
 ==============
 
-Actions related to retrieving, storing and removing user's
-:term:`identity`.
+Authentication is the process where a user's identity is verified. It
+confirms who the user is. This is traditionally done using a user name
+and password (note: this is not the only way).
 
-Authenticated user has no access rights, the system even has no
-knowledge is there the user still registered in DB.
+A authenticated user has no access rights, rather an authenticated
+user merely confirms that the user exists and that the user is who
+they say they are.
 
-If :class:`aiohttp.web.Request` has an :term:`identity` it means the user has
-some ID that should be checked by :term:`authorization` policy.
+In *aiohttp_security* the developer is responsible for their own
+authentication mechanism.  *aiohttp_security* only requires that the
+authentication result in a identity string which corresponds to a
+user's id in the underlying system.
 
-:term:`identity` is a string shared between browser and server.
-Thus it's not supposed to be database primary key, user login/email etc.
-Random string like uuid or hash is better choice.
+.. note::
+
+   :term:`identity` is a string that is shared between the browser and
+   the server.  Therefore it is recommended that a random string
+   such as a uuid or hash is used rather than things like a
+   database primary key, user login/email, etc.
+
+Identity Policy
+===============
+
+Once a user is authenticated the *aiohttp_security* API is invoked for
+storing, retrieving, and removing a user's :term:`identity`.  This is
+accommplished via AbstractIdentityPolicy's :func:`remember`,
+:func:`identify`, and :func:`forget` methods.  The Identity Policy is
+therefore the mechanism by which a authenticated user is persisted in
+the system.
+
+*aiohttp_security* has two built in identity policy's for this
+purpose.  :class:`CookiesIdentityPolicy` that uses cookies and
+:class:`SessionIdentityPolicy` that uses sessions via
+``aiohttp-session`` library.
+
+Authorization
+==============
+
+Once a user is authenticated (see above) it means that the user has an
+:term:`identity`.  This :term:`identity` can now be used for checking
+access rights or :term:`permission` using a :term:`authorization`
+policy.
+
+The authorization policy's :func:`permits()` method is used for this purpose.
+
+
+When :class:`aiohttp.web.Request` has an :term:`identity` it means the
+user has been authenticated and therefore has an :term:`identity` that
+can be checked by the :term:`authorization` policy.
+
+As noted above, :term:`identity` is a string that is shared between
+the browser and the server.  Therefore it is recommended that a
+random string such as a uuid or hash is used rather than things like
+a database primary key, user login/email, etc.
+
+
+.. rubric:: Footnotes
+.. [#f1] jwt - json web tokens in the works

requirements-dev.txt

@@ -1,15 +1,18 @@
 -e .
-flake8==3.5.0
-pytest==3.4.2
-pytest-cov==2.5.1
-coverage==4.5.1
-sphinx==1.7.1
+flake8==3.8.4
+async-timeout==3.0.1
+pytest==6.1.2
+pytest-cov==2.10.1
+pytest-mock==3.3.1
+coverage==5.3
+sphinx==3.3.1
 pep257==0.7.0
-aiohttp-session==2.3.0
-aiopg[sa]==0.13.2
-aioredis==1.1.0
-hiredis==0.2.0
-passlib==1.7.1
-cryptography==2.1.4
-aiohttp==3.0.7
+aiohttp-session==2.9.0
+aiopg[sa]==1.1.0
+aioredis==1.3.1
+hiredis==1.1.0
+passlib==1.7.4
+cryptography==3.3.1
+aiohttp==3.7.3
 pytest-aiohttp==0.3.0
+pyjwt==1.7.1

setup.cfg

@@ -0,0 +1,4 @@
+[tool:pytest]
+testpaths = tests
+filterwarnings=
+    error

setup.py

@@ -1,4 +1,3 @@
-import codecs
 from setuptools import setup, find_packages
 import os
 import re
@@ -16,8 +15,8 @@ class PyTest(TestCommand):
         raise SystemExit(errno)
 
 
-with codecs.open(os.path.join(os.path.abspath(os.path.dirname(
-        __file__)), 'aiohttp_security', '__init__.py'), 'r', 'latin1') as fp:
+with open(os.path.join(os.path.abspath(os.path.dirname(
+        __file__)), 'aiohttp_security', '__init__.py'), 'r', encoding='latin1') as fp:
     try:
         version = re.findall(r"^__version__ = '([^']+)'$", fp.read(), re.M)[0]
     except IndexError:
@@ -28,7 +27,7 @@ def read(f):
     return open(os.path.join(os.path.dirname(__file__), f)).read().strip()
 
 
-install_requires = ['aiohttp>=0.18']
+install_requires = ['aiohttp>=3.2.0']
 tests_require = install_requires + ['pytest']
 extras_require = {'session': 'aiohttp-session'}
 
@@ -44,6 +43,7 @@ setup(name='aiohttp-security',
           'Programming Language :: Python :: 3',
           'Programming Language :: Python :: 3.5',
           'Programming Language :: Python :: 3.6',
+          'Programming Language :: Python :: 3.7',
           'Topic :: Internet :: WWW/HTTP',
           'Framework :: AsyncIO',
       ],

tests/test_cookies_identity.py

@@ -15,23 +15,23 @@ class Autz(AbstractAuthorizationPolicy):
         pass
 
 
-async def test_remember(loop, test_client):
+async def test_remember(loop, aiohttp_client):
 
     async def handler(request):
         response = web.Response()
         await remember(request, response, 'Andrew')
         return response
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', handler)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert 200 == resp.status
     assert 'Andrew' == resp.cookies['AIOHTTP_SECURITY'].value
 
 
-async def test_identify(loop, test_client):
+async def test_identify(loop, aiohttp_client):
 
     async def create(request):
         response = web.Response()
@@ -44,11 +44,11 @@ async def test_identify(loop, test_client):
         assert 'Andrew' == user_id
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', check)
     app.router.add_route('POST', '/', create)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/')
     assert 200 == resp.status
     await resp.release()
@@ -56,7 +56,7 @@ async def test_identify(loop, test_client):
     assert 200 == resp.status
 
 
-async def test_forget(loop, test_client):
+async def test_forget(loop, aiohttp_client):
 
     async def index(request):
         return web.Response()
@@ -64,19 +64,19 @@ async def test_forget(loop, test_client):
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'Andrew')
-        return response
+        raise response
 
     async def logout(request):
         response = web.HTTPFound(location='/')
         await forget(request, response)
-        return response
+        raise response
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', index)
     app.router.add_route('POST', '/login', login)
     app.router.add_route('POST', '/logout', logout)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/login')
     assert 200 == resp.status
     assert str(resp.url).endswith('/')

tests/test_dict_autz.py

@@ -1,10 +1,12 @@
 import enum
+import pytest
 
 from aiohttp import web
 from aiohttp_security import setup as _setup
 from aiohttp_security import (AbstractAuthorizationPolicy, authorized_userid,
                               forget, has_permission, is_anonymous,
-                              login_required, permits, remember)
+                              login_required, permits, remember,
+                              check_authorized, check_permission)
 from aiohttp_security.cookies_identity import CookiesIdentityPolicy
 
 
@@ -23,23 +25,23 @@ class Autz(AbstractAuthorizationPolicy):
             return None
 
 
-async def test_authorized_userid(loop, test_client):
+async def test_authorized_userid(loop, aiohttp_client):
 
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'UserID')
-        return response
+        raise response
 
     async def check(request):
         userid = await authorized_userid(request)
         assert 'Andrew' == userid
         return web.Response(text=userid)
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', check)
     app.router.add_route('POST', '/login', login)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
 
     resp = await client.post('/login')
     assert 200 == resp.status
@@ -47,23 +49,23 @@ async def test_authorized_userid(loop, test_client):
     assert 'Andrew' == txt
 
 
-async def test_authorized_userid_not_authorized(loop, test_client):
+async def test_authorized_userid_not_authorized(loop, aiohttp_client):
 
     async def check(request):
         userid = await authorized_userid(request)
         assert userid is None
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', check)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
 
     resp = await client.get('/')
     assert 200 == resp.status
 
 
-async def test_permits_enum_permission(loop, test_client):
+async def test_permits_enum_permission(loop, aiohttp_client):
     class Permission(enum.Enum):
         READ = '101'
         WRITE = '102'
@@ -86,7 +88,7 @@ async def test_permits_enum_permission(loop, test_client):
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'UserID')
-        return response
+        raise response
 
     async def check(request):
         ret = await permits(request, Permission.READ)
@@ -97,16 +99,16 @@ async def test_permits_enum_permission(loop, test_client):
         assert not ret
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', check)
     app.router.add_route('POST', '/login', login)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/login')
     assert 200 == resp.status
 
 
-async def test_permits_unauthorized(loop, test_client):
+async def test_permits_unauthorized(loop, aiohttp_client):
 
     async def check(request):
         ret = await permits(request, 'read')
@@ -117,38 +119,38 @@ async def test_permits_unauthorized(loop, test_client):
         assert not ret
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', check)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert 200 == resp.status
 
 
-async def test_is_anonymous(loop, test_client):
+async def test_is_anonymous(loop, aiohttp_client):
 
     async def index(request):
         is_anon = await is_anonymous(request)
         if is_anon:
-            return web.HTTPUnauthorized()
-        return web.HTTPOk()
+            raise web.HTTPUnauthorized()
+        return web.Response()
 
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'UserID')
-        return response
+        raise response
 
     async def logout(request):
         response = web.HTTPFound(location='/')
         await forget(request, response)
-        return response
+        raise response
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', index)
     app.router.add_route('POST', '/login', login)
     app.router.add_route('POST', '/logout', logout)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert web.HTTPUnauthorized.status_code == resp.status
 
@@ -161,27 +163,63 @@ async def test_is_anonymous(loop, test_client):
     assert web.HTTPUnauthorized.status_code == resp.status
 
 
-async def test_login_required(loop, test_client):
-    @login_required
+async def test_login_required(loop, aiohttp_client):
+    with pytest.raises(DeprecationWarning):
+
+        @login_required
+        async def index(request):
+            return web.Response()
+
+        async def login(request):
+            response = web.HTTPFound(location='/')
+            await remember(request, response, 'UserID')
+            raise response
+
+        async def logout(request):
+            response = web.HTTPFound(location='/')
+            await forget(request, response)
+            raise response
+
+        app = web.Application()
+        _setup(app, CookiesIdentityPolicy(), Autz())
+        app.router.add_route('GET', '/', index)
+        app.router.add_route('POST', '/login', login)
+        app.router.add_route('POST', '/logout', logout)
+
+        client = await aiohttp_client(app)
+        resp = await client.get('/')
+        assert web.HTTPUnauthorized.status_code == resp.status
+
+        await client.post('/login')
+        resp = await client.get('/')
+        assert web.HTTPOk.status_code == resp.status
+
+        await client.post('/logout')
+        resp = await client.get('/')
+        assert web.HTTPUnauthorized.status_code == resp.status
+
+
+async def test_check_authorized(loop, aiohttp_client):
     async def index(request):
-        return web.HTTPOk()
+        await check_authorized(request)
+        return web.Response()
 
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'UserID')
-        return response
+        raise response
 
     async def logout(request):
         response = web.HTTPFound(location='/')
         await forget(request, response)
-        return response
+        raise response
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/', index)
     app.router.add_route('POST', '/login', login)
     app.router.add_route('POST', '/logout', logout)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert web.HTTPUnauthorized.status_code == resp.status
 
@@ -194,38 +232,97 @@ async def test_login_required(loop, test_client):
     assert web.HTTPUnauthorized.status_code == resp.status
 
 
-async def test_has_permission(loop, test_client):
+async def test_has_permission(loop, aiohttp_client):
+
+    with pytest.warns(DeprecationWarning):
+
+        @has_permission('read')
+        async def index_read(request):
+            return web.Response()
+
+        @has_permission('write')
+        async def index_write(request):
+            return web.Response()
+
+        @has_permission('forbid')
+        async def index_forbid(request):
+            return web.Response()
+
+        async def login(request):
+            response = web.HTTPFound(location='/')
+            await remember(request, response, 'UserID')
+            return response
+
+        async def logout(request):
+            response = web.HTTPFound(location='/')
+            await forget(request, response)
+            raise response
+
+        app = web.Application()
+        _setup(app, CookiesIdentityPolicy(), Autz())
+        app.router.add_route('GET', '/permission/read', index_read)
+        app.router.add_route('GET', '/permission/write', index_write)
+        app.router.add_route('GET', '/permission/forbid', index_forbid)
+        app.router.add_route('POST', '/login', login)
+        app.router.add_route('POST', '/logout', logout)
+        client = await aiohttp_client(app)
+
+        resp = await client.get('/permission/read')
+        assert web.HTTPUnauthorized.status_code == resp.status
+        resp = await client.get('/permission/write')
+        assert web.HTTPUnauthorized.status_code == resp.status
+        resp = await client.get('/permission/forbid')
+        assert web.HTTPUnauthorized.status_code == resp.status
+
+        await client.post('/login')
+        resp = await client.get('/permission/read')
+        assert web.HTTPOk.status_code == resp.status
+        resp = await client.get('/permission/write')
+        assert web.HTTPOk.status_code == resp.status
+        resp = await client.get('/permission/forbid')
+        assert web.HTTPForbidden.status_code == resp.status
+
+        await client.post('/logout')
+        resp = await client.get('/permission/read')
+        assert web.HTTPUnauthorized.status_code == resp.status
+        resp = await client.get('/permission/write')
+        assert web.HTTPUnauthorized.status_code == resp.status
+        resp = await client.get('/permission/forbid')
+        assert web.HTTPUnauthorized.status_code == resp.status
+
+
+async def test_check_permission(loop, aiohttp_client):
 
-    @has_permission('read')
     async def index_read(request):
-        return web.HTTPOk()
+        await check_permission(request, 'read')
+        return web.Response()
 
-    @has_permission('write')
     async def index_write(request):
-        return web.HTTPOk()
+        await check_permission(request, 'write')
+        return web.Response()
 
-    @has_permission('forbid')
     async def index_forbid(request):
-        return web.HTTPOk()
+        await check_permission(request, 'forbid')
+        return web.Response()
 
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'UserID')
-        return response
+        raise response
 
     async def logout(request):
         response = web.HTTPFound(location='/')
         await forget(request, response)
-        return response
+        raise response
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     _setup(app, CookiesIdentityPolicy(), Autz())
     app.router.add_route('GET', '/permission/read', index_read)
     app.router.add_route('GET', '/permission/write', index_write)
     app.router.add_route('GET', '/permission/forbid', index_forbid)
     app.router.add_route('POST', '/login', login)
     app.router.add_route('POST', '/logout', logout)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
 
     resp = await client.get('/permission/read')
     assert web.HTTPUnauthorized.status_code == resp.status

tests/test_jwt_identity.py

@@ -0,0 +1,82 @@
+import jwt
+import pytest
+from aiohttp import web
+
+from aiohttp_security import setup as _setup
+from aiohttp_security import AbstractAuthorizationPolicy
+from aiohttp_security.api import IDENTITY_KEY
+from aiohttp_security.jwt_identity import JWTIdentityPolicy
+
+
+@pytest.fixture
+def make_token():
+    def factory(payload, secret):
+        return jwt.encode(
+            payload,
+            secret,
+            algorithm='HS256',
+        )
+
+    return factory
+
+
+class Autz(AbstractAuthorizationPolicy):
+
+    async def permits(self, identity, permission, context=None):
+        pass
+
+    async def authorized_userid(self, identity):
+        pass
+
+
+async def test_no_pyjwt_installed(mocker):
+    mocker.patch('aiohttp_security.jwt_identity.jwt', None)
+    with pytest.raises(RuntimeError):
+        JWTIdentityPolicy('secret')
+
+
+async def test_identify(loop, make_token, aiohttp_client):
+    kwt_secret_key = 'Key'
+
+    token = make_token({'login': 'Andrew'}, kwt_secret_key)
+
+    async def check(request):
+        policy = request.app[IDENTITY_KEY]
+        identity = await policy.identify(request)
+        assert 'Andrew' == identity['login']
+        return web.Response()
+
+    app = web.Application()
+    _setup(app, JWTIdentityPolicy(kwt_secret_key), Autz())
+    app.router.add_route('GET', '/', check)
+
+    client = await aiohttp_client(app)
+    headers = {'Authorization': 'Bearer {}'.format(token.decode('utf-8'))}
+    resp = await client.get('/', headers=headers)
+    assert 200 == resp.status
+
+
+async def test_identify_broken_scheme(loop, make_token, aiohttp_client):
+    kwt_secret_key = 'Key'
+
+    token = make_token({'login': 'Andrew'}, kwt_secret_key)
+
+    async def check(request):
+        policy = request.app[IDENTITY_KEY]
+
+        try:
+            await policy.identify(request)
+        except ValueError as exc:
+            raise web.HTTPBadRequest(reason=str(exc))
+
+        return web.Response()
+
+    app = web.Application()
+    _setup(app, JWTIdentityPolicy(kwt_secret_key), Autz())
+    app.router.add_route('GET', '/', check)
+
+    client = await aiohttp_client(app)
+    headers = {'Authorization': 'Token {}'.format(token.decode('utf-8'))}
+    resp = await client.get('/', headers=headers)
+    assert 400 == resp.status
+    assert 'Invalid authorization scheme' in resp.reason

tests/test_no_auth.py

@@ -2,21 +2,21 @@ from aiohttp import web
 from aiohttp_security import authorized_userid, permits
 
 
-async def test_authorized_userid(loop, test_client):
+async def test_authorized_userid(loop, aiohttp_client):
 
     async def check(request):
         userid = await authorized_userid(request)
         assert userid is None
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     app.router.add_route('GET', '/', check)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert 200 == resp.status
 
 
-async def test_permits(loop, test_client):
+async def test_permits(loop, aiohttp_client):
 
     async def check(request):
         ret = await permits(request, 'read')
@@ -27,8 +27,8 @@ async def test_permits(loop, test_client):
         assert ret
         return web.Response()
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     app.router.add_route('GET', '/', check)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert 200 == resp.status

tests/test_no_identity.py

@@ -2,15 +2,15 @@ from aiohttp import web
 from aiohttp_security import remember, forget
 
 
-async def test_remember(loop, test_client):
+async def test_remember(loop, aiohttp_client):
 
     async def do_remember(request):
         response = web.Response()
         await remember(request, response, 'Andrew')
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     app.router.add_route('POST', '/', do_remember)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/')
     assert 500 == resp.status
     assert (('Security subsystem is not initialized, '
@@ -18,15 +18,15 @@ async def test_remember(loop, test_client):
             resp.reason)
 
 
-async def test_forget(loop, test_client):
+async def test_forget(loop, aiohttp_client):
 
     async def do_forget(request):
         response = web.Response()
         await forget(request, response)
 
-    app = web.Application(loop=loop)
+    app = web.Application()
     app.router.add_route('POST', '/', do_forget)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/')
     assert 500 == resp.status
     assert (('Security subsystem is not initialized, '

tests/test_session_identity.py

@@ -20,14 +20,14 @@ class Autz(AbstractAuthorizationPolicy):
 
 
 @pytest.fixture
-def make_app(loop):
-    app = web.Application(loop=loop)
+def make_app():
+    app = web.Application()
     setup_session(app, SimpleCookieStorage())
     setup_security(app, SessionIdentityPolicy(), Autz())
     return app
 
 
-async def test_remember(make_app, test_client):
+async def test_remember(make_app, aiohttp_client):
 
     async def handler(request):
         response = web.Response()
@@ -37,12 +37,12 @@ async def test_remember(make_app, test_client):
     async def check(request):
         session = await get_session(request)
         assert session['AIOHTTP_SECURITY'] == 'Andrew'
-        return web.HTTPOk()
+        return web.Response()
 
     app = make_app()
     app.router.add_route('GET', '/', handler)
     app.router.add_route('GET', '/check', check)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.get('/')
     assert 200 == resp.status
 
@@ -50,7 +50,7 @@ async def test_remember(make_app, test_client):
     assert 200 == resp.status
 
 
-async def test_identify(make_app, test_client):
+async def test_identify(make_app, aiohttp_client):
 
     async def create(request):
         response = web.Response()
@@ -66,7 +66,7 @@ async def test_identify(make_app, test_client):
     app = make_app()
     app.router.add_route('GET', '/', check)
     app.router.add_route('POST', '/', create)
-    client = await test_client(app)
+    client = await aiohttp_client(app)
     resp = await client.post('/')
     assert 200 == resp.status
 
@@ -74,28 +74,28 @@ async def test_identify(make_app, test_client):
     assert 200 == resp.status
 
 
-async def test_forget(make_app, test_client):
+async def test_forget(make_app, aiohttp_client):
 
     async def index(request):
         session = await get_session(request)
-        return web.HTTPOk(text=session.get('AIOHTTP_SECURITY', ''))
+        return web.Response(text=session.get('AIOHTTP_SECURITY', ''))
 
     async def login(request):
         response = web.HTTPFound(location='/')
         await remember(request, response, 'Andrew')
-        return response
+        raise response
 
     async def logout(request):
         response = web.HTTPFound('/')
         await forget(request, response)
-        return response
+        raise response
 
     app = make_app()
     app.router.add_route('GET', '/', index)
     app.router.add_route('POST', '/login', login)
     app.router.add_route('POST', '/logout', logout)
 
-    client = await test_client(app)
+    client = await aiohttp_client(app)
 
     resp = await client.post('/login')
     assert 200 == resp.status