https://github.com/socialiteproviders/steam

[READ ONLY] Subtree split of the SocialiteProviders/Steam Provider (see SocialiteProviders/Providers)
https://github.com/socialiteproviders/steam

laravel oauth oauth1 oauth2 social-media socialite socialite-providers

Last synced: 4 days ago
JSON representation

[READ ONLY] Subtree split of the SocialiteProviders/Steam Provider (see SocialiteProviders/Providers)

• Host: GitHub
• URL: https://github.com/socialiteproviders/steam
• Owner: SocialiteProviders
• Created: 2016-08-04T18:20:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T22:14:54.000Z (2 months ago)
• Last Synced: 2024-12-16T21:38:15.917Z (23 days ago)
• Topics: laravel, oauth, oauth1, oauth2, social-media, socialite, socialite-providers
• Language: PHP
• Homepage: https://socialiteproviders.com/Steam/
• Size: 34.2 KB
• Stars: 19
• Watchers: 4
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Steam

```bash

composer require socialiteproviders/steam

```

## Installation & Basic Usage

Please see the [Base Installation Guide](https://socialiteproviders.com/usage/), then follow the provider specific instructions below.

## Add configuration to `config/services.php`

```php

'steam' => [

  'client_id' => null,

  'client_secret' => env('STEAM_CLIENT_SECRET'),

  'redirect' => env('STEAM_REDIRECT_URI'),

  'allowed_hosts' => [

    'example.com',

  ]

],

```

### allowed_hosts

Set this for protect against authorization domain spoofing. When the user returns from the Steam login page, along with the OpenID validation, the return_to parameter will be checked against the available domains in `allowed_hosts`. 

If you don't specify the setting, then fraudsters have the opportunity to enter the application under other users

Issue resolved in https://github.com/SocialiteProviders/Providers/pull/817

By default this protection is disabled. It will only be active when allowed hosts is not equal to an empty array.

### force_https

Set this property to force HTTPS scheme when redirecting from Steam OAuth.

If you do not set it, the scheme will be inferred from your server settings.

```php

'steam' => [

  'client_id' => null,

  'client_secret' => env('STEAM_CLIENT_SECRET'),

  'redirect' => env('STEAM_REDIRECT_URI'),

  'force_https' => true,  // This will force HTTPS scheme

  'allowed_hosts' => [

    'example.com',

  ]

],

```

## Add provider event listener

Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your `listen[]` array in `app/Providers/EventServiceProvider`. See the [Base Installation Guide](https://socialiteproviders.com/usage/) for detailed instructions.

```php

protected $listen = [

    \SocialiteProviders\Manager\SocialiteWasCalled::class => [

        // ... other providers

        \SocialiteProviders\Steam\SteamExtendSocialite::class.'@handle',

    ],

];

```

## Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

```php

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

```

## Returned User fields

- ``id``

- ``nickname``

- ``name``

- ``avatar``