node.bcrypt.js 技术文档

2024-12-23 16:38:35作者：范靓好Udolf

1. 安装指南

环境要求

使用稳定的 Node.js 版本，不稳定版本目前不支持。
确保安装了 node-gyp 及其依赖项。
Windows 用户需要安装 Visual Studio 的 C# 和 C++ 选项。
Python 2.x 或 3.x。
OpenSSL（仅在使用版本 <= 0.7.7 时需要）。

安装步骤

打开终端或命令行工具。
运行以下命令安装 bcrypt：
```
npm install bcrypt
```

注意事项

OS X 用户如果遇到 Xcode 相关错误，可以运行以下命令：
```
sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer
```
如果遇到预编译二进制文件下载失败的问题，请确保安装了所有必要的依赖项。

2. 项目的使用说明

异步模式（推荐）

生成密码哈希

技术 1：分步生成盐和哈希

const bcrypt = require('bcrypt');
const saltRounds = 10;
const myPlaintextPassword = 's0/\/\P4$$w0rD';

bcrypt.genSalt(saltRounds, function(err, salt) {
    bcrypt.hash(myPlaintextPassword, salt, function(err, hash) {
        // 将哈希存储到数据库中
    });
});

技术 2：自动生成盐和哈希

bcrypt.hash(myPlaintextPassword, saltRounds, function(err, hash) {
    // 将哈希存储到数据库中
});

验证密码

bcrypt.compare(myPlaintextPassword, hash, function(err, result) {
    // result == true
});
bcrypt.compare(someOtherPlaintextPassword, hash, function(err, result) {
    // result == false
});

同步模式

生成密码哈希

技术 1：分步生成盐和哈希

const salt = bcrypt.genSaltSync(saltRounds);
const hash = bcrypt.hashSync(myPlaintextPassword, salt);
// 将哈希存储到数据库中

技术 2：自动生成盐和哈希

const hash = bcrypt.hashSync(myPlaintextPassword, saltRounds);
// 将哈希存储到数据库中

验证密码

bcrypt.compareSync(myPlaintextPassword, hash); // true
bcrypt.compareSync(someOtherPlaintextPassword, hash); // false

为什么推荐使用异步模式？

异步模式不会阻塞事件循环，适合在服务器上使用。同步模式会阻塞事件循环，影响应用的响应性能。

3. 项目API使用文档

异步API

bcrypt.genSalt(rounds, minor, cb)
- rounds：哈希处理的代价（默认：10）。
- minor：bcrypt的次版本（默认：'b'）。
- cb：回调函数，返回生成的盐。
bcrypt.hash(data, salt, cb)
- data：要加密的数据。
- salt：用于哈希的盐。
- cb：回调函数，返回生成的哈希。
bcrypt.compare(data, encrypted, cb)
- data：明文密码。
- encrypted：存储的哈希密码。
- cb：回调函数，返回比较结果。

同步API

bcrypt.genSaltSync(rounds, minor)
- rounds：哈希处理的代价（默认：10）。
- minor：bcrypt的次版本（默认：'b'）。
bcrypt.hashSync(data, salt)
- data：要加密的数据。
- salt：用于哈希的盐。
bcrypt.compareSync(data, encrypted)
- data：明文密码。
- encrypted：存储的哈希密码。