feat(mobile): add U2F support for Android devices (#2311)

* feat(mobile): add U2F support for Android devices

* chore: fix specs

packages/snjs/lib/Application/Application.ts

@@ -102,6 +102,7 @@ import { ListRevisions } from '@Lib/Domain/UseCase/ListRevisions/ListRevisions'
 import { GetRevision } from '@Lib/Domain/UseCase/GetRevision/GetRevision'
 import { DeleteRevision } from '@Lib/Domain/UseCase/DeleteRevision/DeleteRevision'
 import { GetAuthenticatorAuthenticationResponse } from '@Lib/Domain/UseCase/GetAuthenticatorAuthenticationResponse/GetAuthenticatorAuthenticationResponse'
+import { GetAuthenticatorAuthenticationOptions } from '@Lib/Domain/UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions'
 
 /** How often to automatically sync, in milliseconds */
 const DEFAULT_AUTO_SYNC_INTERVAL = 30_000
@@ -182,6 +183,7 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
   private declare _addAuthenticator: AddAuthenticator
   private declare _listAuthenticators: ListAuthenticators
   private declare _deleteAuthenticator: DeleteAuthenticator
+  private declare _getAuthenticatorAuthenticationOptions: GetAuthenticatorAuthenticationOptions
   private declare _getAuthenticatorAuthenticationResponse: GetAuthenticatorAuthenticationResponse
   private declare _listRevisions: ListRevisions
   private declare _getRevision: GetRevision
@@ -284,6 +286,10 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
     return this._deleteAuthenticator
   }
 
+  get getAuthenticatorAuthenticationOptions(): GetAuthenticatorAuthenticationOptions {
+    return this._getAuthenticatorAuthenticationOptions
+  }
+
   get getAuthenticatorAuthenticationResponse(): GetAuthenticatorAuthenticationResponse {
     return this._getAuthenticatorAuthenticationResponse
   }
@@ -1819,8 +1825,10 @@ export class SNApplication implements ApplicationInterface, AppGroupManagedAppli
 
     this._deleteAuthenticator = new DeleteAuthenticator(this.authenticatorManager)
 
+    this._getAuthenticatorAuthenticationOptions = new GetAuthenticatorAuthenticationOptions(this.authenticatorManager)
+
     this._getAuthenticatorAuthenticationResponse = new GetAuthenticatorAuthenticationResponse(
-      this.authenticatorManager,
+      this._getAuthenticatorAuthenticationOptions,
       this.options.u2fAuthenticatorVerificationPromptFunction,
     )
 

packages/snjs/lib/Domain/UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions.spec.ts

@@ -0,0 +1,42 @@
+import { AuthenticatorClientInterface } from '@standardnotes/services'
+
+import { GetAuthenticatorAuthenticationOptions } from './GetAuthenticatorAuthenticationOptions'
+
+describe('GetAuthenticatorAuthenticationOptions', () => {
+  let authenticatorClient: AuthenticatorClientInterface
+
+  const createUseCase = () => new GetAuthenticatorAuthenticationOptions(authenticatorClient)
+
+  beforeEach(() => {
+    authenticatorClient = {} as jest.Mocked<AuthenticatorClientInterface>
+    authenticatorClient.generateAuthenticationOptions = jest.fn().mockResolvedValue({ foo: 'bar' })
+  })
+
+  it('should return an error if username is not provided', async () => {
+    const result = await createUseCase().execute({
+      username: '',
+    })
+
+    expect(result.isFailed()).toBe(true)
+    expect(result.getError()).toBe('Could not generate authenticator authentication options: Username cannot be empty')
+  })
+
+  it('should return an error if authenticator client fails to generate authentication options', async () => {
+    authenticatorClient.generateAuthenticationOptions = jest.fn().mockResolvedValue(null)
+
+    const result = await createUseCase().execute({
+      username: 'test@test.te',
+    })
+
+    expect(result.isFailed()).toBe(true)
+    expect(result.getError()).toBe('Could not generate authenticator authentication options')
+  })
+
+  it('should return ok if authenticator client succeeds to generate authenticator response', async () => {
+    const result = await createUseCase().execute({
+      username: 'test@test.te',
+    })
+
+    expect(result.isFailed()).toBe(false)
+  })
+})

packages/snjs/lib/Domain/UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions.ts

@@ -0,0 +1,23 @@
+import { AuthenticatorClientInterface } from '@standardnotes/services'
+import { Result, UseCaseInterface, Username } from '@standardnotes/domain-core'
+
+import { GetAuthenticatorAuthenticationOptionsDTO } from './GetAuthenticatorAuthenticationOptionsDTO'
+
+export class GetAuthenticatorAuthenticationOptions implements UseCaseInterface<Record<string, unknown>> {
+  constructor(private authenticatorClient: AuthenticatorClientInterface) {}
+
+  async execute(dto: GetAuthenticatorAuthenticationOptionsDTO): Promise<Result<Record<string, unknown>>> {
+    const usernameOrError = Username.create(dto.username)
+    if (usernameOrError.isFailed()) {
+      return Result.fail(`Could not generate authenticator authentication options: ${usernameOrError.getError()}`)
+    }
+    const username = usernameOrError.getValue()
+
+    const authenticationOptions = await this.authenticatorClient.generateAuthenticationOptions(username)
+    if (authenticationOptions === null) {
+      return Result.fail('Could not generate authenticator authentication options')
+    }
+
+    return Result.ok(authenticationOptions)
+  }
+}

packages/snjs/lib/Domain/UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptionsDTO.ts

@@ -0,0 +1,3 @@
+export interface GetAuthenticatorAuthenticationOptionsDTO {
+  username: string
+}

packages/snjs/lib/Domain/UseCase/GetAuthenticatorAuthenticationResponse/GetAuthenticatorAuthenticationResponse.spec.ts

@@ -1,40 +1,31 @@
-import { AuthenticatorClientInterface } from '@standardnotes/services'
-
 import { GetAuthenticatorAuthenticationResponse } from './GetAuthenticatorAuthenticationResponse'
+import { GetAuthenticatorAuthenticationOptions } from '../GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions'
+import { Result } from '@standardnotes/domain-core'
 
 describe('GetAuthenticatorAuthenticationResponse', () => {
-  let authenticatorClient: AuthenticatorClientInterface
+  let getAuthenticatorAuthenticationOptions: GetAuthenticatorAuthenticationOptions
   let authenticatorVerificationPromptFunction: (
     authenticationOptions: Record<string, unknown>,
   ) => Promise<Record<string, unknown>>
 
-  const createUseCase = () => new GetAuthenticatorAuthenticationResponse(authenticatorClient, authenticatorVerificationPromptFunction)
+  const createUseCase = () => new GetAuthenticatorAuthenticationResponse(getAuthenticatorAuthenticationOptions, authenticatorVerificationPromptFunction)
 
   beforeEach(() => {
-    authenticatorClient = {} as jest.Mocked<AuthenticatorClientInterface>
-    authenticatorClient.generateAuthenticationOptions = jest.fn().mockResolvedValue({ foo: 'bar' })
+    getAuthenticatorAuthenticationOptions = {} as jest.Mocked<GetAuthenticatorAuthenticationOptions>
+    getAuthenticatorAuthenticationOptions.execute = jest.fn().mockResolvedValue(Result.ok({ foo: 'bar' }))
 
     authenticatorVerificationPromptFunction = jest.fn()
   })
 
-  it('should return an error if username is not provided', async () => {
-    const result = await createUseCase().execute({
-      username: '',
-    })
-
-    expect(result.isFailed()).toBe(true)
-    expect(result.getError()).toBe('Could not generate authenticator authentication options: Username cannot be empty')
-  })
-
-  it('should return an error if authenticator client fails to generate authentication options', async () => {
-    authenticatorClient.generateAuthenticationOptions = jest.fn().mockResolvedValue(null)
+  it('should return an error if it fails to generate authentication options', async () => {
+    getAuthenticatorAuthenticationOptions.execute = jest.fn().mockReturnValue(Result.fail('error'))
 
     const result = await createUseCase().execute({
       username: 'test@test.te',
     })
 
     expect(result.isFailed()).toBe(true)
-    expect(result.getError()).toBe('Could not generate authenticator authentication options')
+    expect(result.getError()).toBe('error')
   })
 
   it('should return an error if authenticator verification prompt function fails', async () => {
@@ -57,7 +48,7 @@ describe('GetAuthenticatorAuthenticationResponse', () => {
   })
 
   it('should return error if authenticatorVerificationPromptFunction is not provided', async () => {
-    const result = await new GetAuthenticatorAuthenticationResponse(authenticatorClient).execute({
+    const result = await new GetAuthenticatorAuthenticationResponse(getAuthenticatorAuthenticationOptions).execute({
       username: 'test@test.te',
     })
 

packages/snjs/lib/Domain/UseCase/GetAuthenticatorAuthenticationResponse/GetAuthenticatorAuthenticationResponse.ts

@@ -1,10 +1,10 @@
-import { AuthenticatorClientInterface } from '@standardnotes/services'
-import { Result, UseCaseInterface, Username } from '@standardnotes/domain-core'
+import { Result, UseCaseInterface } from '@standardnotes/domain-core'
 import { GetAuthenticatorAuthenticationResponseDTO } from './GetAuthenticatorAuthenticationResponseDTO'
+import { GetAuthenticatorAuthenticationOptions } from '../GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions'
 
 export class GetAuthenticatorAuthenticationResponse implements UseCaseInterface<Record<string, unknown>> {
   constructor(
-    private authenticatorClient: AuthenticatorClientInterface,
+    private getAuthenticatorAuthenticationOptions: GetAuthenticatorAuthenticationOptions,
     private authenticatorVerificationPromptFunction?: (
       authenticationOptions: Record<string, unknown>,
     ) => Promise<Record<string, unknown>>,
@@ -17,16 +17,13 @@ export class GetAuthenticatorAuthenticationResponse implements UseCaseInterface<
       )
     }
 
-    const usernameOrError = Username.create(dto.username)
-    if (usernameOrError.isFailed()) {
-      return Result.fail(`Could not generate authenticator authentication options: ${usernameOrError.getError()}`)
-    }
-    const username = usernameOrError.getValue()
-
-    const authenticationOptions = await this.authenticatorClient.generateAuthenticationOptions(username)
-    if (authenticationOptions === null) {
-      return Result.fail('Could not generate authenticator authentication options')
+    const authenticationOptionsOrError = await this.getAuthenticatorAuthenticationOptions.execute({
+      username: dto.username,
+    })
+    if (authenticationOptionsOrError.isFailed()) {
+      return Result.fail(authenticationOptionsOrError.getError())
     }
+    const authenticationOptions = authenticationOptionsOrError.getValue()
 
     let authenticatorResponse
     try {

packages/snjs/lib/Domain/UseCase/UseCaseContainerInterface.ts

@@ -7,6 +7,7 @@ import { GetAuthenticatorAuthenticationResponse } from './GetAuthenticatorAuthen
 import { ListRevisions } from './ListRevisions/ListRevisions'
 import { GetRevision } from './GetRevision/GetRevision'
 import { DeleteRevision } from './DeleteRevision/DeleteRevision'
+import { GetAuthenticatorAuthenticationOptions } from './GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions'
 
 export interface UseCaseContainerInterface {
   get signInWithRecoveryCodes(): SignInWithRecoveryCodes
@@ -15,6 +16,7 @@ export interface UseCaseContainerInterface {
   get listAuthenticators(): ListAuthenticators
   get deleteAuthenticator(): DeleteAuthenticator
   get getAuthenticatorAuthenticationResponse(): GetAuthenticatorAuthenticationResponse
+  get getAuthenticatorAuthenticationOptions(): GetAuthenticatorAuthenticationOptions
   get listRevisions(): ListRevisions
   get getRevision(): GetRevision
   get deleteRevision(): DeleteRevision

packages/snjs/lib/Domain/index.ts

@@ -6,6 +6,8 @@ export * from './UseCase/DeleteAuthenticator/DeleteAuthenticator'
 export * from './UseCase/DeleteAuthenticator/DeleteAuthenticatorDTO'
 export * from './UseCase/DeleteRevision/DeleteRevision'
 export * from './UseCase/DeleteRevision/DeleteRevisionDTO'
+export * from './UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptions'
+export * from './UseCase/GetAuthenticatorAuthenticationOptions/GetAuthenticatorAuthenticationOptionsDTO'
 export * from './UseCase/GetAuthenticatorAuthenticationResponse/GetAuthenticatorAuthenticationResponse'
 export * from './UseCase/GetAuthenticatorAuthenticationResponse/GetAuthenticatorAuthenticationResponseDTO'
 export * from './UseCase/GetRecoveryCodes/GetRecoveryCodes'