oms/backend/app/lib/wms/sign.js
liufumingren ec81f8b3cd feat(backend): 入库单/出库单全流程与 WMS 对接
- 入库单、出库单控制器与模型(状态流转、审核、驳回换号、作废、删除约束)
- 明细共用 stock_items:应/已数量、行级库存类型 ZP/CC、明细锁定
- lib/wms:单据类型常量(orderTypes)、奇门/openapi 客户端(qimenClient)、签名(sign)
- 库存联动:utils/stock.js、utils/completeInbound.js(入库完成加库存,幂等)
- 驳回换号:utils/rejectBillNo.js;旧 orders 模块同步调整
- 相关迁移:入库单 WMS 字段/审核/推送结果、明细计划与实际数量、单据类型落 WMS 编码、出库库存扣减标记等
2026-09-13 02:23:44 +08:00

101 lines
3.9 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
/**
* 类奇门接口(WMS openapi)签名算法
*
* 与 WMS 侧 app/lib/api_sign.js 完全对齐:
* bodySign = md5( stableStringify(body) ).toLowerCase()
* canonicalQuery = 按 key 字母序拼接 `k=v&...`,忽略 sign/signature 与 undefined
* sign = md5( canonicalQuery + secret + bodySign ).toLowerCase()
*
* 注意:body 参与签名的是「解析后的对象」经稳定序列化后的结果(与 JSON 线格式无关),
* 因此调用方务必传入与请求体结构一致的对象(而非字符串)。
*/
const crypto = require('crypto');
/** 签名时忽略的 query 字段 */
const DEFAULT_IGNORE_KEYS = [ 'sign', 'signature' ];
function isPlainObject(value) {
return Object.prototype.toString.call(value) === '[object Object]';
}
/**
* 稳定序列化:递归按 key 字母序排列,确保对象键顺序固定(与 WMS 算法一致)
* @param {*} value
* @return {string}
*/
function stableStringify(value) {
if (value === undefined) return '';
if (value === null || typeof value !== 'object') return JSON.stringify(value);
if (Array.isArray(value)) {
return `[${value.map(stableStringify).join(',')}]`;
}
if (!isPlainObject(value)) return JSON.stringify(value);
const keys = Object.keys(value).sort();
return `{${keys.map(key => `${JSON.stringify(key)}:${stableStringify(value[key])}`).join(',')}}`;
}
/**
* 归一化参数值为可拼接字符串
* @param {*} value
* @return {string}
*/
function normalizeParamValue(value) {
if (value === undefined || value === null) return '';
if (typeof value === 'object') return stableStringify(value);
return String(value);
}
/**
* 构建按 key 字母序排列的 query 参数串(排除忽略字段与 undefined)
* @param {Object} params
* @param {string[]} ignoreKeys
* @return {string}
*/
function buildCanonicalQuery(params = {}, ignoreKeys = []) {
if (!isPlainObject(params)) throw new Error('query 参数必须是对象');
const ignoreKeySet = new Set((Array.isArray(ignoreKeys) ? ignoreKeys : []).map(k => String(k).toLowerCase()));
const keys = Object.keys(params)
.filter(key => !ignoreKeySet.has(String(key).toLowerCase()))
.filter(key => params[key] !== undefined)
.sort();
return keys.map(key => `${key}=${normalizeParamValue(params[key])}`).join('&');
}
/**
* 计算类奇门接口签名
* @param {Object} options
* @param {Object} options.query 参与签名的 query 参数(不含 sign),值与最终放到 URL 上的保持一致
* @param {*} options.body 请求体对象(与发送 JSON 体结构一致)
* @param {string} options.secret 应用密钥 app_secret
* @param {string[]} [options.ignoreKeys] 额外忽略的 query 字段
* @return {string} 签名(小写 hex)
*/
function qimenSign({ query = {}, body, secret, ignoreKeys } = {}) {
const mergedIgnoreKeys = [ ...DEFAULT_IGNORE_KEYS, ...(Array.isArray(ignoreKeys) ? ignoreKeys : []) ];
const canonicalQuery = buildCanonicalQuery(query, mergedIgnoreKeys);
const serializedBody = typeof body === 'string' ? body : stableStringify(body);
const bodySign = crypto.createHash('md5').update(serializedBody, 'utf8').digest('hex')
.toLowerCase();
const signText = `${canonicalQuery}${String(secret || '').trim()}${bodySign}`;
return crypto.createHash('md5').update(signText, 'utf8').digest('hex')
.toLowerCase();
}
/**
* 恒定时间比较签名(避免比较耗时泄露签名信息)
* @param {string} expected 服务端计算出的签名
* @param {string} provided 调用方传入的签名
* @return {boolean} 是否一致
*/
function timingSafeEqual(expected, provided) {
const left = Buffer.from(String(expected || ''), 'utf8');
const right = Buffer.from(String(provided || ''), 'utf8');
if (left.length !== right.length) return false;
return crypto.timingSafeEqual(left, right);
}
module.exports = { qimenSign, timingSafeEqual, stableStringify, buildCanonicalQuery, DEFAULT_IGNORE_KEYS };