ssv-keys/src/commands/actions/validators/file.ts

CLI Tool for splitting a validator key into a predefined threshold of shares via Shamir-Secret-Sharing (SSS), and encrypt them with a set of operator keys.

import fs from "fs";

export const fileExistsValidator = (
  filePath: string,
  message = ""
): boolean | string => {
  filePath = sanitizePath(String(filePath).trim());
  const exists = fs.existsSync(filePath);
  return (
    exists ||
    message ||
    "Could not locate the keystores file path. Please provide a valid path."
  );
};

export const jsonFileValidator = (
  filePath: string,
  message = ""
): boolean | string => {
  let fileContents;
  filePath = sanitizePath(filePath);

  try {
    fileContents = fs.readFileSync(filePath, { encoding: "utf-8" });
  } catch {
    return message || "Could not read a validator keystore file";
  }
  try {
    JSON.parse(fileContents);
  } catch {
    return `Keystore file "${filePath}" must be .JSON format`;
  }
  return true;
};

export const sanitizePath = (inputPath: string): string => {
  // Strip quotes from the beginning or end.
  const strippedPath = inputPath.replace(/^["']|["']$/g, "");

  // Remove any characters that are not typically allowed or are problematic in file paths.
  // Here, we're allowing alphanumeric characters, spaces, hyphens, underscores, and periods.
  // You can adjust the regex as needed.
  const sanitizedPath = strippedPath.replace(/\\([^a-zA-Z0-9_])/g, "$1");

  // On Windows, paths might start with a drive letter. We can check and ensure it's a valid drive letter.
  /*
  if (process.platform === 'win32') {
    const match = sanitizedPath.match(/^([a-zA-Z]:)/);
    if (match) {
      // Ensure the drive letter is uppercase (just a normalization step; not strictly necessary).
      sanitizedPath = match[1].toUpperCase() + sanitizedPath.substring(match[1].length);
    }
  }
  */

  return sanitizedPath;
};