@stacksjs/security 0.37.3

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# Stacks Router
+
+This package contains the Stacks Security.
+
+## ☘️ Features
+
+wip
+
+- ⚡️
+
+wip
+
+## 🤖 Usage
+
+wip
+
+```bash
+pnpm i -D @stacksjs/security
+```
+
+Now, you can use it in your project:
+
+```js
+import * as security from '@stacksjs/security'
+
+// wip
+```
+
+Learn more in the docs.
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/crypt.d.ts

@@ -0,0 +1,3 @@
+declare function encrypt(message: string): string;
+declare function decrypt(encrypted: string): string;
+export { encrypt, decrypt };

package/dist/crypt.mjs

@@ -0,0 +1,10 @@
+import aes from "crypto-js/aes";
+import utf8 from "crypto-js/enc-utf8";
+const passphrase = import.meta.env.APP_KEY;
+function encrypt(message) {
+  return aes.encrypt(message, passphrase).toString();
+}
+function decrypt(encrypted) {
+  return aes.decrypt(encrypted, passphrase).toString(utf8);
+}
+export { encrypt, decrypt };

package/dist/hash.d.ts

@@ -0,0 +1,8 @@
+declare function make(password: string, algorithm?: string): Promise<any>;
+declare function verify(password: string, hash: string, algorithm?: string): Promise<any>;
+declare function bcryptEncode(password: string): Promise<any>;
+declare function bcryptVerify(password: string, hash: string): Promise<any>;
+declare function base64Encode(password: string): Promise<string>;
+declare function base64Verify(password: string, hash: string): Promise<boolean>;
+declare function md5Encode(password: string): Promise<any>;
+export { make as makeHash, verify as verifyHash, base64Encode, base64Verify, bcryptEncode, bcryptVerify, md5Encode };

package/dist/hash.mjs

@@ -0,0 +1,38 @@
+import bcryptjs from "bcryptjs";
+import { Base64 } from "js-base64";
+import md5 from "crypto-js/md5";
+import { hashing } from "../../../config";
+async function make(password, algorithm = "bcrypt") {
+  if (algorithm === "bcrypt")
+    return bcryptEncode(password);
+  if (algorithm === "base64")
+    return base64Encode(password);
+  throw new Error("Unsupported algorithm");
+}
+async function verify(password, hash, algorithm = "bcrypt") {
+  if (algorithm === "bcrypt")
+    return bcryptVerify(password, hash);
+  if (algorithm === "base64")
+    return base64Verify(password, hash);
+  throw new Error("Unsupported algorithm");
+}
+async function bcryptEncode(password) {
+  if (!hashing.bcrypt)
+    throw new Error("Bcrypt hashing is not configured");
+  const salt = await bcryptjs.genSaltSync(hashing.bcrypt.rounds);
+  const hash = await bcryptjs.hash(password, salt);
+  return hash;
+}
+async function bcryptVerify(password, hash) {
+  return await bcryptjs.compare(password, hash);
+}
+async function base64Encode(password) {
+  return await Base64.encode(password);
+}
+async function base64Verify(password, hash) {
+  return Base64.decode(hash) === password;
+}
+async function md5Encode(password) {
+  return md5(password);
+}
+export { make as makeHash, verify as verifyHash, base64Encode, base64Verify, bcryptEncode, bcryptVerify, md5Encode };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './key';
+export * from './crypt';
+export * from './hash';

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export * from "./key.mjs";
+export * from "./crypt.mjs";
+export * from "./hash.mjs";

package/dist/key.d.ts

@@ -0,0 +1 @@
+export declare function generateAppKey(): Promise<string>;

package/dist/key.mjs

@@ -0,0 +1,9 @@
+import { getRandomValues } from "node:crypto";
+import utf8 from "crypto-js/enc-utf8";
+import base64 from "crypto-js/enc-base64";
+export async function generateAppKey() {
+  const random = getRandomValues(new Uint8Array(32));
+  const encodedWord = utf8.parse(random.toString());
+  const key = base64.stringify(encodedWord);
+  return `base64:${key}`;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@stacksjs/security",
+  "type": "module",
+  "version": "0.37.3",
+  "packageManager": "pnpm@7.13.6",
+  "description": "The Stacks framework security.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/security#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/security"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "security",
+    "framework",
+    "typescript",
+    "javascript"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.10.0",
+    "pnpm": ">=7.13.6"
+  },
+  "dependencies": {
+    "@types/bcryptjs": "^2.4.2",
+    "@types/crypto-js": "^4.1.1",
+    "bcryptjs": "^2.4.3",
+    "crypto-js": "^4.1.1",
+    "js-base64": "^3.7.2"
+  },
+  "devDependencies": {
+    "mkdist": "^0.3.13"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/crypt.ts

@@ -0,0 +1,14 @@
+import aes from 'crypto-js/aes'
+import utf8 from 'crypto-js/enc-utf8'
+
+const passphrase = import.meta.env.APP_KEY as string
+
+function encrypt(message: string): string {
+  return aes.encrypt(message, passphrase).toString()
+}
+
+function decrypt(encrypted: string): string {
+  return aes.decrypt(encrypted, passphrase).toString(utf8)
+}
+
+export { encrypt, decrypt }

package/src/hash.ts

@@ -0,0 +1,52 @@
+import bcryptjs from 'bcryptjs'
+import { Base64 } from 'js-base64'
+import md5 from 'crypto-js/md5'
+import { hashing } from '../../../config'
+
+async function make(password: string, algorithm = 'bcrypt') {
+  if (algorithm === 'bcrypt')
+    return bcryptEncode(password)
+
+  if (algorithm === 'base64')
+    return base64Encode(password)
+
+  throw new Error('Unsupported algorithm')
+}
+
+async function verify(password: string, hash: string, algorithm = 'bcrypt') {
+  if (algorithm === 'bcrypt')
+    return bcryptVerify(password, hash)
+
+  if (algorithm === 'base64')
+    return base64Verify(password, hash)
+
+  throw new Error('Unsupported algorithm')
+}
+
+async function bcryptEncode(password: string) {
+  if (!hashing.bcrypt)
+    throw new Error('Bcrypt hashing is not configured')
+
+  const salt = await bcryptjs.genSaltSync(hashing.bcrypt.rounds)
+  const hash = await bcryptjs.hash(password, salt)
+
+  return hash
+}
+
+async function bcryptVerify(password: string, hash: string) {
+  return await bcryptjs.compare(password, hash)
+}
+
+async function base64Encode(password: string) {
+  return await Base64.encode(password)
+}
+
+async function base64Verify(password: string, hash: string) {
+  return Base64.decode(hash) === password
+}
+
+async function md5Encode(password: string) {
+  return md5(password)
+}
+
+export { make as makeHash, verify as verifyHash, base64Encode, base64Verify, bcryptEncode, bcryptVerify, md5Encode }

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './key'
+export * from './crypt'
+export * from './hash'

package/src/key.ts

@@ -0,0 +1,11 @@
+import { getRandomValues } from 'node:crypto'
+import utf8 from 'crypto-js/enc-utf8'
+import base64 from 'crypto-js/enc-base64'
+
+export async function generateAppKey() {
+  const random = getRandomValues(new Uint8Array(32))
+  const encodedWord = utf8.parse(random.toString())
+  const key = base64.stringify(encodedWord)
+
+  return `base64:${key}`
+}