truckersmp/steam-socialite

Introduction

The TruckersMP PHP library for Laravel Socialite provides an adapter for the Steam OpenID authentication.

Requirements

• PHP 7.3
• Composer
• Laravel 6.x (or newer)
• Laravel Socialite 4.4 (or newer)

Installation

To get started, use Composer to add the package to your application:

composer require truckersmp/steam-socialite

Following the documentation of Laravel Socialite, you will also need to add credentials for the Steam service. These credentials should be placed in your config/services.php configuration file:

'steam' => [
    'client_id' => null,
    'client_secret' => env('STEAM_SECRET'),
    'redirect' => env('STEAM_REDIRECT_URI'),
],

As OpenID does not use the client_id and client_secret properties, the latter is actually utilized as the Steam API key and is used for fetching the user data. For more information about the API, check the Steam developer portal.

Do not forget to put new environment variables into your .env application file:

# Steam OpenID
STEAM_SECRET=
STEAM_REDIRECT_URI=

Laravel 5.5+ uses Package Auto-Discovery, so does not require you to manually add the SteamSocialiteProvider.

If you do not use auto-discovery, you will need register the provider in your config/app.php configuration file as a package service provider:

'providers' => [

    // ...

    /*
     * Package Service Providers...
     */
    TruckersMP\SteamSocialite\SteamSocialiteProvider::class,

    // ...

],

Consult the documentation of Laravel Socialite to implement the application functionality.

The callback is only accepted on the URL that the user was redirected from, so the redirect URL must match the URL your application sees in the callback request. If your application runs behind a reverse proxy, make sure to configure trusted proxies so the URL scheme and host are detected correctly.

The provider stores a state in the session to protect the login against CSRF. If your application does not use sessions, call the stateless method on both the redirect and the callback:

return Socialite::driver('steam')->stateless()->redirect();

$user = Socialite::driver('steam')->stateless()->user();

Support

If you have any questions about the library, you can create a topic on our forum.

License

This package is open-source and is licensed under the MIT license.