Overview

Steamworks exposes multiple methods for authenticating a Steam user's identity and verifying ownership of an application. The following document describes each of these authentication methods used in the following scenarios:

• Between a game client and other clients (P2P) or game servers using Session Tickets
  
• Between a game client and a backend server using:
  
  • Session Tickets and the Steamworks Web API
    
  • Encrypted Application Ticket Library
    
• When a user is in a web browser using OpenID and Steamworks Web API

Identifying a user within Steam

Every Steam user can be uniquely identified by a 64-bit numeric ID, known as the user's Steam ID. In the Steamworks C++ APIs, a user's SteamID is contained within a CSteamID object. You can retrieve the current user's SteamID by calling ISteamUser::GetSteamID and then retrieve the 64-bit ID by calling CSteamID.ConvertToUint64() on the returned value.

The following authentication methods can be used to securely verify a user's Steam ID.

APIs covered in this document

Session Tickets

Session Tickets are signed tickets that can be used to verify a user's identity between the user's game client and any number of other game clients (such as in a peer-to-peer multiplayer session) or to a listen/dedicated game server (using the ISteamGameServer API). These tickets can also be used to verify ownership of the current game and related downloadable content, and determine if the user has been VAC-banned (See Античіт Valve (VAC) та ігрові блокування).
Session Tickets can also be used to verify a user's identity between a game client and a secure, backend server using the Steamworks Web API. Requires that the secure server can make HTTPS requests to partner.steam-api.com.

Encrypted Application Tickets

Encrypted Application Tickets can be used to verify a user's identity between a game client and a secure, backend server. Unlike Session Tickets, verifying Encrypted Application Tickets does not require that the secure server can make HTTPS requests. Instead, a C++ library and a private, symmetric key are used by the secure server to verify the ticket. The Steamworks SDK includes 32-bit and 64-bit versions of this library for Windows and Linux under the public/steam/lib directory.

Before using Encrypted Application Tickets, you must generate a private key for each title. You can do this by navigating to Edit Steamworks Settings for your application and selecting 'SDK Auth' from the 'Security' drop-down. This key will be associated with your title's AppID and any downloadable content for that title. In order to access this section of Steamworks, a user must have the "Manage Signing" permission for the relevant Application.

Steamworks Web API

Steam exposes an HTTP based Web API which can be used to access many Steamworks features. The API contains public methods that can be accessed from any application capable of making an HTTP request, such as game client or server. The API also contains protected methods that require authentication and are intended to be accessed from trusted back-end applications. More details on the Web API can be found here.

P2P or Game Servers

Session Tickets

User Authentication

The following steps detail how to use Session Tickets to verify a user's identity between the user's game client (client A) and another client or game server (client B):

• Client A must retrieve a session ticket by calling ISteamUser::GetAuthSessionTicket.
  
• Client A must send its session ticket to client B.
  
• Client B must pass client A's ticket to ISteamUser::BeginAuthSession, which will perform a quick validity check. If the ticket is valid, then ISteamUser::BeginAuthSession will forward the ticket to then the Steam backend to verify that the ticket has not been reused and was issued by the account owner of client A. The result of this verification will be returned in a ISteamUser::ValidateAuthTicketResponse_t callback.
  
• When the multiplayer session terminates:
  
  • Client A must pass the handle initially returned from ISteamUser::GetAuthSessionTicket to ISteamUser::CancelAuthTicket.
    
  • Client B must pass the SteamID of client A to ISteamUser::EndAuthSession.
    

A few important notes about Session Tickets:

• Session Tickets must only be used once. ISteamUser::GetAuthSessionTicket must be called for every client in the mulitplayer session who requests a ticket.
  
• When used to authenticate players within a peer-to-peer multiplayer session, each game client should verify the identity of every other game client in the multiplayer session.
  
• When finished with a Session Ticket, ISteamUser::CancelAuthTicket must be called for every handle returned by ISteamUser::GetAuthSessionTicket.
  
• When client A calls ISteamUser::CancelAuthTicket, client B will receive a ISteamUser::ValidateAuthTicketResponse_t callback stating that client A's ticket is no longer valid.
  
• When client A leaves a game with client B, if client A's call of ISteamUser::CancelAuthTicket is processed before client B call's of ISteamUser::EndAuthSession, then client B may receive a ISteamUser::ValidateAuthTicketResponse_t callback stating that the ticket was cancelled. Because there is mutual agreement that client A is leaving, this callback can be ignored.
  
• Network conditions may prevent the Steam backend from providing a callback to the caller of ISteamUser::BeginAuthSession for an indefinite period of time. The caller of ISteamUser::BeginAuthSession ( client B ) should not assume that he knows the true identity of client A until this callback has been received, but should allow the multiplayer session to continue.
  
• If the caller of ISteamUser::BeginAuthSession receives a ISteamUser::ValidateAuthTicketResponse_t callback stating that the ticket for client A is invalid, the caller must refuse to continue the multiplayer session with client A. If the other peers in the game do not also refuse to play with client A, the caller should leave the multiplayer session.
  
• ISteamGameServer exposes the same Session Ticket methods to perform authentication between a game client and game server.

Ownership Verification

When using Session Tickets, Steam will automatically verify ownership of the current AppID. If the user does not own the current AppID, then m_eAuthSessionResponse field of the ISteamUser::ValidateAuthTicketResponse_t will be set to k_EAuthSessionResponseNoLicenseOrExpired. After receiving a user's Session Ticket and passing it to ISteamUser::BeginAuthSession then, ISteamUser::UserHasLicenseForApp can be used to determine if the user owns a specific piece of downloadable content.

Backend Server

Session Tickets and the Steamworks Web API

User Authentication

The following steps detail how to use Session Tickets to verify a user's identity between the user's game client and a secure server:

• The client must retrieve a session ticket by calling ISteamUser::GetAuthSessionTicket.
  
• To guarantee a valid ticket, the client must wait for the ISteamUser::GetAuthSessionTicketResponse_t callback.
  
• The client must send its session ticket to the secure server.
  
• The secure server must make an HTTPS request to partner.steam-api.com and call the ISteamUserAuth/AuthenticateUserTicket web method, passing the user's session ticket as a hex encoded UTF-8 string. Please note that this method allows either a Steam Web API Key or a Web API Publisher Key that is associated with the AppID for the provided ticket to be passed in. A future update to this API may return more information to the caller when a Web API Publisher key is supplied.
  
• If the user's ticket is valid, then ISteamUserAuth/AuthenticateUserTicket will return the user's 64-bit SteamID.

Ownership Verification

Once a user's identity has been verified, a secure server can use the ISteamUser/CheckAppOwnership Web API method to check if the user owns a particular AppID, or call ISteamUser/GetPublisherAppOwnership to retrieve a list of all user owned AppIDs that are associated with the provided Publisher Key.

Encrypted Application Tickets

User Authentication

The following steps detail how to use Encrypted Application Tickets to verify a user's identity between the user's game client and a secure server:

• The client must call ISteamUser::RequestEncryptedAppTicket and wait for the ISteamUser::EncryptedAppTicketResponse_t call result.
  
• The client must then call ISteamUser::GetEncryptedAppTicket to retrieve the user's encrypted ticket and send that ticket to the secured server.
  
• Using the Encrypted Application Ticket library, the secure server must then:
  
  • Call SteamEncryptedAppTicket::BDecryptTicket to decrypt the user's ticket
    
  • Call SteamEncryptedAppTicket::BIsTicketForApp to verify that the ticket is for the expected application
    
  • Call SteamEncryptedAppTicket::GetTicketIssueTime to verify that the ticket has not expired (expiration time defined by the application)
    
  • Call SteamEncryptedAppTicket::GetTicketSteamID to retrieve the user's SteamID
    

An example implementation can be found in the Steamworks API Example Application (SpaceWar) project in the SDK. Specifically CSpaceWarClient::RetrieveEncryptedAppTicket and CSpaceWarClient::OnRequestEncryptedAppTicket.

Ownership Verification

Steam will only create Encrypted Application Tickets for users who own the AppID for which the ticket was created. After decrypting an Encrypted Application Ticket, the secure server can use SteamEncryptedAppTicket::BIsTicketForApp to verify the AppID of the ticket matches the title's AppID. The server can also use SteamEncryptedAppTicket::BUserOwnsAppInTicket to determine if the user owns a specific piece of Завантажувальний вміст (DLC).

Web Browser based authentication with OpenID

Steam is an OpenID Provider, as described in the OpenID 2.0 specification. Inside a web browser, a third-party website can use OpenID to obtain a user's SteamID which can be used as the login credentials for the 3rd party website, or linked to an existing account on that website.

When using OpenID, the user begins in a web browser at the third-party website. When the user wishes to login/link their account to that website, using OpenID, the site directs the user to a login form on the Steam Community website. Once the user has entered their Steam login credentials, the user's web browser is automatically redirected back to the 3rd party website with some additional OpenID specific data appended to the return URL. The site's OpenID library can then use this data to verify and obtain the user's SteamID.

Steam provides the following images which may be used by 3rd party sites when linking to the Steam sign in page:

User Authentication

Steam's OpenID 2.0 implementation can be used to link a users Steam account to their account on the third-party website.
A list of open source OpenID libraries can be found at the OpenID website. To use OpenID to verify a user's identity:

• Configure your OpenID library to use the following URL as Steam's OP Endpoint URL: https://steamcommunity.com/openid/
  
• After a user has been authenticated, the user's Claimed ID will contain the user's SteamID. The Steam Claimed ID format is: http://steamcommunity.com/openid/id/<steamid>.

Ownership Verification

Once a user's identity has been verified, a secure server can use the ISteamUser/CheckAppOwnership Web API method to check if the user owns a particular AppID, or call ISteamUser/GetPublisherAppOwnership to retrieve a list of all user owned AppIDs that are associated with the provided Web API Publisher Key.

Examples

Linking third-party accounts to Steam accounts

Third-party accounts can be linked to Steam accounts by associating a user's SteamID with the 3rd party account.

A user's SteamID can be securely retrieved either in-game or through a web browser and once the initial association has occurred, you can safely allow access to the 3rd party account by merely verifying a user's SteamID. This eliminates the need for Steam users to do any sort of secondary login to 3rd party account systems. Additionally, if new 3rd party accounts can be automatically created and linked when a new SteamID is encountered, the Steam user will never have to be aware that a secondary authentication is taking place at all. Instead, their single Steam account can grant access to all of their games, streamlining the user experience and removing potential barriers to installing and trying new games.

Linking From In-game

Session Tickets can be used to verify a user's identity between a game client and a secure, backend server using the Steamworks Web API:

• The client must retrieve a session ticket by calling ISteamUser::GetAuthSessionTicket.
  
• To guarantee a valid ticket, the client must wait for the ISteamUser::GetAuthSessionTicketResponse_t callback.
  
• The client must send its session ticket to the secure server.
  
• The secure server must make an HTTPS request to api.steampowered.com and call the ISteamUserAuth/AuthenticateUserTicket web method, passing the user's session ticket as a hex encoded UTF-8 string. Please note that this method requires a Web API Publisher Key that is associated with the AppID for the provided ticket.
  
• If the user's ticket is valid, ISteamUserAuth/AuthenticateUserTicket will return the user's 64-bit SteamID.

Linking From a Web Browser

Steam supports the OpenID 2.0 specification so that you can allow users to securly log into their Steam accounts from your website and retrieve their SteamID. For details on how to use OpenID with Steam go to Using OpenID

Ownership Verification

Once a user's identity has been verified, a secure server can use the ISteamUser/CheckAppOwnership Web API method to check if the user owns a particular AppID, or call ISteamUser/GetPublisherAppOwnership to retrieve a list of all user owned AppIDs that are associated with the provided Web API Publisher Key.

Migrating from Third-Party CD Keys to native Steam Ownership Checks

Steam itself has a number of ways a title can authenticate a user with, removing the need for a third-party CD key. We've compiled a list of common use cases for CD Keys and how you might implement each case natively with Steam:

Private Forum Access

You'll want to have users login directly with their Steam account using OpenID. OpenID will return the user's 64bit SteamID which can then be used with ISteamUser/CheckAppOwnership to verify the user owns your appid. More details can be found above at Linking 3rd party accounts to Steam accounts.

Unlocking a non-Steam, DRM-free build of a game

Use OpenID and ISteamUser/CheckAppOwnership (documented above) to unlock the content on your own site. Alternatively, you could upload the DRM-free build as optional, free DLC.

The software is sold on my own web site and unlocks with a key

You'll want to have users login directly with their Steam account using OpenID. OpenID will return the user's 64bit SteamID which can then be used with ISteamUser/CheckAppOwnership to verify the user owns your appid. More details can be found in Linking third-party accounts to Steam accounts above.

Dropping in-game items for registering your third-party key

If you are using the Steam Inventory Service, make sure the item's itemdef is configured correctly as a promo item and call ISteamInventory::AddPromoItem from the client.
If you have your own item backend, you can call ISteamUser::GetAuthSessionTicket from the game client and then use ISteamUserAuth/AuthenticateUserTicket with ISteamUser/CheckAppOwnership to verify ownership. More Information...

The key controls which version of the software is unlocked

Each version of your game should have its own AppID. From the game client, call ISteamUser::GetAuthSessionTicket and then use ISteamUserAuth/AuthenticateUserTicket with ISteamUser/CheckAppOwnership to verify ownership. More Information...