Metadata-Version: 2.1
Name: starlette-authlib
Version: 0.1.2
Summary: A drop-in replacement for Starlette session middleware, using authlib's jwt.
Home-page: https://github.com/aogier/starlette-authlib
Author: Alessandro Ogier
Author-email: alessandro.ogier@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: authlib
Requires-Dist: starlette

# Starlette Authlib Middleware

## Introduction

A drop-in replacement for Starlette session middleware, using [authlib's jwt](https://docs.authlib.org/en/latest/jose/jwt.html)

## Requirements

* Python 3.6+
* Starlette 0.9+

## Installation

```console
$ pip install starlette-authlib

...
```

## Usage

A complete example where we drop-in replace standard session middleware:

```python
from starlette.applications import Starlette

from starlette_authlib.middleware import AuthlibMiddleware as SessionMiddleware


app = Starlette()

app.add_middleware(SessionMiddleware, secret='secret')
```

Other things you can configure either via environment variables or `.env` file:

* `DOMAIN` - declare cookie domain. App must be under this domain. If empty,
  the cookie is restricted to the subdomain of the app (this is useful when you
  write eg. SSO portals)
* `JWT_ALG` - one of authlib JWT [supported algorithms](https://docs.authlib.org/en/latest/specs/rfc7518.html#specs-rfc7518)
* `JWT_SECRET` - jwt secret. Be aware that for non-HMAC algorithms this
  variable must point to a proper key filename

## Contributing

This project is absolutely open to contributions so if you have a nice idea,
create an issue to let the community discuss it.


