Custom Authentication

By default, all applications allow anonymous users to connect and do not have any authentication mechanism. Photon provides the option to implement custom authentication for Photon applications.

Custom Authentication with Photon is flexible. It supports well known third-party authentication providers as well as fully personalized solutions for that matter.

  • Facebook Authentication Provider, hosted by Exit Games.

Check out the tutorial * Custom Authentication Provider, built - and maybe hosted by you. We provide sample implementations of authentication providers via a Git repository. Feel free to fork the repository and send us your pull requests. You find the sources on GitHub.

Content

Authentication Flow

The following steps describe the general flow of the authentication process.

Photon Cloud: Custom Authentication Flow Diagram
Custom authentication flow diagram

  1. Your client passes info about which authentication provider to use and the necessary authentication data to the Photon server with Connect().
  2. The Photon server gets the desired authentication provider for your application and takes one of these steps
    • The authentication provider configuration is found -> the authentication proceeds with step 3.
    • The authentication provider configuration is not found -> the client will be either allowed to connect or rejected, depending on a setting of your application
  3. The Photon server calls the authentication provider with the authentication info passed with Connect().
    • The authentication provider is online -> the authentication proceeds with step 4.
    • The authentication provider is offline -> the client will be either allowed to connect or rejected, depending on the corresponding provider setting.
  4. The authentication provider processes the authentication information and returns the result to the Photon Server
  5. Depending on the authentication result, the client will be either successfully authenticated or rejected

Implementation

If you use facebook authentication with Photon Cloud you can skip this part.

Client Side

The PUN Free and PUN+ packages for Unity include a demo that uses Custom Authentication.

Import the package into a new, empty project, run it and the "Demo Hub" should show the available demos. Pick "Friends & Custom Auth Demo".

PUN: Custom Authentication Demo
Screenshot from PUN's "Friends & Custom Authorization" Demo

The "DemoFriends-Scene" shows a simple input form for a user login. Check out the OnGUI() method in "GUICustomAuth.cs". The code of the "Login with Custom Authentication"-button sets the AuthValues and connects. This automatically triggers a custom authentication request to your configured service.

Note the callback method OnCustomAuthenticationFailed in the same file. It implements a reaction for the case that a user's authentication failed.

Server Side

Once the web server receives the authentication request, the query parameters should be checked and validated. As an example, credentials could be compared to existing ones stored in a database.

If the received parameters are missing or are invalid the returned results should be {'ResultCode': 3}

After finishing the validation the outcome should be returned as follow:

  • Success: {'ResultCode': 1, 'UserId': <userId>}
  • Failure: {'ResultCode': 2}

Advanced Features

Other than authenticating users, extra information can be returned from the authentication provider. In order to do so, the user should establish some kind of protocol between client and the web service who plays the role of the "authenticator".

Sending Data to Server

The easiest and simplest thing to do is an "all or nothing" strategy: chose whether or not to return a static number of variables to the client. But some use cases require a more complex approach where the web service returns data "on-demand" based on what the client has requested. This subsection explains how the client can send data to the web service. The data can be the credentials necessary for authentication plus any extra parameters. The extra parameters are what could be used, among other things, to request piece of data available from server side to be returned within the authentication response. This is pretty useful as it saves extra API calls and simplifies the login workflow.

The default HTTP method used in authentication is GET. So, parameters can be sent as key/value pairs in the query string. The final URL will include the "union" of the key/value pairs set from client and those set from the dashboard. In case, the same key is used in both places, only the dashboard value will be sent. A best practice is to set from the dashboard any "sensitive" static values that should be "invisible" to the client; e.g.: API key, API version. Also dashboard key/values can be changed on the fly without the need to update client.

In some rare cases, authentication may require a lot of data. On the other hand, most web servers have a limit for the number of characters used in the query string or a threshold for the length of the URL. That is why Photon offers the possibility of changing the HTTP method to POST from the client by explicitly setting the AuthenticationValues.AuthPostData field to a value. The latter can be of type string or byte[]. The AuthenticationValues class offers respectively two setters per type.

Since this could be a requirement or a constraint, the POST method option is also available for anyone who opts for receiving authentication requests as POST method from web service.

In other words, to send authentication parameters you are free to use query string or POST data or both. The following table gives the possible combinations.

AuthPostData AuthGetParameters HTTP method
null * GET
empty string * GET
string (not null, not empty) * POST
byte[] (not null, can be empty) * POST

Returning Data to Client

Since Photon server is a proxy between the client and the web service, you should take note of the variables that could be handled by Photon servers.

Like all HTTP incoming responses received by Photon server, the web server should return a JSON object that includes a ResultCode and an optional Message. Additionally, here is a list of what Photon servers can expect from the web service during authentication.

  • UserId: this could be used as a parameter of the authentication itself or it could be requested from client side. This is always forwarded to the client when received by Photon servers. Otherwise, if AuthenticationValues.UserId was not initially set a randomly generated UserId will be sent back to client. This will override the value of UserId in client and cannot be changed after that.
  • Nickname: this could be used as a parameter of the authentication itself or it could be requested from client side. When returned from web service this will override the value of Nickname in client. The Nickname can still be updated after that from client side.
  • AuthCookie: also called secure data, is a JSON object returned by the web service but will not be accessible from client side as it will be embedded in the encrypted token received. It could be sent later with Webhook or WebRPC HTTP requests.
  • Data: JSON object that contains any extra values that should be returned to the client. Please keep in mind that nested arrays or objects are not supported.

The ResultCode is the only required return variable, anything else is optional. The following table summarizes what could be returned by the web server.

ResultCode Description UserId Nickname AuthCookie Data
0 Authentication incomplete, only Data returned.* x x x
1 Authentication successful. ✓ (optional) ✓ (optional) ✓ (optional) ✓ (optional)
2 Authentication failed. Wrong credentials. x x x x
3 Invalid parameters. x x x x

*: This may be useful for implementing OAuth 2.0 for instance or two-step verification.

Reading Data from Client

Here is a code snippet of how to get the returned values from the response:

The callback (available starting from v1.66) to retrieve custom optional Data returned during authentication with your custom server:

Data Types Conversion

In this section, only the type of data exchanged between Photon server and the web service is explained. For more information about data types between clients and Photon servers please refer to serialization in Photon page.

Photon Server -> Web Service

C# / .Net (Photon supported types) JavaScript / JSON
byte number
short
int
long
double
bool bool
string string
byte array (length < short.MaxValue) string (Base64 encoded)
array ([] of supported type, length < short.MaxValue) array
Hashtable (of supported types, count < short.MaxValue, preferably Photon implementation) object
Dictionary (keys and values of supported types, count < short.MaxValue) object
null null

Sample request data (types are concatenated)

As sent from Photon Server:

As read by Web Service:

Web Service -> Photon Server

Here is a table that matches each JavaScript/JSON type to its equivalent one in C#/.Net :

JavaScript / JSON C# / .Net
object Dictionary<string, object>
array object[]
number (integral) long
number (floating) double
string string
boolean bool
null (not a type) null
undefined (when sent) null

Sample response data (types are concatenated)

As sent from Web Service:

As read from Photon Server:

Troubleshooting

When Custom Authentication fails, the following callback is triggered:

In case the authentication URL you configured in your dashboard returns some HTTP error, the Photon server pauses the authentication calls for a short time to avoid some overhead. Take this "backoff" time into consideration when configuring or testing your URLs.

Best Practices

  • From dashboard, set static key/value pairs that should not be set from client side. This will prevent duplicate keys in the resulting query string.
  • For security reasons, do not send plain text passwords as authentication parameter.
  • It is recommended to set query string parameters from Photon dashboard. That way you can check the origin of the request.
  • Make use of the AuthenticationValues methods to set parameters and do not affect a value directly to AuthGetParameters. This will prevent malformed query string.
  • The returned result from the authentication provider should contain a readable Message especially in case of failure. This will save you a lot of debugging pain.

Use Case Example: Block Old Client Versions

You can use custom authentication to refuse connections incoming from clients using old versions (or unexpected versions) and return a specific error so you can ask the user to update. To do this you need to send the version in the custom authentication request. It is up to you to decide if you want to do it as query string parameter or a POST data argument. In the example below we will use query string parameter:

If your custom authentication URL is https://example.com then the request will be sent as https://example.com?version={version}. From your authentication provider implementation you should get and compare the version received. If the version is allowed return {ResultCode:1}. If not you should return a ResultCode with a custom value of your choice (different than 1), preferably with a message. Example: {ResultCode:5, Message: 'Version not allowed.'}.

 To Document Top