@onekeyfe/hd-core 1.1.34-alpha.3 → 1.1.34-alpha.4

package/src/api/firmware/FirmwareUpdatePreparedPlan.ts

@@ -1,403 +0,0 @@
-import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
-
-import { assertFirmwareArtifactReference } from './FirmwareArtifactSource';
-import {
-  FIRMWARE_UPDATE_PLAN_EPOCH_KINDS,
-  FIRMWARE_UPDATE_PLAN_ROLES,
-  FIRMWARE_UPDATE_PLAN_TARGETS,
-  assertFirmwareUpdatePlan,
-  digestFirmwareUpdateContract,
-} from './FirmwareUpdatePlan';
-
-import type {
-  FirmwareUpdatePreparedArtifact,
-  FirmwareUpdatePreparedArtifactInput,
-  FirmwareUpdatePreparedEntry,
-  FirmwareUpdatePreparedPlan,
-} from '../../types/api/firmwareUpdatePreparedPlan';
-import type { FirmwareArtifactReference } from '../../types/api/firmwareUpdate';
-import type { FirmwareUpdatePlan } from '../../types/api/firmwareUpdatePlan';
-
-const preparedPlanError = (message: string): never => {
-  throw ERRORS.TypedError(HardwareErrorCode.RuntimeError, message, {
-    firmwareUpdateCode: 'FirmwarePreparedPlanInvalid',
-  });
-};
-
-const digestPreparedPlan = (plan: Omit<FirmwareUpdatePreparedPlan, 'preparedPlanDigest'>): string =>
-  digestFirmwareUpdateContract(plan);
-
-const assertOpaqueLeaseRef = (value: unknown): string => {
-  if (
-    typeof value !== 'string' ||
-    value.length === 0 ||
-    value.length > 160 ||
-    value.includes('/') ||
-    value.includes('\\')
-  ) {
-    return preparedPlanError('Firmware prepared plan leaseRef must be opaque');
-  }
-  return value;
-};
-
-export const getFirmwareUpdateResourceName = (value: unknown): string => {
-  const normalized = typeof value === 'string' ? value.normalize('NFC') : undefined;
-  const parts = normalized?.split('/');
-  const resourceName = parts?.at(-1);
-  if (
-    typeof value !== 'string' ||
-    value.length === 0 ||
-    value.length > 512 ||
-    value !== normalized ||
-    value.startsWith('/') ||
-    value.includes('\\') ||
-    value.includes(':') ||
-    [...value].some(char => {
-      const code = char.charCodeAt(0);
-      return code <= 0x1f || code === 0x7f;
-    }) ||
-    !parts?.every(
-      part =>
-        part.length > 0 &&
-        part !== '.' &&
-        part !== '..' &&
-        !part.endsWith('.') &&
-        !part.endsWith(' ')
-    ) ||
-    !resourceName ||
-    resourceName.length > 128
-  ) {
-    return preparedPlanError('Firmware prepared plan entry name is invalid');
-  }
-  return resourceName;
-};
-
-const assertPreparedEntry = (value: unknown): FirmwareUpdatePreparedEntry => {
-  if (!value || typeof value !== 'object' || Array.isArray(value)) {
-    return preparedPlanError('Firmware prepared plan entry must be an object');
-  }
-  const entry = value as Record<string, unknown>;
-  if (
-    Object.keys(entry).length !== 2 ||
-    !Object.prototype.hasOwnProperty.call(entry, 'entryName') ||
-    !Object.prototype.hasOwnProperty.call(entry, 'artifact')
-  ) {
-    return preparedPlanError('Firmware prepared plan entry fields are invalid');
-  }
-  getFirmwareUpdateResourceName(entry.entryName);
-  assertFirmwareArtifactReference(entry.artifact as FirmwareUpdatePreparedEntry['artifact']);
-  return value as FirmwareUpdatePreparedEntry;
-};
-
-const assertPreparedArtifacts = ({
-  plan,
-  artifacts,
-}: {
-  plan: FirmwareUpdatePlan;
-  artifacts: readonly FirmwareUpdatePreparedArtifactInput[];
-}): FirmwareUpdatePreparedArtifact[] => {
-  if (artifacts.length !== plan.artifacts.length) {
-    return preparedPlanError('Firmware prepared plan does not cover every artifact');
-  }
-  const inputs = new Map<string, FirmwareUpdatePreparedArtifactInput>();
-  for (const input of artifacts) {
-    if (
-      !input ||
-      typeof input !== 'object' ||
-      typeof input.artifactId !== 'string' ||
-      inputs.has(input.artifactId)
-    ) {
-      return preparedPlanError('Firmware prepared plan contains a duplicate artifact receipt');
-    }
-    inputs.set(input.artifactId, input);
-  }
-  return plan.artifacts.map(planArtifact => {
-    const input = inputs.get(planArtifact.artifactId);
-    if (!input) {
-      return preparedPlanError('Firmware prepared plan artifact receipt is missing');
-    }
-    const artifact = assertFirmwareArtifactReference(input.artifact);
-    if (
-      (planArtifact.expectedSize !== undefined && artifact.size !== planArtifact.expectedSize) ||
-      (planArtifact.expectedSha256 !== undefined &&
-        artifact.sha256.toLowerCase() !== planArtifact.expectedSha256.toLowerCase())
-    ) {
-      return preparedPlanError('Firmware prepared plan receipt does not match the update plan');
-    }
-    const materializedEntries = input.materializedEntries?.map(value => {
-      const entry = assertPreparedEntry(value);
-      return {
-        entryName: entry.entryName,
-        artifact: {
-          ...entry.artifact,
-          sha256: entry.artifact.sha256.toLowerCase(),
-        },
-      };
-    });
-    if (
-      (planArtifact.container === 'raw' && materializedEntries?.length) ||
-      (planArtifact.container === 'zip' && !materializedEntries?.length)
-    ) {
-      return preparedPlanError('Firmware prepared plan materialization is incomplete');
-    }
-    if (
-      materializedEntries &&
-      new Set(
-        materializedEntries.map(entry =>
-          getFirmwareUpdateResourceName(entry.entryName).toLowerCase()
-        )
-      ).size !== materializedEntries.length
-    ) {
-      return preparedPlanError('Firmware prepared plan contains duplicate entry names');
-    }
-    return {
-      artifactId: planArtifact.artifactId,
-      role: planArtifact.role,
-      target: planArtifact.target,
-      container: planArtifact.container,
-      ...(planArtifact.logicalName ? { logicalName: planArtifact.logicalName } : {}),
-      ...(planArtifact.targetVersion ? { targetVersion: planArtifact.targetVersion } : {}),
-      artifact: {
-        ...artifact,
-        sha256: artifact.sha256.toLowerCase(),
-      },
-      ...(materializedEntries?.length ? { materializedEntries } : {}),
-    };
-  });
-};
-
-export const prepareFirmwareUpdatePlan = ({
-  plan: value,
-  leaseRef,
-  artifacts,
-}: {
-  plan: FirmwareUpdatePlan;
-  leaseRef: string;
-  artifacts: FirmwareUpdatePreparedArtifactInput[];
-}): FirmwareUpdatePreparedPlan => {
-  const plan = assertFirmwareUpdatePlan(value);
-  const planWithoutDigest: Omit<FirmwareUpdatePreparedPlan, 'preparedPlanDigest'> = {
-    schemaVersion: 1,
-    planDigest: plan.planDigest,
-    networkPolicy: 'forbid',
-    executor: plan.executor,
-    deviceIdentity: plan.deviceIdentity,
-    deviceModel: plan.deviceModel,
-    firmwareType: plan.firmwareType,
-    platform: plan.platform,
-    leaseRef: assertOpaqueLeaseRef(leaseRef),
-    artifacts: assertPreparedArtifacts({ plan, artifacts }),
-    epochs: plan.epochs,
-    targetsToUpdate: plan.targetsToUpdate,
-  };
-  return {
-    ...planWithoutDigest,
-    preparedPlanDigest: digestPreparedPlan(planWithoutDigest),
-  };
-};
-
-export const validateFirmwareUpdatePreparedPlan = (value: unknown): FirmwareUpdatePreparedPlan => {
-  if (!value || typeof value !== 'object' || Array.isArray(value)) {
-    return preparedPlanError('Firmware prepared plan must be an object');
-  }
-  const preparedPlan = value as FirmwareUpdatePreparedPlan;
-  const exactKeys = [
-    'schemaVersion',
-    'preparedPlanDigest',
-    'planDigest',
-    'networkPolicy',
-    'executor',
-    'deviceIdentity',
-    'deviceModel',
-    'firmwareType',
-    'platform',
-    'leaseRef',
-    'artifacts',
-    'epochs',
-    'targetsToUpdate',
-  ];
-  if (
-    Object.keys(value).length !== exactKeys.length ||
-    exactKeys.some(key => !Object.prototype.hasOwnProperty.call(value, key)) ||
-    preparedPlan.schemaVersion !== 1 ||
-    preparedPlan.networkPolicy !== 'forbid' ||
-    !/^[a-f0-9]{64}$/u.test(preparedPlan.planDigest) ||
-    !/^[a-f0-9]{64}$/u.test(preparedPlan.preparedPlanDigest) ||
-    !Array.isArray(preparedPlan.artifacts) ||
-    !Array.isArray(preparedPlan.epochs) ||
-    !Array.isArray(preparedPlan.targetsToUpdate) ||
-    (preparedPlan.executor !== 'v2' &&
-      preparedPlan.executor !== 'v3' &&
-      preparedPlan.executor !== 'v4') ||
-    (preparedPlan.platform !== 'native' &&
-      preparedPlan.platform !== 'desktop' &&
-      preparedPlan.platform !== 'ext' &&
-      preparedPlan.platform !== 'web' &&
-      preparedPlan.platform !== 'web-embed') ||
-    (preparedPlan.firmwareType !== 'universal' && preparedPlan.firmwareType !== 'bitcoinonly') ||
-    typeof preparedPlan.deviceIdentity !== 'string' ||
-    preparedPlan.deviceIdentity.length === 0 ||
-    typeof preparedPlan.deviceModel !== 'string' ||
-    preparedPlan.deviceModel.length === 0
-  ) {
-    return preparedPlanError('Firmware prepared plan header is invalid');
-  }
-  assertOpaqueLeaseRef(preparedPlan.leaseRef);
-  const artifactIds = new Set<string>();
-  const artifactTargets = new Set<string>();
-  for (const artifact of preparedPlan.artifacts) {
-    if (!artifact || typeof artifact !== 'object') {
-      return preparedPlanError('Firmware prepared plan artifact is invalid');
-    }
-    const artifactKeys = [
-      'artifactId',
-      'role',
-      'target',
-      'container',
-      'artifact',
-      ...(artifact.logicalName !== undefined ? ['logicalName'] : []),
-      ...(artifact.targetVersion !== undefined ? ['targetVersion'] : []),
-      ...(artifact.materializedEntries !== undefined ? ['materializedEntries'] : []),
-    ];
-    if (
-      typeof artifact.artifactId !== 'string' ||
-      artifact.artifactId.length === 0 ||
-      artifactIds.has(artifact.artifactId) ||
-      Object.keys(artifact).length !== artifactKeys.length ||
-      artifactKeys.some(key => !Object.prototype.hasOwnProperty.call(artifact, key)) ||
-      !FIRMWARE_UPDATE_PLAN_ROLES.has(artifact.role) ||
-      !FIRMWARE_UPDATE_PLAN_TARGETS.has(artifact.target) ||
-      (artifact.container !== 'raw' && artifact.container !== 'zip') ||
-      (artifact.logicalName !== undefined &&
-        (typeof artifact.logicalName !== 'string' || artifact.logicalName.length === 0)) ||
-      (artifact.targetVersion !== undefined &&
-        (typeof artifact.targetVersion !== 'string' || artifact.targetVersion.length === 0)) ||
-      (artifact.materializedEntries !== undefined &&
-        !Array.isArray(artifact.materializedEntries)) ||
-      (artifact.container === 'raw' && Boolean(artifact.materializedEntries?.length)) ||
-      (artifact.container === 'zip' && !artifact.materializedEntries?.length)
-    ) {
-      return preparedPlanError('Firmware prepared plan artifact is invalid');
-    }
-    artifactIds.add(artifact.artifactId);
-    artifactTargets.add(artifact.target);
-    assertFirmwareArtifactReference(artifact.artifact);
-    artifact.materializedEntries?.forEach(assertPreparedEntry);
-  }
-  for (const [index, epoch] of preparedPlan.epochs.entries()) {
-    if (
-      !epoch ||
-      typeof epoch !== 'object' ||
-      Object.keys(epoch).length !== 4 ||
-      !Object.prototype.hasOwnProperty.call(epoch, 'epoch') ||
-      !Object.prototype.hasOwnProperty.call(epoch, 'kind') ||
-      !Object.prototype.hasOwnProperty.call(epoch, 'artifactIds') ||
-      !Object.prototype.hasOwnProperty.call(epoch, 'targets') ||
-      epoch.epoch !== index ||
-      !FIRMWARE_UPDATE_PLAN_EPOCH_KINDS.has(epoch.kind) ||
-      !Array.isArray(epoch.artifactIds) ||
-      !Array.isArray(epoch.targets) ||
-      epoch.artifactIds.some(artifactId => !artifactIds.has(artifactId)) ||
-      new Set(epoch.artifactIds).size !== epoch.artifactIds.length ||
-      epoch.targets.some(target => !FIRMWARE_UPDATE_PLAN_TARGETS.has(target)) ||
-      new Set(epoch.targets).size !== epoch.targets.length
-    ) {
-      return preparedPlanError('Firmware prepared plan epoch is invalid');
-    }
-  }
-  if (
-    preparedPlan.targetsToUpdate.some(target => !FIRMWARE_UPDATE_PLAN_TARGETS.has(target)) ||
-    new Set(preparedPlan.targetsToUpdate).size !== preparedPlan.targetsToUpdate.length ||
-    preparedPlan.targetsToUpdate.length !== artifactTargets.size ||
-    preparedPlan.targetsToUpdate.some(target => !artifactTargets.has(target))
-  ) {
-    return preparedPlanError('Firmware prepared plan targets are invalid');
-  }
-  const { preparedPlanDigest, ...withoutDigest } = preparedPlan;
-  if (digestPreparedPlan(withoutDigest) !== preparedPlanDigest) {
-    return preparedPlanError('Firmware prepared plan digest is invalid');
-  }
-  return preparedPlan;
-};
-
-export type FirmwareUpdatePreparedBinding = {
-  target: FirmwareUpdatePlan['targetsToUpdate'][number];
-  artifact: FirmwareArtifactReference;
-  logicalName?: string;
-  entryName?: string;
-};
-
-const sameArtifactReference = (
-  first: FirmwareArtifactReference,
-  second: FirmwareArtifactReference
-) =>
-  first.artifactRef === second.artifactRef &&
-  first.size === second.size &&
-  first.sha256.toLowerCase() === second.sha256.toLowerCase();
-
-export const assertFirmwareUpdatePreparedPlanBinding = ({
-  preparedPlan: value,
-  executor,
-  platform,
-  deviceIdentity,
-  scopeTargets,
-  bindings,
-}: {
-  preparedPlan: unknown;
-  executor: FirmwareUpdatePreparedPlan['executor'];
-  platform?: FirmwareUpdatePreparedPlan['platform'];
-  deviceIdentity?: string;
-  scopeTargets: FirmwareUpdatePreparedPlan['targetsToUpdate'];
-  bindings: FirmwareUpdatePreparedBinding[];
-}): FirmwareUpdatePreparedPlan => {
-  const preparedPlan = validateFirmwareUpdatePreparedPlan(value);
-  if (
-    preparedPlan.executor !== executor ||
-    (platform !== undefined && preparedPlan.platform !== platform) ||
-    (deviceIdentity !== undefined && preparedPlan.deviceIdentity !== deviceIdentity)
-  ) {
-    return preparedPlanError('Firmware prepared plan executor binding is invalid');
-  }
-  const scope = new Set(scopeTargets);
-  const expectedBindings: FirmwareUpdatePreparedBinding[] = [];
-  for (const artifact of preparedPlan.artifacts) {
-    if (scope.has(artifact.target)) {
-      if (artifact.container === 'zip') {
-        for (const entry of artifact.materializedEntries ?? []) {
-          expectedBindings.push({
-            target: artifact.target,
-            ...(artifact.target === 'resource' && artifact.logicalName
-              ? { logicalName: artifact.logicalName }
-              : {}),
-            entryName: entry.entryName,
-            artifact: entry.artifact,
-          });
-        }
-      } else {
-        expectedBindings.push({
-          target: artifact.target,
-          ...(artifact.target === 'resource' && artifact.logicalName
-            ? { logicalName: artifact.logicalName }
-            : {}),
-          artifact: artifact.artifact,
-        });
-      }
-    }
-  }
-  if (
-    expectedBindings.length !== bindings.length ||
-    expectedBindings.some(expected => {
-      const matching = bindings.filter(
-        binding =>
-          binding.target === expected.target &&
-          binding.logicalName === expected.logicalName &&
-          binding.entryName === expected.entryName &&
-          sameArtifactReference(binding.artifact, expected.artifact)
-      );
-      return matching.length !== 1;
-    })
-  ) {
-    return preparedPlanError('Firmware prepared plan artifact binding is invalid');
-  }
-  return preparedPlan;
-};

package/src/api/firmware/progressThrottle.ts

@@ -1,44 +0,0 @@
-import type { IFirmwareUpdateProgressType } from '../../events/ui-request';
-
-const DEFAULT_FIRMWARE_PROGRESS_INTERVAL_MS = 250;
-
-type FirmwareProgressThrottleState = {
-  lastEmittedAt: number;
-  lastProgress?: number;
-};
-
-export const createFirmwareProgressThrottle = (
-  intervalMs = DEFAULT_FIRMWARE_PROGRESS_INTERVAL_MS
-) => {
-  const stateByType = new Map<IFirmwareUpdateProgressType, FirmwareProgressThrottleState>();
-
-  return (progress: number, progressType: IFirmwareUpdateProgressType) => {
-    if (progressType !== 'transferData') {
-      return true;
-    }
-
-    const normalizedProgress = Math.max(0, Math.min(100, Math.floor(progress)));
-    if (normalizedProgress === 0 || normalizedProgress === 100) {
-      stateByType.set(progressType, {
-        lastEmittedAt: Date.now(),
-        lastProgress: normalizedProgress,
-      });
-      return true;
-    }
-
-    const now = Date.now();
-    const state = stateByType.get(progressType);
-    if (
-      state &&
-      (state.lastProgress === normalizedProgress || now - state.lastEmittedAt < intervalMs)
-    ) {
-      return false;
-    }
-
-    stateByType.set(progressType, {
-      lastEmittedAt: now,
-      lastProgress: normalizedProgress,
-    });
-    return true;
-  };
-};

package/src/api/helpers/filesystemValidation.ts

@@ -1,112 +0,0 @@
-import { ERRORS, HardwareErrorCode } from '@onekeyfe/hd-shared';
-
-export const invalidParameter = (message: string) =>
-  ERRORS.TypedError(HardwareErrorCode.CallMethodInvalidParameter, message);
-
-export function validateNonEmptyString(value: unknown, name: string): string {
-  if (typeof value !== 'string' || value.trim().length === 0) {
-    throw invalidParameter(`Parameter [${name}] is required and must be a non-empty string.`);
-  }
-  return value;
-}
-
-const PROTOCOL_V2_FILESYSTEM_VOLUMES = new Set(['vol0', 'vol1']);
-// Bootloader and romloader reserve 128 bytes including the terminating NUL.
-const MAX_PROTOCOL_V2_FILESYSTEM_PATH_BYTES = 127;
-
-function getUtf8ByteLength(value: string) {
-  return Array.from(value).reduce((length, character) => {
-    const codePoint = character.codePointAt(0) ?? 0;
-    if (codePoint <= 0x7f) return length + 1;
-    if (codePoint <= 0x7ff) return length + 2;
-    if (codePoint <= 0xffff) return length + 3;
-    return length + 4;
-  }, 0);
-}
-
-export function validateProtocolV2FilesystemPath(
-  value: unknown,
-  name: string,
-  options: { allowVolumeRoot?: boolean } = {}
-): string {
-  const rawPath = validateNonEmptyString(value, name).trim();
-  const containsUnsupportedCharacter = Array.from(rawPath).some(character => {
-    const codePoint = character.charCodeAt(0);
-    return codePoint <= 0x1f || codePoint === 0x7f || character === '\\';
-  });
-
-  if (containsUnsupportedCharacter) {
-    throw invalidParameter(`Parameter [${name}] contains unsupported path characters.`);
-  }
-
-  const match = /^([a-zA-Z0-9]+):(.*)$/.exec(rawPath);
-  if (!match) {
-    throw invalidParameter(
-      `Parameter [${name}] must use a supported Protocol V2 filesystem volume.`
-    );
-  }
-
-  const volume = match[1].toLowerCase();
-  if (!PROTOCOL_V2_FILESYSTEM_VOLUMES.has(volume)) {
-    throw invalidParameter(`Parameter [${name}] uses an unsupported filesystem volume.`);
-  }
-
-  const rawSuffix = match[2];
-  if (rawSuffix.length === 0) {
-    if (options.allowVolumeRoot) return `${volume}:`;
-    throw invalidParameter(`Parameter [${name}] must identify a filesystem entry.`);
-  }
-
-  const suffix = rawSuffix.startsWith('/') ? rawSuffix : `/${rawSuffix}`;
-  const segments = suffix.slice(1).split('/');
-  if (segments.some(segment => segment.length === 0 || segment === '.' || segment === '..')) {
-    throw invalidParameter(`Parameter [${name}] contains an invalid path segment.`);
-  }
-
-  const canonicalPath = `${volume}:${rawSuffix.startsWith('/') ? '/' : ''}${segments.join('/')}`;
-  if (getUtf8ByteLength(canonicalPath) > MAX_PROTOCOL_V2_FILESYSTEM_PATH_BYTES) {
-    throw invalidParameter(`Parameter [${name}] exceeds the maximum filesystem path length.`);
-  }
-
-  return canonicalPath;
-}
-
-export function validateNonNegativeInteger(
-  value: unknown,
-  name: string,
-  defaultValue?: number
-): number {
-  if (value === undefined || value === null) {
-    if (defaultValue !== undefined) return defaultValue;
-    throw invalidParameter(`Missing required parameter: ${name}`);
-  }
-
-  const numeric = typeof value === 'string' && value.trim() !== '' ? Number(value) : value;
-  if (typeof numeric !== 'number' || !Number.isSafeInteger(numeric) || numeric < 0) {
-    throw invalidParameter(`Parameter [${name}] must be a non-negative integer.`);
-  }
-  return numeric;
-}
-
-export function validateOptionalNonNegativeInteger(
-  value: unknown,
-  name: string
-): number | undefined {
-  if (value === undefined || value === null) return undefined;
-  return validateNonNegativeInteger(value, name);
-}
-
-export function validateOptionalPercentage(value: unknown, name: string): number | undefined {
-  const numeric = validateOptionalNonNegativeInteger(value, name);
-  if (numeric === undefined) return undefined;
-  if (numeric > 100) {
-    throw invalidParameter(`Parameter [${name}] must be between 0 and 100.`);
-  }
-  return numeric;
-}
-
-export function validateRequiredData(value: unknown, name: string): void {
-  if (value === undefined || value === null) {
-    throw invalidParameter(`Missing required parameter: ${name}`);
-  }
-}