xinix-technology/bono-auth

Bono Auth

Tuesday, March 7, 2017
by reekoheek
Repository
1 Watchers
1 Stars
580 Installations

PHP
0 Dependents
0 Suggesters
3 Forks
0 Open issues
19 Versions
5 % Grown

The README.md

bono-auth

Your solution to use authorization and authentication with Bono Framework., _(*1)

Setup

To use bono-auth you have to setup bono using bono-auth middleware in config.php., _(*2)

'bono.middlewares' => array(
  '\\Xinix\\BonoAuth\\Middleware\\AuthMiddleware' => array(
    ...
  ),
),

bono-auth has two drivers to use, each will have distinct configuration:, _(*3)

Xinix\BonoAuth\Driver\NormAuth

'bono.middlewares' => array(
  '\\Xinix\\BonoAuth\\Middleware\\AuthMiddleware' => array(
    'driver' => '\\Xinix\\BonoAuth\\Driver\\NormAuth'
  ),
),

Xinix\BonoAuth\Driver\OAuth

'bono.middlewares' => array(
  '\\Xinix\\BonoAuth\\Middleware\\AuthMiddleware' => array(
    'driver' => '\\Xinix\\BonoAuth\\Driver\\OAuth',
    'debug' => true, // enable or disable debug
    'baseUrl' => 'http://to.your.oauth.provider',
    'authUrl' => '/oauth/auth', // URI to access auth
    'tokenUrl' => '/oauth/token', // URI to get token
    'revokeUrl' => '/oauth/revoke', // URI to revoke auth
    'clientId' => '*the client id*',
    'clientSecret' => '*the client secret*',
    'redirectUri' => \Bono\Helper\URL::site('/login'), // application redirect url
    'scope' => 'user',
  ),
),

Above configuration will enable default bono-auth. The default value will prevent guest to access to every pages accessed. And after user get login, he will be able to access every pages available., _(*4)

Authorization

To authorize/deauthorize specific pages, you have to write codes to register filter "auth.authorize" that run before the middleware invoked by system. Usually you can put this codes in provider file. The codes will be in this following form:, _(*5)

$app->filter('auth.authorize', function ($options) {
  // something to do
  return $allowed;
});

Return value

If the return value will be the one of the following conditions: - True (bool), url is authorized - False (bool), url is not authorized - (original argument), bono-auth will decide authorization for you, the default is logined user authorize to access and guest user is not authorized, _(*6)

Arguments

The filter will accept single argument $options. As the nature of Bono Filter, the $options will be return value of previous ran of the same context name function. The first time value of $options will be the URI string (or assoc array contains URI string)., _(*7)

If the $options is_bool, it means one of previous filter functions already handle the URI, you can skip the current filter function by adding if-statement., _(*8)

$app->filter('auth.authorize', function ($options) {
  if (is_bool($options)) {
    return $options;
  }
  // something to do
});

The Versions

07/03 2017

v2.x-dev

2.9999999.9999999.9999999-dev

Bono Auth

library bono-auth

Bono Auth

xinix-technology/bono-auth

The README.md

bono-auth

Setup

Xinix\BonoAuth\Driver\NormAuth

Xinix\BonoAuth\Driver\OAuth

Authorization

Return value

Arguments

The Versions

v2.x-dev

The Requires

The Development Requires

by Ganesha

2.0.2

The Requires

The Development Requires

by Ganesha

2.0.1

The Requires

The Development Requires

by Ganesha

2.0.0

The Requires

The Development Requires

by Ganesha

dev-master

The Requires

by Ganesha

1.0.2

The Requires

by Ganesha

0.2.2

The Requires

by Ganesha

1.0.0

The Requires

by Ganesha

1.0.1

The Requires

by Ganesha

0.2.1

The Requires

by Ganesha

0.2.0

The Requires

by Ganesha

0.1.6

The Requires

by Ganesha

0.1.5

The Requires

by Ganesha

0.1.4

The Requires

by Ganesha

0.1.3

The Requires

by Ganesha

0.1.1

The Requires

by Ganesha

0.1.2

The Requires

by Ganesha

0.0.1

The Requires

by Ganesha

0.1.0

The Requires

by Ganesha