@typinghare/trick 1.0.6 → 2.0.0

package/src/encrypt.ts

@@ -1,29 +1,29 @@
 import { execa } from 'execa'
 import * as path from 'node:path'
 import fsExtra from 'fs-extra'
+import { FailToDecryptFileError, FailToEncryptFileError } from './error.js'
 
-export class FailToEncryptFileError extends Error {
-    public constructor(
-        public readonly srcFilePath: string,
-        public readonly opensslErrMessage?: string
-    ) {
-        super(`Fail to encrypt source file: ${srcFilePath}`)
-    }
-}
-
-export class FailToDecryptFileError extends Error {
-    public constructor(
-        public readonly destFilePath: string,
-        public readonly opensslErrMessage?: string
-    ) {
-        super(`Fail to decrypt destination file: ${destFilePath}`)
-    }
-}
-
+/**
+ * Encrypts a file using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
+ *
+ * This function checks whether the source file exists, constructs an OpenSSL
+ * command, ensures the destination directory exists, and then executes the
+ * encryption command.
+ *
+ * @param srcFilePath The path to the source file that needs to be encrypted.
+ * @param destFilePath The path where the encrypted file will be saved.
+ * @param passphrase The passphrase used for encryption.
+ * @param iteration_count The number of iterations to use for PBKDF2.
+ * @returns Resolves when the file is successfully encrypted.
+ * @throws {FailToEncryptFileError} If the source file does not exist or if
+ *         OpenSSL returns an error during encryption.
+ * @throws {FailToDecryptFileError} If an unknown error occurs during
+ *         encryption.
+ */
 export async function encryptFile(
     srcFilePath: string,
     destFilePath: string,
-    secret: string,
+    passphrase: string,
     iteration_count: number
 ): Promise<void> {
     if (!(await fsExtra.pathExists(srcFilePath))) {
@@ -37,13 +37,13 @@ export async function encryptFile(
         '-salt',
         '-pbkdf2',
         '-iter',
-        iteration_count,
+        Number(iteration_count),
         '-in',
         srcFilePath,
         '-out',
         destFilePath,
         '-pass',
-        `'pass:${secret}'`,
+        `'pass:${passphrase}'`,
     ].join(' ')
 
     await fsExtra.ensureDir(path.dirname(destFilePath))
@@ -52,14 +52,8 @@ export async function encryptFile(
         await execa(`${command}`, { shell: true })
     } catch (err) {
         if (typeof err == 'object' && err && Object.hasOwn(err, 'stderr')) {
-            throw new FailToEncryptFileError(
-                srcFilePath,
-                (
-                    err as {
-                        stderr: string
-                    }
-                ).stderr
-            )
+            const error = err as { stderr: string }
+            throw new FailToEncryptFileError(srcFilePath, error.stderr)
         } else {
             throw new FailToDecryptFileError(
                 srcFilePath,
@@ -69,10 +63,27 @@ export async function encryptFile(
     }
 }
 
+/**
+ * Decrypts a file using OpenSSL with AES-256-CBC and PBKDF2 key derivation.
+ *
+ * This function checks whether the encrypted file exists, constructs an OpenSSL
+ * decryption command, ensures the destination directory exists, and then
+ * executes the decryption command.
+ *
+ * @param srcFilePath The path where the decrypted file will be saved.
+ * @param destFilePath The path to the encrypted source file.
+ * @param passphrase The passphrase used for decryption.
+ * @param iteration_count The number of iterations used for PBKDF2.
+ * @returns Resolves when the file is successfully decrypted.
+ * @throws {FailToDecryptFileError} If the encrypted file does not exist or if
+ *         OpenSSL returns an error during decryption.
+ * @throws {FailToDecryptFileError} If an unknown error occurs during
+ *         decryption.
+ */
 export async function decryptFile(
     srcFilePath: string,
     destFilePath: string,
-    secret: string,
+    passphrase: string,
     iteration_count: number
 ): Promise<void> {
     if (!(await fsExtra.pathExists(destFilePath))) {
@@ -87,13 +98,13 @@ export async function decryptFile(
         '-salt',
         '-pbkdf2',
         '-iter',
-        iteration_count,
+        Number(iteration_count),
         '-in',
         destFilePath,
         '-out',
         srcFilePath,
         '-pass',
-        `'pass:${secret}'`,
+        `'pass:${passphrase}'`,
     ].join(' ')
 
     await fsExtra.ensureDir(path.dirname(srcFilePath))
@@ -102,14 +113,8 @@ export async function decryptFile(
         await execa(`${command}`, { shell: true })
     } catch (err) {
         if (typeof err == 'object' && err && Object.hasOwn(err, 'stderr')) {
-            throw new FailToDecryptFileError(
-                srcFilePath,
-                (
-                    err as {
-                        stderr: string
-                    }
-                )['stderr']
-            )
+            const error = err as { stderr: string }
+            throw new FailToDecryptFileError(srcFilePath, error.stderr)
         } else {
             throw new FailToDecryptFileError(
                 srcFilePath,
@@ -119,28 +124,68 @@ export async function decryptFile(
     }
 }
 
+/**
+ * Encrypts multiple files using OpenSSL with AES-256-CBC and PBKDF2 key
+ * derivation.
+ *
+ * For each source file path provided, this function constructs the destination
+ * file path by appending `.enc`, then calls `encryptFile` and logs the
+ * operation.
+ *
+ * @param srcFilePaths An array of file paths to be encrypted.
+ * @param destDir The directory where the encrypted files will be saved.
+ * @param passphrase The passphrase used for encryption.
+ * @param iteration_count The number of iterations to use for PBKDF2.
+ * @returns Resolves when all files are successfully encrypted.
+ * @throws {FailToEncryptFileError} If any file fails to encrypt.
+ */
 export async function encryptFiles(
     srcFilePaths: string[],
     destDir: string,
-    secret: string,
+    passphrase: string,
     iteration_count: number
 ): Promise<void> {
     for (const srcFilePath of srcFilePaths) {
         const destFilePath: string = path.join(destDir, srcFilePath + '.enc')
-        await encryptFile(srcFilePath, destFilePath, secret, iteration_count)
+        await encryptFile(
+            srcFilePath,
+            destFilePath,
+            passphrase,
+            iteration_count
+        )
         console.log(`[ENCRYPTED] ${srcFilePath} -> ${destFilePath}`)
     }
 }
 
+/**
+ * Decrypts multiple files using OpenSSL with AES-256-CBC and PBKDF2 key
+ * derivation.
+ *
+ * For each source file path provided, this function assumes the corresponding
+ * encrypted file has the `.enc` extension and calls `decryptFile`, logging the
+ * operation.
+ *
+ * @param srcFilePaths An array of original file paths that were encrypted.
+ * @param destDir The directory containing the encrypted files.
+ * @param passphrase The passphrase used for decryption.
+ * @param iteration_count The number of iterations used for PBKDF2.
+ * @returns Resolves when all files are successfully decrypted.
+ * @throws {FailToDecryptFileError} If any file fails to decrypt.
+ */
 export async function decryptFiles(
     srcFilePaths: string[],
     destDir: string,
-    secret: string,
+    passphrase: string,
     iteration_count: number
 ): Promise<void> {
     for (const srcFilePath of srcFilePaths) {
         const destFilePath: string = path.join(destDir, srcFilePath + '.enc')
-        await decryptFile(srcFilePath, destFilePath, secret, iteration_count)
+        await decryptFile(
+            srcFilePath,
+            destFilePath,
+            passphrase,
+            iteration_count
+        )
         console.log(`[DECRYPTED] ${destFilePath} -> ${srcFilePath}`)
     }
 }

package/src/error.ts

@@ -0,0 +1,82 @@
+import chalk from 'chalk'
+
+export class WriteConfigError extends Error {
+    public constructor(err: any) {
+        super(`Fail to write the configuration file. ${err}`)
+    }
+}
+
+export class ReadConfigError extends Error {
+    public constructor(err: any) {
+        super(`Fail to read the configuration file: ${err}`)
+    }
+}
+
+export class TargetNotFoundError extends Error {
+    public constructor(public readonly targetName: string) {
+        super(`Target not found: ${targetName}`)
+    }
+}
+
+export class FailToEncryptFileError extends Error {
+    public constructor(
+        public readonly srcFilePath: string,
+        public readonly opensslErrMessage?: string
+    ) {
+        super(`Fail to encrypt source file: ${srcFilePath}`)
+    }
+}
+
+export class FailToDecryptFileError extends Error {
+    public constructor(
+        public readonly destFilePath: string,
+        public readonly opensslErrMessage?: string
+    ) {
+        super(`Fail to decrypt destination file: ${destFilePath}`)
+    }
+}
+
+export class PassphraseFileNotFoundError extends Error {
+    public constructor(public readonly passphraseFilePath: string) {
+        super(`Passphrase file not found: ${passphraseFilePath}`)
+    }
+}
+
+export class PassphraseNotFoundError extends Error {
+    public constructor(
+        public readonly passphraseFilePath: string,
+        public readonly targetName: string
+    ) {
+        super(
+            `Passphrase for target ${targetName} is not found in the passphrase file: ${passphraseFilePath}`
+        )
+    }
+}
+
+export function resolve_error(err: any): void {
+    if (!(err instanceof Error)) {
+        console.error(`Unknown error: ${err}`)
+        process.exit(2)
+    }
+
+    if (err.message) {
+        console.log(chalk.red(err.message))
+    }
+
+    if (
+        err instanceof FailToEncryptFileError ||
+        err instanceof FailToDecryptFileError
+    ) {
+        if (err.opensslErrMessage) {
+            console.error(chalk.red(err.opensslErrMessage))
+        }
+
+        console.error(
+            chalk.yellow(
+                'Make sure the file exists and you have enough permission to access it.'
+            )
+        )
+    }
+
+    process.exit(1)
+}

package/src/index.ts

@@ -1,5 +1,4 @@
 export * from './app.js'
 export * from './config.js'
-export * from './constant.js'
 export * from './encrypt.js'
-export * from './secret.js'
+export * from './passphrase.js'

package/src/passphrase.ts

@@ -0,0 +1,39 @@
+import { Config } from './config.js'
+import fsExtra from 'fs-extra'
+import {
+    PassphraseFileNotFoundError,
+    PassphraseNotFoundError,
+} from './error.js'
+import os from 'node:os'
+
+/**
+ * Retrieves the passphrase from the passphrase file.
+ *
+ * First, gets the passphrase object from the passphrase file path specified in
+ * the configuration object. Second, gets and returns the passphrase associated
+ * with the given target name.
+ *
+ * @param config The configuration to use.
+ * @param targetName The name of the target.
+ * @return The passphrase associated with the target name.
+ */
+export function getPassphrase(config: Config, targetName: string): string {
+    const passphraseFilePath = config.passphrase_file_path.replaceAll(
+        /~/g,
+        os.homedir()
+    )
+    if (!fsExtra.existsSync(passphraseFilePath)) {
+        throw new PassphraseFileNotFoundError(passphraseFilePath)
+    }
+
+    const passphraseObject = fsExtra.readJsonSync(passphraseFilePath) as {
+        [name: string]: string
+    }
+    const passphrase = passphraseObject[targetName] || null
+
+    if (passphrase === null) {
+        throw new PassphraseNotFoundError(passphraseFilePath, targetName)
+    }
+
+    return passphrase
+}

package/test/resources/really.json

@@ -1,4 +1,4 @@
 {
-  "message": "Ok",
-  "userId": 123
+    "message": "Ok",
+    "userId": 123456
 }

package/test/resources/task.yml

@@ -1,4 +1,3 @@
-my_task:
-  name: My Task
-  time_unit: milliseconds
-  time: 350
+response:
+  message: Ok
+  userId: 123456

package/test/trick.config.json

@@ -0,0 +1,13 @@
+{
+    "targets": {
+        "MyTestTarget": {
+            "files": ["resources/really.json", "resources/task.yml"]
+        }
+    },
+    "default_target_name": "MyTestTarget",
+    "root_directory": ".trick",
+    "passphrase_file_path": "~/.config/trick_passphrase.json",
+    "encryption": {
+        "iteration_count": 100000
+    }
+}

package/.prettierrc.yaml

@@ -1,6 +0,0 @@
-trailingComma: es5
-tabWidth: 4
-semi: false
-singleQuote: true
-endOfLine: lf
-printWidth: 80

package/.wander/jameschan312.cn@gmail.com/.idea/codeStyles/Project.xml

@@ -1,52 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <option name="LINE_SEPARATOR" value="&#10;" />
-    <option name="RIGHT_MARGIN" value="80" />
-    <HTMLCodeStyleSettings>
-      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
-    </HTMLCodeStyleSettings>
-    <JSCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <VueCodeStyleSettings>
-      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
-      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
-    </VueCodeStyleSettings>
-    <codeStyleSettings language="HTML">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="CONTINUATION_INDENT_SIZE" value="4" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="80" />
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="80" />
-    </codeStyleSettings>
-    <codeStyleSettings language="Vue">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="4" />
-        <option name="TAB_SIZE" value="4" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.wander/jameschan312.cn@gmail.com/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.wander/jameschan312.cn@gmail.com/.idea/jsLibraryMappings.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptLibraryMappings">
-    <includedPredefinedLibrary name="Node.js Core" />
-  </component>
-</project>

package/.wander/jameschan312.cn@gmail.com/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MarkdownSettingsMigration">
-    <option name="stateVersion" value="1" />
-  </component>
-</project>

package/.wander/jameschan312.cn@gmail.com/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/trick.iml" filepath="$PROJECT_DIR$/.idea/trick.iml" />
-    </modules>
-  </component>
-</project>

package/.wander/jameschan312.cn@gmail.com/.idea/prettier.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myConfigurationMode" value="AUTOMATIC" />
-  </component>
-</project>

package/.wander/jameschan312.cn@gmail.com/.idea/trick.iml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.wander/jameschan312.cn@gmail.com/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/.wander/jameschan312.cn@gmail.com/.idea/webResources.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="WebResourcesPaths">
-    <contentEntries>
-      <entry url="file://$PROJECT_DIR$">
-        <entryData>
-          <resourceRoots>
-            <path value="file://$PROJECT_DIR$/src" />
-          </resourceRoots>
-        </entryData>
-      </entry>
-    </contentEntries>
-  </component>
-</project>

package/dist/constant.d.ts

@@ -1,2 +0,0 @@
-export declare const TRICK_ROOT_DIR = ".trick";
-export declare const TRICK_ENCRYPTED_DIR: string;

package/dist/constant.js

@@ -1,3 +0,0 @@
-import * as path from 'node:path';
-export const TRICK_ROOT_DIR = '.trick';
-export const TRICK_ENCRYPTED_DIR = path.join(TRICK_ROOT_DIR, 'encrypted');

package/dist/secret.d.ts

@@ -1,5 +0,0 @@
-export declare class SecretNotFoundError extends Error {
-    readonly secretName: string;
-    constructor(secretName: string);
-}
-export declare function getSecret(secretName: string): string;

package/dist/secret.js

@@ -1,14 +0,0 @@
-export class SecretNotFoundError extends Error {
-    secretName;
-    constructor(secretName) {
-        super(`Secret ${secretName} is not presented in the environment`);
-        this.secretName = secretName;
-    }
-}
-export function getSecret(secretName) {
-    const secret = process.env[secretName];
-    if (secret === undefined) {
-        throw new SecretNotFoundError(secretName);
-    }
-    return secret;
-}

package/src/constant.ts

@@ -1,4 +0,0 @@
-import * as path from 'node:path'
-
-export const TRICK_ROOT_DIR = '.trick'
-export const TRICK_ENCRYPTED_DIR = path.join(TRICK_ROOT_DIR, 'encrypted')

package/src/secret.ts

@@ -1,14 +0,0 @@
-export class SecretNotFoundError extends Error {
-    public constructor(public readonly secretName: string) {
-        super(`Secret ${secretName} is not presented in the environment`)
-    }
-}
-
-export function getSecret(secretName: string): string {
-    const secret = process.env[secretName]
-    if (secret === undefined) {
-        throw new SecretNotFoundError(secretName)
-    }
-
-    return secret
-}

package/trick.config.json

@@ -1,20 +0,0 @@
-{
-  "iteration_count": 114514,
-  "targets": [
-    {
-      "secret_name": "TRICK_SECRET_NAME",
-      "files": [
-        "test/resources/really.json",
-        "test/resources/task.yml"
-      ]
-    },
-    {
-      "secret_name": "SUPERVISOR_SERVER_TRICK_SECRET_NAME",
-      "files": [
-        "test/main/resources/database.properties",
-        "test/main/resources/password.properties"
-      ]
-    }
-  ],
-  "default_secret_name": "SUPERVISOR_SERVER_TRICK_SECRET_NAME"
-}