Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stratedge/visa
A complimentary extension of the official Laravel Passport package.
https://github.com/stratedge/visa
laravel laravel-5-package laravel-passport oauth2 passport php php7
Last synced: about 17 hours ago
JSON representation
A complimentary extension of the official Laravel Passport package.
- Host: GitHub
- URL: https://github.com/stratedge/visa
- Owner: stratedge
- License: mit
- Created: 2018-11-15T23:12:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-03T01:19:23.000Z (almost 6 years ago)
- Last Synced: 2024-04-21T06:41:33.389Z (7 months ago)
- Topics: laravel, laravel-5-package, laravel-passport, oauth2, passport, php, php7
- Language: PHP
- Size: 85.9 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/stratedge/visa)
[](https://packagist.org/packages/stratedge/visa)
[](https://packagist.org/packages/stratedge/visa)
[](https://packagist.org/packages/stratedge/visa)
# Visa
A complimentary extension of the official Laravel Passport package.
Visa provides the following functionality:
* Use a random string for Client ID;
* Add configuration to use a UUID for Client ID instead of a random string;
* Provide the `CheckFirstPartyClient` middleware class to authenticate a client as a first party client;
* Add configuration to use the global Laravel error handler to handle errors thrown by Passport instead of Passport's built-in handler; and
* Provide overwrite-able `enableCustomGrants()` method in the service provider to make registering custom grants easier.
# Passport Compatability
While this library mostly adheres to semantic versioning, major version numbers are set to align to major versions for the Passport library. This simplifies determining which version of Visa includes which version of Passport.
| Visa Version | Configured Passport Version |
| ------------ | --------------------------- |
| 7.* | ^7.0 |
# Installation
Visa is registered with [Packagist](https://packagist.org) and can be installed with [Composer](https://getcomposer.org). Run the following on the command line:
```sh
composer require stratedge/visa
```
Since Visa _extends_ Passport, installing Visa will install Passport for you.
For versions of Laravel that support auto-registration of packages, Visa will automatically register itself. For older versions, be sure to add `Stratedge\Visa\VisaServiceProvider::class` to your list of service providers in `config/app.php`.
> No need to include Passport's service provider, the Visa provider extends it.
From here, complete all the typical [Passport installation steps](https://laravel.com/docs/master/passport#installation).
> **PLEASE NOTE:** See configuration below to ensure you complete any optional Visa configurations before running migrations to ensure columns are created with the correct types.
# Configuration
To configure core Passport features, refer to the [Passport documentation](https://laravel.com/docs/master/passport). Since Visa uses Passport, you're free to configure whatever you want from Passport.
## Using Random Strings for Client ID
By default Visa will use random 40-character strings for client IDs, the same as the client secrets. No configuration required.
## Using UUIDs for Client ID
Visa also supports UUIDs for client IDs, but must be configured to do so _before migrations are run_ so that the migrations specify the correct column type for `client_id`.
To use UUIDs, call `\Stratedge\Visa\Visa::enableClientUUIDs()` in the `boot()` method of your `AppServiceProvider`:
```php
\Stratedge\Visa\Http\Middleware\CheckFirstPartyClient::class,
];
```
The middleware can then be registered for any route or route group with the key `auth.first-party`. Any clients that are not considered first-party that attempt to authenticate with endpoints assigned the `CheckFirstPartyClient` middleware will fail with an authentication error.
## Error Handling
By default, Visa will use the built-in Passport error handler that will catch and respond to errors automatically. If you wish to disable the built-in handler and use the global Laravel error handler to control the logging and output of errors, call `\Stratedge\Visa\Visa::disablePassportErrorHandling()` in the `boot()` method of your `AppServiceProvider`:
```php
enableGrantType(/* Register custom grant here */);
}
}
```
> **PLEASE NOTE:** When extending the service provider, be sure to register your custom `VisaServiceProvider` in the `app.php` configuration file and turn off the auto-discovery of the default provider provided by this library through your `composer.json` file.
# Extension Philosophy
Because Passport is an authorization library, integrating security patches quickly is immensely important. Unlike a fork, which creates a separately maintained version of the entire Passport library, Visa is a complimentary package that sits alongside the core Passport in your project. In that sense Visa extends Passport and makes only the smallest required changes.
In fact, when Visa is installed it will automatically require Passport. But since Passport remains a separate library, the developer is free to specify the version of Passport they wish to use. This allows the developer to take advantage of incremental security updates in Passport without requiring corresponding changes to Visa. So long as the newest version of Passport makes no breaking API changes, changing the Passport version should work just fine.