oauth2-server/upgrade-guide.md

layout	title	permalink
default	Upgrade Guide	/upgrade-guide/

Upgrade Guide

6.x.x → 7.x.x

Version 7.x.x requires PHP 7.0.0 or higher. This version is not backwards compatible with version 6.x.x of the library.

The interface for getClientEntity() in the clientRepositoryInterface has changed. The $grantType argument must now default to null.

  public function getClientEntity(
      $clientIdentifier, 
-     $grantType,
+     $grantType = null,
      $clientSecret = null, 
      $mustValidateSecret = true
  );

Please see the changelog for a complete list of all changes.

5.1.x → 6.x.x

Version 6.x.x is not backwards compatible with version 5.1.x but only requires you to make one line of code change:

  $server = new AuthorizationServer(
      $clientRepository,
      $accessTokenRepository,
      $scopeRepository,
      $privateKeyPath,
+     'lxZFUEsBCJ2Yb14IF2ygAHI5N4+ZAUXXaSeeJm6+twsUmIen'
-      $publicKeyPath
  );

All you need to do is replace the public key that was being passed into the constructor of AuthorizationServer with a 32 bit encryption key.

To generate an encryption key for the AuthorizationServer run the following command in the terminal:

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