ilzrv/laravel-steam-auth

Steam Auth for Laravel

v3.1.0 2024-03-13 08:04 UTC

Requires

• php: ^8.1
• illuminate/support: ^9.0|^10.0|^11.0
• psr/http-client: ^1.0
• psr/http-factory: ^1.0
• psr/http-message: ^2.0

Requires (Dev)

• orchestra/testbench: 7.x|^8.5
• phpunit/phpunit: ^10.0
• roave/security-advisories: dev-latest
• vimeo/psalm: ^5.12

MIT

• Ilia Lazarev

README

Package allows you to implement Steam authentication in your Laravel project.

Requirements

• Laravel 9+
• PHP 8.1+

Installation

Install the package

composer require ilzrv/laravel-steam-auth

Publish the config file

php artisan vendor:publish --provider="Ilzrv\LaravelSteamAuth\ServiceProvider"

Setup Steam API Key(s)

Add your Steam API key to your .env file. You can find it here.

if you want to use multiple API keys just list them separated by commas

STEAM_AUTH_API_KEYS=YourSteamApiKey1,YourSteamApiKey2

Tips

Client Settings

You can use any settings that your client supports, for example, a Guzzle Proxy:

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\HttpFactory;
use Illuminate\Http\Request;
use Ilzrv\LaravelSteamAuth\SteamAuthenticator;

public function __invoke(
    Request $request,
    HttpFactory $httpFactory,
): RedirectResponse {
    $client = new Client([
        'proxy' => 'socks5://user:password@192.168.1.1:1080',
    ]);

    $steamAuthenticator = new SteamAuthenticator(
        new Uri($request->getUri()),
        $client,
        $httpFactory,
    );
    
    // Continuation of your code...
}

Proxy Domain

If you want to make a proxy domain. Update redirect_url inside steam-auth.php to your absolute address like https://auth.test/login. You can use different domains for the local environment and for production like this:

<?php

declare(strict_types=1);

return [
    'redirect_url' => env('APP_ENV', 'production') == 'production'
        ? 'https://auth.test/login'
        : null,
];

In the NGINX settings for proxy domain, you can specify the following:

server {
    listen 443 ssl http2;
    server_name auth.test;
    return 301 https://general.test$uri$is_args$args;
}

Basic example

In routes/web.php:

Route::get('login', \App\Http\Controllers\Auth\SteamAuthController::class);

Create a controller SteamAuthController.php:

<?php

declare(strict_types=1);

namespace App\Http\Controllers\Auth;

use App\Models\User;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\HttpFactory;
use GuzzleHttp\Psr7\Uri;
use Illuminate\Auth\AuthManager;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Routing\Redirector;
use Ilzrv\LaravelSteamAuth\Exceptions\Authentication\SteamResponseNotValidAuthenticationException;
use Ilzrv\LaravelSteamAuth\Exceptions\Validation\ValidationException;
use Ilzrv\LaravelSteamAuth\SteamAuthenticator;
use Ilzrv\LaravelSteamAuth\SteamUserDto;

final class SteamAuthController
{
    public function __invoke(
        Request $request,
        Redirector $redirector,
        Client $client,
        HttpFactory $httpFactory,
        AuthManager $authManager,
    ): RedirectResponse {
        $steamAuthenticator = new SteamAuthenticator(
            new Uri($request->getUri()),
            $client,
            $httpFactory,
        );

        try {
            $steamAuthenticator->auth();
        } catch (ValidationException|SteamResponseNotValidAuthenticationException) {
            return $redirector->to(
                $steamAuthenticator->buildAuthUrl()
            );
        }

        $steamUser = $steamAuthenticator->getSteamUser();

        $authManager->login(
            $this->firstOrCreate($steamUser),
            true
        );

        return $redirector->to('/');
    }

    private function firstOrCreate(SteamUserDto $steamUser): User
    {
        return User::firstOrCreate([
            'steam_id' => $steamUser->getSteamId(),
        ], [
            'name' => $steamUser->getPersonaName(),
            'avatar' => $steamUser->getAvatarFull(),
            'player_level' => $steamUser->getPlayerLevel(),
            // ...and other what you need
        ]);
    }
}