一、前置知识:NJS Crypto 模块基础
1.1 模块引入
NJS 从 0.7.0 版本开始,将 crypto 作为全局对象提供(无需额外安装依赖),也可通过 import 显式引入,两种方式均可:
// 方式 1:全局对象直接使用(推荐,NJS 0.7.0+)
const hash = crypto.createHash();
crypto ;
hmac = crypto.(, );
本文介绍 NJS 中 Crypto 模块的 Hash 与 HMAC 加密用法。Hash 用于数据完整性校验,HMAC 用于接口签名验证。文章涵盖核心 API 说明、基础代码示例及 NGINX 实战配置(响应头指纹添加、API 请求验签)。同时提供版本兼容性建议、性能优化及安全最佳实践,如避免使用 MD5/SHA1、密钥管理策略等,帮助开发者在 NJS 环境中实现轻量级加密需求。
NJS 从 0.7.0 版本开始,将 crypto 作为全局对象提供(无需额外安装依赖),也可通过 import 显式引入,两种方式均可:
// 方式 1:全局对象直接使用(推荐,NJS 0.7.0+)
const hash = crypto.createHash();
crypto ;
hmac = crypto.(, );
| 类型 | 核心特点 | 适用场景 |
|---|---|---|
| Hash(哈希) | 单向加密,无密钥,相同输入必出相同输出 | 数据完整性校验(如文件指纹)、简单数据脱敏 |
| HMAC(哈希消息认证码) | 基于 Hash 算法 + 密钥,需密钥验证,更安全 | 接口签名、数据防篡改(如 API 请求验签) |
crypto.createHash(algorithm) 是创建 Hash 对象的入口,核心参数和方法如下:
md5、sha1、sha256(NJS 内置,无需额外配置);hash.update(data):追加待加密的字符串/数据(可多次调用,数据会拼接);hash.digest([encoding]):计算最终哈希值,支持 hex、base64、base64url 编码,无编码参数时返回 Buffer 对象。import crypto from 'crypto';
// 1. 创建 SHA1 Hash 对象
const hash = crypto.createHash('sha1');
// 2. 传入待加密数据
hash.update('A');
// 3. 计算并输出 Base64URL 编码的哈希值
const result = hash.digest('base64url');
console.log(result);
// 输出:BtlFlCqiamG-GMPiK_GbvKjdK10
update() 可多次调用,数据会按调用顺序拼接,效果等同于单次传入拼接后的字符串:
const hash = crypto.createHash('sha1');
// 多次 update 等价于 update('AB')
hash.update('A').update('B');
const result = hash.digest('base64url');
console.log(result);
// 输出:BtlFlCqiamG-GMPiK_GbvKjdK10(与单次传入'AB'结果一致)
const hash = crypto.createHash('md5').update('test');
console.log(hash.digest('hex'));
// 16 进制:098f6bcd4621d373cade4e832627b4f6
console.log(hash.digest('base64'));
// Base64:CJ7gi1p+z8UYhhyw2bbQhg==
// 注意:digest() 只能调用一次,再次调用会报错,需重新创建 Hash 对象
在 NGINX 配置中,可通过 NJS 计算响应体的 Hash 值并添加到响应头,用于客户端校验数据完整性:
# nginx.conf 配置
http {
js_import crypto.js; # 导入 NJS 脚本
server {
listen 80;
location / {
# 响应体过滤,计算 Hash 并添加响应头
js_filter crypto.addHashHeader;
return 200 "Hello NJS Crypto";
}
}
}
# crypto.js 脚本
function addHashHeader(r) {
const data = r.responseBody; // 获取响应体
// 计算 SHA256 哈希(Hex 编码)
const hash = crypto.createHash('sha256').update(data).digest('hex');
// 添加到响应头
r.headersOut['X-Data-Hash'] = hash;
}
crypto.createHmac(algorithm, secretKey) 是创建 HMAC 对象的入口,相比 Hash 多了密钥参数,核心规则:
hmac.update(data)/hmac.digest(encoding):用法与 Hash 完全一致;import crypto from 'crypto';
// 1. 创建 HMAC 对象(算法 + 密钥)
const hmac = crypto.createHmac('sha1', 'secret.key');
// 2. 传入待加密数据
hmac.update('AB');
// 3. 计算 Base64URL 编码的结果
const result = hmac.digest('base64url');
console.log(result);
// 输出:Oglm93xn23_MkiaEq_e9u8zk374
// 密钥 1:secret.key
const hmac1 = crypto.createHmac('sha1', 'secret.key').update('AB').digest('hex');
// 密钥 2:secret.key1(仅多 1 个字符)
const hmac2 = crypto.createHmac('sha1', 'secret.key1').update('AB').digest('hex');
console.log(hmac1);
// 5e0659fddf19f777f3922684a7f7bdbbcec937ee
console.log(hmac2);
// 7a8d9c8b7e6f5a4d3b2a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e1d0c
// 结果完全不同,体现密钥的唯一性
在 NGINX 中拦截 API 请求,通过 HMAC 验证请求签名是否合法(防止篡改/伪造请求):
# nginx.conf 配置
http {
js_import crypto.js;
server {
listen 80;
location /api {
# 前置校验签名
js_access crypto.verifyHmacSign;
proxy_pass http://backend;
}
}
}
# crypto.js 脚本
function verifyHmacSign(r) {
// 1. 获取请求参数:客户端传的签名 + 请求体
const clientSign = r.headersIn['X-API-Sign'];
const requestData = r.requestBody;
// 2. 服务端密钥(与客户端约定)
const secretKey = 'my-api-secret-2025';
// 3. 计算服务端签名
const serverSign = crypto.createHmac('sha256', secretKey)
.update(requestData)
.digest('base64url');
// 4. 验证签名
if (clientSign !== serverSign) {
r.return(403, 'Invalid sign'); // 签名不匹配,拒绝请求
}
}
crypto 为全局对象,hash.copy() 从 0.7.12 开始支持;digest() 无编码参数时返回 Buffer,0.4.4 之前返回字节字符串(建议升级到 0.7.0+)。md5/sha1(安全性低),优先选择 sha256;digest() called twice:digest() 调用后 Hash/HMAC 对象会销毁,需重新创建对象才能再次计算;algorithm not supported:仅支持 md5/sha1/sha256,勿使用其他算法(如 sha512)。crypto 模块无需额外依赖,createHash() 适用于无密钥的单向哈希,createHmac() 基于密钥更适合安全认证;update() 可多次拼接数据,digest() 是最终计算入口,支持 hex/base64/base64url 三种编码;
微信公众号「极客日志」,在微信中扫描左侧二维码关注。展示文案:极客日志 zeeklog
使用加密算法(如AES、TripleDES、Rabbit或RC4)加密和解密文本明文。 在线工具,加密/解密文本在线工具,online
查找任何按下的键的javascript键代码、代码、位置和修饰符。 在线工具,Keycode 信息在线工具,online
JavaScript 字符串转义/反转义;Java 风格 \uXXXX(Native2Ascii)编码与解码。 在线工具,Escape 与 Native 编解码在线工具,online
使用 Prettier 在浏览器内格式化 JavaScript 或 HTML 片段。 在线工具,JavaScript / HTML 格式化在线工具,online
Terser 压缩、变量名混淆,或 javascript-obfuscator 高强度混淆(体积会增大)。 在线工具,JavaScript 压缩与混淆在线工具,online
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具,Base64 字符串编码/解码在线工具,online