starlette-auth-toolkit

Authentication backends and helpers for Starlette-based apps and frameworks.

Note: documentation is in progress — in the meantime, feel free to read the source code!

Installation

pip install starlette-auth-toolkit

Note: you need to install Starlette yourself.

Base backends

Base backends implement an authentication flow, but the exact implementation of credentials verification is left up to you. You can choose to perform a database query, use environment variables or private files, etc.

Base backends are user model agnostic, although we recommend you use a subclass of starlette.authentication.BaseUser.

The documentation below lists which scopes each backend grants when authentication succeeds.

Please refer to the Starlette authentication documentation for more information on Starlette's authentication and permissions interface.

Basic auth

Abstract methods

• .verify(self, username: str, password: str) -> Optional[BaseUser]

  If username and password are valid, return the corresponding user. Otherwise, return None.

Scopes

• authenticated

Example

# myapp/auth.py
from starlette.authentication import SimpleUser  # or a custom user model
from starlette_auth_toolkit.backends import BaseBasicAuthBackend

class BasicAuthBackend(BaseBasicAuthBackend):
    async def verify(self, username: str, password: str):
        # TODO: you'd probably want to make a DB call here.
        if (username, password) != ("guido", "s3kr3t"):
            return None
        return SimpleUser(username)

Contributing

Want to contribute? Awesome! Be sure to read our Contributing guidelines.

Changelog

See CHANGELOG.md.

License

MIT