Skip to content

Custom Auth Setup

Estimated time to read: 2 minutes

Learn how to configure Custom Auth for using the Arcana Auth SDK in apps that use custom user authentication and allow authenticated users to sign blockchain transactions.

Prerequisites

Logging into Arcana Developer Dashboard requires an account with a supported social login provider or an email for passwordless access.

  • Google
  • GitHub
  • Twitch
  • Discord

Visit https://dashboard.arcana.network and log in using one of the available options.

Welcome screen
Developer Dashboard Login Page

Aggregate Login

The Arcana Developer Dashboard protocol combines multiple login identities from social providers into single Arcana account. This means developers can log into the Arcana Developer Dashboard with any supported login provider. They will still access the same Arcana developer account and app settings.

1. Register App

Log into the Arcana Developer Dashboard to register the app. Create a new app. Jump to the next section if the app is already registered.

2. Configure Custom Auth

In the 'Manage Apps' screen, click Configure in the LHS navigation. Select Social Auth and scroll down to the section Custom Auth.

Custom Auth Nav
Update Custom Auth Settings

Provide inputs for the Custom Auth settings:

  • JWKS Endpoint: This is a read-only URL exposed by the Custom Auth server or any other server that manages the cryptographic keys or JSON Web Keys (JWK) as per the IETF RFC7517 standard.
  • User Identifier String: Select the type of user identifier that the developer will share while integrating the app with the Arcana Auth SDK, as part of input parameters CustomProviderParams in the loginWithCustomProvider() function call. Choose one of the sub, email or a custom string.
  • Issuer: A string identifier representing the principal who issued the JWT.
  • Audience: A string identifier representing the recipient that the JWT is intended for.
  • JWT Validation (Optional): Specify one or more key, value pairs of attributes/claims that can be used to verify the JWT provided as the input parameter CustomProviderParams in the loginWithCustomProvider() function call.

Click Save after specifying the Custom Auth settings in the dashboard.

3. Get Custom Provider ID

In addition to the Client ID, every registered app configured for using Custom Auth is also allocated a unique custom provider identifier. It is displayed in the dashboard once the Custom Auth settings are updated. Make a note of the custom provider identifier.

Both, the Client ID assigned to the app after registration and the custom provider identifier is required later for integrating the app using Custom Auth with the Arcana Auth SDK.

What's Next?

After configuring, integrate the Web3 app using Custom Auth with the Auth SDK, use loginWithCustomProvider to assign keys to authenticated users securely. Then use the AuthProvider to issue JSON/RPC functions and Web3 wallet operations from within the app context.

See Also


Last update: September 4, 2024 by shaloo