Download the PHP package notwes/laravel-uls without Composer
On this page you can find all versions of the php package notwes/laravel-uls. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-uls
VATUSA ULS Handling for Laravel 5.x
About
Provides a wrapper around the web-token libraries for use with VATUSA's Unified Login Scheme.
Installation
-
Require the
vatusa/laravel-uls
package in yourcomposer.json
and update your dependencies: - Generate the configuration file
Configuration
The defaults are set in config/uls.php
. Copy this file to your own config directory to modify the values. You can publish the config using this command:
Lumen
On Laravel Lumen, load your configuration file manually in bootstrap/app.php
:
Usage
Using laravel-uls is fairly easy.
- Get your JSON Web Key from your facility's Technical Configuration page. https://www.vatusa.net/mgt/facility (NOTE: You must hold a ATM, DATM or WM role for that facility to generate/see the generated JSON Web Key)
- Store the JWK, unedited, in the config above (or, recommended quoted with single quotes in the .env file as ULS_JWK='... JWK from VATUSA...')
-
To generate the redirect url, use:
To handle the developmental returns, specify a boolean argument of true
-
To verify a token, assume $token is the full token received from VATUSA's ULS endpoint
The laravel-uls library conducts header verifications to ensure that the accepted algorithms are received. Additionally, it conducts the following claims checks, including:
- Ensures the audience is you (IE, the token isn't meant for another facility)
- The token is not expired
- The Issued at time is logical (ie, not in the future)
Because of this, a number of exceptions may be thrown:
- InvalidArgumentException
- Jose\Component\Checker\InvalidClaimException
- Jose\Component\Checker\InvalidHeaderException
-
To get the information of the user associated with the token, use:
This will return an array of the decoded JSON from ULS. Details of the array can be found in the VATUSA Technical Manual M1022 at https://www.vatusa.net.
License
Released under the GNU Public License 3.0, see LICENSE.
All versions of laravel-uls with dependencies
web-token/jwt-core Version ^1.0
web-token/jwt-key-mgmt Version ^1.0
web-token/jwt-signature Version ^1.0
web-token/jwt-checker Version ^1.0
namshi/jose Version ^7.0
illuminate/support Version 5.3.x|5.4.x|5.5.x