Skip to content

Custom OAuth Setup

This guide shows how to configure Arcana Auth SDK for apps using custom OAuth and allow authenticated users to sign blockchain transactions.

Prerequisites

Step 1: Dashboard Log-in

Log in to the Arcana Developer Dashboard and click your registered app entry from the 'Manage Apps' screen. Click Configure in the LHS navigation area. Select Social Auth and scroll down to the Custom OAuth section.

Custom OAuth Nav

Step 2: Configure JWK Settings

  • JWKS Endpoint: This is a read-only URL exposed by the custom OAuth 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.

See custom OAuth settings for details.

Step3: Get Custom Provider ID

Click Save after specifying the custom OAuth settings in the dashboard. Each application intending to utilize custom OAuth is allocated a unique custom provider identifier, visible within the dashboard interface once the custom OAuth 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 OAuth with the Arcana Auth SDK.

That's all!

What's Next?

After configuring the custom OAuth settings via the dashboard, you can install the Arcana Auth SDK and integrate your app.

Make sure you have already added code for custom OAuth and enabled user login via the custom authentication server. Get a JWT for the authenticated user.

During app integration with the Arcana Auth SDK, initialize the SDK first and then call loginWithCustomProvider with the JWT token and the custom provider identifier as input parameters along with user identifier string. This function will fetch the authenticated user key shares securely. See how to integrate apps using custom OAuth for details.

See Also


Last update: May 15, 2024 by shaloo