README

Introduction 👋

This allows your Silverstripe site to be in OAuth 2.0 provider.

Please note that this is under development. It should work just fine, but has not been extensively tested, and is poorly documented.

It supports the following grants:

• Authorization code grant
• Refresh grant

⚠️ Upgrade Warning

Grant Type Validation

Grant type validation has been updated to strictly match the grant type stored in the Silverstripe CMS against the grant type sent in the request. Previously, these could differ without causing an error.

Action required: If you are upgrading from previous module version or upgrading to CMS version 6, you must ensure that the Grant Type value stored against each OAuth client in the CMS matches the grant type used in your access token requests (e.g. authorization_code, client_credentials). Mismatched values will now cause the token request to be rejected.

Requirements 🦺

• PHP ^8.1
• Silverstripe ^4.13

Installation 👷‍♀️

Install the add-on with Composer:

composer require iansimpson/ss-oauth2-server

Next, generate a private/public key pair:

openssl genrsa -out private.key 2048
openssl rsa -in private.key -pubout -out public.key
chmod 600 private.key
chmod 600 public.key

Put these on your web server, somewhere outside the web root

Generate encryption key:

php -r 'echo base64_encode(random_bytes(36)), PHP_EOL;'

Add the following lines in your .env, updating the OAUTH_PRIVATE_KEY_PATH and OAUTH_PUBLIC_KEY_PATH to point to the key files, and adding the encryption key you have just generated:

OAUTH_PRIVATE_KEY_PATH="/path/to/my/private.key"
OAUTH_PUBLIC_KEY_PATH="/path/to/my/public.key"
OAUTH_ENCRYPTION_KEY="my-encryption-key"

Finally, after doing a /dev/build/ go into your site settings and on the OAuth Configuration and add a new Client. Using this you should now be able to generate a key at /oauth/authorize, per the OAuth 2.0 spec (https://tools.ietf.org/html/rfc6749).

Usage 🏃🏃🏃

To verify the Authorization header being submitted is correct, add this to your Controller:

$member = IanSimpson\OAuth2\OauthServerController::getMember($this);

it will return a Member object if the Authorization header is correct, or null if there's an error. Simple!