This project is no longer maintained.
github-callback
GitHub authorization helper, built with Scotty. Intended to supply the callback URL for the authorization code flow.
Usage
Listens for HTTP GET requests. All requests are forwarded to the GitHub /login/oauth/access_token endpoint.
If an incoming request includes an authorization code, the helper requests an access token. If an access token is granted, the helper redirects the user to the target URL, with additional access_token and scope parameters.
On failure, the user is also redirected to the target URL, with an error parameter.
The state parameter is included both on success and on failure, if it was supplied with the authorization code request.
To help distinguish requests made to the target URL, vendor=github is always included.
| Query parameter | Description |
|---|---|
access_token |
Access token. Included on success. |
scope |
Comma-separated list of scopes. Included on success. |
error |
Either no_code or no_token. Included on failure. |
state |
Arbitrary string. Optional. |
vendor |
Always github. |
Configuration
Authentication credentials and defaults can be configured by setting environment variables.
TLS is used if server.key and server.crt are found in the run-time data files directory.
| Environment variable | Description |
|---|---|
GITHUB_CLIENT_ID |
Application identifier. Required. |
GITHUB_CLIENT_SECRET |
Authentication token. Required. |
CALLBACK_URL |
Helper’s own URL. Required. |
TARGET_URL |
URL to which the user is redirected. Required. |
PORT |
HTTP listening port. Defaults to 8080. |
Deployment
Installs in seconds on most Linux and OS X machines, using Halcyon.
$ halcyon install https://github.com/mietek/github-callback
$ export GITHUB_CLIENT_ID=…
$ export GITHUB_CLIENT_SECRET=…
$ export CALLBACK_URL=…
$ export TARGET_URL=…
$ github-callback
Deploying to Heroku
Ready to deploy in one click to the Heroku web application platform, using Haskell on Heroku.
Clicking the button is equivalent to executing the following commands:
$ git clone https://github.com/mietek/github-callback
$ cd github-callback
$ heroku create -b https://github.com/mietek/haskell-on-heroku
$ heroku config:set GITHUB_CLIENT_ID=…
$ heroku config:set GITHUB_CLIENT_SECRET=…
$ heroku config:set CALLBACK_URL=…
$ heroku config:set TARGET_URL=…
$ git push heroku master
$ heroku ps:scale web=1
$ heroku open
About
Made by Miëtek Bak. Published under the BSD license.