Add support for custom auth providers (authcode & authcode-pkce only)

Author: patrislav

packages/wallet/wdk/src/dbs/auth-commitments.ts

@@ -5,7 +5,7 @@ const TABLE_NAME = 'auth-commitments'
 
 export type AuthCommitment = {
   id: string
-  kind: 'google-pkce' | 'apple'
+  kind: 'google-pkce' | 'apple' | `custom-${string}`
   metadata: { [key: string]: string }
   verifier?: string
   challenge?: string

packages/wallet/wdk/src/sequence/handlers/authcode-pkce.ts

@@ -8,15 +8,16 @@ import { AuthCodeHandler } from './authcode.js'
 
 export class AuthCodePkceHandler extends AuthCodeHandler implements Handler {
   constructor(
-    signupKind: 'google-pkce',
+    signupKind: 'google-pkce' | `custom-${string}`,
     issuer: string,
+    oauthUrl: string,
     audience: string,
     nitro: Identity.IdentityInstrument,
     signatures: Signatures,
     commitments: Db.AuthCommitments,
     authKeys: Db.AuthKeys,
   ) {
-    super(signupKind, issuer, audience, nitro, signatures, commitments, authKeys)
+    super(signupKind, issuer, oauthUrl, audience, nitro, signatures, commitments, authKeys)
   }
 
   public async commitAuth(target: string, isSignUp: boolean, state?: string, signer?: string) {
@@ -50,8 +51,7 @@ export class AuthCodePkceHandler extends AuthCodeHandler implements Handler {
       state,
     })
 
-    const oauthUrl = this.oauthUrl()
-    return `${oauthUrl}?${searchParams.toString()}`
+    return `${this.oauthUrl}?${searchParams.toString()}`
   }
 
   public async completeAuth(

packages/wallet/wdk/src/sequence/handlers/authcode.ts

@@ -11,8 +11,9 @@ export class AuthCodeHandler extends IdentityHandler implements Handler {
   protected redirectUri: string = ''
 
   constructor(
-    public readonly signupKind: 'apple' | 'google-pkce',
+    public readonly signupKind: 'apple' | 'google-pkce' | `custom-${string}`,
     public readonly issuer: string,
+    protected readonly oauthUrl: string,
     public readonly audience: string,
     nitro: Identity.IdentityInstrument,
     signatures: Signatures,
@@ -48,12 +49,11 @@ export class AuthCodeHandler extends IdentityHandler implements Handler {
       client_id: this.audience,
       redirect_uri: this.redirectUri,
       response_type: 'code',
-      scope: 'openid',
+      scope: 'openid profile email',
       state,
     })
 
-    const oauthUrl = this.oauthUrl()
-    return `${oauthUrl}?${searchParams.toString()}`
+    return `${this.oauthUrl}?${searchParams.toString()}`
   }
 
   public async completeAuth(
@@ -100,15 +100,4 @@ export class AuthCodeHandler extends IdentityHandler implements Handler {
       },
     }
   }
-
-  protected oauthUrl() {
-    switch (this.issuer) {
-      case 'https://accounts.google.com':
-        return 'https://accounts.google.com/o/oauth2/v2/auth'
-      case 'https://appleid.apple.com':
-        return 'https://appleid.apple.com/auth/authorize'
-      default:
-        throw new Error('unsupported-issuer')
-    }
-  }
 }

packages/wallet/wdk/src/sequence/manager.ts

@@ -79,6 +79,13 @@ export type ManagerOptions = {
       enabled: boolean
       clientId: string
     }
+    customProviders?: {
+      kind: `custom-${string}`
+      authMethod: 'id-token' | 'authcode' | 'authcode-pkce'
+      issuer: string
+      oauthUrl: string
+      clientId: string
+    }[]
   }
 }
 
@@ -466,6 +473,7 @@ export class Manager {
         new AuthCodePkceHandler(
           'google-pkce',
           'https://accounts.google.com',
+          'https://accounts.google.com/o/oauth2/v2/auth',
           ops.identity.google.clientId,
           identityInstrument,
           modules.signatures,
@@ -480,6 +488,7 @@ export class Manager {
         new AuthCodeHandler(
           'apple',
           'https://appleid.apple.com',
+          'https://appleid.apple.com/auth/authorize',
           ops.identity.apple.clientId,
           identityInstrument,
           modules.signatures,
@@ -488,6 +497,46 @@ export class Manager {
         ),
       )
     }
+    if (ops.identity.customProviders?.length) {
+      for (const provider of ops.identity.customProviders) {
+        switch (provider.authMethod) {
+          case 'id-token':
+            throw new Error('id-token is not supported yet')
+          case 'authcode':
+            shared.handlers.set(
+              provider.kind,
+              new AuthCodeHandler(
+                provider.kind,
+                provider.issuer,
+                provider.oauthUrl,
+                provider.clientId,
+                identityInstrument,
+                modules.signatures,
+                shared.databases.authCommitments,
+                shared.databases.authKeys,
+              ),
+            )
+            break
+          case 'authcode-pkce':
+            shared.handlers.set(
+              provider.kind,
+              new AuthCodePkceHandler(
+                provider.kind,
+                provider.issuer,
+                provider.oauthUrl,
+                provider.clientId,
+                identityInstrument,
+                modules.signatures,
+                shared.databases.authCommitments,
+                shared.databases.authKeys,
+              ),
+            )
+            break
+          default:
+            throw new Error('unsupported auth method')
+        }
+      }
+    }
 
     shared.modules = modules
     this.shared = shared

packages/wallet/wdk/src/sequence/signers.ts

@@ -8,7 +8,11 @@ export function isWitnessExtraSignerKind(extra: any): extra is WitnessExtraSigne
 }
 
 function toKnownKind(kind: string): Kind {
-  if (Object.values(Kinds).includes(kind as Kind)) {
+  if (kind.startsWith('custom-')) {
+    return kind as Kind
+  }
+
+  if (Object.values(Kinds).includes(kind as (typeof Kinds)[keyof typeof Kinds])) {
     return kind as Kind
   }
 

packages/wallet/wdk/src/sequence/types/signer.ts

@@ -12,7 +12,7 @@ export const Kinds = {
   Unknown: 'unknown',
 } as const
 
-export type Kind = (typeof Kinds)[keyof typeof Kinds]
+export type Kind = (typeof Kinds)[keyof typeof Kinds] | `custom-${string}`
 
 export type WitnessExtraSignerKind = {
   signerKind: string

packages/wallet/wdk/src/sequence/wallets.ts

@@ -14,7 +14,7 @@ import { PasskeysHandler } from './handlers/passkeys.js'
 import { GuardRole } from './guards.js'
 
 export type StartSignUpWithRedirectArgs = {
-  kind: 'google-pkce' | 'apple'
+  kind: 'google-pkce' | 'apple' | `custom-${string}`
   target: string
   metadata: { [key: string]: string }
 }
@@ -55,7 +55,7 @@ export type CompleteRedirectArgs = CommonSignupArgs & {
 }
 
 export type AuthCodeSignupArgs = CommonSignupArgs & {
-  kind: 'google-pkce' | 'apple'
+  kind: 'google-pkce' | 'apple' | `custom-${string}`
   commitment: AuthCommitment
   code: string
   target: string
@@ -693,10 +693,30 @@ export class Wallets implements WalletsInterface {
         }
       }
     }
+
+    if (args.kind.startsWith('custom-')) {
+      // TODO: support other custom auth methods (e.g. id-token)
+      const handler = this.shared.handlers.get(args.kind) as AuthCodeHandler
+      if (!handler) {
+        throw new Error('handler-not-registered')
+      }
+
+      const [signer, metadata] = await handler.completeAuth(args.commitment, args.code)
+      return {
+        signer,
+        extra: {
+          signerKind: args.kind,
+        },
+        loginEmail: metadata.email,
+      }
+    }
+
+    throw new Error('invalid-signup-kind')
   }
 
   async startSignUpWithRedirect(args: StartSignUpWithRedirectArgs) {
-    const handler = this.shared.handlers.get('login-' + args.kind) as AuthCodeHandler
+    const kind = args.kind.startsWith('custom-') ? args.kind : 'login-' + args.kind
+    const handler = this.shared.handlers.get(kind) as AuthCodeHandler
     if (!handler) {
       throw new Error('handler-not-registered')
     }
@@ -721,7 +741,8 @@ export class Wallets implements WalletsInterface {
         use4337: args.use4337,
       })
     } else {
-      const handler = this.shared.handlers.get('login-' + commitment.kind) as AuthCodeHandler
+      const kind = commitment.kind.startsWith('custom-') ? commitment.kind : 'login-' + commitment.kind
+      const handler = this.shared.handlers.get(kind) as AuthCodeHandler
       if (!handler) {
         throw new Error('handler-not-registered')
       }