11# Steam Auth for Laravel
22[ ![ Latest Stable Version] ( https://img.shields.io/packagist/v/ilzrv/laravel-steam-auth.svg )] ( https://packagist.org/packages/ilzrv/laravel-steam-auth )
3+ [ ![ Codecov] ( https://img.shields.io/codecov/c/github/ilzrv/laravel-steam-auth?token=MIEA87EZGP )] ( https://app.codecov.io/github/ilzrv/laravel-steam-auth )
34[ ![ Total Downloads] ( https://img.shields.io/packagist/dt/ilzrv/laravel-steam-auth.svg )] ( https://packagist.org/packages/ilzrv/laravel-steam-auth )
45[ ![ License] ( https://img.shields.io/github/license/ilzrv/laravel-steam-auth.svg )] ( https://packagist.org/packages/ilzrv/laravel-steam-auth )
56
67Package allows you to implement Steam authentication in your Laravel project.
78
89## Requirements
9- * Laravel 7+
10+ * Laravel 9+
11+ * PHP 8.1+
1012
1113## Installation
1214#### Install the package
@@ -31,18 +33,34 @@ STEAM_AUTH_API_KEYS=YourSteamApiKey1,YourSteamApiKey2
3133
3234## Tips
3335
34- #### PendingRequest Settings
35- You can use any of the Laravel PendingRequest settings. Proxies and retries for example
36+ #### Client Settings
37+ You can use any settings that your client supports, for example, a [ Guzzle Proxy ] ( https://docs.guzzlephp.org/en/latest/request-options.html#proxy ) :
3638
3739``` php
38- public function __construct(Request $request)
39- {
40- $pendingRequest = \Illuminate\Support\Facades\Http::withOptions([
41- 'proxy' => 'http://username:password@ip',
42- 'connect_timeout' => 10,
43- ])->retry(3);
40+ <?php
4441
45- $this->steamAuth = new SteamAuth($request, $pendingRequest);
42+ declare(strict_types=1);
43+
44+ use GuzzleHttp\Client;
45+ use GuzzleHttp\Psr7\HttpFactory;
46+ use Illuminate\Http\Request;
47+ use Ilzrv\LaravelSteamAuth\SteamAuthenticator;
48+
49+ public function __invoke(
50+ Request $request,
51+ HttpFactory $httpFactory,
52+ ): RedirectResponse {
53+ $client = new Client([
54+ 'proxy' => 'socks5://user:password@192.168.1.1:1080',
55+ ]);
56+
57+ $steamAuthenticator = new SteamAuthenticator(
58+ new Uri($request->getUri()),
59+ $client,
60+ $httpFactory,
61+ );
62+
63+ // Continuation of your code...
4664}
4765```
4866
@@ -52,6 +70,8 @@ If you want to make a proxy domain. Update `redirect_url` inside `steam-auth.php
5270``` php
5371<?php
5472
73+ declare(strict_types=1);
74+
5575return [
5676 'redirect_url' => env('APP_ENV', 'production') == 'production'
5777 ? 'https://auth.test/#'
@@ -68,93 +88,76 @@ server {
6888}
6989```
7090
71- ## Example
91+ ## Basic example
7292
7393In ` routes/web.php ` :
7494
7595``` php
76- Route::get('login', [ \App\Http\Controllers\Auth\SteamAuthController::class, 'login'] );
96+ Route::get('login', \App\Http\Controllers\Auth\SteamAuthController::class);
7797```
7898
7999Create a controller ` SteamAuthController.php ` :
80100
81101``` php
82102<?php
83103
84- namespace App\Http\Controllers\Auth ;
104+ declare(strict_types=1) ;
85105
86- use App\Http\Controllers\Controller;
87- use App\Providers\RouteServiceProvider;
88- use App\User;
89- use Illuminate\Support\Facades\Auth;
90- use Ilzrv\LaravelSteamAuth\SteamAuth;
91- use Ilzrv\LaravelSteamAuth\SteamData;
106+ namespace App\Http\Controllers\Auth;
92107
93- class SteamAuthController extends Controller
108+ use App\Models\User;
109+ use GuzzleHttp\Client;
110+ use GuzzleHttp\Psr7\HttpFactory;
111+ use GuzzleHttp\Psr7\Uri;
112+ use Illuminate\Auth\AuthManager;
113+ use Illuminate\Http\RedirectResponse;
114+ use Illuminate\Http\Request;
115+ use Illuminate\Routing\Redirector;
116+ use Ilzrv\LaravelSteamAuth\Exceptions\Validation\ValidationException;
117+ use Ilzrv\LaravelSteamAuth\SteamAuthenticator;
118+ use Ilzrv\LaravelSteamAuth\SteamUserDto;
119+
120+ final class SteamAuthController
94121{
95- /**
96- * The SteamAuth instance.
97- *
98- * @var SteamAuth
99- */
100- protected $steamAuth;
101-
102- /**
103- * Where to redirect users after login.
104- *
105- * @var string
106- */
107- protected $redirectTo = RouteServiceProvider::HOME;
108-
109- /**
110- * SteamAuthController constructor.
111- *
112- * @param SteamAuth $steamAuth
113- */
114- public function __construct(SteamAuth $steamAuth)
115- {
116- $this->steamAuth = $steamAuth;
117- }
122+ public function __invoke(
123+ Request $request,
124+ Redirector $redirector,
125+ Client $client,
126+ HttpFactory $httpFactory,
127+ AuthManager $authManager,
128+ ): RedirectResponse {
129+ $steamAuthenticator = new SteamAuthenticator(
130+ new Uri($request->getUri()),
131+ $client,
132+ $httpFactory,
133+ );
118134
119- /**
120- * Get user data and login
121- *
122- * @return \Illuminate\Http\RedirectResponse
123- */
124- public function login()
125- {
126- if (!$this->steamAuth->validate()) {
127- return $this->steamAuth->redirect();
135+ try {
136+ $steamAuthenticator->auth();
137+ } catch (ValidationException) {
138+ return $redirector->to(
139+ $steamAuthenticator->buildAuthUrl()
140+ );
128141 }
129142
130- $data = $this->steamAuth->getUserData();
131-
132- if (is_null($data)) {
133- return $this->steamAuth->redirect();
134- }
143+ $steamUser = $steamAuthenticator->getSteamUser();
135144
136- Auth:: login(
137- $this->firstOrCreate($data ),
145+ $authManager-> login(
146+ $this->firstOrCreate($steamUser ),
138147 true
139148 );
140149
141- return redirect($this->redirectTo );
150+ return $redirector->to('/' );
142151 }
143152
144- /**
145- * Get the first user by SteamID or create new
146- *
147- * @param SteamData $data
148- * @return User|\Illuminate\Database\Eloquent\Model
149- */
150- protected function firstOrCreate(SteamData $data)
153+ private function firstOrCreate(SteamUserDto $steamUser): User
151154 {
152155 return User::firstOrCreate([
153- 'steam_id' => $data ->getSteamId(),
156+ 'steam_id' => $steamUser ->getSteamId(),
154157 ], [
155- 'name' => $data ->getPersonaName(),
156- 'avatar' => $data ->getAvatarFull(),
157- 'player_level' => $data ->getPlayerLevel(),
158+ 'name' => $steamUser ->getPersonaName(),
159+ 'avatar' => $steamUser ->getAvatarFull(),
160+ 'player_level' => $steamUser ->getPlayerLevel(),
158161 // ...and other what you need
159162 ]);
160163 }
0 commit comments