@powerlines/plugin-crypto 0.1.0 → 0.3.0

package/README.md

@@ -47,6 +47,13 @@ This package is part of the ⚡<b>Powerlines</b> monorepo. Powerlines packages i
 
 A Powerlines plugin that provides cryptography capabilities at runtime by adding the `crypto` builtin module.
 
+Since cryptography is such a complex and nuanced topic, this plugin relies on the noble cryptography packages since they are audited for security and written in pure TypeScript.
+
+The noble packages used can be found below:
+
+- [`@noble/ciphers`](https://www.npmjs.com/package/@noble/ciphers)
+- [`@noble/hashes`](https://www.npmjs.com/package/@noble/hashes)
+
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 ## Table of Contents

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-crypto",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "type": "module",
   "description": "A Powerlines plugin that provides unique identifier generation capabilities at runtime by adding the `id` builtin module.",
   "repository": {
@@ -116,17 +116,17 @@
   "files": ["dist/**/*"],
   "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
   "dependencies": {
-    "@powerlines/plugin-env": "^0.3.0",
+    "@powerlines/plugin-env": "^0.5.0",
     "@storm-software/config-tools": "^1.188.6",
-    "@stryke/path": "^0.15.5",
+    "@stryke/path": "^0.16.0",
     "defu": "^6.1.4",
-    "powerlines": "^0.4.0"
+    "powerlines": "^0.5.0"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.4.0",
+    "@powerlines/nx": "^0.5.0",
     "@storm-software/tsup": "^0.2.4",
-    "@types/node": "^22.18.11"
+    "@types/node": "^22.18.12"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "f4d0c8a8f0036ac8de46ac96afd9336a390a7268"
+  "gitHead": "8ec5ff52ffc87cfbf2807e077209ea5745a95d43"
 }

package/dist/components/crypto.cjs

@@ -1,117 +0,0 @@
-'use strict';var fileHeader=require('powerlines/lib/utilities/file-header');/*****************************************
-*
-*      ⚡ Built by Storm Software
-*
-*****************************************/
-
-var a=Object.defineProperty;var t=(e,r)=>a(e,"name",{value:r,configurable:true});function d(e){return `
-/**
- * The cryptography module provides custom helper functions to support encrypting and decrypting data.
- *
- * @module ${e.config.output.builtinPrefix}:crypto
- */
-
-${fileHeader.getFileHeader(e)}
-
-import { xchacha20poly1305, chacha20poly1305 } from "@noble/ciphers/chacha.js";
-import { randomBytes, managedNonce } from "@noble/ciphers/utils.js";
-import { scrypt } from "@noble/hashes/scrypt.js";
-
-const CIPHER_KEY_LENGTH = 32; // https://stackoverflow.com/a/28307668/4397028
-const CIPHER_NONCE_LENGTH = 24;
-
-const nonce = randomBytes(CIPHER_NONCE_LENGTH);
-const chacha = xchacha20poly1305("${e.env.parsed.ENCRYPTION_KEY}", nonce);
-
-/**
- * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param plaintext - The data to encrypt.
- * @returns The encrypted data.
- */
-export function encrypt(plaintext: string): string {
-  return chacha.encrypt(
-    nonce,
-    new TextEncoder().encode(plaintext),
-    null
-  );
-}
-
-/**
- * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param encrypted - The encrypted data to decrypt.
- * @returns The decrypted data.
- */
-export function decrypt(encrypted: string): string {
-  const decrypted = chacha.decrypt(
-    nonce,
-    encrypted,
-    null
-  );
-
-  return new TextDecoder().decode(decrypted);
-}
-
-export * from "@noble/ciphers/chacha.js";
-export * from "@noble/ciphers/utils.js";
-
-/**
- * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher with a password.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param password - The password used to derive the encryption key.
- * @param plaintext - The data to encrypt.
- * @returns The encrypted data.
- */
-export function encryptWithPassword(password: string, plaintext: string): string {
-  const key = scrypt(
-    new TextEncoder().encode(password),
-    ${e.config.crypto.salt?e.config.crypto.salt:"nonce"},
-    1048576, // requires 1GB of RAM to calculate
-    8,
-    1,
-    CIPHER_KEY_LENGTH
-  );
-
-  return chacha20poly1305(key).encrypt(
-    nonce,
-    new TextEncoder().encode(plaintext),
-    null
-  );
-}
-
-/**
- * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher with a password.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param password - The password used to derive the decryption key.
- * @param encrypted - The encrypted data to decrypt.
- * @returns The decrypted data.
- */
-export function decryptWithPassword(password: string, encrypted: string): string {
-  const key = scrypt(
-    new TextEncoder().encode(password),
-    ${e.config.crypto.salt?e.config.crypto.salt:"nonce"},
-    1048576, // requires 1GB of RAM to calculate
-    8,
-    1,
-    CIPHER_KEY_LENGTH
-  );
-
-  const decrypted = chacha20poly1305(key).decrypt(
-    nonce,
-    encrypted,
-    null
-  );
-
-  return new TextDecoder().decode(decrypted);
-}
-
-`}t(d,"cryptoModule");exports.cryptoModule=d;

package/dist/components/crypto.d.cts

@@ -1,35 +0,0 @@
-import { CryptoPluginContext } from '../types/plugin.cjs';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';
-
-/**
- * Generates the crypto module content.
- *
- * @param context - The build context containing runtime information.
- * @returns A string representing the crypto module code.
- */
-declare function cryptoModule(context: CryptoPluginContext): string;
-
-export { cryptoModule };

package/dist/components/crypto.d.ts

@@ -1,35 +0,0 @@
-import { CryptoPluginContext } from '../types/plugin.js';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';
-
-/**
- * Generates the crypto module content.
- *
- * @param context - The build context containing runtime information.
- * @returns A string representing the crypto module code.
- */
-declare function cryptoModule(context: CryptoPluginContext): string;
-
-export { cryptoModule };

package/dist/components/crypto.js

@@ -1,117 +0,0 @@
-import {getFileHeader}from'powerlines/lib/utilities/file-header';/*****************************************
-*
-*      ⚡ Built by Storm Software
-*
-*****************************************/
-
-var a=Object.defineProperty;var t=(e,r)=>a(e,"name",{value:r,configurable:true});function h(e){return `
-/**
- * The cryptography module provides custom helper functions to support encrypting and decrypting data.
- *
- * @module ${e.config.output.builtinPrefix}:crypto
- */
-
-${getFileHeader(e)}
-
-import { xchacha20poly1305, chacha20poly1305 } from "@noble/ciphers/chacha.js";
-import { randomBytes, managedNonce } from "@noble/ciphers/utils.js";
-import { scrypt } from "@noble/hashes/scrypt.js";
-
-const CIPHER_KEY_LENGTH = 32; // https://stackoverflow.com/a/28307668/4397028
-const CIPHER_NONCE_LENGTH = 24;
-
-const nonce = randomBytes(CIPHER_NONCE_LENGTH);
-const chacha = xchacha20poly1305("${e.env.parsed.ENCRYPTION_KEY}", nonce);
-
-/**
- * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param plaintext - The data to encrypt.
- * @returns The encrypted data.
- */
-export function encrypt(plaintext: string): string {
-  return chacha.encrypt(
-    nonce,
-    new TextEncoder().encode(plaintext),
-    null
-  );
-}
-
-/**
- * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param encrypted - The encrypted data to decrypt.
- * @returns The decrypted data.
- */
-export function decrypt(encrypted: string): string {
-  const decrypted = chacha.decrypt(
-    nonce,
-    encrypted,
-    null
-  );
-
-  return new TextDecoder().decode(decrypted);
-}
-
-export * from "@noble/ciphers/chacha.js";
-export * from "@noble/ciphers/utils.js";
-
-/**
- * Symmetrically encrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher with a password.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param password - The password used to derive the encryption key.
- * @param plaintext - The data to encrypt.
- * @returns The encrypted data.
- */
-export function encryptWithPassword(password: string, plaintext: string): string {
-  const key = scrypt(
-    new TextEncoder().encode(password),
-    ${e.config.crypto.salt?e.config.crypto.salt:"nonce"},
-    1048576, // requires 1GB of RAM to calculate
-    8,
-    1,
-    CIPHER_KEY_LENGTH
-  );
-
-  return chacha20poly1305(key).encrypt(
-    nonce,
-    new TextEncoder().encode(plaintext),
-    null
-  );
-}
-
-/**
- * Symmetrically decrypts data using the [ChaCha20-Poly1305](https://en.wikipedia.org/wiki/ChaCha20-Poly1305) cipher with a password.
- *
- * @see https://en.wikipedia.org/wiki/ChaCha20-Poly1305
- *
- * @param password - The password used to derive the decryption key.
- * @param encrypted - The encrypted data to decrypt.
- * @returns The decrypted data.
- */
-export function decryptWithPassword(password: string, encrypted: string): string {
-  const key = scrypt(
-    new TextEncoder().encode(password),
-    ${e.config.crypto.salt?e.config.crypto.salt:"nonce"},
-    1048576, // requires 1GB of RAM to calculate
-    8,
-    1,
-    CIPHER_KEY_LENGTH
-  );
-
-  const decrypted = chacha20poly1305(key).decrypt(
-    nonce,
-    encrypted,
-    null
-  );
-
-  return new TextDecoder().decode(decrypted);
-}
-
-`}t(h,"cryptoModule");export{h as cryptoModule};

package/dist/components/index.cjs

@@ -1 +0,0 @@
-'use strict';var crypto=require('./crypto');Object.keys(crypto).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return crypto[k]}})});

package/dist/components/index.d.cts

@@ -1,26 +0,0 @@
-export { cryptoModule } from './crypto.cjs';
-import '../types/plugin.cjs';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';

package/dist/components/index.d.ts

@@ -1,26 +0,0 @@
-export { cryptoModule } from './crypto.js';
-import '../types/plugin.js';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';

package/dist/components/index.js

@@ -1 +0,0 @@
-export*from'./crypto';

package/dist/types/index.cjs

@@ -1 +0,0 @@
-'use strict';var plugin=require('./plugin');Object.keys(plugin).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return plugin[k]}})});

package/dist/types/index.d.cts

@@ -1,25 +0,0 @@
-export { CryptoPluginContext, CryptoPluginOptions, CryptoPluginResolvedConfig, CryptoPluginUserConfig, __ΩCryptoPluginContext, __ΩCryptoPluginOptions, __ΩCryptoPluginResolvedConfig, __ΩCryptoPluginUserConfig } from './plugin.cjs';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';

package/dist/types/index.d.ts

@@ -1,25 +0,0 @@
-export { CryptoPluginContext, CryptoPluginOptions, CryptoPluginResolvedConfig, CryptoPluginUserConfig, __ΩCryptoPluginContext, __ΩCryptoPluginOptions, __ΩCryptoPluginResolvedConfig, __ΩCryptoPluginUserConfig } from './plugin.js';
-import '@alloy-js/core/jsx-runtime';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import '@stryke/env/get-env-paths';
-import '@stryke/types/package-json';
-import 'jiti';
-import '@deepkit/type';
-import 'semver';
-import 'unplugin';
-import '@stryke/capnp';
-import '@stryke/types/base';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import 'memfs';
-import 'node:fs';
-import 'unionfs';
-import '@stryke/types/array';
-import '@stryke/env/types';

package/dist/types/index.js

@@ -1 +0,0 @@
-export*from'./plugin';

package/dist/types/plugin.cjs

@@ -1 +0,0 @@
-'use strict';