Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romis2012/aiohttp-basicauth
HTTP basic authentication middleware for aiohttp 3.0+
https://github.com/romis2012/aiohttp-basicauth
aiohttp authentication authentication-middleware http
Last synced: about 2 months ago
JSON representation
HTTP basic authentication middleware for aiohttp 3.0+
- Host: GitHub
- URL: https://github.com/romis2012/aiohttp-basicauth
- Owner: romis2012
- License: apache-2.0
- Created: 2018-06-07T10:47:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T12:04:36.000Z (4 months ago)
- Last Synced: 2024-11-12T23:41:44.319Z (2 months ago)
- Topics: aiohttp, authentication, authentication-middleware, http
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 16
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## aiohttp-basicauth
[](https://github.com/romis2012/aiohttp-basicauth/actions/workflows/ci.yml)
[](https://codecov.io/gh/romis2012/aiohttp-basicauth)
[](https://badge.fury.io/py/aiohttp-basicauth)
HTTP basic authentication middleware for aiohttp 3.0+.
Inspired by [Flask-BasicAuth](https://github.com/jpvanhal/flask-basicauth).
## Requirements
- Python >= 3.7
- aiohttp >= 3.0
## Installation
```
pip install aiohttp_basicauth
```
## Simple usage
```python
from aiohttp import web
from aiohttp_basicauth import BasicAuthMiddleware
auth = BasicAuthMiddleware(username='user', password='password')
app = web.Application(middlewares=[auth])
web.run_app(app, host='127.0.0.1', port=80)
```
## Protect specific view(s)
```python
from aiohttp import web
from aiohttp_basicauth import BasicAuthMiddleware
auth = BasicAuthMiddleware(username='user', password='password', force=False)
async def public_view(request):
return web.Response(text='Public view')
@auth.required
async def secret_view(request):
return web.Response(text='Secret view')
app = web.Application(middlewares=[auth])
app.router.add_route('GET', '/public', public_view)
app.router.add_route('GET', '/secret', secret_view)
web.run_app(app, host='127.0.0.1', port=80)
```
## Advanced usage
You can override ```check_credentials``` method to implement more complex user verification logic:
```python
from aiohttp import web
from aiohttp_basicauth import BasicAuthMiddleware
class CustomBasicAuth(BasicAuthMiddleware):
async def check_credentials(self, username, password, request):
# here, for example, you can search user in the database by passed `username` and `password`, etc.
return username == 'user' and password == 'password'
auth = CustomBasicAuth()
app = web.Application(middlewares=[auth])
web.run_app(app, host='127.0.0.1', port=80)
```