Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teh9/laravel-steam-auth
Support for Laravel 10
https://github.com/teh9/laravel-steam-auth
Last synced: about 2 months ago
JSON representation
Support for Laravel 10
- Host: GitHub
- URL: https://github.com/teh9/laravel-steam-auth
- Owner: teh9
- License: mit
- Created: 2024-04-25T17:26:11.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-04-25T17:39:24.000Z (9 months ago)
- Last Synced: 2024-04-26T18:00:02.255Z (9 months ago)
- Language: PHP
- Homepage: https://github.com/invisnik/laravel-steam-auth
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Steam authentication for Laravel
[](https://codeclimate.com/github/invisnik/laravel-steam-auth)
[](https://packagist.org/packages/invisnik/laravel-steam-auth)
[](https://packagist.org/packages/invisnik/laravel-steam-auth)
[](https://packagist.org/packages/invisnik/laravel-steam-auth)
This package is a Laravel 5 service provider which provides support for Steam OpenID and is very easy to integrate with any project that requires Steam authentication.
## Requirements
* PHP 7+
* Laravel 10+
## Installation
#### Via Composer
```bash
composer require teh9/laravel-steam-auth
```
#### Steam API Key
Add your Steam API key to your `.env` file. You can get your API key [here](http://steamcommunity.com/dev/apikey).
```
STEAM_API_KEY=SomeKindOfAPIKey
```
#### Config Files
Publish the config file.
```
php artisan vendor:publish --provider="Teh9\LaravelSteamAuth\SteamServiceProvider"
```
## Usage example
In `config/steam-auth.php`:
```php
return [
/*
* Redirect URL after login
*/
'redirect_url' => '/auth/steam/handle',
/*
* Realm override. Bypass domain ban by Valve.
* Use alternative domain with redirection to main for authentication (banned by valve).
*/
// 'realm' => 'redirected.com',
/*
* API Key (set in .env file) [http://steamcommunity.com/dev/apikey]
*/
'api_key' => env('STEAM_API_KEY', ''),
/*
* Is using https?
*/
'https' => false,
];
```
In `routes/web.php`:
```php
Route::get('auth/steam', 'AuthController@redirectToSteam')->name('auth.steam');
Route::get('auth/steam/handle', 'AuthController@handle')->name('auth.steam.handle');
```
**Note:** if you want to keep using Laravel's default logout route, add the following as well:
```php
Route::post('logout', 'Auth\LoginController@logout')->name('logout');
```
In `AuthController`:
```php
namespace App\Http\Controllers;
use Invisnik\LaravelSteamAuth\SteamAuth;
use App\User;
use Auth;
class AuthController extends Controller
{
/**
* The SteamAuth instance.
*
* @var SteamAuth
*/
protected $steam;
/**
* The redirect URL.
*
* @var string
*/
protected $redirectURL = '/';
/**
* AuthController constructor.
*
* @param SteamAuth $steam
*/
public function __construct(SteamAuth $steam)
{
$this->steam = $steam;
}
/**
* Redirect the user to the authentication page
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/
public function redirectToSteam()
{
return $this->steam->redirect();
}
/**
* Get user info and log in
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
*/
public function handle()
{
if ($this->steam->validate()) {
$info = $this->steam->getUserInfo();
if (!is_null($info)) {
$user = $this->findOrNewUser($info);
Auth::login($user, true);
return redirect($this->redirectURL); // redirect to site
}
}
return $this->redirectToSteam();
}
/**
* Getting user by info or created if not exists
*
* @param $info
* @return User
*/
protected function findOrNewUser($info)
{
$user = User::where('steamid', $info->steamID64)->first();
if (!is_null($user)) {
return $user;
}
return User::create([
'username' => $info->personaname,
'avatar' => $info->avatarfull,
'steamid' => $info->steamID64
]);
}
}
```
Should you wish to use a login redirection URL that is differant from the one you specified in the config
```php
// Inside your controller login method
$this->steam->setRedirectUrl(route('login.route'));
...
return $this->steam->redirect();
```
If you need another steamID you can use another package to convert the given steamID64 to another type like [xPaw/SteamID](https://github.com/xPaw/SteamID.php).