Skip to main content

Asymmetric key based authentication for HTTP APIs

Project description

https://img.shields.io/pypi/v/asymmetric_jwt_auth.svg https://img.shields.io/pypi/dm/asymmetric_jwt_auth.svg https://travis-ci.org/crgwbr/asymmetric_jwt_auth.svg

What?

This is an library designed to handle authentication in server-to-server API requests. It accomplishes this using RSA public / private key pairs.

Why?

The standard pattern of using username and password works well for user-to-server requests, but is lacking for server-to-server applications. In these scenarios, since the password doesn’t need to be memorable by a user, we can use something far more secure: asymmetric key cryptography. This has the advantage that a password is never actually sent to the server.

How?

A public / private key pair is generated by the client machine. The server machine is then supplied with the public key, which it can store in any method it likes. When this library is used with Django, it provides a model for storing public keys associated with built-in User objects. When a request is made, the client creates a JWT including several claims and signs it using it’s private key. Upon receipt, the server verifies the claim to using the public key to ensure the issuer is legitimately who they claim to be.

The claim (issued by the client) includes components: the username of the user who is attempting authentication, the current unix timestamp, and a randomly generated nonce. For example:

{
    "username": "guido",
    "time": 1439216312,
    "nonce": "1"
}

The timestamp must be within ±20 seconds of the server time and the nonce must be unique within the given timestamp and user. In other words, if more than one request from a user is made within the same second, the nonce must change. Due to these two factors no token is usable more than once, thereby preventing replay attacks.

To make an authenticated request, the client must generate a JWT following the above format and include it as the HTTP Authorization header in the following format:

Authorization: JWT <my_token>

Important note: the claim is not encrypted, only signed. Additionally, the signature only prevents the claim from being tampered with or re-used. Every other part of the request is still vulnerable to tamper. Therefore, this is not a replacement for using SSL in the transport layer.

Full Documentation: https://asymmetric-jwt-auth.readthedocs.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asymmetric_jwt_auth-0.3.0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

asymmetric_jwt_auth-0.3.0-py2.py3-none-any.whl (15.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file asymmetric_jwt_auth-0.3.0.tar.gz.

File metadata

File hashes

Hashes for asymmetric_jwt_auth-0.3.0.tar.gz
Algorithm Hash digest
SHA256 7e9114d9b64c8363d4c6cb484b8294d48c074365bc8fcb4d169154da2a60a373
MD5 acd7b44149406bbb727288ab566c5f93
BLAKE2b-256 9cad51c2c182119c27d6dd203546902732ba834797434447aed366f32fb0f442

See more details on using hashes here.

Provenance

File details

Details for the file asymmetric_jwt_auth-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for asymmetric_jwt_auth-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a1421d8f9099e59ee5125b7a9b2568a881a527ae6e6561ea73273b9bf25afe35
MD5 de669c6c17316b6638431fb73e27edf4
BLAKE2b-256 44ce0e6f04730478f71e0fa4500b7ce92dd3fda523cd569680ebc19c0eacda13

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page