Microsoft - hippogamesunity/SimpleSignIn GitHub Wiki

Welcome to Simple Microsoft Sign-In wiki!

The asset provides Microsoft sign-in with OAuth 2.0 for Android, iOS, Windows, macOS, Universal Windows Platform (UWP) and WebGL apps made with Unity. You can also get access tokens to make REST API calls.

Benefits

  • Cross-platform user auth for cross-platform games and apps
  • No plugins, no 3rd party libs, no dependencies
  • No impact to build size
  • Get access tokens for integration with other Microsoft services
  • More security for client-server apps (get an access token on a client, get all user data on a server to avoid tampering)
  • JSON Web Tokens (JWT) validation
  • SFSafariViewController is used on iOS (required by App Store review)
  • Deep linking for Windows (UNITY_STANDALONE_WIN)

Terminology

Understanding how it works

  • Generic workflow (for platforms that support deep linking):

    • Your app navigates users to Microsoft Authorization Endpoint using a default web browser (embedded webviews are not allowed)
    • Users perform sign-in using their login and password
    • Microsoft Authorization Endpoint redirects users to Redirect URI (this can be a deep link when possible) and provides an authorization code to the app (as URI parameters)
    • The app is activated and obtains code
    • The app exchanges code for access token
    • The app requests user data with access token (ID, name, email and other data according access scope defined)

  • For Android, iOS, macOS, Windows and Universal Windows Platform (platforms that support deep linking):

    • Redirect URI is a deep link which activates the app and provides code in URI parameters

  • Loopback flow for Editor and Windows (optional):

    • This flow is optional for Windows (the generic workflow is used by default)
    • Redirect URI is http://localhost:PORT/ with a random unused port
    • The app listens to localhost using System.Net.HttpListener
    • The app obtains code and asks a user to close the browser tab and to return to the app
    • Further workflow is the same (exchanging code for access token, requesting user data)

  • Middleware flow for WebGL (the platform doesn't support deep linking and loopback):

    • OAuth Redirect to Authorization Middleware is used to temporary save code
    • The app obtains code from Authorization Middleware with a POST request
    • Further workflow is the same (exchanging code for access token, requesting user data)

Preconditions

  • For Android, iOS, macOS, Windows and UWP (platforms that support deep linking): COME UP WITH your Custom URI scheme (or Protocol). It MUST contain the period symbol . and small alphanumeric symbols only (no spaces, no undercores). In my example it is simple.oauth, but it can be jelly.bean (note that Custom URI scheme is not the same as your actual package name or bundle id).
  • For Android, iOS, UWP: enable deep linking as described in Unity documentation or as described below.
  • For Android: create AndroidManifest.xml inside Assets/Plugins/Android/, SET your Custom URI scheme inside, like <data android:scheme="simple.oauth" />. You can use AndroidManifestExample.xml from the asset as an example, just copy, rename and edit. AGAIN, DON'T FORGET TO REPLACE simple.oauth with your Custom URI scheme!
  • For iOS and macOS: navigate to Player Settings > Other > Configuration and add your Custom URI scheme to Supported URL schemes. In Xcode, make sure that the URL scheme is added (Register your URL scheme).
  • For Universal Windows Platform: navigate to Player Settings > Publishing Settings and set Protocol (it MUST contain a period symbol, for example simple.oauth), then enable InternetClient in Capabilities.
  • For Windows: navigate to Player Settings and enable Resolution and Presentation > Force Single Instance and set Other Settings > Api Compatibility Level = .NET Framework
  • For Editor: Set Allow downloads over HTTP = Always allowed (Unity 2022+)

Setup steps

  1. Visit Microsoft Entra admin center
  2. Navigate to Applications > App registrations and press New registration
  3. Enter your app name, choose Supported account types = Personal Microsoft accounts only and press Register Screenshot(https://github.com/hippogamesunity/SimpleSignIn/blob/main/Screenshots/Microsoft/RegisterApp.png?raw=true)
  4. Navigate to App registrations, select your app and copy Application (client) ID from Overview Screenshot(https://github.com/hippogamesunity/SimpleSignIn/blob/main/Screenshots/Microsoft/GetClientId.png?raw=true)
  5. Navigate to Authentication, press Add a platform in Platform configurations and chose Mobile and desktop applications type
  6. Add simple.oauth://oauth2/ms (USE YOUR custom URI scheme from Preconditions, but leave the same path oauth2/ms) to Redirect URIs and press Configure, then add http://localhost to Redirect URIs and press Save
  7. Press Add a platform in Platform configurations and choose Single-page application
  8. Add https://hippogames.dev/api/oauth/redirect to Redirect URIs, check Access tokens and ID tokens and press Configure
  9. Ensure you have the same setup as on Screenshot(https://github.com/hippogamesunity/SimpleSignIn/blob/main/Screenshots/Microsoft/RedirectURIs.png?raw=true)
  10. Return to Unity and configure Resources/MicrosoftAuthSettings.asset
    • Set Client Id from step 4
    • Set Client Uri Scheme from Preconditions
    • Check Access Scopes (openid, email, profile are required to get user info, offline_access is required to get refresh tokens)

Checklist

  • Custom URI scheme is picked, and it has a different value than simple.oauth
  • Custom URI scheme is set in 3 places: [1] Microsoft Entra admin center (Redirect URIs), [2] Resources/MicrosoftAuthSettings.asset, [3] your application manifest (AndroidManifest.xml for Android, Supported URL schemes for iOS, Protocol for UWP)
  • Client Id is copied to Resources/MicrosoftAuthSettings.asset

Usage

  1. Check our Example scene and C# code of Example.cs
  2. Create an instance of MicrosoftAuth
  3. Call MicrosoftAuth.SignIn or MicrosoftAuth.GetAccessToken
  4. Create OnSignIn or OnGetAccessToken callbacks
  5. Build and test
  6. Write a review on the Asset Store :)

Best practices

  • Call MicrosoftAuth.SignIn with caching: true to return cached UserInfo
  • Call MicrosoftAuth.SignIn with caching: false to request UserInfo from Microsoft
  • Call MicrosoftAuth.GetAccessToken instead of MicrosoftAuth.SignIn if you need an access token only (and don't need UserInfo)
  • You can use MicrosoftAuth.SavedAuth to get TokenResponse or UserInfo (don't forget to check all values for null)
  • Call MicrosoftAuth.SignOut when 'Sign out` button is pressed, optionally you can redirect user to Microsoft website for logout
  • Disable debug logs for production by setting MicrosoftAuth.DebugLog = false

Next steps (optional)

  • You can add extra access scopes in Resources/MicrosoftAuthSettings.asset
  • If you have a backend (server), send TokenResponse to it (to avoid tapmering user data when sending from clients to your server)
  • Validate JSON Web Token (JWT) encoded in TokenResponse.IdToken on your server (refer to JWT class for parsing and signature validation example)
  • For Editor and Windows (optional), you can modify StandaloneTemplate.html (used by the loopback flow) to edit the message "Success! Please close the browser tab and return to the app."
  • For Windows, check Settings for Windows
  • For WebGL, consider deploying your own Authorization Middleware
  • You can use this asset with async methods, just refer to MicrosoftAuth.cs for examples

Can I trust Authorization Middleware? Is it secure to use a 3rd party service?

  • Authorization Middleware can't exchange code for access token without knowing both client secret and code verifier. Only the app itself can exchange code for access token.
  • It's recommended to deploy your own trusted Authorization Middleware to handle sensitive data. Please refer to Authorization Middleware article.

Notes

  • Please refer to User data disclosure
  • Don't use default credentials that come with the asset in production, they are for test purposes only and can be disabled/blocked
  • Check Manual cancellation if needed

Known issues

  • Please visit Common issues section
  • To perform complete user sign out, you should redirect users to Microsoft website for logout by calling MicrosoftAuth.SignOut(logout: true) (after this, users will be able to enter credentinals)

Support

Links