vatsim/sso-laravel

VATSIM OAuth for Laravel

This package is no longer maintained. Consider using the Laravel Socialite provider.

VatsimSSO for Laravel

Version: 3.0, _(*1)

The VatsimSSO package integrates with the VATSIM.net Single Sign On, which lets your users log themselves in using their VATSIM ID. This is especially useful for official vACCs and ARTCCs., _(*2)

This package supports both Laravel 5 and 6., _(*3)

Installation

Use Composer to install the VatsimSSO and dependencies., _(*4)

$ composer require vatsim/sso-laravel 3.*

Set up

Add the provider and facade to your app.php config file (config/app.php)., _(*5)

• Provider: Vatsim\OAuthLaravel\OAuthServiceProvider
• Facade: Vatsim\OAuthLaravel\SSOFacade

Configuration file

Use artisan to publish the configuration file. Change the settings accordingly., _(*6)

$ artisan vendor:publish --provider="Vatsim\OAuthLaravel\OAuthServiceProvider"

It is strongly recommended you use Laravel's built-in support for environment files to protect sensitive data. Additional details can be found in the comments of the config file., _(*7)

Usage

Logging In

The first step would be to send a request to VATSIM to let the user login. The easiest approach would be using the login function. The function takes three parameters., _(*8)

Parameters

Success

The success parameter provides three arguments: $key, $secret and $url. The key and secret should be stored in a session for the validation process. The url will be used to redirect the user to the VATSIM SSO site., _(*9)

Error

Optional parameter. If this parameter is ignored and an error occurs, a SSOException will be thrown. If you pass a function then one parameter will be returned $error, which is the instance of SSOException., _(*10)

Example

$returnUrl = '...'; // load URL from config

return VatsimSSO::login(
    $returnUrl,
    function($key, $secret, $url) {
        Session::put('vatsimauth', compact('key', 'secret'));
        return Redirect::to($url);
    },
    function($e) {
        throw $e; // Do something with the exception
    }
);

If you prefer not to use the ->login() function, you may use ->requestToken($returnUrl). This will return an object containing the key and secret or throw VATSIM\OAuth\SSOException if an error occurs. Then use ->redirectUrl() to get the URL for the redirect., _(*11)

Validating login

After the login has been successful, we need to get the user data from VATSIM. Also for this we wrote a function to make it easier for you., _(*12)

Parameters

Success

The success parameter returns two variables: $user and $request. The user variable will be an object containing all user data available to your organisation. The request variable will give you information about the request., _(*13)

Error

Optional parameter. If this parameter is ignored and an error occurs, a SSOException will be thrown. If you pass a function then one parameter will be returned $error, which is the instance of SSOException., _(*14)

Example

$session = Session::get('vatsimauth');

return VatsimSSO::validate(
    $session['key'],
    $session['secret'],
    Input::get('oauth_verifier'),
    function($user, $request) {
        // At this point we can remove the session data.
        Session::forget('vatsimauth');

        Auth::loginUsingId($user->id);
        return Redirect::home();
    },
    function($error) {
        throw $e; // Do something with the exception
    }
);

If you prefer not to use the ->validate() function, you may use ->checkLogin($key, $secret, $verifier). This will return an object containing the user and request objects or throw VATSIM\OAuth\SSOException if an error occurs., _(*15)

License

MIT, _(*16)

Free Software, Hell Yeah!, _(*17)