Files
inji-wallet/machines/settings.ts
KiruthikaJeyashankar 33be02538a refactor(INJI-449): replace crypto-js with node-forge for encryption/decryption (#1034)
* refactor(INJI-449): replace crypo-js with node-forge

crypto-js has vulneraribitiles prior to version 4.2.0 for encryption / decryption & 4.x.x version is not compatible with our react native project For this reason we had to move to different library for encryption / decryption

Co-authored-by: Sreenadh S <32409698+sree96@users.noreply.github.com>
Signed-off-by: Kiruthika Jeyashankar <81218987+KiruthikaJeyashankar@users.noreply.github.com>

* fix(INJI-449): secure-keystore warning popup shown on reload of app

settings key which was stored in storage was not loaded into settings machine context correctly, which caused the bug - on reload settings related flows was falling back to initial setting.

Co-authored-by: Sreenadh S <32409698+sree96@users.noreply.github.com>

Signed-off-by: Kiruthika Jeyashankar <81218987+KiruthikaJeyashankar@users.noreply.github.com>

* refactor(INJI-449): gitignore automation test results

Signed-off-by: Kiruthika Jeyashankar <81218987+KiruthikaJeyashankar@users.noreply.github.com>

* refactor(INJI-449): simplify usage of methods in node-forge

Signed-off-by: Kiruthika Jeyashankar <81218987+KiruthikaJeyashankar@users.noreply.github.com>

---------

Signed-off-by: Kiruthika Jeyashankar <81218987+KiruthikaJeyashankar@users.noreply.github.com>
Co-authored-by: Sreenadh S <32409698+sree96@users.noreply.github.com>
2023-11-29 14:32:34 +05:30

326 lines
8.9 KiB
TypeScript

import {assign, ContextFrom, EventFrom, send, StateFrom} from 'xstate';
import {createModel} from 'xstate/lib/model';
import {AppServices} from '../shared/GlobalContext';
import {
APP_ID_DICTIONARY,
APP_ID_LENGTH,
MIMOTO_BASE_URL,
isIOS,
SETTINGS_STORE_KEY,
ESIGNET_BASE_URL,
} from '../shared/constants';
import {VCLabel} from '../types/VC/ExistingMosipVC/vc';
import {StoreEvents} from './store';
import getAllConfigurations, {
COMMON_PROPS_KEY,
} from '../shared/commonprops/commonProps';
import Storage from '../shared/storage';
import ShortUniqueId from 'short-unique-id';
import {__AppId} from '../shared/GlobalVariables';
import {isHardwareKeystoreExists} from '../shared/cryptoutil/cryptoUtil';
const model = createModel(
{
serviceRefs: {} as AppServices,
name: '',
vcLabel: {
singular: 'Card',
plural: 'Cards',
} as VCLabel,
isBiometricUnlockEnabled: false,
credentialRegistry: MIMOTO_BASE_URL,
esignetHostUrl: ESIGNET_BASE_URL,
appId: null,
hasUserShownWithHardwareKeystoreNotExists: false,
credentialRegistryResponse: '' as string,
},
{
events: {
UPDATE_NAME: (name: string) => ({name}),
UPDATE_VC_LABEL: (label: string) => ({label}),
TOGGLE_BIOMETRIC_UNLOCK: (enable: boolean) => ({enable}),
STORE_RESPONSE: (response: unknown) => ({response}),
CHANGE_LANGUAGE: (language: string) => ({language}),
UPDATE_MIMOTO_HOST: (credentialRegistry: string) => ({
credentialRegistry,
}),
UPDATE_ESIGNET_HOST: (esignetHostUrl: string) => ({esignetHostUrl}),
UPDATE_CREDENTIAL_REGISTRY_RESPONSE: (
credentialRegistryResponse: string,
) => ({
credentialRegistryResponse: credentialRegistryResponse,
}),
INJI_TOUR_GUIDE: () => ({}),
BACK: () => ({}),
CANCEL: () => ({}),
ACCEPT_HARDWARE_SUPPORT_NOT_EXISTS: () => ({}),
},
},
);
export const SettingsEvents = model.events;
export const settingsMachine = model.createMachine(
{
predictableActionArguments: true,
preserveActionOrder: true,
tsTypes: {} as import('./settings.typegen').Typegen0,
schema: {
context: model.initialContext,
events: {} as EventFrom<typeof model>,
},
id: 'settings',
initial: 'init',
states: {
init: {
entry: ['requestStoredContext'],
on: {
STORE_RESPONSE: [
{
cond: 'hasPartialData',
target: 'idle',
actions: ['setContext', 'updatePartialDefaults', 'storeContext'],
},
{cond: 'hasData', target: 'idle', actions: ['setContext']},
{target: 'storingDefaults'},
],
},
},
storingDefaults: {
entry: ['updateDefaults', 'storeContext'],
on: {
STORE_RESPONSE: 'idle',
},
},
idle: {
on: {
TOGGLE_BIOMETRIC_UNLOCK: {
actions: ['toggleBiometricUnlock', 'storeContext'],
},
UPDATE_NAME: {
actions: ['updateName', 'storeContext'],
},
UPDATE_VC_LABEL: {
actions: ['updateVcLabel', 'storeContext'],
},
UPDATE_MIMOTO_HOST: {
actions: ['resetCredentialRegistry'],
target: 'resetInjiProps',
},
UPDATE_ESIGNET_HOST: {
actions: ['updateEsignetHostUrl', 'storeContext'],
},
CANCEL: {
actions: ['resetCredentialRegistry'],
},
INJI_TOUR_GUIDE: {
target: 'showInjiTourGuide',
},
ACCEPT_HARDWARE_SUPPORT_NOT_EXISTS: {
actions: [
'updateUserShownWithHardwareKeystoreNotExists',
'storeContext',
],
target: 'idle',
},
},
},
resetInjiProps: {
invoke: {
src: 'resetInjiProps',
onDone: {
actions: [
'updateCredentialRegistrySuccess',
'updateCredentialRegistry',
'storeContext',
],
target: 'idle',
},
onError: {
actions: ['updateCredentialRegistryResponse'],
target: 'idle',
},
},
on: {
CANCEL: {
actions: ['resetCredentialRegistry'],
target: 'idle',
},
},
},
showInjiTourGuide: {
on: {
BACK: {
target: 'idle',
},
},
},
},
},
{
actions: {
requestStoredContext: send(StoreEvents.GET(SETTINGS_STORE_KEY), {
to: context => context.serviceRefs.store,
}),
updateDefaults: model.assign({
appId: (_, event) => {
const appId =
event.response != null &&
event.response.encryptedData == null &&
event.response.appId != null
? event.response.appId
: generateAppId();
__AppId.setValue(appId);
return appId;
},
hasUserShownWithHardwareKeystoreNotExists: () => false,
}),
updatePartialDefaults: model.assign({
appId: context => context.appId || generateAppId(),
}),
storeContext: send(
context => {
const {serviceRefs, ...data} = context;
return StoreEvents.SET(SETTINGS_STORE_KEY, data);
},
{to: context => context.serviceRefs.store},
),
setContext: model.assign((context, event) => {
const newContext = event.response as ContextFrom<typeof model>;
__AppId.setValue(newContext.appId);
return {
...context,
...newContext.encryptedData,
appId: newContext.appId,
};
}),
updateName: model.assign({
name: (_, event) => event.name,
}),
updateEsignetHostUrl: model.assign({
esignetHostUrl: (_, event) => event.esignetHostUrl,
}),
updateVcLabel: model.assign({
vcLabel: (_, event) => ({
singular: event.label,
plural: event.label + 's',
}),
}),
updateCredentialRegistry: assign({
credentialRegistry: (_context, event) => event.data.warningDomainName,
}),
updateCredentialRegistryResponse: assign({
credentialRegistryResponse: () => 'error',
}),
updateCredentialRegistrySuccess: assign({
credentialRegistryResponse: () => 'success',
}),
resetCredentialRegistry: model.assign({
credentialRegistryResponse: () => '',
}),
updateUserShownWithHardwareKeystoreNotExists: model.assign({
hasUserShownWithHardwareKeystoreNotExists: () => true,
}),
toggleBiometricUnlock: model.assign({
isBiometricUnlockEnabled: (_, event) => event.enable,
}),
},
services: {
resetInjiProps: async (context, event) => {
try {
await Storage.removeItem(COMMON_PROPS_KEY);
return await getAllConfigurations(event.credentialRegistry);
} catch (error) {
console.log('Error from resetInjiProps ', error);
throw error;
}
},
},
guards: {
hasData: (_, event) =>
event.response != null &&
event.response.encryptedData != null &&
event.response.appId != null,
hasPartialData: (_, event) =>
event.response != null && event.response.appId == null,
},
},
);
export function createSettingsMachine(serviceRefs: AppServices) {
return settingsMachine.withContext({
...settingsMachine.context,
serviceRefs,
});
}
function generateAppId() {
const shortUUID = new ShortUniqueId({
length: APP_ID_LENGTH,
dictionary: APP_ID_DICTIONARY,
});
return shortUUID.randomUUID();
}
function deviceSupportsHardwareKeystore() {
return isIOS() ? true : isHardwareKeystoreExists;
}
type State = StateFrom<typeof settingsMachine>;
export function selectName(state: State) {
return state.context.name;
}
export function selectAppId(state: State) {
return state.context.appId;
}
/** Alerting the user when the hardware keystore not supported by device and
* not shown to user atlease once */
export function selectShowHardwareKeystoreNotExistsAlert(state: State) {
const hasShown = state.context.hasUserShownWithHardwareKeystoreNotExists;
const deviceSupports = deviceSupportsHardwareKeystore();
return !hasShown && !deviceSupports;
}
export function selectVcLabel(state: State) {
return state.context.vcLabel;
}
export function selectCredentialRegistry(state: State) {
return state.context.credentialRegistry;
}
export function selectEsignetHostUrl(state: State) {
return state.context.esignetHostUrl;
}
export function selectCredentialRegistryResponse(state: State) {
return state.context.credentialRegistryResponse;
}
export function selectBiometricUnlockEnabled(state: State) {
return state.context.isBiometricUnlockEnabled;
}
export function selectIsResetInjiProps(state: State) {
return state.matches('resetInjiProps');
}