Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knojector/steamauthenticationbundle
:steam_locomotive: A Symfony Bundle that provides authentication via Steam for your application.
https://github.com/knojector/steamauthenticationbundle
steam symfony symfony-bundle
Last synced: 2 months ago
JSON representation
:steam_locomotive: A Symfony Bundle that provides authentication via Steam for your application.
- Host: GitHub
- URL: https://github.com/knojector/steamauthenticationbundle
- Owner: knojector
- License: mit
- Created: 2021-02-08T19:30:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T21:20:50.000Z (11 months ago)
- Last Synced: 2024-09-30T17:23:06.771Z (3 months ago)
- Topics: steam, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 34.2 KB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/knojector/SteamAuthenticationBundle/blob/main/LICENSE)
[](https://github.com/knojector/SteamAuthenticationBundle/issues)
[](https://github.com/knojector/SteamAuthenticationBundle/pulls)
[](https://github.com/knojector/SteamAuthenticationBundle/stargazers)
# SteamAuthenticationBundle - Steam authentication for Symfony
The SteamAuthenticationBundle provides an easy way to integrate Steams OpenID login for your application.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Bugs and ideas?](#bugs-and-ideas)
- [Requirements](#requirements)
## Installation
### Step 1 - Install the bundle
```shell
composer require knojector/steam-authentication-bundle
```
### Step 2 - Configuration
```yaml
knojector_steam_authentication:
login_success_redirect: 'app.protected_route'
login_failure_redirect: 'app.error_route'
```
As you can see there are only two options available for configuration. Both are very self-explanatory. The option `login_success_redirect` contains the name of the route the user should be redirected to if the login was successful. The option `login_failure_redirect` contains the route the user is redirected to if the login fails.
Furthermore you have to adjust your `security.yml`. In the following snippet you can see an example with a basic configuration. There are only two important things to consider:
- The firewall name must be `steam`
- You can use any user provider as long as the Steam CommunityId is the property to query for
```yaml
security:
providers:
users:
entity:
class: 'App\Entity\User'
property: 'username'
firewalls:
dev:
pattern: ^/(_(profiler|wdt)|css|images|js)/
security: false
steam:
pattern: ^/
lazy: true
provider: users
```
The final step is to enable the bundle's controller in your `routes.yaml`
```yaml
steam_authentication_callback:
path: /steam/login_check
controller: Knojector\SteamAuthenticationBundle\Controller\SteamController::callback
```
## Usage
### Step 1 - Create your own registration subscriber
Technically there is no registration available in this bundle. The bundle receives an ID from Steam and tries to load a user via the configured user provider. If no user exists you can assume that the user logged in for the first time. Instead of throwing an exception, the bundle dispatches an event you can subscribe to. A simple example for your subscriber is shown below
```php
'onFirstLogin'
];
}
public function onFirstLogin(FirstLoginEvent $event)
{
$communityId = $event->getCommunityId();
$user = new User();
$user->setUsername($communityId);
// e.g. call the Steam API to fetch more profile information
// e.g. create user entity and persist it
// dispatch the authenticate event in order to sign in the new created user.
$this->eventDispatcher->dispatch(new AuthenticateUserEvent($user), AuthenticateUserEvent::NAME);
}
}
```
### Step 2 - Place the login button
To place the "Sign in through Steam" button you can include the following snippet in your template
```
{% include '@KnojectorSteamAuthentication/button.html.twig' %}
```
## Bugs and ideas?
Feel free to open an issue or submit a pull request :wink:
## Requirements
The bundle requires:
- PHP 8.0.0+
- Symfony 5.3/6