Skip to content

UniversityofWarwick/python-warwick-sso-oauth-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Introduction

Simple self-contained Flask application which uses requests_oauthlib and Warwick's OAuth support in single-sign on.

Demonstrates how to log users in, retrieve basic attributes and fetch information from a Warwick application (in this case, from Tabula).

Usage:

Fill in your consumer key and secret within main.py. You can request these from the web development team. This code assumes you're using a shared consumer secret (HMAC-SHA1), so don't provide a certificate.

Run the app: python3 main.py

To get started, visit: http://127.0.0.1:8091/oauth/begin

Click the grant access button, you'll be redirected back to receive a UUID from the Flask app. The UUID is tied to the access token/secret. In this example repository they're just stored in a Python dictionary. In a real app you'd use a database.

For example, say the UUID is 1b49ee4e-16de-11ea-8625-00d86136d1aa, substitute it into the UUID parameter in the URLs below:

Now, visit:

http://localhost:8091/oauth/userInfo?uuid=1b49ee4e-16de-11ea-8625-00d86136d1aa

This will give you user information from single-sign on.

http://localhost:8091/oauth/tabula/events/?uuid=1b49ee4e-16de-11ea-8625-00d86136d1aa

This might show you some events from your Tabula timetable (if you have any).

Another example, fetching assignments:

http://localhost:8091/oauth/tabula/assignments/?uuid=1b49ee4e-16de-11ea-8625-00d86136d1aa

Logging/debugging

You can get some useful debugging information from the requests_oauthlib which will help you even if you don't plan to implement OAuth 1 using Python. It will show the signature base strings, the normalized URIs, the requests made to single sign-on etc.

--- a/main.py
+++ b/main.py
@@ -2,7 +2,7 @@ import json
 import urllib
 import urllib.parse
 import uuid
-
+import logging
 from flask import Flask, redirect, jsonify, request, Response
 from oauthlib.oauth1 import SIGNATURE_HMAC, SIGNATURE_TYPE_AUTH_HEADER, Client
 from requests_oauthlib import OAuth1Session
@@ -137,4 +137,5 @@ def _get_oauth_session_for_request():
     return oauth
 
 if __name__ == "__main__":
+    logging.basicConfig(level=logging.DEBUG)
     app.run(host="0.0.0.0", port=8091, debug=False)

Releases

No releases published

Packages

No packages published

Languages