feat: improving loginAttempt storage (#1067)

Signed-off-by: Caroline Lucas Calheirani <[email protected]>

packages/legacy/core/App/constants.ts

@@ -12,7 +12,6 @@ export const testIdPrefix = 'com.ariesbifold:id/'
 
 export enum LocalStorageKeys {
   Onboarding = 'OnboardingState',
-  LoginAttempts = 'LoginAttempts',
   // FIXME: Once hooks are updated this should no longer be necessary
   RevokedCredentials = 'RevokedCredentials',
   RevokedCredentialsMessageDismissed = 'RevokedCredentialsMessageDismissed',
@@ -24,6 +23,7 @@ export enum LocalStorageKeys {
 export enum KeychainServices {
   Salt = 'secret.wallet.salt',
   Key = 'secret.wallet.key',
+  LoginAttempt = 'wallet.loginAttempt',
 }
 
 export enum EventTypes {

packages/legacy/core/App/contexts/reducers/store.ts

@@ -1,6 +1,7 @@
 import AsyncStorage from '@react-native-async-storage/async-storage'
 
 import { LocalStorageKeys } from '../../constants'
+import { storeLoginAttempt } from '../../services/keychain'
 import {
   Preferences as PreferencesState,
   Tours as ToursState,
@@ -415,7 +416,7 @@ export const reducer = <S extends State>(state: S, action: ReducerAction<Dispatc
         ...state,
         loginAttempt,
       }
-      AsyncStorage.setItem(LocalStorageKeys.LoginAttempts, JSON.stringify(newState.loginAttempt))
+      storeLoginAttempt(loginAttempt)
       return newState
     }
     case LockoutDispatchAction.LOCKOUT_UPDATED: {

packages/legacy/core/App/index.ts

@@ -42,6 +42,7 @@ import Preface from './screens/Preface'
 import Splash from './screens/Splash'
 import Terms from './screens/Terms'
 import UseBiometry from './screens/UseBiometry'
+import { loadLoginAttempt } from './services/keychain'
 import * as types from './types'
 
 export { LocalStorageKeys } from './constants'
@@ -144,4 +145,5 @@ export {
   components,
   contexts,
   Text,
+  loadLoginAttempt,
 }

packages/legacy/core/App/screens/Splash.tsx

@@ -17,6 +17,7 @@ import { useConfiguration } from '../contexts/configuration'
 import { DispatchAction } from '../contexts/reducers/store'
 import { useStore } from '../contexts/store'
 import { useTheme } from '../contexts/theme'
+import { loadLoginAttempt } from '../services/keychain'
 import { BifoldError } from '../types/error'
 import { Screens, Stacks } from '../types/navigators'
 import {
@@ -104,9 +105,8 @@ const Splash: React.FC = () => {
   })
 
   const loadAuthAttempts = async (): Promise<LoginAttemptState | undefined> => {
-    const attemptsData = await AsyncStorage.getItem(LocalStorageKeys.LoginAttempts)
-    if (attemptsData) {
-      const attempts = JSON.parse(attemptsData) as LoginAttemptState
+    const attempts = await loadLoginAttempt()
+    if (attempts) {
       dispatch({
         type: DispatchAction.ATTEMPT_UPDATED,
         payload: [attempts],

packages/legacy/core/App/services/keychain.ts

@@ -4,11 +4,12 @@ import uuid from 'react-native-uuid'
 
 import { walletId, KeychainServices } from '../constants'
 import { WalletSecret } from '../types/security'
+import { LoginAttempt } from '../types/state'
 import { hashPIN } from '../utils/crypto'
 
 const keyFauxUserName = 'WalletFauxPINUserName'
 const saltFauxUserName = 'WalletFauxSaltUserName'
-
+const loginAttemptFauxUserName = 'WalletFauxLoginAttemptUserName'
 export interface WalletSalt {
   id: string
   salt: string
@@ -72,6 +73,13 @@ export const storeWalletSalt = async (secret: WalletSalt): Promise<boolean> => {
   return typeof result === 'boolean' ? false : true
 }
 
+export const storeLoginAttempt = async (loginAttempt: LoginAttempt): Promise<boolean> => {
+  const opts = optionsForKeychainAccess(KeychainServices.LoginAttempt, false)
+  const loginAttemptAsString = JSON.stringify(loginAttempt)
+  const result = await Keychain.setGenericPassword(loginAttemptFauxUserName, loginAttemptAsString, opts)
+  return typeof result !== 'boolean'
+}
+
 export const storeWalletSecret = async (secret: WalletSecret, useBiometrics = false): Promise<boolean> => {
   let keyResult = false
   if (secret.key) {
@@ -95,6 +103,19 @@ export const loadWalletSalt = async (): Promise<WalletSalt | undefined> => {
   return JSON.parse(result.password) as WalletSalt
 }
 
+export const loadLoginAttempt = async (): Promise<LoginAttempt | undefined> => {
+  const opts: Keychain.Options = {
+    service: KeychainServices.LoginAttempt,
+  }
+
+  const result = await Keychain.getGenericPassword(opts)
+  if (!result) {
+    return
+  }
+
+  return JSON.parse(result.password) as LoginAttempt
+}
+
 export const loadWalletKey = async (title?: string, description?: string): Promise<WalletKey | undefined> => {
   let opts: Keychain.Options = {
     service: KeychainServices.Key,

packages/legacy/core/__tests__/screens/Splash.test.tsx

@@ -9,6 +9,7 @@ import Splash from '../../App/screens/Splash'
 import AsyncStorage from '../../__mocks__/@react-native-async-storage/async-storage'
 import authContext from '../contexts/auth'
 import configurationContext from '../contexts/configuration'
+import { loadLoginAttempt } from '../../App/services/keychain'
 
 jest.mock('@hyperledger/aries-askar-react-native', () => ({}))
 jest.mock('@hyperledger/anoncreds-react-native', () => ({}))
@@ -24,12 +25,15 @@ jest.mock('@react-navigation/core', () => {
     }),
   }
 })
+jest.mock('../../App/services/keychain', () => ({
+  loadLoginAttempt: jest.fn(),
+}))
 
 describe('Splash Screen', () => {
-  beforeAll(()=>{
+  beforeAll(() => {
     jest.useFakeTimers()
   })
-  afterAll(()=>{
+  afterAll(() => {
     jest.useRealTimers()
   })
   test('Renders default correctly', async () => {
@@ -40,18 +44,18 @@ describe('Splash Screen', () => {
         </AuthContext.Provider>
       </ConfigurationContext.Provider>
     )
-    await act(()=>{ jest.runAllTimers() })
+    await act(() => {
+      jest.runAllTimers()
+    })
     expect(tree).toMatchSnapshot()
   })
 
   test('Starts onboarding correctly', async () => {
+    // @ts-ignore-next-line
+    loadLoginAttempt.mockReturnValue({ servedPenalty: true, loginAttempts: 0 })
+
     AsyncStorage.getItem = jest.fn().mockImplementation((key: string) => {
       switch (key) {
-        case LocalStorageKeys.LoginAttempts:
-          return JSON.stringify({
-            servedPenalty: true,
-            loginAttempts: 0,
-          })
         case LocalStorageKeys.Preferences:
           return JSON.stringify({
             useBiometry: false,
@@ -101,7 +105,9 @@ describe('Splash Screen', () => {
         </StoreProvider>
       )
     })
-    await act(()=>{ jest.runAllTimers() })
+    await act(() => {
+      jest.runAllTimers()
+    })
     expect(mockedDispatch).toHaveBeenCalled()
   })
 })