jwelmac/bit6-token-generator-php

Token generator for Bit6 external authentication

Bit6 Token Generator for PHP

A PHP package demonstrating the use of delegated authentication in Bit6., _(*1)

Prerequisites

• Get the API Key and Secret at Bit6 Dashboard.

Install via Composer

To incorporate into your current project simply run:, _(*2)

$ composer.phar require bit6/bit6-token-generator-php

Generating Tokens

• Create token generator:

// Ideally pull variables by parsing ini file or from env
$apiKey = 'API_KEY';  
$apiSecret = 'API_SECRET';

// Create new TokenGenerator
$bit6_tg = new Bit6\TokenGenerator($apiKey, $apiSecret);

• Get identities from your app following internal authentication., _(*3)

• Generate token using one of the following options:, _(*4)

Option 1: Using a string to represent an identity URI, _(*5)

$identities = "mailto:user@test.com";

// Generate token
$token = $bit6_tg->createToken($identities);

Option 2: Using an indexed array of identity URIs, _(*6)

$identities = array("usr:john123", "tel:12345678901");

// Generate token
$token = $bit6_tg->createToken($identities);

Option 3: Using an associative array of options, _(*7)

$options = array(
  "identities" => array("usr:john123", "mailto:user@test.com"),
  "issued" => 1468709885,
  "expires" => 1468796285
);

// Generate token
$token = $bit6_tg->createToken($options);

Create Token Options

The createToken method can be called with an associative array with the following keys: * identities (required) - A string or array of strings of identity URIs as shown below. When an array is used the first value becomes the primary identity., _(*8)

• issued (optional) - The unix timestamp at which token was generated (default - current system time)
• expires (optional) - The unix timestamp at which the token will expire (default - 10 minutes from time of creation)

Authentication

Pass the token to browser using your preferred method eg. via JSON response, url or inline-script., _(*9)

Authenticate user in javascript (after loading bit6.min.js) as shown below:, _(*10)

  // Authenticate with external token
  b6.session.external(token, function(err) {
    if (err) {
      // Houston we have a problem!
      console.log('Token login error', err);
    }
    else {
      // Code to run post authentication
      console.log('Token login successful');
    }
  });
</script>

Using example code

Running Locally

$ git clone git@github.com:bit6/bit6-token-generator-php.git
$ cd bit6-token-generator-php
$ composer update

Specify your Bit6 API key and secret using environment variables or a local .env config file. The file should contain two lines:, _(*11)

BIT6_API_KEY=abc
BIT6_API_SECRET=xyz

Start the application, _(*12)

$ php -S localhost:5000 -t example/
# Alternatively run:
# heroku local

Your app should now be running on localhost:5000., _(*13)

Deploying to Heroku

Make sure you have the Heroku Toolbelt installed., _(*14)

$ heroku create
$ git push heroku master

or, _(*15)

, _(*16)

Set Bit6 API key and secret:, _(*17)

$ heroku config:set BIT6_API_KEY=abc
$ heroku config:set BIT6_API_SECRET=xyz

Generating a Token

You would normally generate an external token by doing a POST from your app client to your application server. To simulate this using curl:, _(*18)

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{"identities": ["usr:john","tel:+12123331234"]}' \
    http://localhost:5000/auth.php

The response should be a JSON object:, _(*19)

{
    "ext_token": "..."
}

Documentation

For more information about using PHP on Heroku, see these Dev Center articles:, _(*20)

• Getting Started with PHP on Heroku