Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chadicus/slim-oauth2-routes

OAuth2 routes for use within a Slim Framework API
https://github.com/chadicus/slim-oauth2-routes

Last synced: 4 days ago
JSON representation

OAuth2 routes for use within a Slim Framework API

Awesome Lists containing this project

README 

        
# Chadicus\Slim\OAuth2\Routes



[![Build Status](https://travis-ci.org/chadicus/slim-oauth2-routes.svg?branch=master)](https://travis-ci.org/chadicus/slim-oauth2-routes)

[![Code Quality](https://scrutinizer-ci.com/g/chadicus/slim-oauth2-routes/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/chadicus/slim-oauth2-routes/?branch=master)

[![Code Coverage](https://coveralls.io/repos/github/chadicus/slim-oauth2-routes/badge.svg?branch=master)](https://coveralls.io/github/chadicus/slim-oauth2-routes?branch=master)



[![Latest Stable Version](https://poser.pugx.org/chadicus/slim-oauth2-routes/v/stable)](https://packagist.org/packages/chadicus/slim-oauth2-routes)

[![Latest Unstable Version](https://poser.pugx.org/chadicus/slim-oauth2-routes/v/unstable)](https://packagist.org/packages/chadicus/slim-oauth2-routes)

[![License](https://poser.pugx.org/chadicus/slim-oauth2-routes/license)](https://packagist.org/packages/chadicus/slim-oauth2-routes)



[![Total Downloads](https://poser.pugx.org/chadicus/slim-oauth2-routes/downloads)](https://packagist.org/packages/chadicus/slim-oauth2-routes)

[![Daily Downloads](https://poser.pugx.org/chadicus/slim-oauth2-routes/d/daily)](https://packagist.org/packages/chadicus/slim-oauth2-routes)

[![Monthly Downloads](https://poser.pugx.org/chadicus/slim-oauth2-routes/d/monthly)](https://packagist.org/packages/chadicus/slim-oauth2-routes)



[![Documentation](https://img.shields.io/badge/reference-phpdoc-blue.svg?style=flat)](http://pholiophp.org/chadicus/slim-oauth2-routes)



[OAuth2 Server](http://bshaffer.github.io/oauth2-server-php-docs/) route callbacks for use within a [Slim 3 Framework](http://www.slimframework.com/) API



## Requirements



Chadicus\Slim\OAuth2\Routes requires PHP 5.6 (or later).



## Composer

To add the library as a local, per-project dependency use [Composer](http://getcomposer.org)! Simply add a dependency on

`chadicus/slim-oauth2-routes` to your project's `composer.json` file such as:



```sh

composer require chadicus/slim-oauth2-routes

```



## Contact

Developers may be contacted at:



 * [Pull Requests](https://github.com/chadicus/slim-oauth2-routes/pulls)

 * [Issues](https://github.com/chadicus/slim-oauth2-routes/issues)



## Project Build

With a checkout of the code get [Composer](http://getcomposer.org) in your PATH and run:



```sh

./composer install

./vendor/bin/phpunit

```



## A Note on Using Views

The `authorize` and `receive-code` route require `view` objects. The given view object must implement a render method such as the one found in [slim/twig-view](https://github.com/slimphp/Twig-View/blob/master/src/Twig.php#L103) and [slim/php-view](https://github.com/slimphp/PHP-View/blob/master/src/PhpRenderer.php#L64). It would be best if there was a common `ViewInterface` which both implementing but as of now such an interface does not exist.



## Community

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/slim-oauth2/Lobby#)



## Example Usage

```php

use Chadicus\Slim\OAuth2\Routes;

use OAuth2;

use OAuth2\GrantType;

use OAuth2\Storage;

use Slim;

use Slim\Views;



//Set-up the OAuth2 Server

$storage = new Storage\Pdo(array('dsn' => $dsn, 'username' => $username, 'password' => $password));

$server = new OAuth2\Server($storage);

$server->addGrantType(new GrantType\AuthorizationCode($storage));

$server->addGrantType(new GrantType\ClientCredentials($storage));



//Set-up the Slim Application

$app = new Slim\App(

    [

        'view' => new Views\PhpRenderer('/path/to/chadicus/slim-oauth2-routes/templates'),

    ]

);



$container = $app->getContainer();



$app->map(['GET', 'POST'], Routes\Authorize::ROUTE, new Routes\Authorize($server, $container['view']))->setName('authorize');

$app->post(Routes\Token::ROUTE, new Routes\Token($server))->setName('token');

$app->map(['GET', 'POST'], Routes\ReceiveCode::ROUTE, new Routes\ReceiveCode($container['view']))->setName('receive-code');

$app->post(Routes\Revoke::ROUTE, new Routes\Revoke($server))->setName('revoke');



//Add custom routes

$slim->get('/foo', function($request, $response, $args) {

    $authorization = $request->getHeaderLine('Authorization');



    //validate access token against your storage



    return $response->withStatus(200);

});



//run the app

$app->run();

```

## Authorize and The UserIdProvider

Within the Authorization route, you can define a  `UserIdProviderInterface` to extract the user_id from the incoming request. By default the

route will look in the `GET` query params.



```php



class ArgumentUserIdProvider implements UserIdProviderInterface

{

	public function getUserId(ServerRequestInterface $request, array $arguments)

	{

		return isset($arguments['user_id']) ? $arguments['user_id'] : null;

	}

}



//middleware to add user_id to route parameters

$loginMiddelware = function ($request, $response, $next) {

	// Validate the user credentials

	$userId = MyUserService::getUserIdIfValidCredentials($request);

	if ($userId === false) {

		return $response->withStatus(303);

	}



	//Put user_id into the route parameters

	$route = $request->getAttribute('route');

	$route->setArgument('user_id', $userId);



	//Credentials are valid, continue so the authorization code can be sent to the clients callback_uri

	return $next($request, $response);

};



$authorizeRoute = new Routes\Authorize($server, $view, 'authorize.phtml', new ArgumentUserIdProvider());

$app->map(

	['GET', 'POST'],

	Routes\Authorize::ROUTE,

	$authorizeRoute

)->add($loginMiddleware)->setName('authorize');

```