bedrockstreaming/gatekeeper

Enables client-side applications to dance OAuth with GitHub.

Gatekeeper

Because of some security-related limitations, Github prevents you from implementing the OAuth Web Application Flow on a client-side only application.

This is a real bummer. So we built Gatekeeper, which is the missing piece you need in order to make it work.

Gatekeeper works well with Github.js, which helps you accessing the Github API from the browser.

API

GET http://localhost:9999/authenticate/CLIENT_ID/TEMPORARY_CODE

OAuth Steps

Also see the documentation on Github.

1. Redirect users to request GitHub access.

   GET https://github.com/login/oauth/authorize
   

2. GitHub redirects back to your site including a temporary code you need for the next step.

   You can grab it like so:

   var code = window.location.href.match(/\?code=(.*)/)[1];

3. Request the actual token using your instance of Gatekeeper, which knows your client_secret.

   $.getJSON('http://localhost:9999/authenticate/'+clientId+'/'+code, function(data) {
     console.log(data.token);
   });

Setup your Gatekeeper

1. Clone it

   git clone [email protected]:prose/gatekeeper.git
   

2. Install Dependencies

   cd gatekeeper && npm install
   

3. Adjust config.json

    {
      "port": 9999,
      "apps": [
        {
          "oauth_client_id": "GITHUB_APPLICATION_CLIENT_ID",
          "oauth_client_secret": "GITHUB_APPLICATION_CLIENT_SECRET",
          "oauth_host": "github.enterprise.fr",
          "oauth_port": 443,
          "oauth_path": "/login/oauth/access_token",
          "oauth_method": "POST"
        },
        {
          "oauth_client_id": "GITHUB_APPLICATION_CLIENT_ID",
          "oauth_client_secret": "GITHUB_APPLICATION_CLIENT_SECRET",
          "oauth_host": "github.com",
          "oauth_port": 443,
          "oauth_path": "/login/oauth/access_token",
          "oauth_method": "POST"
        }
      ]
    }

4. Serve it

   $ node server.js
   

Deploy on Heroku

Heroku Button

Use the button below to instantly setup your own Gatekeeper instance on Heroku.

Heroku manually

1. Create a new Heroku app

   heroku apps:create APP_NAME
   

2. Adjust config.json

3. Push changes to heroku

   git push heroku master
   

##Deploy on Azure

Azure Button

Use the button below to instantly setup your own Gatekeeper instance on Azure.

Azure manually

1. Create a new Azure site

   azure site create SITE_NAME --git
   

2. Adjust config.json

3. Push changes to Azure

   git push azure master