Skip to content

Latest commit

 

History

History
224 lines (151 loc) · 7.68 KB

README.md

File metadata and controls

224 lines (151 loc) · 7.68 KB
Raw

Adgangsplatformen Provider for OAuth 2.0 Client

codecov

This package provides OAuth 2.0 for accessing Adgangsplatformen currently running at https://login.bib.dk/ - a single sign-on solution for public libraries in Denmark. It is based on the PHP League's OAuth 2.0 Client.

Usage

To use the provider first of all you need to obtain a client id and secret from your library partner or directly from DBC, the company responsible for running Adgangsplatfomen.

To install this package use Composer:

composer require danskernesdigitalebibliotek/oauth2-adgangsplatformen

The package contains several elements:

  1. OAuth 2.0 provider
  2. Middleware for mapping server requests to users
  3. Integration with Laravel and Lumen
  4. CLI application for demonstration and debugging

OAuth 2.0 provider

You can use the provider to obtain an access token and information about a library patron:

$provider = new Adgangsplatformen\Provider\Adgangsplatformen([
    'clientId'     => '{client-id}',
    'clientSecret' => '{client-secret}',
]);
$accessToken = $provider->getAccessToken('password', [
    'username' => '{patron-id}',
    'password' => '{patron-password}',
    'agency' => '{library-id}'
]);
$patron = $provider->getResourceOwner($accessToken);

Note: The provider has currently only been tested with password grants. Other types of grant may or may not work.

PSR-15 middleware

The package also includes PSR-15 compliant middleware which can be used to map requests containing an OAuth 2.0 compliant Authentication header containing the value "Bearer {access-token}" to the corresponding patron. Otherwise an error response is returned.

Consuming the middleware depends on the framework used.

In Zend Expressive the following would work:

$app->post('/api/foo', [
    new TokenResourceOwnerMapper($provider)
]);

Laravel/Lumen integration

The package includes a service provider which can be registered to use the middleware in a Laravel or Lumen application.

The use the service provider:

In the environment or in .env define how Adgangsplatform is accessed.

# Use testing to no contact Adgangsplatformen and instead map tokens
# to resource owners with the same id.
# ADGANGSPLATFORMEN_DRIVER=testing
ADGANGSPLATFORMEN_DRIVER=production
ADGANGSPLATFORMEN_CLIENT_ID={client-id}
ADGANGSPLATFORMEN_CLIENT_SECRET={client-secret}

In app.php register the service provider:

$app->register(\Adgangsplatformen\Support\Illuminate\AdgangsplatformenServiceProvider::class);

In routes.php add routes to the auth middleware group:

$router->group(['middleware' => 'auth'], function () use ($router) {
    $router->get('/list/{listId}', 'ListController@get');
    // More routes here.
});

In controller implementations retrieve the resource owner matching the access token:

class ListController extends \Laravel\Lumen\Routing\Controller
{
    public function get(Request $request, string $listId)
    {
        /* @var \Adgangsplatformen\Provider\AdgangsplatformenUser $user */
        $user = $request->user();
        // Do something...
    }
}

CLI application

The package includes a CLI application which can be used to demo the provider and inspect client-server communication.

To use the application you have to have the suggested dependencies installed as well:

composer require mnapoli/silly-php-di rtheunissen/guzzle-log-middleware vlucas/phpdotenv

Run the application to show the list of available commands:

vendor/bin/adgangsplatformen list

As an example show an access token for a user:

CLIENT_ID={client-id} CLIENT_SECRET={client-secret} AGENCY={library-agency} USERNAME={patron-username} PASSWORD={patron-password} vendor/bin/adgangsplatformen token

Instead of including them in the command environment variables can also be set in the environment or defined in a .env file containing one or more of the values:

CLIENT_ID={client-id}
CLIENT_SECRET={client-secret}
AGENCY={library-agency}
USERNAME={patron-username}
PASSWORD={patron-password}

To see the actual requests and responses sent between the application and Adgangsplatformen add the -v option:

vendor/bin/adgangsplatformen token -v

Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

The library uses the Composer package manager and all requirements to setup a development environment are defined in the composer.json package specification.

Key requirements are:

  1. PHP 7.2 or newer compiled with JSON support
  2. Composer

Installing

To get a depeloment environment up and running follow these steps:

1: Clone the repository

git clone https://github.com/danskernesdigitalebibliotek/oauth2-adgangsplatformen

2: Install third-party dependencies including developer dependencies

composer install

If you have obtained a client id and secret and have authentication information for a patron you can test the provider by using the CLI application:

CLIENT_ID={client-id} \
CLIENT_SECRET={client-secret} \
AGENCY={library-agency} \
USERNAME={patron-username} \
PASSWORD={patron-password} bin/adgangsplatformen token

Note that the binary is located in bin and not in vendor/bin when you are working directly with the package.

Code quality

To maintain a consistent functional codebase the project uses unit tests and static code analysis.

The codebase is automatically tested using GitHub Actions.

Unit tests

Unit tests are located under tests and developed using PHPUnit.

Developers can run the test suite locally:

vendor/bin/phpunit

The project aims to maintain a high level of code coverage.

Code consistency

The code is analysed using static code analysis tools to maintain a high level of consistency.

The project follows the PSR-2 code style and the most strict rule level set by PHPStan.

Code standard compliance is checked using PHP_Codesniffer. Developer can run the tool locally:

vendor/bin/phpcs

Developers can run PHPStan locally:

vendor/bin/phpstan

License

Copyright (C) 2019 Danskernes Digitale Bibliotek (DDB)

This project is licensed under the GNU Affero General Public License - see the LICENSE.md file for details