charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Authentication doc

Browse Source
This commit is contained in:
Chris Langsenkamp 2019-07-06 16:32:21 -04:00
parent e9205823ca
commit 7348ab3ecd
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/Concepts/Authentication.md
View File

@ -1,14 +1,20 @@
# Authentication
When you have a multiplayer game, often you need to store information about your player for later games, keep game stats or communicate with your friends. For all these use cases, you often need a way to uniquely identify a user. Being able to tell users appart is called authentication. There are several methods available, some examples include:
When you have a multiplayer game, often you need to store information about your player for later games, keep game stats or communicate with your friends. For all these use cases, you often need a way to uniquely identify a user. Being able to tell users apart is called authentication. There are several methods available, some examples include:
* Ask the user for username and password
* Use a third party oath or openid identity provider, such as facebook, twitter, google
* Use a third party service such as playfab, gamelift or steam
* Use the device id, very popular method in mobile
* Use Google Play in android
* Use Game Center in ios
* Use a web service in your website
- Ask the user for username and password
- Use a third party oath or OpenID identity provider, such as Facebook, Twitter, Google
- Use a third party service such as PlayFab, GameLift or Steam
- Use the device id, very popular method in mobile
- Use Google Play in Android
- Use Game Center in IOS
- Use a web service in your website
Trying to write a comprehensive authentication framework that cover all these is very complex. There is no one size fit all, and we would quickly end up with bloated code.
@ -16,15 +22,17 @@ Instead, **Mirror does not perform authentication**, but we provide hooks you c
Here is an example of how to implement simple username/password authentication:
1) Select your NetworkManager gameobject in the unity editor.
2) In the inspector, under `Spawn Info`, disable `Auto Create Player`
3) Call `AddPlayer` in your client to pass the credentials.
4) Override the `OnServerAddPlayer` method and validate the user's credential.
1. Select your `NetworkManager` game object in the unity editor.
2. In the inspector, under `Spawn Info`, disable `Auto Create Player`
For example this would be part of your NetworkManager class:
3. Call `AddPlayer` in your client to pass the credentials.
```cs
4. Override the `OnServerAddPlayer` method and validate the user's credential.
For example this would be part of your `NetworkManager` class:
``` cs
class MyGameNetworkManager : NetworkManager {
class CredentialsMessage : MessageBase
@ -35,16 +43,14 @@ class MyGameNetworkManager : NetworkManager {
public string password;
}
// this gets called in your client after
// it has connected to the server,
// this gets called on the client after it has connected to the server
public override void OnClientConnect(NetworkConnection conn)
{
base.OnClientConnect(conn);
var msg = new CredentialsMessage()
CredentialsMessage msg = new CredentialsMessage()
{
// perhaps get the username and password
// from textboxes instead
// perhaps get the username and password from textboxes instead
username = "Joe",
password = "Gaba Gaba"
};
@ -52,11 +58,10 @@ class MyGameNetworkManager : NetworkManager {
ClientScene.AddPlayer(conn, MessagePacker.Pack(msg));
}
// this gets called in your server when the
// client requests to add a player.
// this gets called in your server when the client requests to add a player.
public override void OnServerAddPlayer(NetworkConnection conn, AddPlayerMessage extraMessage)
{
var msg = MessagePacker.Unpack<CredentialsMessage>(extraMessage.value);
CredentialsMessage msg = MessagePacker.Unpack<CredentialsMessage>(extraMessage.value);
// check the credentials by calling your web server, database table, playfab api, or any method appropriate.
if (msg.username == "Joe" && msg.password == "Gaba Gaba")
@ -70,7 +75,6 @@ class MyGameNetworkManager : NetworkManager {
}
}
}
```
## Warning