Authentication with Battle.net
Prerequisites
Before configuring Catena to authenticate users with Battle.net, you must create a client in Battle.net community API Access.
To configure the client, you will need to provide Redirect URLs. This will be a combination of the PlatformUrl and the Battle.net RedirectUri - for example, when developing locally, this might look like (http://localhost:5000 http://localhost:5000/api/v1/authentication/PROVIDER_BATTLENET_WEB/callback)
You will need the "Client ID" and "Client Secret" from the created client to configure Catena.
Catena configuration
Open the appsettings for your environment and look for the Catena authentication service configuration section which contains a section for Battle.net (PROVIDER_BATTLENET_WEB). If the section does not exist, you may need to create it.
Fill ClientID and ClientSecret with the values from the created Battle.net client. Set the RedirectUri to the one shown in the example below as a starting point and make sure IsEnabled is set to true.
For example, in appsettings.Development.json:
{
"Catena": {
"Authentication": {
"Validators": {
"PROVIDER_BATTLENET_WEB": {
"ClientID": "<your client ID>",
"ClientSecret": "<your client secret>",
"RedirectUri": "/api/v1/authentication/PROVIDER_BATTLENET_WEB/callback",
"IsEnabled": true
}
}
}
}
}Make sure your appsettings.Development.json is added to .gitignore
ClientID/ClientSecret values to version of appsettings.json or appsettings.Production.json — these files are part of your deployed source and shouldn't hold production secrets. Use appsettings.Development.json for local testing only. Setting secrets in production
For a live production deployment, you don't want to expose your secrets in the appsettings file.
Catena provides 2 potential solutions for this.
- Inline Encryption - This allows you to encrypt values in your
appsettings.jsonso it can be commited and shared across the team with only one shared password stored offline. - Configuring Dokku Secrets - Using dokku, setup environment variables that are read in by the app
When using Dokku secrets, you can map the nested JSON values to a new environment variable.
For example, ClientID maps too:
Catena__Authentication__Validators__PROVIDER_BATTLENET_WEB__ClientIDThen Client Secret maps too:
Catena__Authentication__Validators__PROVIDER_BATTLENET_WEB__ClientSecretIf deploying via the AWS deployment guide, add these to your dokku-secrets.env file and run ./set-dokku-secrets.sh. For more details and instructions on how to rotate secrets, view the Secrets management page.