zanderwar / steamauth
Steam Authenticator
Installs: 7
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 3
Type:silverstripe-module
Requires
- silverstripe/framework: ^4.0@dev
This package is auto-updated.
Last update: 2024-10-29 05:10:31 UTC
README
Steam Authenticator for SilverStripe 4
When a user logs in via Steam, this module will check to see if a Member with the users SteamID already exists. If it doesn't it will create it as a regular user and log them in immediately.
If you're an admin, it's essential that you manually add your 64-bit Steam ID if you wish to be able to log into the administrator panel via Steam
#Installation
Installation is supported by composer only
composer require zander/steamauth ~1.0
- Add these lines to your /mysite/_config.php
// add this after your namespace or use FQCN instead use SilverStripe\Security\Member; use Zanderwar\SteamAuth\Extensions\MemberExtension; use Zanderwar\SteamAuth\Extensions\PageControllerExtension; ///// Member::add_extension(MemberExtension::class); PageController::add_extension(PageControllerExtension::class);
-
Create a new page through the CMS using the SteamAuth Page Type. You should also hide this page from the menu and search via the Settings tab as it has no frontend purpose beyond validating the Steam Authentication
-
Create a
steamauth.yml
configuration file in/mysite/_config.php
Zanderwar\SteamAuth\SteamAuth: steam_api_key: ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789 validate_url: "http://{{HOST}}/steamauth/validate"
{{HOST}}
will automatically be replaced with example.com
and steamauth
should point to the SteamAuth Page Type url you created earlier
Extension Points
onBeforeMemberCreate($steamId)
- This is handy if you wish to whitelist specific players or my intention for this was to only allow players who have joined the game server previously access to the site
- Passed the 64-Bit SteamID
- If the member already exists however, this extension point will never be reached.
onAfterMemberCreate($Member)
- Passed the created
Member
object as reference - If the member already exists however, this extension point will never be reached.
- Passed the created
Roadmap
- Forum Support