vikas5914/steam-auth

A simple PHP Steam login and User Detail package

Steam authentication and User Details

This package enables you to easily log users in via Steam and get user details , using their OpenID service. However, this package does not require that you have the OpenID PHP module installed!

Installation Via Composer

Add this to your composer.json file, in the require object:

"vikas5914/steam-auth": "1.*"

After that, run composer install to install the package.

OR

composer require vikas5914/steam-auth:1.*

Usage example

require __DIR__ . '/vendor/autoload.php';

$config = array(
    'apikey' => 'xxxxxxxxxxxxxxxxx', // Steam API KEY
    'domainname' => 'http://localhost:3000', // Displayed domain in the login-screen
    'loginpage' => 'http://localhost:3000/index.php', // Returns to last page if not set
    "logoutpage" => "",
    "skipAPI" => false, // true = dont get the data from steam, just return the steamid64
);

$steam = new Vikas5914\SteamAuth($config);

if ($steam->loggedIn()) {
    echo "Hello " . $steam->personaname . "!";
    echo "<a href='" . $steam->logout() . "'>Logout</a>";
} else {
    echo "<a href='" . $steam->loginUrl() . "'>Login</a>";
}

User-Data is accessible through $steam->varName; You can find a basic list of variables in the demo file or a more advanced one in the code.

Check if the user is logged in with $steam->loggedIn(); (Will return true or false)

Planned

1. Test Case
2. Better ReadMe

Legal stuff

If you choose to use the steam web-api you need to follow the Steam Web API Terms of Use found at http://steamcommunity.com/dev/apiterms

The marked code is taken from Syntax_Error's "Ultra Simple Steam-Login" Class found at http://forums.steampowered.com/forums/showthread.php?t=1430511

steam-auth's Issues

Logging out after login/refresh

In the usage example the $steam->logout() function is called which logs out the user after login. I think this is what issue #5 is refering to.

echo "<a href='" . $steam->logout() . "'>Logout</a>";

This is my modified example if anyone has issues like #5:

<?php
session_start();
require __DIR__ . '/vendor/autoload.php';

$config = array(
    'apikey' => 'xxxxxxxxxxxxxxxxx', // Steam API KEY https://steamcommunity.com/dev/apikey
    'domainname' => 'http://localhost:3000', // Displayed domain in the login-screen
    'loginpage' => 'http://localhost:3000/index.php', // Returns to last page if not set
    "logoutpage" => "",
    "skipAPI" => false, // true = dont get the data from steam, just return the steamid64
);

$steam = new Vikas5914\SteamAuth($config);

if(isset($_GET['logout'])){
    $steam->logout();
    echo'Logged out...<br/>';
}

if ($steam->loggedIn()) {
    echo "Hello " . $steam->personaname . "! ";
    echo "<a href='?logout'>Logout</a>";
} else {
    echo "<a href='" . $steam->loginUrl() . "'>Login</a>";
}

echo $steam->debug();
?>

how to make composer work on normal host ?

Logs out after refreshing page

What am I doing wrong

getaddrinfo failed

Getting this below error while testing

file_get_contents(): php_network_getaddresses: getaddrinfo failed: nodename nor servname provided, or not known

Steamid validation failure

On line 134 of src/SteamAuth.php, $result is now always an empty string due to the requested resource now returning 403 as described by the PHP warning:

file_get_contents(https://steamcommunity.com/openid/login): failed to open stream: HTTP request failed! HTTP/1.0 403 Forbidden

Because of this, the validate() function never returns a steamid, and login validation always fails.

This came to my attention about 5 days ago when I was getting messages that registration on my site stopped working. This issue entirely prevents this script from working, for everyone.

get_magic_quotes_gpc has been deprecated as of PHP 7.4.0, and removed as of PHP 8.0.0

I encountered a problem caused by the absence of the get_magic_quotes_gpc function in PHP 8.

From PHP.net on the function spec page:

This function has been DEPRECATED as of PHP 7.4.0, and REMOVED as of PHP 8.0.0. Relying on this function is highly discouraged.

Seems that the function can be removed from the code without particolar problems: PHP 7.4 deprecated get_magic_quotes_gpc function alternative (Stack Overflow).

For others using the lastest release (v1.0.2) with PHP 8+, a workaround can be adding this code:

//Fix "get_magic_quotes_gpc" in PHP 8+.
if(!function_exists('get_magic_quotes_gpc')) {
  function get_magic_quotes_gpc() { return false; }
}