5.0 KiB
Executable File
Upgrade Guide
General Notes
Upgrading To 10.0 From 9.x
Minimum PHP Version
PHP 7.3 is now the minimum required version.
Minimum Laravel Version
Laravel 8.0 is now the minimum required version.
Old Static Personal Client Methods Removed
PR: https://github.com/laravel/passport/pull/1325
The personal client configuration methods have been removed from the Passport class since they are no longer necessary. You should remove calls to these methods from your AuthServiceProvider.
Upgrading To 9.0 From 8.x
Support For Multiple Guards
PR: https://github.com/laravel/passport/pull/1220
Passport now has support for multiple guard user providers. Because of this change, you must add a provider column to the oauth_clients database table:
Schema::table('oauth_clients', function (Blueprint $table) {
$table->string('provider')->after('secret')->nullable();
});
If you have not previously published the Passport migrations, you should manually add the provider column to your database.
Client Credentials Secret Hashing
PR: https://github.com/laravel/passport/pull/1145
Client secrets may now be stored using a Bcrypt hash. However, before enabling this functionality, please consider the following. First, there is no way to reverse the hashing process once you have migrated your existing tokens. Secondly, when hashing client secrets, you will only have one opportunity to display the plain-text value to the user before it is hashed and stored in the database.
Personal Access Clients
Before you continue, you should set your personal access client ID and unhashed secret in your .env file:
PASSPORT_PERSONAL_ACCESS_CLIENT_ID=client-id-value
PASSPORT_PERSONAL_ACCESS_CLIENT_SECRET=unhashed-client-secret-value
Next, you should register these values by placing the following calls within the boot method of your AppServiceProvider:
Passport::personalAccessClientId(config('passport.personal_access_client.id'));
Passport::personalAccessClientSecret(config('passport.personal_access_client.secret'));
Make sure you follow the instructions above before hashing your secrets. Otherwise, irreversible data loss may occur.
Hashing Existing Secrets
You may enable client secret hashing by calling the Passport::hashClientSecrets() method within the boot method of your AppServiceProvider. For convenience, we've included a new Artisan command which you can run to hash all existing client secrets:
php artisan passport:hash
Again, please be aware that running this command cannot be undone. For extra precaution, you may wish to create a backup of your database before running the command.
Client Credentials Middleware Changes
PR: https://github.com/laravel/passport/pull/1132
After a lengthy debate, it was decided to revert the change made in a previous PR that introduced an exception when the client credentials middleware was used to authenticate first party clients.
Switch From getKey To getAuthIdentifier
PR: https://github.com/laravel/passport/pull/1134
Internally, Passport will now use the getAuthIdentifier method to determine a model's primary key. This is consistent with the framework and Laravel's first party libraries.
Remove Deprecated Functionality
PR: https://github.com/laravel/passport/pull/1235
The deprecated revokeOtherTokens and pruneRevokedTokens methods and the revokeOtherTokens and pruneRevokedTokens properties were removed from the Passport object.
Upgrading To 8.0 From 7.x
Minimum & Upgraded Versions
Commit: 97e3026790
The minimum Laravel version is now v6.0 and the minimum PHP version is now 7.2. The underlying league/oauth2-server has also been updated to v8.
Public Clients
PR: https://github.com/laravel/passport/pull/1065
Passport now supports public clients and PCKE. To leverage this feature, you should update the the secret column of the oauth_clients table to be nullable:
Schema::table('oauth_clients', function (Blueprint $table) {
$table->string('secret', 100)->nullable()->change();
});
Renderable Exceptions For OAuth Errors
PR: https://github.com/laravel/passport/pull/1066
OAuth exceptions can now be rendered. They will first be converted to Passport exceptions. If you are explicitly handling League\OAuth2\Server\Exception\OAuthServerException in your exception handler's report method you will now need to check for an instance of Laravel\Passport\Exceptions\OAuthServerException instead.
Fixed Credential Checking
PR: https://github.com/laravel/passport/pull/1040
In the previous versions of Passport, you could pass tokens granted by a different client type to the CheckClientCredential and CheckClientCredentialForAnyScope middleware. This behavior has been corrected and an exception will be thrown if you attempt to pass a token generated by a different client type.