https://github.com/ayys/knoxth
Knoxth uses Knox tokens to provide token-level authorization management for DRF viewsets.
https://github.com/ayys/knoxth
django django-rest-knox drf knox-tokens
Last synced: 6 months ago
JSON representation
Knoxth uses Knox tokens to provide token-level authorization management for DRF viewsets.
- Host: GitHub
- URL: https://github.com/ayys/knoxth
- Owner: ayys
- License: gpl-3.0
- Created: 2021-05-06T12:21:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-23T13:09:53.000Z (over 4 years ago)
- Last Synced: 2025-02-13T20:52:03.097Z (8 months ago)
- Topics: django, django-rest-knox, drf, knox-tokens
- Language: Python
- Homepage: https://ayys.gitlab.io/knoxth
- Size: 1.02 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Knoxth - Auth for Knox
A authorization module for django built on top of DRF and Knox.
Introduction •
Installation •
How To Use •
Documentation •
License
## Introduction
Knoxth uses Knox tokens to provide token-level authorization management for DRF viewsets.
Django Rest Frameowork is an amazingly simple to use and easy
frameowork to write REST APIs in Django. With Knox, you can secure
your API with Access Tokens. Yet, there is a gap left by Knox, the
need for context-specific authentication system built on top of knox.
Users will want to customize the "scope" of each token they
create. This way, users may create different tokens for separate
usecases.
Let's take an example. Let us say you are developinga rest api that
lets it's create and manage TODO lists. Now, you have a viewset that
handles all CRUD operations, but you want to provide a way for users
to manage access to their todo lists on a token level. So, a user may
want to create a token, with which they can only read TODO lists, but
not modify them.
This is where knoxth comes in. Knoxth implements contextual
authorization of DRF viewsets on token level, using Knox Tokens.
## Installation
Knox should be installed with pip
### 1. Install knoxth
```bash
pip install knoxth
```
For pipenv projects, it can also be installed as such
```bash
pipenv install knoxth
```
After installing knoxth, you will need to setup knoxth to work with your existing project.
Before seting up knoxth, make sure you have rest_framework and knox setup and ready to go.
### 2. Add to INSTALLED_APPS
Add `rest_framework`, `knox` and `knoxth` to your `INSTALLED_APPS`, and add
`rest_framework.authtoken` if you removed it while setting up knox.
```python
INSTALLED_APPS = (
...
'rest_framework',
'rest_framework.authtoken',
'knox',
'knoxth',
...
)
```
### 3. Setup default Authentication class
Make knox's TokenAuthentication your default authentication class
for django-rest-framework:
```python
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': ('knox.auth.TokenAuthentication',),
...
}
```
### 4. Include knoxth URLS
Knoxth provides a url config ready with its four default views routed.
This can easily be included in your url config:
```python
urlpatterns = [
#...snip...
url(r'api/auth/', include('knoxth.urls'))
#...snip...
]
```
**Note** It is important to use the string syntax and not try to import `knoxth.urls`,
as the reference to the `User` model will cause the app to fail at import time.
The views would then acessible as:
| Endpoint | Description |
| --- | --- |
| `/api/auth/authorize` | Authorize username & password. Return authorization code. |
| `/api/auth/login` | Accept authorization code and return access token |
| `/api/auth/logout` | Logout the user and delete the access token and authorization code. |
| `/api/auth/logoutall` | Same as logout, but logs out of all running sessions. |
| | |
they can also be looked up by name:
```python
reverse('knoxth_login')
reverse('knoxth_logout')
reverse('knoxth_logoutall')
reverse('knoxth_authorize')
```
### 5. Migrate
Apply the migrations for the models
```bash
python manage.py migrate
```
## How To Use
Refer to our [documentation](https://ayys.gitlab.io/knoxth/") for details, or follow our [getting started guide](https://ayys.gitlab.io/knoxth/getting-started/").
## License
GNU GPL V3
---
> GitHub [@ayys](https://github.com/ayys) ·
> Twitter [@habuayush](https://twitter.com/habuayush)