@stacksjs/security 0.37.8 → 0.38.3

package/README.md

@@ -1,32 +1,30 @@
-# Stacks Router
+# Stacks Path
 
-This package contains the Stacks Security.
+Easily work with encryptions, decryptions, and hashing.
 
 ## ☘️ Features
 
-wip
-
-- ⚡️
-
-wip
+- Base64 support
+- Bcrypt support
+- Argon support
+- Implements the Advanced Encryption Standard (AES)
+- Written in modern ESM/TypeScript
 
 ## 🤖 Usage
 
-wip
-
 ```bash
 pnpm i -D @stacksjs/security
 ```
 
-Now, you can use it in your project:
+Now, you can easily access it in your project:
 
 ```js
-import * as security from '@stacksjs/security'
+import { base64Encode, base64Verify, bcryptEncode, bcryptVerify, decrypt, encrypt, makeHash, md5Encode, verifyHash } from '@stacksjs/security'
 
-// wip
+// and more...
 ```
 
-Learn more in the docs.
+To view the full documentation, please visit [https://stacksjs.dev/security](https://stacksjs.dev/security).
 
 ## 🧪 Testing
 
@@ -36,7 +34,7 @@ pnpm test
 
 ## 📈 Changelog
 
-Please see our [releases](https://github.com/stacksjs/stacksjs/releases) page for more information on what has changed recently.
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
 ## 💪🏼 Contributing
 
@@ -52,6 +50,15 @@ For casual chit-chat with others using this package:
 
 [Join the Open Web Discord Server](https://discord.ow3.org)
 
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [crypto-js](https://github.com/brix/crypto-js)
+- [js-base64](https://www.npmjs.com/package/js-base64)
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [All Contributors](../../contributors)
+
 ## 📄 License
 
 The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.

package/dist/hash.mjs

@@ -1,7 +1,7 @@
 import bcryptjs from "bcryptjs";
 import { Base64 } from "js-base64";
 import md5 from "crypto-js/md5";
-import { hashing } from "../../../config";
+import { hashing } from "@stacksjs/config";
 async function make(password, algorithm = "bcrypt") {
   if (algorithm === "bcrypt")
     return bcryptEncode(password);

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/security",
   "type": "module",
-  "version": "0.37.8",
-  "packageManager": "pnpm@7.14.0",
+  "version": "0.38.3",
+  "packageManager": "pnpm@7.15.0",
   "description": "The Stacks framework security.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -30,22 +30,22 @@
   ],
   "files": [
     "dist",
-    "src",
     "README.md"
   ],
   "engines": {
-    "node": ">=v18.10.0",
-    "pnpm": ">=7.14.0"
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.15.0"
   },
-  "dependencies": {
-    "@types/bcryptjs": "^2.4.2",
-    "@types/crypto-js": "^4.1.1",
+  "peerDependencies": {
+    "@stacksjs/config": "0.38.3",
+    "@stacksjs/types": "0.38.3",
     "bcryptjs": "^2.4.3",
     "crypto-js": "^4.1.1",
     "js-base64": "^3.7.2"
   },
   "devDependencies": {
-    "mkdist": "^0.3.13"
+    "mkdist": "^0.4.0",
+    "typescript": "^4.8.4"
   },
   "scripts": {
     "build": "mkdist -d",

package/src/crypt.ts

@@ -1,14 +0,0 @@
-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

@@ -1,52 +0,0 @@
-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

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

package/src/key.ts

@@ -1,11 +0,0 @@
-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}`
-}