Web and Mobile Development: OAuth Receiver (100 Points)

Assignment Goals

The goals of this assignment are:
  1. To implement the OAuth protocol with a node.js receiver

The Assignment

If (and only if) you are using GitHub to submit, you can clone this assignment from GitHub Classroom at https://classroom.github.com/a/epgvwhOa. Otherwise, you may skip this step!

In this lab, you will connect to a service using OAuth and obtain a key [1]. We will implement a proper online OAuth protocol, such that a node.js web service will receive the callback from the service provider to parse the token for the user. We will use Github in this example, but you may substitute any service provider you choose (as long as it offers a 3-Legged OAuth option with a callback).

Part 1: Allowing the User to Log In

Direct the user to the github page at https://github.com/login/oauth/authorize?client_id=<CLIENT ID>&redirect_uri=http://<YOUR REPL.IT PROJECT URL>/oauth/redirect&state=<RANDOM STRING>

You can generate a Client ID and Client Secret for your application at the Github Developer page.

Part 2: Intercepting the OAuth Callback Redirection

Deploy a repl.it project in node.js that uses express to capture a call to /oauth/redirect (which will be invoked automatically by OAuth redirection step above).

The HTTP request will contain a query parameter called code that you can extract. You will also receive the state string that you originally passed - this should equal your original string. In the handler for this endpoint, use the code to make a POST request to:

https://github.com/login/oauth/access_token?client_id=<CLIENT ID>&client_secret=<CLIENT SECRET>&code=<CODE>

with a header: accept: application/json.

The response to this request will contain a body parameter called access_token. This is the user’s access token to utilize the Github API on their behalf.

You can pass a user ID back to the user, to which you associate the corresponding access_token in a secure data store. Ideally, this would be encrypted. If the token should fail at some point due to expiration (or if a token doesn’t exist for this user), you could automatically trigger the OAuth process again.

Part 3: Accessing the Github User’s Information

Perform a GET request to https://api.github.com/user with header: Authorization: token <ACCESS TOKEN> to test that the OAuth protocol you implemented successfully authenticated the user. You could use this account information as the basis of your own app authentication, avoiding the need to store a password for the user.

  1. https://www.sohamkamani.com/blog/javascript/2018-06-24-oauth-with-node-js/ ↩

Submission

In your submission, please include answers to any questions asked on the assignment page in your README file. If you wrote code as part of this assignment, please describe your design, approach, and implementation in your README file as well. Finally, include answers to the following questions:
  • Describe what you did, how you did it, what challenges you encountered, and how you solved them.
  • Please answer any questions found throughout the narrative of this assignment.
  • If collaboration with a buddy was permitted, did you work with a buddy on this assignment? If so, who? If not, do you certify that this submission represents your own original work?
  • Please identify any and all portions of your submission that were not originally written by you (for example, code originally written by your buddy, or anything taken or adapted from a non-classroom resource). It is always OK to use your textbook and instructor notes; however, you are certifying that any portions not designated as coming from an outside person or source are your own original work.
  • Approximately how many hours it took you to finish this assignment (I will not judge you for this at all...I am simply using it to gauge if the assignments are too easy or hard)?
  • Your overall impression of the assignment. Did you love it, hate it, or were you neutral? One word answers are fine, but if you have any suggestions for the future let me know.
  • Using the grading specifications on this page, discuss briefly the grade you would give yourself and why. Discuss each item in the grading specification.
  • Any other concerns that you have. For instance, if you have a bug that you were unable to solve but you made progress, write that here. The more you articulate the problem the more partial credit you will receive (it is fine to leave this blank).

Assignment Rubric

Description Pre-Emerging (< 50%) Beginning (50%) Progressing (85%) Proficient (100%)
Algorithm Implementation (50%) The algorithm fails on the test inputs due to major issues, or the program fails to compile and/or run The algorithm fails on the test inputs due to one or more minor issues The algorithm is implemented to solve the problem correctly according to given test inputs, but would fail if executed in a general case due to a minor issue or omission in the algorithm design or implementation A reasonable algorithm is implemented to solve the problem which correctly solves the problem according to the given test inputs, and would be reasonably expected to solve the problem in the general case
Code Quality and Documentation (40%) Code commenting and structure are absent, or code structure departs significantly from best practice, and/or the code departs significantly from the style guide Code commenting and structure is limited in ways that reduce the readability of the program, and/or there are minor departures from the style guide Code documentation is present that re-states the explicit code definitions, and/or code is written that mostly adheres to the style guide Code is documented at non-trivial points in a manner that enhances the readability of the program, and code is written according to the style guide
Writeup and Submission (10%) An incomplete submission is provided The program is submitted, but not according to the directions in one or more ways (for example, because it is lacking a readme writeup) The program is submitted according to the directions with a minor omission or correction needed The program is submitted according to the directions, including a readme writeup describing the solution

Please refer to the Style Guide for code quality examples and guidelines.