Authlib
Authlib
This part of the documentation covers the interface of Flask OAuth 1.0 Server.
Flask implementation of authlib.rfc5849.AuthorizationServer.
Initialize it with Flask app instance, client model class and cache:
server = AuthorizationServer(app=app, query_client=query_client)
# or initialize lazily
server = AuthorizationServer()
server.init_app(app, query_client=query_client)
app – A Flask app instance
query_client – A function to get client by client_id. The client
model class MUST implement the methods described by
ClientMixin.
token_generator – A function to generate token
Validate authorization request and create authorization response.
Assume the endpoint for authorization request is
https://photos.example.net/authorize, the client redirects Jane’s
user-agent to the server’s Resource Owner Authorization endpoint to
obtain Jane’s approval for accessing her private photos:
https://photos.example.net/authorize?oauth_token=hh5s93j4hdidpola
The server requests Jane to sign in using her username and password and if successful, asks her to approve granting ‘printer.example.com’ access to her private photos. Jane approves the request and her user-agent is redirected to the callback URI provided by the client in the previous request (line breaks are for display purposes only):
http://printer.example.com/ready?
oauth_token=hh5s93j4hdidpola&oauth_verifier=hfdp7dh39dks9884
request – OAuth1Request instance.
grant_user – if granted, pass the grant user, otherwise None.
(status_code, body, headers)
Create and bind oauth_verifier to temporary credential. It
could be re-implemented in this way:
def create_authorization_verifier(self, request):
verifier = generate_token(36)
temporary_credential = request.credential
user_id = request.user.id
temporary_credential.user_id = user_id
temporary_credential.oauth_verifier = verifier
# if the credential has a save method
temporary_credential.save()
# remember to return the verifier
return verifier
request – OAuth1Request instance
A string of oauth_verifier
Generate and save a temporary credential into database or cache. A temporary credential is used for exchanging token credential. This method should be re-implemented:
def create_temporary_credential(self, request):
oauth_token = generate_token(36)
oauth_token_secret = generate_token(48)
temporary_credential = TemporaryCredential(
oauth_token=oauth_token,
oauth_token_secret=oauth_token_secret,
client_id=request.client_id,
redirect_uri=request.redirect_uri,
)
# if the credential has a save method
temporary_credential.save()
return temporary_credential
request – OAuth1Request instance
TemporaryCredential instance
Create and save token credential into database. This method would be re-implemented like this:
def create_token_credential(self, request):
oauth_token = generate_token(36)
oauth_token_secret = generate_token(48)
temporary_credential = request.credential
token_credential = TokenCredential(
oauth_token=oauth_token,
oauth_token_secret=oauth_token_secret,
client_id=temporary_credential.get_client_id(),
user_id=temporary_credential.get_user_id()
)
# if the credential has a save method
token_credential.save()
return token_credential
request – OAuth1Request instance
TokenCredential instance
Validate token request and create token response. Assuming the
endpoint of token request is https://photos.example.net/token,
the callback request informs the client that Jane completed the
authorization process. The client then requests a set of token
credentials using its temporary credentials (over a secure Transport
Layer Security (TLS) channel):
POST /token HTTP/1.1
Host: photos.example.net
Authorization: OAuth realm="Photos",
oauth_consumer_key="dpf43f3p2l4k3l03",
oauth_token="hh5s93j4hdidpola",
oauth_signature_method="HMAC-SHA1",
oauth_timestamp="137131201",
oauth_nonce="walatlh",
oauth_verifier="hfdp7dh39dks9884",
oauth_signature="gKgrFCywp7rO0OXSjdot%2FIHF7IU%3D"
The server validates the request and replies with a set of token credentials in the body of the HTTP response:
HTTP/1.1 200 OK
Content-Type: application/x-www-form-urlencoded
oauth_token=nnch734d00sl2jdk&oauth_token_secret=pfkkdhi9sl3r4s00
request – OAuth1Request instance.
(status_code, body, headers)
Delete temporary credential from database or cache. For instance, if temporary credential is saved in cache:
def delete_temporary_credential(self, request):
key = 'a-key-prefix:{}'.format(request.token)
cache.delete(key)
request – OAuth1Request instance
The nonce value MUST be unique across all requests with the same timestamp, client credentials, and token combinations.
nonce – A string value of oauth_nonce
request – OAuth1Request instance
Boolean
Get client instance with the given client_id.
client_id – A string of client_id
Client instance
Get the temporary credential from database or cache. A temporary
credential should share the same methods as described in models of
TemporaryCredentialMixin:
def get_temporary_credential(self, request):
key = 'a-key-prefix:{}'.format(request.token)
data = cache.get(key)
# TemporaryCredential shares methods from TemporaryCredentialMixin
return TemporaryCredential(data)
request – OAuth1Request instance
TemporaryCredential instance
A protecting method for resource servers. Initialize a resource protector with the these method:
query_client
query_token,
exists_nonce
Usually, a query_client method would look like (if using SQLAlchemy):
def query_client(client_id):
return Client.query.filter_by(client_id=client_id).first()
A query_token method accept two parameters, client_id and oauth_token:
def query_token(client_id, oauth_token):
return Token.query.filter_by(client_id=client_id, oauth_token=oauth_token).first()
And for exists_nonce, if using cache, we have a built-in hook to create this method:
from authlib.integrations.flask_oauth1 import create_exists_nonce_func
exists_nonce = create_exists_nonce_func(cache)
Then initialize the resource protector with those methods:
require_oauth = ResourceProtector(
app, query_client=query_client,
query_token=query_token, exists_nonce=exists_nonce,
)
Get client instance with the given client_id.
client_id – A string of client_id
Client instance
Fetch the token credential from data store like a database, framework should implement this function.
request – OAuth1Request instance
Token model instance
The nonce value MUST be unique across all requests with the same timestamp, client credentials, and token combinations.
nonce – A string value of oauth_nonce
request – OAuth1Request instance
Boolean
Routes protected by ResourceProtector can access current credential
with this variable.