github/self
1
1
Fork 0
mirror of https://github.com/selfxyz/self.git synced 2026-02-19 02:24:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Centralize keychain error helpers and add unit tests (#1571)

Browse Source 
* Add keychain error tests

* format
This commit is contained in:
Justin Hernandez
2026-01-10 00:43:36 -08:00
committed by GitHub
parent 9d4c62225f
commit 665545cd65
4 changed files with 164 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
app/src/providers/authProvider.tsx
View File

@@ -25,6 +25,11 @@ import {
import { trackEvent } from '@/services/analytics';
import { useSettingStore } from '@/stores/settingStore';
import type { Mnemonic } from '@/types/mnemonic';
import {
getKeychainErrorIdentity,
isKeychainCryptoError,
isUserCancellation,
} from '@/utils/keychainErrors';
const SERVICE_NAME = 'secret';
@@ -151,29 +156,6 @@ let keychainCryptoFailureCallback:
| ((errorType: 'user_cancelled' | 'crypto_failed') => void)
| null = null;
function isUserCancellation(error: unknown): boolean {
const err = error as { code?: string; message?: string };
return Boolean(
err?.code === 'E_AUTHENTICATION_FAILED' ||
err?.code === 'USER_CANCELED' ||
err?.message?.includes('User canceled') ||
err?.message?.includes('Authentication canceled') ||
err?.message?.includes('cancelled by user'),
);
}
function isKeychainCryptoError(error: unknown): boolean {
const err = error as { code?: string; name?: string; message?: string };
return Boolean(
(err?.code === 'E_CRYPTO_FAILED' ||
err?.name === 'com.oblador.keychain.exceptions.CryptoFailedException' ||
err?.message?.includes('CryptoFailedException') ||
err?.message?.includes('Decryption failed') ||
err?.message?.includes('Authentication tag verification failed')) &&
!isUserCancellation(error),
);
}
async function loadOrCreateMnemonic(
keychainOptions: KeychainOptions,
): Promise<string | false> {
@@ -214,7 +196,7 @@ async function loadOrCreateMnemonic(
}
if (isKeychainCryptoError(error)) {
const err = error as { code?: string; name?: string };
const err = getKeychainErrorIdentity(error);
console.error('Keychain crypto error:', {
code: err?.code,
name: err?.name,

109
app/src/providers/passportDataProvider.tsx
View File

@@ -67,6 +67,12 @@ import { getAllDocuments, useSelfClient } from '@selfxyz/mobile-sdk-alpha';
import { createKeychainOptions } from '@/integrations/keychain';
import { unsafe_getPrivateKey, useAuth } from '@/providers/authProvider';
import type { KeychainErrorType } from '@/utils/keychainErrors';
import {
getKeychainErrorIdentity,
isKeychainCryptoError,
isUserCancellation,
} from '@/utils/keychainErrors';
let keychainCryptoFailureCallback:
| ((errorType: 'user_cancelled' | 'crypto_failed') => void)
@@ -78,29 +84,41 @@ export function setPassportKeychainErrorCallback(
keychainCryptoFailureCallback = callback;
}
function isUserCancellation(error: unknown): boolean {
const err = error as { code?: string; message?: string };
// User cancelled biometric/PIN authentication
return Boolean(
err?.code === 'E_AUTHENTICATION_FAILED' ||
err?.code === 'USER_CANCELED' ||
err?.message?.includes('User canceled') ||
err?.message?.includes('Authentication canceled') ||
err?.message?.includes('cancelled by user'),
);
function notifyKeychainFailure(type: KeychainErrorType) {
if (keychainCryptoFailureCallback) {
keychainCryptoFailureCallback(type);
}
}
function isKeychainCryptoError(error: unknown): boolean {
const err = error as { code?: string; name?: string; message?: string };
// Only true crypto failures, not user cancellations
return Boolean(
(err?.code === 'E_CRYPTO_FAILED' ||
err?.name === 'com.oblador.keychain.exceptions.CryptoFailedException' ||
err?.message?.includes('CryptoFailedException') ||
err?.message?.includes('Decryption failed') ||
err?.message?.includes('Authentication tag verification failed')) &&
!isUserCancellation(error),
);
function handleKeychainReadError({
contextLabel,
error,
throwOnUserCancel = false,
}: {
contextLabel: string;
error: unknown;
throwOnUserCancel?: boolean;
}) {
if (isUserCancellation(error)) {
console.log(`User cancelled authentication for ${contextLabel}`);
notifyKeychainFailure('user_cancelled');
if (throwOnUserCancel) {
throw error;
}
}
if (isKeychainCryptoError(error)) {
const err = getKeychainErrorIdentity(error);
console.error(`Keychain crypto error loading ${contextLabel}:`, {
code: err?.code,
name: err?.name,
});
notifyKeychainFailure('crypto_failed');
}
console.log(`Error loading ${contextLabel}:`, error);
}
// Create safe wrapper functions to prevent undefined errors during early initialization
@@ -482,25 +500,10 @@ export async function loadDocumentByIdDirectlyFromKeychain(
return JSON.parse(documentCreds.password);
}
} catch (error) {
if (isUserCancellation(error)) {
console.log(`User cancelled authentication for document ${documentId}`);
if (keychainCryptoFailureCallback) {
keychainCryptoFailureCallback('user_cancelled');
}
}
if (isKeychainCryptoError(error)) {
const err = error as { code?: string; name?: string };
console.error(`Keychain crypto error loading document ${documentId}:`, {
code: err?.code,
name: err?.name,
});
if (keychainCryptoFailureCallback) {
keychainCryptoFailureCallback('crypto_failed');
}
}
console.log(`Error loading document ${documentId}:`, error);
handleKeychainReadError({
contextLabel: `document ${documentId}`,
error,
});
}
return null;
}
@@ -544,27 +547,11 @@ export async function loadDocumentCatalogDirectlyFromKeychain(): Promise<Documen
return parsed;
}
} catch (error) {
if (isUserCancellation(error)) {
console.log('User cancelled authentication for document catalog');
if (keychainCryptoFailureCallback) {
keychainCryptoFailureCallback('user_cancelled');
}
throw error;
}
if (isKeychainCryptoError(error)) {
const err = error as { code?: string; name?: string };
console.error('Keychain crypto error loading document catalog:', {
code: err?.code,
name: err?.name,
});
if (keychainCryptoFailureCallback) {
keychainCryptoFailureCallback('crypto_failed');
}
}
console.log('Error loading document catalog:', error);
handleKeychainReadError({
contextLabel: 'document catalog',
error,
throwOnUserCancel: true,
});
}
// Return empty catalog if none exists

46
app/src/utils/keychainErrors.ts Normal file
View File

@@ -0,0 +1,46 @@
// SPDX-FileCopyrightText: 2025 Social Connect Labs, Inc.
// SPDX-License-Identifier: BUSL-1.1
// NOTE: Converts to Apache-2.0 on 2029-06-11 per LICENSE.
export type KeychainErrorIdentity = {
code?: string;
name?: string;
};
type KeychainError = {
code?: string;
message?: string;
name?: string;
};
export type KeychainErrorType = 'user_cancelled' | 'crypto_failed';
export function getKeychainErrorIdentity(
error: unknown,
): KeychainErrorIdentity {
const err = error as KeychainError;
return { code: err?.code, name: err?.name };
}
export function isKeychainCryptoError(error: unknown): boolean {
const err = error as KeychainError;
return Boolean(
(err?.code === 'E_CRYPTO_FAILED' ||
err?.name === 'com.oblador.keychain.exceptions.CryptoFailedException' ||
err?.message?.includes('CryptoFailedException') ||
err?.message?.includes('Decryption failed') ||
err?.message?.includes('Authentication tag verification failed')) &&
!isUserCancellation(error),
);
}
export function isUserCancellation(error: unknown): boolean {
const err = error as KeychainError;
return Boolean(
err?.code === 'E_AUTHENTICATION_FAILED' ||
err?.code === 'USER_CANCELED' ||
err?.message?.includes('User canceled') ||
err?.message?.includes('Authentication canceled') ||
err?.message?.includes('cancelled by user'),
);
}