django-rest-knox

v4.1.0

Authentication for django rest framework

PyPI

README

GitHub

MIT

Latest version published 2 years ago

    pip install django-rest-knox

Explore Similar Packages

jwt 76 / 100

Package Health Score

58 / 100

Popularity
Popular
Maintenance
Inactive
Security
Security review needed
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Popular

Total Weekly Downloads (10,924)

Dependents: 0
GitHub Stars: 647
Forks: 100
Contributors: 40

The PyPI package django-rest-knox receives a total of 10,924 downloads a week. As such, we scored django-rest-knox popularity level to be Popular.

Based on project statistics from the GitHub repository for the PyPI package django-rest-knox, we found that it has been starred 647 times, and that 0 other projects in the ecosystem are dependent on it.

The download numbers shown are the average weekly downloads from the last 6 weeks.

Security

Security review needed

Security and license risk for latest version

Version: 4.1.0 See all versions
Release Date: 06/2019
Direct Vulnerabilities: 0
H

0
M

0
L
Indirect Vulnerabilities: 0
H

2
M

1
L
License Risk: 0
H

0
M

0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like django-rest-knox is missing a security policy.

A security vulnerability was detected in an indirect dependency that is added to your project when the latest version of django-rest-knox is installed.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

Open Issues: 28
Merged PR: 106
Open PR: 10
Last Commit: 3 months ago

Further analysis of the maintenance status of django-rest-knox based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for django-rest-knox is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the django-rest-knox repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like django-rest-knox is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Python Versions Compatibility: ==2.7.*, ==3.4.*, ==3.5.*, ==3.6.*, ==3.7.*

Age: 5 years
Latest Release: 2 years ago
Dependencies: 3 Direct / 9 Total
Versions: 24
Maintainers: 1
Wheels: OS Independent

django-rest-knox

Authentication Module for django rest auth

Knox provides easy to use authentication for Django REST Framework The aim is to allow for common patterns in applications that are REST based, with little extra effort; and to ensure that connections remain secure.

Knox authentication is token based, similar to the TokenAuthentication built in to DRF. However, it overcomes some problems present in the default implementation:

DRF tokens are limited to one per user. This does not facilitate securely signing in from multiple devices, as the token is shared. It also requires all devices to be logged out if a server-side logout is required (i.e. the token is deleted).

Knox provides one token per call to the login view - allowing each client to have its own token which is deleted on the server side when the client logs out.

Knox also provides an option for a logged in client to remove all tokens that the server has - forcing all clients to re-authenticate.
DRF tokens are stored unencrypted in the database. This would allow an attacker unrestricted access to an account with a token if the database were compromised.

Knox tokens are only stored in an encrypted form. Even if the database were somehow stolen, an attacker would not be able to log in with the stolen credentials.
DRF tokens track their creation time, but have no inbuilt mechanism for tokens expiring. Knox tokens can have an expiry configured in the app settings (default is 10 hours.)

More information can be found in the Documentation

Run the tests locally

If you need to debug a test locally and if you have docker installed:

simply run the ./docker-run-test.sh script and it will run the test suite in every Python / Django versions.

You could also simply run regular tox in the root folder as well, but that would make testing the matrix of Python / Django versions a bit more tricky.

Work on the documentation

Our documentation is generated by Mkdocs.

You can refer to their documentation on how to install it locally.

Another option is to use mkdocs.sh in this repository. It will run mkdocs in a docker container.

Running the script without any params triggers the serve command. The server is exposed on localhost on port 8000.

To configure the port the serve command will be exposing the server to, you can use the following env var:

MKDOCS_DEV_PORT="8080"

You can also pass any mkdocs command like this:

./mkdocs build
./mkdocs --help

Check the Mkdocs documentation for more.

Last updated on 25 February-2021, at 21:41 (UTC).

django-rest-knox

Authentication for django rest framework

Explore Similar Packages

Package Health Score

Popularity

Total Weekly Downloads (10,924)

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Package

django-rest-knox

Run the tests locally

Work on the documentation

django-rest-knox dependencies

What is django-rest-knox?

Is django-rest-knox safe to use?

Is django-rest-knox well maintained?