diff --git a/docs/rental-api-debugger.md b/docs/rental-api-debugger.md index f5b8918..654436e 100644 --- a/docs/rental-api-debugger.md +++ b/docs/rental-api-debugger.md @@ -14,6 +14,10 @@ ## 调试信息 +### 格式化请求的签名兼容 + +全局 `RepeatedlyRequestWrapper` 必须按原始字节缓存请求体。原实现通过 `HttpHelper.getBodyString` 逐行拼接,删除JSON中的LF/CRLF,造成页面签名与服务端验签请求体不同,表现为凭证正确但“租赁签名无效”。已改为原始字节缓存,并显式使用UTF-8读取字符,保留空格、换行和中文。此修复需要更新后端;不能通过要求用户删除换行或放宽验签来绕过。 + 默认使用表单填写网络、套餐ID、接收地址、商户单号、时长、资源数量、预计金额和回调地址。查询仅需原商户订单号,套餐查询仅需网络。选填参数清空时从请求中移除,不发送空字符串;金额和资源整数按精确字符串提交。需要扩展参数或排查原始字节时,切换“高级JSON / 请求预览”,两种模式共享同一份请求数据。无效JSON需先修正才能继续表单编辑。 页面展示HTTP状态、业务原始响应、耗时、可见响应头、完整请求URL、JSON原文、请求体SHA256和脱敏签名原文。API Key与签名脱敏,Secret不展示、不写日志、不持久化。签名与发送共用同一原始UTF-8请求体,时间戳和nonce每次更新;反向代理前缀不参与签名。 @@ -22,7 +26,23 @@ 初版仅调试当前服务已提供的7个用户接入接口,不提供不存在的余额、取消或退款API。回调地址通过下单JSON的notify_url填写;Webhook接收和验签示例参见 `/rental-api` 文档页面。 -## 验证 +## 服务端验签日志排查 + +`RentalIdentity`在INFO级别打印“租赁认证开始 / 凭证已定位 / 认证成功”,失败在WARN打印“租赁认证失败”。同一次认证使用相同`diagnosticId`,同时沿用项目日志traceId。不会输出Secret、请求正文、完整Key或完整签名。 + +| stage | 排查方向 | +| --- | --- | +| AUTH_FIELDS | 检查keyValid、nonceValid、timestamp、serverTime、clockSkewMs;客户端时间必须在±60秒内 | +| CREDENTIAL_LOAD | Key不存在、凭证已吊销或过期,或数据库异常;使用Key的SHA256前16位keyFingerprint关联同一凭证 | +| OWNER_TYPE | 例如在商户API中使用NODE节点凭证;此处需要APP凭证 | +| SIGNATURE_FORMAT | 签名缺失、长度不为64或不是十六进制;观察signatureLength/Whitespace等字段 | +| SECRET_DECRYPT | 检查部署主密钥及版本,不能通过重填客户端Secret修复服务端解密问题 | +| SIGNATURE_COMPARE | 将method、path、bodySha256与调试台逐项对照;路径不含代理剥离前缀,JSON签名后不能修改;协议输出小写签名。若路径和摘要一致,再检查原始Secret是否匹配、是否复制了空格 | +| NONCE_SAVE | 检查是否重复提交同一nonce或数据库结构问题,每次请求必须产生新nonce | + +bodyBytes为UTF-8字节数,bodyLfCount/bodyCrCount为服务端实际收到的换行数。比如页面请求有格式化换行而日志显示0,应继续排查部署版本、全局过滤器和代理是否改写正文。storedMasterVersion/configuredMasterVersion仅显示版本号,不输出密钥内容。 + +## 本地验证 已校验Vue模板与脚本解析;使用Node Web Crypto及独立HMAC计算交叉核对签名、JSON原文字节、代理前缀、地址上链子路径和随机nonce。未用真实凭证创建订单或冻结资金。 diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/filter/RepeatedlyRequestWrapper.java b/ruoyi-common/src/main/java/com/ruoyi/common/filter/RepeatedlyRequestWrapper.java index 614c24c..0c524c2 100644 --- a/ruoyi-common/src/main/java/com/ruoyi/common/filter/RepeatedlyRequestWrapper.java +++ b/ruoyi-common/src/main/java/com/ruoyi/common/filter/RepeatedlyRequestWrapper.java @@ -4,12 +4,13 @@ import java.io.BufferedReader; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStreamReader; +import java.nio.charset.StandardCharsets; import javax.servlet.ReadListener; import javax.servlet.ServletInputStream; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequestWrapper; -import com.ruoyi.common.utils.http.HttpHelper; +import org.apache.commons.io.IOUtils; /** * 构建可重复读取inputStream的request @@ -26,13 +27,18 @@ public class RepeatedlyRequestWrapper extends HttpServletRequestWrapper request.setCharacterEncoding("UTF-8"); response.setCharacterEncoding("UTF-8"); - body = HttpHelper.getBodyString(request).getBytes("UTF-8"); + // 必须缓存原始字节。按行读取再拼接会删除LF/CRLF,导致租赁HMAC验签失败; + // 解码再编码也可能改变非法UTF-8,掩盖接口自身对编码的校验。 + try (java.io.InputStream input = request.getInputStream()) + { + body = IOUtils.toByteArray(input); + } } @Override public BufferedReader getReader() throws IOException { - return new BufferedReader(new InputStreamReader(getInputStream())); + return new BufferedReader(new InputStreamReader(getInputStream(), StandardCharsets.UTF_8)); } @Override @@ -50,19 +56,19 @@ public class RepeatedlyRequestWrapper extends HttpServletRequestWrapper @Override public int available() throws IOException { - return body.length; + return bais.available(); } @Override public boolean isFinished() { - return false; + return bais.available() == 0; } @Override public boolean isReady() { - return false; + return true; } @Override diff --git a/ruoyi-system/src/main/java/com/ruoyi/system/rental/RentalIdentity.java b/ruoyi-system/src/main/java/com/ruoyi/system/rental/RentalIdentity.java index 3a1d4fd..530da41 100644 --- a/ruoyi-system/src/main/java/com/ruoyi/system/rental/RentalIdentity.java +++ b/ruoyi-system/src/main/java/com/ruoyi/system/rental/RentalIdentity.java @@ -11,6 +11,7 @@ import java.util.*; /** 外部APP和本地NODE共用凭证认证,登录用户归属仍由sys_user及RBAC决定。 */ @Service +@lombok.extern.slf4j.Slf4j public class RentalIdentity { private final RentalStore store; private final RentalCrypto crypto; @@ -49,33 +50,68 @@ public class RentalIdentity { String path, String body, String signature) { - require( - key != null - && key.length() <= 64 - && nonce != null - && nonce.matches("[A-Za-z0-9_-]{16,64}") - && timestamp > System.currentTimeMillis() - 60000 - && timestamp < System.currentTimeMillis() + 60000, - "认证时间或随机数无效"); - Map row = credential(key); - require( - ownerType.equals(text(row, "owner_type")) - && RentalCrypto.equal( - RentalCrypto.sign( - secret(row), - scope, - key, - timestamp, - nonce, - method, - path, - body), - signature), - "租赁签名无效"); - store.insert( - "nonce", - map("api_key", key, "scope", scope, "nonce", nonce, "expires_at", after(180))); - return row; + String diagnosticId = UUID.randomUUID().toString().replace("-", ""); + long serverTime = System.currentTimeMillis(); + boolean keyValid = key != null && !key.isEmpty() && key.length() <= 64; + boolean nonceValid = nonce != null && nonce.matches("[A-Za-z0-9_-]{16,64}"); + boolean timeValid = timestamp > serverTime - 60000 && timestamp < serverTime + 60000; + boolean signatureFormatValid = signature != null && signature.matches("[0-9a-fA-F]{64}"); + String keyFingerprint = key == null ? "missing" : RentalCrypto.sha256(key).substring(0, 16); + // 只记录请求体摘要和长度,不记录正文、Secret、完整认证头或服务端计算的签名。 + // bodySha256、method和path可直接与调试台“请求与签名”页逐项核对。 + log.info("租赁认证开始 diagnosticId={} keyFingerprint={} expectedOwnerType={} scope={} method={} path={}" + + " serverTime={} timestamp={} clockSkewMs={} keyValid={} nonceValid={} nonceLength={}" + + " signatureLength={} signatureFormatValid={} signatureLowercase={} signatureWhitespace={}" + + " bodyBytes={} bodySha256={} bodyLfCount={} bodyCrCount={}", + diagnosticId, keyFingerprint, safeLog(ownerType), safeLog(scope), safeLog(method), safeLog(path), + serverTime, timestamp, timestamp > 0 ? Long.toString(timestamp - serverTime) : "invalid", keyValid, + nonceValid, nonce == null ? 0 : nonce.length(), signature == null ? 0 : signature.length(), + signatureFormatValid, signature != null && signature.equals(signature.toLowerCase(Locale.ROOT)), + signature != null && !signature.equals(signature.trim()), + body == null ? 0 : body.getBytes(java.nio.charset.StandardCharsets.UTF_8).length, + body == null ? "missing" : RentalCrypto.sha256(body), count(body, '\n'), count(body, '\r')); + String stage = "AUTH_FIELDS"; + try { + require(keyValid && nonceValid && timeValid, "认证时间或随机数无效"); + stage = "CREDENTIAL_LOAD"; + Map row = credential(key); + log.info("租赁认证凭证已定位 diagnosticId={} credentialId={} ownerId={} ownerType={} status={}" + + " storedMasterVersion={} configuredMasterVersion={}", diagnosticId, + row.get("id"), row.get("owner_id"), safeLog(text(row, "owner_type")), safeLog(text(row, "status")), + safeLog(text(row, "master_key_version")), safeLog(masterVersion)); + stage = "OWNER_TYPE"; + require(ownerType != null && ownerType.equals(text(row, "owner_type")), "租赁签名无效"); + stage = "SIGNATURE_FORMAT"; + require(signatureFormatValid, "租赁签名无效"); + stage = "SECRET_DECRYPT"; + String credentialSecret = secret(row); + stage = "SIGNATURE_COMPARE"; + String expected = RentalCrypto.sign(credentialSecret, scope, key, timestamp, nonce, method, path, body); + require(RentalCrypto.equal(expected, signature), "租赁签名无效"); + stage = "NONCE_SAVE"; + store.insert("nonce", map("api_key", key, "scope", scope, "nonce", nonce, "expires_at", after(180))); + log.info("租赁认证成功 diagnosticId={} credentialId={} scope={}", diagnosticId, row.get("id"), safeLog(scope)); + return row; + } catch (RuntimeException ex) { + log.warn("租赁认证失败 diagnosticId={} stage={} keyFingerprint={} diagnostic={}", + diagnosticId, stage, keyFingerprint, RentalDiagnostics.describe(ex)); + throw ex; + } + } + + /** 日志字段限制长度并移除控制字符,防止外部认证参数注入伪造日志。 */ + private static String safeLog(String value) { + return value == null ? "missing" : value.replaceAll("[\\p{Cntrl}]", "_").substring(0, Math.min(value.length(), 256)); + } + + private static int count(String value, char character) { + int total = 0; + if (value != null) { + for (int index = 0; index < value.length(); index++) { + if (value.charAt(index) == character) { total++; } + } + } + return total; } /** 轮换保留历史Secret,仅明确在途任务可以使用VERIFY_ONLY,不能签发新任务。 */ diff --git a/ruoyi-system/src/test/java/com/ruoyi/system/rental/RentalBusinessTest.java b/ruoyi-system/src/test/java/com/ruoyi/system/rental/RentalBusinessTest.java index bab405b..bb8fe17 100644 --- a/ruoyi-system/src/test/java/com/ruoyi/system/rental/RentalBusinessTest.java +++ b/ruoyi-system/src/test/java/com/ruoyi/system/rental/RentalBusinessTest.java @@ -675,6 +675,38 @@ public class RentalBusinessTest { } catch (IllegalArgumentException expected) { /* 类型不允许覆盖 */ } } + /** 经过生产可重复读过滤器再验签,防止格式化JSON的LF/CRLF被全局过滤器删除。 */ + @Test + public void formattedPackagesRequestSurvivesRepeatableFilterAndAuthenticates() throws Exception { + Map credential = tx.execute(status -> identity.issue("APP", app, 10)); + RentalApiController api = new RentalApiController(identity, store, orders, json); + for (String body : new String[] {"{\n \"network\": \"NILE\"\n}", + " \r\n{\r\n \"network\": \"NILE\",\r\n \"note\": \"中文调试\"\r\n}\r\n "}) { + javax.servlet.http.HttpServletRequest signed = signedRequest("/api/rental/v1/packages", body, + text(credential, "api_key"), text(credential, "api_secret"), "API"); + javax.servlet.http.HttpServletRequest input = new javax.servlet.http.HttpServletRequestWrapper(signed) { + @Override public String getContentType() { return "application/json;charset=UTF-8"; } + }; + javax.servlet.ServletResponse response = (javax.servlet.ServletResponse) java.lang.reflect.Proxy.newProxyInstance( + getClass().getClassLoader(), new Class[] {javax.servlet.ServletResponse.class}, (proxy, method, args) -> null); + new com.ruoyi.common.filter.RepeatableFilter().doFilter(input, response, (filtered, ignored) -> { + try { + javax.servlet.http.HttpServletRequest actual = (javax.servlet.http.HttpServletRequest) filtered; + assertTrue(actual instanceof com.ruoyi.common.filter.RepeatedlyRequestWrapper); + javax.servlet.ServletInputStream stream = actual.getInputStream(); + assertFalse(stream.isFinished()); + assertArrayEquals(body.getBytes(StandardCharsets.UTF_8), org.apache.commons.io.IOUtils.toByteArray(stream)); + assertTrue(stream.isFinished()); + assertEquals(0, stream.available()); + assertEquals(body, org.apache.commons.io.IOUtils.toString(actual.getReader())); + assertEquals(200, api.execute("packages", actual).get("code")); + } catch (Exception ex) { + throw new javax.servlet.ServletException(ex); + } + }); + } + } + /** Servlet代理保留原始字节,无需启动真实HTTP端口。 */ private javax.servlet.http.HttpServletRequest demoRequest(String operation, String body, String secret) { return signedRequest("/api/rental/v1/demo/callback/" + operation, body, "RKdemo", secret, "WEBHOOK");