exeba/simplesamlphp-module-oauth2

A SimpleSAMLphp module adding support for the OAuth2 protocol.

4.0.1 2024-04-16 08:30 UTC

Requires

• php: >=7.1
• ext-json: *
• ext-pdo: *
• doctrine/orm: ^2.10
• laminas/laminas-diactoros: ^2.4
• league/oauth2-server: ^8.1
• nette/forms: ~3.0
• psr/http-server-middleware: ^1.0
• simplesamlphp/composer-module-installer: ~1.0
• symfony/psr-http-message-bridge: ^2.0

Requires (Dev)

• dama/doctrine-test-bundle: ^7.1
• doctrine/data-fixtures: ^1.5
• phpunit/phpunit: ^9.0
• simplesamlphp/simplesamlphp: ^2.0.0

MIT

• Sergio Gómez
• Sebastiano Degan

• oauth2

README

Installation

This package add support for the OAuth2 protocol through a SimpleSAMLphp module installable through Composer. Installation can be as easy as executing:

composer.phar require exeba/simplesamlphp-module-oauth2 ~3.0

Configuration

Configure the module

Copy the template file to the config directory:

cp modules/oauth2/config-template/module_oauth2.php config/

and edit it. The options are self explained.

Create or the schema

The schema is maintaned using doctrine command line tool located at

path/to/simplesaml/modules/oauth2/bin/doctrine

Create oauth2 clients

To add and remove Oauth2 clients, you need to logon on simplesaml with an admin account. Open the Federation tab and you will see the OAuth2 Client Registry option.

You can specify as many redirect address as you want.

Using the module

This module is based on Oauth2 Server from the PHP League and supports the following grants:

• Authorization code grant
• Client credentials grant
• Refresh grant

Create the oauth2 keys:

The oauth2 library used generates Json Web Tokens to create the Access Tokens, so you need to create a public and private cert keys:

To generate the private key run this command on the terminal:

openssl genrsa -out cert/oauth2_module.pem 1024

If you want to provide a passphrase for your private key run this command instead:

openssl genrsa -passout pass:_passphrase_ -out cert/oauth2_module.pem 1024

then extract the public key from the private key:

openssl rsa -in cert/oauth2_module.pem -pubout -out cert/oauth2_module.crt

or use your passphrase if provided on private key generation:

openssl rsa -in cert/oauth2_module.pem -passin pass:_passphrase_ -pubout -out cert/oauth2_module.crt

If you use a passphrase remember to configure it in the module_oauth2.php config file.

Endpoints

• Authorization Endpoint: {{baseurlpath}}/module.php/oauth2/authorize
• Token Endpoint: {{baseurlpath}}/module.php/oauth2/access_token
• Token Introspection Endpoint: {{baseurlpath}}/module.php/oauth2/userinfo