feat(bcrypt): genSalt and genSaltSync

Author: Brooooooklyn

package.json

@@ -2,13 +2,10 @@
   "name": "node-rs",
   "version": "0.0.0",
   "description": "Node & Rust bindings monorepo",
-  "main": "index.js",
   "author": "LongYinan <[email protected]>",
   "license": "MIT",
   "private": true,
-  "workspaces": [
-    "packages/*"
-  ],
+  "workspaces": ["packages/*"],
   "scripts": {
     "artifacts": "lerna run artifacts",
     "bench": "lerna run bench --concurrency 1 --stream --no-prefix",
@@ -47,33 +44,18 @@
     "typescript": "^4.2.3"
   },
   "ava": {
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "@swc-node/register"
-    ],
-    "files": [
-      "packages/**/*.spec.ts"
-    ],
+    "extensions": ["ts"],
+    "require": ["@swc-node/register"],
+    "files": ["packages/**/*.spec.ts"],
     "environmentVariables": {
       "TS_NODE_PROJECT": "./tsconfig.test.json"
     }
   },
   "lint-staged": {
-    "*.@(js|ts|tsx)": [
-      "prettier --write",
-      "eslint -c .eslintrc.yml --fix"
-    ],
-    "*.@(yml|yaml)": [
-      "prettier --parser yaml --write"
-    ],
-    "*.json": [
-      "prettier --parser json --write"
-    ],
-    "*.md": [
-      "prettier --parser markdown --write"
-    ]
+    "*.@(js|ts|tsx)": ["prettier --write", "eslint -c .eslintrc.yml --fix"],
+    "*.@(yml|yaml)": ["prettier --parser yaml --write"],
+    "*.json": ["prettier --parser json --write"],
+    "*.md": ["prettier --parser markdown --write"]
   },
   "prettier": {
     "printWidth": 120,
@@ -83,4 +65,4 @@
     "arrowParens": "always",
     "parser": "typescript"
   }
-}
+}

packages/bcrypt/benchmark/bcrypt.js

@@ -1,19 +1,18 @@
 const { cpus } = require('os')
 
-const { hashSync, hash, compare } = require('bcrypt')
-const { hashSync: hashSyncJs, hash: hashJs, compare: compareJs } = require('bcryptjs')
+const { hashSync, hash, compare, genSaltSync } = require('bcrypt')
+const { hashSync: hashSyncJs, hash: hashJs, compare: compareJs, genSaltSync: genSaltSyncJs } = require('bcryptjs')
 const { Suite } = require('benchmark')
 const chalk = require('chalk')
 const { range } = require('lodash')
 
-const { hash: napiHash, hashSync: napiHashSync, verify } = require('../index')
+const { hash: napiHash, hashSync: napiHashSync, verify, genSaltSync: napiGenSaltSync } = require('../index')
 
-const hashRounds = [10, 12, 14]
 const parallel = cpus().length
 
 const password = 'node-rust-password'
 
-function runAsync(round) {
+function runAsync(round = 12) {
   const asyncHashSuite = new Suite(`Async hash round ${round}`)
   return new Promise((resolve) => {
     asyncHashSuite
@@ -53,11 +52,7 @@ function runAsync(round) {
   })
 }
 
-hashRounds
-  .reduce(async (acc, cur) => {
-    await acc
-    return runAsync(cur)
-  }, Promise.resolve())
+runAsync()
   .then(
     () =>
       new Promise((resolve) => {
@@ -103,24 +98,47 @@ hashRounds
       }),
   )
   .then(() => {
-    for (const round of hashRounds) {
-      const syncHashSuite = new Suite(`Hash round ${round}`)
+    return new Promise((resolve) => {
+      const syncHashSuite = new Suite(`Hash round 12`)
       syncHashSuite
         .add('@node-rs/bcrypt', () => {
-          napiHashSync(password, round)
+          napiHashSync(password, 12)
         })
         .add('node bcrypt', () => {
-          hashSync(password, round)
+          hashSync(password, 12)
         })
         .add('bcryptjs', () => {
-          hashSyncJs(password, round)
+          hashSyncJs(password, 12)
         })
         .on('cycle', function (event) {
           console.info(String(event.target))
         })
         .on('complete', function () {
           console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+          resolve()
         })
         .run()
-    }
+    })
+  })
+  .then(() => {
+    return new Promise((resolve) => {
+      new Suite('genSaltSync')
+        .add('@node-rs/bcrypt', () => {
+          napiGenSaltSync(10, '2b')
+        })
+        .add('node bcrypt', () => {
+          genSaltSync(10, 'b')
+        })
+        .add('bcryptjs', () => {
+          genSaltSyncJs(10)
+        })
+        .on('cycle', function (event) {
+          console.info(String(event.target))
+        })
+        .on('complete', function () {
+          console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+          resolve()
+        })
+        .run()
+    })
   })

packages/bcrypt/index.d.ts

@@ -4,3 +4,23 @@ export function hashSync(password: string | Buffer, round?: number): string
 export function hash(password: string | Buffer, round?: number): Promise<string>
 export function verifySync(password: string | Buffer, hash: string | Buffer): boolean
 export function verify(password: string | Buffer, hash: string | Buffer): Promise<boolean>
+/**
+ * The same with `verifySync`
+ */
+export function compareSync(password: string | Buffer, hash: string | Buffer): boolean
+/**
+ * The same with `verify`
+ */
+export function compare(password: string | Buffer, hash: string | Buffer): Promise<boolean>
+
+export type Version = '2a' | '2x' | '2y' | '2b'
+/**
+ * @param round default 10
+ * @param version default '2b'
+ */
+export function genSaltSync(round?: number, version?: Version): string
+/**
+ * @param round default 10
+ * @param version default '2b'
+ */
+export function genSalt(round?: number, version?: Version): Promise<string>

packages/bcrypt/index.js

@@ -4,9 +4,25 @@ const binding = loadBinding(__dirname, 'bcrypt', '@node-rs/bcrypt')
 
 const DEFAULT_COST = 12
 
+function verify(password, hash) {
+  password = Buffer.isBuffer(password) ? password : Buffer.from(password)
+  hash = Buffer.isBuffer(hash) ? hash : Buffer.from(hash)
+  return binding.verify(password, hash)
+}
+
+function verifySync(password, hash) {
+  password = Buffer.isBuffer(password) ? password : Buffer.from(password)
+  hash = Buffer.isBuffer(hash) ? hash : Buffer.from(hash)
+  return binding.verifySync(password, hash)
+}
+
 module.exports = {
   DEFAULT_COST: DEFAULT_COST,
 
+  genSaltSync: function genSaltSync(round = 10, version = '2b') {
+    return binding.genSaltSync(round, version)
+  },
+
   genSalt: function genSalt(round = 10, version = '2b') {
     return binding.genSalt(round, version)
   },
@@ -21,15 +37,8 @@ module.exports = {
     return binding.hash(input, round)
   },
 
-  verifySync: function verifySync(password, hash) {
-    password = Buffer.isBuffer(password) ? password : Buffer.from(password)
-    hash = Buffer.isBuffer(hash) ? hash : Buffer.from(hash)
-    return binding.verifySync(password, hash)
-  },
-
-  verify: function verify(password, hash) {
-    password = Buffer.isBuffer(password) ? password : Buffer.from(password)
-    hash = Buffer.isBuffer(hash) ? hash : Buffer.from(hash)
-    return binding.verify(password, hash)
-  },
+  verifySync,
+  verify,
+  compareSync: verifySync,
+  compare: verify,
 }

packages/bcrypt/package.json

@@ -49,6 +49,7 @@
     "@node-rs/helper": "^1.1.0"
   },
   "devDependencies": {
+    "@types/bcrypt": "^3.0.0",
     "bcrypt": "^5.0.1",
     "bcryptjs": "^2.4.3"
   },

packages/bcrypt/src/lib.rs

@@ -17,6 +17,7 @@ mod bcrypt;
 mod errors;
 mod hash_task;
 mod lib_bcrypt;
+mod salt_task;
 mod verify_task;
 
 #[cfg(all(unix, not(target_env = "musl"), not(target_arch = "aarch64")))]
@@ -29,9 +30,10 @@ static ALLOC: mimalloc::MiMalloc = mimalloc::MiMalloc;
 
 #[module_exports]
 fn init(mut exports: JsObject) -> Result<()> {
+  exports.create_named_method("genSaltSync", js_salt)?;
+  exports.create_named_method("genSalt", js_async_salt)?;
   exports.create_named_method("hash", js_async_hash)?;
   exports.create_named_method("hashSync", js_hash)?;
-  exports.create_named_method("genSalt", js_salt)?;
   exports.create_named_method("verifySync", js_verify)?;
   exports.create_named_method("verify", js_async_verify)?;
 
@@ -51,6 +53,18 @@ fn js_salt(ctx: CallContext) -> Result<JsString> {
   ctx.env.create_string(&salt_string)
 }
 
+#[js_function(2)]
+fn js_async_salt(ctx: CallContext) -> Result<JsObject> {
+  let round = ctx.get::<JsNumber>(0)?;
+  let version = ctx.get::<JsString>(1)?.into_utf8()?;
+  let task = salt_task::SaltTask {
+    round: round.try_into()?,
+    version: Version::from_str(version.as_str()?)
+      .map_err(|_| Error::from_status(Status::InvalidArg))?,
+  };
+  ctx.env.spawn(task).map(|t| t.promise_object())
+}
+
 #[js_function(2)]
 fn js_hash(ctx: CallContext) -> Result<JsString> {
   let password = ctx.get::<JsBuffer>(0)?.into_value()?;

packages/bcrypt/src/lib_bcrypt.rs

@@ -24,6 +24,7 @@ pub struct HashParts {
 
 /// BCrypt hash version
 /// https://en.wikipedia.org/wiki/Bcrypt#Versioning_history
+#[derive(Debug, Clone, Copy)]
 pub enum Version {
   TwoA,
   TwoX,

packages/bcrypt/src/salt_task.rs

@@ -0,0 +1,22 @@
+use napi::{Env, JsString, Result, Task};
+
+use crate::{format_salt, gen_salt, Version};
+
+pub struct SaltTask {
+  pub(crate) round: u32,
+  pub(crate) version: Version,
+}
+
+impl Task for SaltTask {
+  type Output = String;
+  type JsValue = JsString;
+
+  fn compute(&mut self) -> Result<Self::Output> {
+    let random = gen_salt();
+    Ok(format_salt(self.round, self.version, &random))
+  }
+
+  fn resolve(self, env: Env, output: Self::Output) -> Result<Self::JsValue> {
+    env.create_string(output.as_str())
+  }
+}

yarn.lock

@@ -1290,6 +1290,11 @@
   resolved "https://registry.npmjs.org/@types/anymatch/-/anymatch-1.3.1.tgz#336badc1beecb9dacc38bea2cf32adf627a8421a"
   integrity sha512-/+CRPXpBDpo2RK9C68N3b2cOvO0Cf5B9aPijHsoDQTHivnGSObdOF2BRQOYjojWTDy6nQvMjmqRXIxH55VjxxA==
 
+"@types/bcrypt@^3.0.0":
+  version "3.0.0"
+  resolved "https://registry.npmjs.org/@types/bcrypt/-/bcrypt-3.0.0.tgz#851489a9065a067cb7f3c9cbe4ce9bed8bba0876"
+  integrity sha512-nohgNyv+1ViVcubKBh0+XiNJ3dO8nYu///9aJ4cgSqv70gBL+94SNy/iC2NLzKPT2Zt/QavrOkBVbZRLZmw6NQ==
+
 "@types/crc@^3.4.0":
   version "3.4.0"
   resolved "https://registry.npmjs.org/@types/crc/-/crc-3.4.0.tgz#2366beb4399cd734b33e42c7ac809576e617d48a"