Connect an email ID to your IIT KGP roll number!
Note: The public API can be accessed only by a few applications right now. If you would like to use the API, contact one of the maintainers on Metakgp Slack.
Endpoint: GET /get/{rollNumber}
Response:
application/json with the key email if this Roll number is authenticated
401 if you don't send the correct bearer token
404 if the roll number is not authenticated
Curl Verbose:
$ curl -vvv -H "Authorization: Bearer abcdefghijklmnopqrstuvwxyz" http://localhost:8080/get/12AB3456789
* Trying 127.0.0.1...
* Connected to localhost (127.0.0.1) port 8080 (#0)
> GET /get/12AB34567 HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.47.0
> Accept: */*
> Authorization: Bearer abcdefghijklmnopqrstuvwxyz
>
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Thu, 04 Jan 2018 10:08:58 GMT
< Content-Length: 41
<
* Connection #0 to host localhost left intact
{"email": "foobar@example.com"}Endpoint: POST /get with the header Content-Type: application/x-www-form-urlencoded
Response:
application/json with the key email if this Roll number is authenticated
401 if you don't send the correct bearer token
404 if the roll number is not authenticated
Curl Verbose:
$ curl -d 'roll=12AB3456789' -vvv -H "Authorization: Bearer abcdefghijklmnopqrstuvwxyz" http://localhost:8080/get
* Trying 127.0.0.1...
* Connected to localhost (127.0.0.1) port 8080 (#0)
> POST /get HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.47.0
> Accept: */*
> Authorization: Bearer abcdefghijklmnopqrstuvwxyz
> Content-Length: 14
> Content-Type: application/x-www-form-urlencoded
>
* upload completely sent off: 14 out of 14 bytes
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Thu, 04 Jan 2018 10:11:26 GMT
< Content-Length: 41
<
* Connection #0 to host localhost left intact
{"email": "foobar@example.com"}To run this locally:
$ go get github.com/icyflame/leprechaun
$ cd $GOPATH/github.com/icyflame/leprechaun
$ npm install -g gulp-cli
$ npm install
$ gulp
$ go build
$ cp .env.template .env
# populate .env with the appropriate values
$ PORT=8080 ./leprechaunYou need to have MongoDB, Node.js, npm, Golang and gulp installed.
To populate the .env file, you need an active Sendgrid account.
To push this to Heroku, run the build script. Note that this is run inside
Heroku under a GoLang buildpack. But before go build, we need to run gulp
and create all the HTML and Template assets. The build script takes care of
this. (It switches to a different branch, deletes dist/ from gitignore, runs
gulp, adds everything, commits, pushes to Heroku and then, switches back to
master)
Vikrant Varma posted the Idea document for Leprechaun to the Metakgp Slack on 3rd January, 2018.
Leprechaun was envisioned as an authentication service which will associate an email address to an IIT Kharagpur Roll Number, using proof-of-control over the ERP account. Since only students of IIT Kharagpur have active ERP IIT KGP accounts, this service can only be used by students of IIT Kharagpur.
This service ensures that students don't have to share their ERP credentials with any application where they would like to authenticate themselves as students of IIT Kharagpur.
The authentication flow goes like this:
- User visits Leprechaun and asserts their roll number and email address. The user is given a unique verification key and a unique link to visit.
- The user is shown a verification key which they must add to one of their secret question text. When they have completed this addition, they can visit the link provided to them in step 1.
- Leprechaun will make requests to ERP IIT KGP to check whether one of the secret questions tied to the user's roll number has the verification key in it's text.
- If step 3 is not successful, it tells the user to check their association.
- If step 3 is successful, Authentication Step 1 is now complete. The service has verified that the user has control over the roll number's ERP account. Now, a verification email is sent to the email address entered in step 1.
- The user visits their inbox and clicks on the link in this verification email.
- This leads them back to the service which will verify the token embedded in this verification link. If verified succesfully, Authentication Step 2 is complete! The roll number and email supplied by the user in step 1 are now associated in Leprechaun's DB
Services (like Metakgp Dashboard) can use Leprechaun using the Public API to find the email address that a supplied roll number is associated with. This email address can be used as a proxy for the user's roll number.
Leprechaun
n. a mischievous elf of Irish folklore usually believed to reveal the hiding place of treasure if caught
Search for the strings TODO and ENHANCE in the codebase.
Code licensed under MIT.
Metakgp 2018