diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0c9fed7..1021c9d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,7 +2,7 @@ name: CI on: push: - branches: [main] + branches: [main, 'release/**'] pull_request: schedule: - cron: '0 2 * * 1' # 每周一 02:00 UTC 跑 mutation(低频收集 PIT 基线) diff --git a/.gitignore b/.gitignore index 70452ff..b47a31f 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,9 @@ target/ dependency-reduced-pom.xml .flattened-pom.xml +# 本地代码审查报告(不随仓库分发) +.zcode-review/ + # python __pycache__ .pytest_cache diff --git a/README.en.md b/README.en.md index de59a60..a1c99b1 100644 --- a/README.en.md +++ b/README.en.md @@ -11,8 +11,8 @@ wire byte formats. - Protocol sources: [crypto-strategy-spec.md](https://github.com/wop-platform/wop-specs/blob/main/crypto/crypto-strategy-spec.md) (v0.4-draft) + [wop-sdk-spec.md](https://github.com/wop-platform/wop-specs/blob/main/docs/specs/wop-sdk-spec.md) (v1.0-ratified) - Vector source of truth: [crypto-vectors.json](https://github.com/wop-platform/wop-specs/blob/main/crypto/crypto-vectors.json) (fetched at build time from the pinned commit SHA with sha256 verification; no copy kept in this repo) -- JDK 8+, Maven multi-module (`groupId: com.wanlianyida`, version 0.3.0; the unirest adapter requires Java 11+ at runtime — JDK 8 users should use the okhttp/jdkhttp adapters) -- Single runtime dependency: BouncyCastle (the only supported path for SM2/SM3/SM4) +- JDK 8+, Maven multi-module (`groupId: com.wanlianyida`, version 0.3.0-jdk15on.1; the unirest adapter requires Java 11+ at runtime — JDK 8 users should use the okhttp/jdkhttp adapters) +- Single runtime dependency: BouncyCastle (the only supported path for SM2/SM3/SM4); this release line uses `bcprov-jdk15on` | Module | Description | |--------|-------------| @@ -23,6 +23,17 @@ wire byte formats. Supported suites: `WOP-RSA2048-SHA256` / `WOP-RSA3072-SHA256` / `WOP-RSA4096-SHA256` / `WOP-SM2-SM3`. +> **Release line selection (important)**: the SDK ships two BouncyCastle lines, and they **must not coexist on one classpath** (`jdk15on` and `jdk18on` are distinct artifacts sharing the same packages). +> +> | Release line | Coordinates | Intended for | +> |---|---|---| +> | `jdk15on` (this branch) | `0.3.0-jdk15on.1` | Projects already using `bcprov-jdk15on` (≥1.65); no exclusions needed | +> | `jdk18on` (main) | `0.3.0` | Projects without BC, or already on `bcprov-jdk18on` | +> +> Pick with `mvn dependency:tree -Dincludes=org.bouncycastle`: if you see `bcprov-jdk15on`, use this line; otherwise use `main`. The `jdk15on` branch is no longer security-maintained (1.70 is the final release); new projects should prefer the `jdk18on` line. +> +> Both release lines share one coordinate space: Maven orders an unrecognized qualifier after the release version (`0.3.0-jdk15on.1 > 0.3.0`), so **users on either line can be pulled across by update tools**. Pin an exact version and configure Renovate/Dependabot as described in [docs/release-lines.md](docs/release-lines.md); see [SECURITY.md](SECURITY.md) for the security boundary. + > **JDK adapter memory profile (`wop-sdk-jdkhttp`)**: request bodies are sent through `HttpURLConnection`'s default buffering mode — in streaming mode the JDK discards 401/407 challenge response bodies (`getErrorStream()` is always null), so buffering is the only correct option — meaning peak memory during a send is roughly 2x the request body size; response reading still streams under the 11MB cap. For very large request bodies prefer the okhttp/unirest adapters. ## Quick Start @@ -31,26 +42,26 @@ Supported suites: `WOP-RSA2048-SHA256` / `WOP-RSA3072-SHA256` / `WOP-RSA4096-SHA com.wanlianyida wop-sdk-core - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-okhttp - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-jdkhttp - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-unirest - 0.3.0 + 0.3.0-jdk15on.1 ``` diff --git a/README.md b/README.md index 785d727..7c6b93c 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ WOP 网关商户侧官方 Java 客户端:封装协议核心(签名 / 摘要 - 协议真源:[crypto-strategy-spec.md](https://github.com/wop-platform/wop-specs/blob/main/crypto/crypto-strategy-spec.md)(v0.4-draft)+ [wop-sdk-spec.md](https://github.com/wop-platform/wop-specs/blob/main/docs/specs/wop-sdk-spec.md)(v1.0-ratified) - 向量真源:[crypto-vectors.json](https://github.com/wop-platform/wop-specs/blob/main/crypto/crypto-vectors.json)(构建期按 commit SHA 钉版拉取 + sha256 校验,本仓不保留副本) -- JDK 8+,Maven 多模块(`groupId: com.wanlianyida`,版本 0.3.0;unirest 适配器运行时要求 Java 11+,JDK 8 用户请用 okhttp/jdkhttp 适配器) -- 运行时依赖仅 BouncyCastle(国密 SM2/SM3/SM4 唯一路径) +- JDK 8+,Maven 多模块(`groupId: com.wanlianyida`,版本 0.3.0-jdk15on.1;unirest 适配器运行时要求 Java 11+,JDK 8 用户请用 okhttp/jdkhttp 适配器) +- 运行时依赖仅 BouncyCastle(国密 SM2/SM3/SM4 唯一路径);本发行线使用 `bcprov-jdk15on` | 模块 | 说明 | |------|------| @@ -23,6 +23,17 @@ WOP 网关商户侧官方 Java 客户端:封装协议核心(签名 / 摘要 支持套件:`WOP-RSA2048-SHA256` / `WOP-RSA3072-SHA256` / `WOP-RSA4096-SHA256` / `WOP-SM2-SM3`。 +> **发行线选择(重要)**:SDK 提供两条 BouncyCastle 依赖线,二者**不可同时出现在同一 classpath**(`jdk15on` 与 `jdk18on` 是不同 artifact、同名包)。 +> +> | 发行线 | 坐标版本 | 适用项目 | +> |---|---|---| +> | `jdk15on`(本分支) | `0.3.0-jdk15on.1` | 已有 `bcprov-jdk15on`(≥1.65)的老项目,无需排除任何依赖 | +> | `jdk18on`(main) | `0.3.0` | 无 BC 依赖、或已使用 `bcprov-jdk18on` 的项目 | +> +> 选择规则:运行 `mvn dependency:tree -Dincludes=org.bouncycastle`,看到 `bcprov-jdk15on` 就用本发行线,否则用 `main` 发行线。`jdk15on` 分支已停止安全维护(1.70 为最后一版),新项目优先选择 `jdk18on` 线。 +> +> 两条发行线共用同一坐标空间:Maven 把未识别限定符排在发布版之后(`0.3.0-jdk15on.1 > 0.3.0`),**两条线的使用者都可能被更新工具诱导跨线**。请锁定精确版本并按 [docs/release-lines.md](docs/release-lines.md) 配置 Renovate/Dependabot;安全边界见 [SECURITY.md](SECURITY.md)。 + > **JDK 适配器内存画像(`wop-sdk-jdkhttp`)**:请求体经 `HttpURLConnection` 默认缓冲模式发送——streaming 模式遇 401/407 挑战会丢弃错误响应体(`getErrorStream()` 恒 null),缓冲是唯一正确解——发送期间峰值内存约为请求体字节数的 2 倍;响应侧仍为 11MB 流式读取。超大请求体场景建议改用 okhttp/unirest 适配器。 ## 配置层一站式接入(wop-sdk-config-spec) @@ -34,7 +45,7 @@ WOP 网关商户侧官方 Java 客户端:封装协议核心(签名 / 摘要 com.wanlianyida wop-sdk-jdkhttp - 0.3.0 + 0.3.0-jdk15on.1 ``` @@ -94,26 +105,26 @@ trim;可打印 ASCII、无内部空白、≤128 字符,控制字符含 tab/ com.wanlianyida wop-sdk-core - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-okhttp - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-jdkhttp - 0.3.0 + 0.3.0-jdk15on.1 com.wanlianyida wop-sdk-unirest - 0.3.0 + 0.3.0-jdk15on.1 ``` diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..c2264c0 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,31 @@ +# 安全策略 + +## 支持的版本 + +| 发行线 | 版本示例 | 状态 | +|---|---|---| +| jdk18on(`main`) | `0.3.x` | 正常维护,接收安全修复 | +| jdk15on(`release/jdk15on-*`) | `0.3.0-jdk15on.x` | 过渡发行线,尽力修复;底层 BC 已停止维护 | + +15on 线使用 `bcprov-jdk15on` 1.70(该 artifact 的最后一版,2021-12)。此后 +BouncyCastle 的安全修复只进入 `bcprov-jdk18on` 分支,1.70 不会获得回灌补丁。 +两条线的差异与选择方法见 [docs/release-lines.md](docs/release-lines.md)。 + +## 上报漏洞 + +请**不要**通过公开 issue 披露未修复的安全问题。使用 GitHub 仓库的 +**Security → Report a vulnerability** 私密上报,并尽量包含: + +- 受影响版本与发行线(`mvn dependency:tree -Dincludes=org.bouncycastle` 输出); +- 最小复现步骤或 PoC(不要附带真实密钥、证书或生产数据); +- 影响评估(机密性 / 完整性 / 可用性)。 + +我们会在确认后同步修复计划;需要协调披露时,请在报告中说明期望的时间线。 + +## 不在范围内 + +- 消费者自行替换或排除 SDK 依赖后产生的组合问题; +- 消费者 classpath 上同时存在 `bcprov-jdk15on` 与 `bcprov-jdk18on` 的配置错误 + (这属于依赖冲突,不是 SDK 漏洞); +- 已停止维护的 15on 线中、且仅存在于 EOL BouncyCastle 1.70 自身的问题—— + 此类问题应推动迁移到 18on 线。 diff --git a/docs/release-lines.md b/docs/release-lines.md new file mode 100644 index 0000000..103fc11 --- /dev/null +++ b/docs/release-lines.md @@ -0,0 +1,123 @@ +# 发行线(jdk15on / jdk18on) + +本仓库对外提供两条 BouncyCastle 依赖线。两条线**代码同源、二进制行为一致**,唯一差异是 +BC 的 Maven 坐标;它们**不能出现在同一个 classpath**(`bcprov-jdk15on` 与 `bcprov-jdk18on` +是不同 artifact,但包含同名 `org.bouncycastle.*` 包,同名类随机取胜)。 + +## 如何选择 + +```bash +mvn dependency:tree -Dincludes=org.bouncycastle +``` + +| 依赖树结果 | 选择 | 坐标示例 | +|---|---|---| +| 无 BouncyCastle | 18on 线(`main`) | `0.3.0` | +| `bcprov-jdk18on` | 18on 线(`main`) | `0.3.0` | +| `bcprov-jdk15on`(≥1.65) | 15on 线 | `0.3.0-jdk15on.1` | +| `bcprov-jdk15on`(<1.65) | 先升级 BC,再选 15on 线 | — | + +15on 线由 `BouncyCastleVersionGuard` 在运行时校验版本,低于 1.65 会抛 +`WopError`(`category=configuration`)并给出升级提示。 + +## 为什么不能"自动升级" + +Maven 的 `ComparableVersion` 会把未识别限定符排在发布版本**之后**,因此: + +``` +0.3.0-jdk15on.1 > 0.3.0 +``` + +这带来两个方向的跨线风险: + +- **18on 使用者**(当前 `0.3.0`)会被 Renovate / Dependabot / `mvn versions:display-dependency-updates` + 提示升级到 `0.3.0-jdk15on.1`——这会把项目迁到 15on 线,并在 classpath 上同时引入 + `bcprov-jdk18on` 与 `bcprov-jdk15on`; +- **15on 使用者**(当前 `0.3.0-jdk15on.1`)暂时不会被拉回 `0.3.0`,但主干发布 `0.3.1+` + 之后,同样会被提示跨线升级。 + +单一坐标空间无法靠版本排序隔离两条发行线。**结构性方案是给 15on 线使用独立 +artifactId**(例如 `wop-sdk-core-jdk15on`);在完成该改造之前,两条线都必须锁定 +精确版本并限制更新工具。 + +Renovate(15on 项目限制在本发行线): + +```json +{ + "packageRules": [ + { + "matchPackageNames": [ + "com.wanlianyida:wop-sdk-core", + "com.wanlianyida:wop-sdk-jdkhttp", + "com.wanlianyida:wop-sdk-okhttp", + "com.wanlianyida:wop-sdk-unirest" + ], + "allowedVersions": "/^0\\.3\\.0-jdk15on\\.\\d+$/" + } + ] +} +``` + +Renovate(18on 项目排除 15on 发行线): + +```json +{ + "packageRules": [ + { + "matchPackageNames": [ + "com.wanlianyida:wop-sdk-core", + "com.wanlianyida:wop-sdk-jdkhttp", + "com.wanlianyida:wop-sdk-okhttp", + "com.wanlianyida:wop-sdk-unirest" + ], + "allowedVersions": "/^\\d+\\.\\d+\\.\\d+$/" + } + ] +} +``` + +Dependabot 的 `ignore` 只能列举具体版本,必须覆盖**全部四个构件**;15on 项目需忽略 +18on 线的版本,18on 项目需忽略 15on 线的版本,且两条线每次发版都要补充: + +```yaml +version: 2 +updates: + - package-ecosystem: "maven" + directory: "/" + schedule: + interval: "weekly" + ignore: + # 示例:15on 项目忽略 18on 线;反向场景把版本列表换成 15on 线 + - dependency-name: "com.wanlianyida:wop-sdk-core" + versions: ["0.3.0"] + - dependency-name: "com.wanlianyida:wop-sdk-jdkhttp" + versions: ["0.3.0"] + - dependency-name: "com.wanlianyida:wop-sdk-okhttp" + versions: ["0.3.0"] + - dependency-name: "com.wanlianyida:wop-sdk-unirest" + versions: ["0.3.0"] +``` + +不论使用哪种工具,都必须在 pom 中写死精确版本(不要用范围),并在升级 PR 中检查 +`dependency:tree` 是否仍只有一个 `bcprov-*`。 + +## 维护者约定 + +1. **版本格式**:`<基线版本>-jdk15on.<序号>`,序号从 1 递增;同一基线只发布一次,不可覆盖。 + 该方案是单坐标空间下的临时折中(排序无法隔离两条线);长期应改为独立 artifactId。 +2. **发布**:`tag = v<完整版本>`,与根 pom 一致(`release.yml` 会校验);发布前跑 + `mvn -B -ntp verify`,覆盖率与 japicmp 门禁必须全绿。 +3. **BC 升级**:15on 分支已冻结在 1.70(最后一版)。若确需变更,必须同步更新 + `BouncyCastleVersionGuard.MIN_VERSION`、CI 兼容矩阵与 README 的适用版本。 +4. **不要合回 main**:15on 分支的 BC 坐标变更是发行线差异,不是可合并的功能提交。 +5. **变更同步**:15on 线只接受安全修复与兼容性修复;功能开发仍以 `main` 为准, + 需要时手工 cherry-pick 并单独发版。 + +## 安全边界 + +`bcprov-jdk15on` 的最后一个版本是 1.70(2021-12)。此后 BouncyCastle 只在 +`bcprov-jdk18on` 分支修复安全问题,**1.70 不会获得回灌补丁**。 + +- 15on 线定位为存量项目的过渡发行线,不承诺长期安全维护; +- 新项目应使用 18on 线; +- 上报渠道与处理流程见仓库根目录 [SECURITY.md](../SECURITY.md)。 diff --git a/pom.xml b/pom.xml index 3130809..8bbff9a 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,10 @@ com.wanlianyida wop-java-sdk - 0.3.0 + + 0.3.0-jdk15on.1 pom WOP Java SDK WOP 商户侧官方 Java SDK:签名/摘要/L2 数字信封/验签解密协议核心 + HTTP 适配器 @@ -24,7 +27,9 @@ UTF-8 UTF-8 8 - 1.85 + + 1.70 5.12.2 4.12.0 4.10.1 @@ -42,7 +47,7 @@ org.bouncycastle - bcprov-jdk18on + bcprov-jdk15on ${bc.version} diff --git a/wop-sdk-core/pom.xml b/wop-sdk-core/pom.xml index 41483f8..fc58e92 100644 --- a/wop-sdk-core/pom.xml +++ b/wop-sdk-core/pom.xml @@ -7,7 +7,7 @@ com.wanlianyida wop-java-sdk - 0.3.0 + 0.3.0-jdk15on.1 wop-sdk-core @@ -28,7 +28,7 @@ org.bouncycastle - bcprov-jdk18on + bcprov-jdk15on org.junit.jupiter @@ -99,7 +99,7 @@ org.bouncycastle - bcprov-jdk18on + bcprov-jdk15on ${bc.version} diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleHolder.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleHolder.java index 7b1bab1..b336062 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleHolder.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleHolder.java @@ -3,12 +3,19 @@ import org.bouncycastle.jce.provider.BouncyCastleProvider; import java.security.Provider; -import java.security.Security; /** - * BouncyCastle Provider 进程级单例注册(国密 SM2/SM3/SM4 唯一路径,E5)。 - * 直接持有自身实例:Security.addProvider 对同名已注册情形返回 -1 无害, - * 我们始终使用自建实例,规避对全局注册状态的分支依赖。 + * BouncyCastle Provider 进程级单例(国密 SM2/SM3/SM4 唯一路径,E5)。 + *

+ * 不调用 {@code Security.addProvider}:所有 JCA 查找都显式传入 provider 实例, + * 既避免污染宿主的全局 Provider 表,也保证被版本守卫拒绝的实例不会残留可被 + * 其他组件选中。 + *

+ * 版本校验放在 {@link #provider()} 取用时而非静态初始化块:静态初始化抛出的 + * 运行时异常会被 JVM 包装为 {@link ExceptionInInitializerError},调用方按 + * {@code WopError} catch 不到;取用时校验可让配置错误以原始类型直达调用方。 + *

+ * jdk15on 发行线:最低版本 1.65,见 {@link BouncyCastleVersionGuard}。 */ public final class BouncyCastleHolder { @@ -18,15 +25,17 @@ public final class BouncyCastleHolder { private BouncyCastleHolder() { } - /** 已注册的 BC Provider(类加载即完成注册,进程级单例)。 */ + /** + * BC Provider 单例(未注册到全局 Provider 表)。 + * + * @throws com.wanlianyida.wop.WopError BC 版本低于 {@link BouncyCastleVersionGuard#MIN_VERSION} + */ public static Provider provider() { - return PROVIDER; + return BouncyCastleVersionGuard.requireSupported(PROVIDER); } - /** 自建实例注册(同名已注册返回 -1 无害,始终使用自建实例)。 */ + /** 创建自建实例(仅持有,不注册全局)。 */ private static Provider register() { - Provider provider = new BouncyCastleProvider(); - Security.addProvider(provider); - return provider; + return new BouncyCastleProvider(); } } diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuard.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuard.java new file mode 100644 index 0000000..89d3053 --- /dev/null +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuard.java @@ -0,0 +1,39 @@ +package com.wanlianyida.wop.crypto; + +import com.wanlianyida.wop.WopError; + +import java.security.Provider; + +/** + * jdk15on 发行线的 BouncyCastle 版本下限守卫(1.65)。 + *

+ * 消费者可能在自己的 pom 中声明更低的 bcprov-jdk15on,并因 Maven 就近优先胜出; + * 此处 fail-fast 转为明确的配置错误,避免下游抛 {@code NoSuchMethodError}。 + *

+ * 独立成包内类而非挂在 {@link BouncyCastleHolder} 上:后者是公共 API 门禁覆盖的类, + * 任何成员增减都会被 japicmp 记为 break。 + */ +final class BouncyCastleVersionGuard { + + /** 最低 BC 版本(1.65 起纳入测试矩阵)。 */ + static final double MIN_VERSION = 1.65; + + /** 工具类禁实例化。 */ + private BouncyCastleVersionGuard() { + } + + /** 版本守卫:低于 {@link #MIN_VERSION} 明确拒绝。 */ + static Provider requireSupported(Provider provider) { + requireSupportedVersion(provider.getVersion()); + return provider; + } + + /** 版本判定(拆出便于单测覆盖两侧分支)。 */ + static void requireSupportedVersion(double version) { + if (version < MIN_VERSION) { + throw WopError.configuration("BouncyCastle 版本过低(当前 " + version + + ",要求 >= " + MIN_VERSION + "):请将 bcprov-jdk15on 升级到 1.65 及以上," + + "或改用 jdk18on 发行线"); + } + } +} diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2KeyEncryptStrategy.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2KeyEncryptStrategy.java index 25c92a1..775fc7a 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2KeyEncryptStrategy.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2KeyEncryptStrategy.java @@ -1,5 +1,6 @@ package com.wanlianyida.wop.crypto.strategies; +import com.wanlianyida.wop.crypto.BouncyCastleHolder; import com.wanlianyida.wop.crypto.CryptoException; import org.bouncycastle.crypto.engines.SM2Engine; import org.bouncycastle.crypto.params.ECPrivateKeyParameters; @@ -34,9 +35,10 @@ public byte[] encrypt(byte[] plainKey, PublicKey publicKey) { return encrypt(plainKey, publicKey, RANDOM); } - /** 加密随机 k 取自注入源(确定性钩子)。 */ + /** 加密随机 k 取自注入源(确定性钩子);版本守卫在 try 之外。 */ @Override public byte[] encrypt(byte[] plainKey, PublicKey publicKey, SecureRandom random) { + BouncyCastleHolder.provider(); try { ECPublicKeyParameters params = Sm2Support.toPublicParams(publicKey); SM2Engine engine = new SM2Engine(SM2Engine.Mode.C1C3C2); @@ -47,9 +49,10 @@ public byte[] encrypt(byte[] plainKey, PublicKey publicKey, SecureRandom random) } } - /** 解包(C1C3C2 顺序;旧国标 C1C2C3 密文必然失败)。 */ + /** 解包(C1C3C2 顺序;旧国标 C1C2C3 密文必然失败);版本守卫在 try 之外。 */ @Override public byte[] decrypt(byte[] cipherText, PrivateKey privateKey) { + BouncyCastleHolder.provider(); try { ECPrivateKeyParameters params = Sm2Support.toPrivateParams(privateKey); SM2Engine engine = new SM2Engine(SM2Engine.Mode.C1C3C2); diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2SignatureStrategy.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2SignatureStrategy.java index 5882574..40bf9df 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2SignatureStrategy.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2SignatureStrategy.java @@ -1,5 +1,6 @@ package com.wanlianyida.wop.crypto.strategies; +import com.wanlianyida.wop.crypto.BouncyCastleHolder; import com.wanlianyida.wop.crypto.CryptoException; import org.bouncycastle.asn1.ASN1EncodableVector; import org.bouncycastle.asn1.ASN1Integer; @@ -39,9 +40,10 @@ public final class Sm2SignatureStrategy implements SignatureStrategy { private Sm2SignatureStrategy() { } - /** 加签(BC 产出 DER 后转裸 r‖s 64B,D9;userId 贯通 D14)。 */ + /** 加签(BC 产出 DER 后转裸 r‖s 64B,D9;userId 贯通 D14);版本守卫在 try 之外。 */ @Override public byte[] sign(byte[] data, PrivateKey privateKey, byte[] userId) { + BouncyCastleHolder.provider(); try { ECPrivateKeyParameters params = Sm2Support.toPrivateParams(privateKey); SM2Signer signer = new SM2Signer(); @@ -59,6 +61,7 @@ public boolean verify(byte[] data, byte[] signature, PublicKey publicKey, byte[] if (signature == null || signature.length != RS_BYTES * 2) { return false; } + BouncyCastleHolder.provider(); try { ECPublicKeyParameters params = Sm2Support.toPublicParams(publicKey); SM2Signer verifier = new SM2Signer(); diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2Support.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2Support.java index 60f1c6e..028b42f 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2Support.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm2Support.java @@ -1,5 +1,7 @@ package com.wanlianyida.wop.crypto.strategies; +import com.wanlianyida.wop.crypto.BouncyCastleHolder; + import org.bouncycastle.crypto.params.ECDomainParameters; import org.bouncycastle.crypto.params.ECPrivateKeyParameters; import org.bouncycastle.crypto.params.ECPublicKeyParameters; @@ -26,8 +28,9 @@ public final class Sm2Support { private Sm2Support() { } - /** JCA BCEC 公钥 → BC 轻量参数(曲线守卫)。 */ + /** JCA BCEC 公钥 → BC 轻量参数(曲线守卫);SM2 轻量 API 不经过 JCA,此处承担版本守卫。 */ public static ECPublicKeyParameters toPublicParams(PublicKey publicKey) { + BouncyCastleHolder.provider(); if (!(publicKey instanceof ECPublicKey)) { throw new IllegalArgumentException("公钥非 SM2 椭圆曲线密钥"); } @@ -40,8 +43,9 @@ public static org.bouncycastle.crypto.params.ECNamedDomainParameters namedDomain return Sm2DomainHolder.NAMED; } - /** JCA BCEC 私钥 → BC 轻量参数(曲线守卫)。 */ + /** JCA BCEC 私钥 → BC 轻量参数(曲线守卫);SM2 轻量 API 不经过 JCA,此处承担版本守卫。 */ public static ECPrivateKeyParameters toPrivateParams(PrivateKey privateKey) { + BouncyCastleHolder.provider(); if (!(privateKey instanceof ECPrivateKey)) { throw new IllegalArgumentException("私钥非 SM2 椭圆曲线密钥"); } diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm3DigestStrategy.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm3DigestStrategy.java index bdf0953..8250529 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm3DigestStrategy.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm3DigestStrategy.java @@ -4,6 +4,7 @@ import com.wanlianyida.wop.crypto.CryptoException; import java.security.MessageDigest; +import java.security.Provider; /** * 国密摘要策略:SM3(BC 承接)。 @@ -18,11 +19,12 @@ public final class Sm3DigestStrategy implements DigestStrategy { private Sm3DigestStrategy() { } - /** 计算 SM3 摘要(BC 承接)。 */ + /** 计算 SM3 摘要(BC 承接);版本守卫在 try 之外,保证配置错误不被包装为加密失败。 */ @Override public byte[] digest(byte[] data) { + Provider provider = BouncyCastleHolder.provider(); try { - return MessageDigest.getInstance(ALGORITHM, BouncyCastleHolder.provider()).digest(data); + return MessageDigest.getInstance(ALGORITHM, provider).digest(data); } catch (Exception e) { throw new CryptoException("DIGEST", ALGORITHM, "SM3 摘要失败", e); } diff --git a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm4GcmStrategy.java b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm4GcmStrategy.java index d9aa398..2029b59 100644 --- a/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm4GcmStrategy.java +++ b/wop-sdk-core/src/main/java/com/wanlianyida/wop/crypto/strategies/Sm4GcmStrategy.java @@ -3,6 +3,7 @@ import com.wanlianyida.wop.crypto.BouncyCastleHolder; import com.wanlianyida.wop.crypto.CryptoException; +import java.security.Provider; import java.security.SecureRandom; import javax.crypto.Cipher; @@ -48,8 +49,9 @@ public CipherResult encrypt(byte[] plain, byte[] key, SecureRandom random) { CipherResult encryptForVector(byte[] plain, byte[] key, byte[] iv) { requireKey(key); requireIv(iv); + Provider provider = BouncyCastleHolder.provider(); try { - Cipher cipher = Cipher.getInstance(TRANSFORMATION, BouncyCastleHolder.provider()); + Cipher cipher = Cipher.getInstance(TRANSFORMATION, provider); cipher.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key, "SM4"), new GCMParameterSpec(TAG_BITS, iv)); return new CipherResult(cipher.doFinal(plain), iv); } catch (Exception e) { @@ -62,8 +64,9 @@ CipherResult encryptForVector(byte[] plain, byte[] key, byte[] iv) { public byte[] decrypt(byte[] cipher, byte[] iv, byte[] key) { requireKey(key); requireIv(iv); + Provider provider = BouncyCastleHolder.provider(); try { - Cipher decryptor = Cipher.getInstance(TRANSFORMATION, BouncyCastleHolder.provider()); + Cipher decryptor = Cipher.getInstance(TRANSFORMATION, provider); decryptor.init(Cipher.DECRYPT_MODE, new SecretKeySpec(key, "SM4"), new GCMParameterSpec(TAG_BITS, iv)); return decryptor.doFinal(cipher); } catch (Exception e) { diff --git a/wop-sdk-core/src/test/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuardTest.java b/wop-sdk-core/src/test/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuardTest.java new file mode 100644 index 0000000..768be63 --- /dev/null +++ b/wop-sdk-core/src/test/java/com/wanlianyida/wop/crypto/BouncyCastleVersionGuardTest.java @@ -0,0 +1,68 @@ +package com.wanlianyida.wop.crypto; + +import com.wanlianyida.wop.WopError; +import org.junit.jupiter.api.Test; + +import java.security.Provider; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * jdk15on 发行线:BC 版本下限守卫(1.65)。 + *

+ * 消费者可能在自己的 pom 中声明更低的 bcprov-jdk15on 并因 Maven 就近优先胜出, + * 此处必须 fail-fast 为明确的配置错误,而不是让下游抛 {@code NoSuchMethodError}。 + */ +class BouncyCastleVersionGuardTest { + + @Test + void rejectVersionBelowFloor() { + WopError error = assertThrows(WopError.class, + () -> BouncyCastleVersionGuard.requireSupportedVersion(1.5)); + assertEquals(WopError.Category.configuration, error.category()); + assertTrue(error.getMessage().contains("1.65")); + } + + @Test + void acceptFloorVersion() { + assertDoesNotThrow(() -> BouncyCastleVersionGuard.requireSupportedVersion(1.65)); + } + + @Test + void acceptNewerVersion() { + assertDoesNotThrow(() -> BouncyCastleVersionGuard.requireSupportedVersion(1.70)); + } + + @Test + void rejectProviderBelowFloor() { + Provider old = new FakeProvider(1.5); + WopError error = assertThrows(WopError.class, + () -> BouncyCastleVersionGuard.requireSupported(old)); + assertEquals(WopError.Category.configuration, error.category()); + } + + @Test + void acceptProviderAtFloor() { + Provider provider = new FakeProvider(1.65); + assertSame(provider, BouncyCastleVersionGuard.requireSupported(provider)); + } + + @Test + void holderReturnsSingletonAboveFloor() { + Provider provider = BouncyCastleHolder.provider(); + assertSame(provider, BouncyCastleHolder.provider()); + assertTrue(provider.getVersion() >= BouncyCastleVersionGuard.MIN_VERSION); + } + + /** 测试用 Provider(protected 构造函数经子类访问)。 */ + private static final class FakeProvider extends Provider { + + private FakeProvider(double version) { + super("WOP-TEST", version, "test provider"); + } + } +} diff --git a/wop-sdk-jdkhttp/pom.xml b/wop-sdk-jdkhttp/pom.xml index d331b16..7e2d1b7 100644 --- a/wop-sdk-jdkhttp/pom.xml +++ b/wop-sdk-jdkhttp/pom.xml @@ -7,7 +7,7 @@ com.wanlianyida wop-java-sdk - 0.3.0 + 0.3.0-jdk15on.1 wop-sdk-jdkhttp diff --git a/wop-sdk-okhttp/pom.xml b/wop-sdk-okhttp/pom.xml index e13ad82..876ece3 100644 --- a/wop-sdk-okhttp/pom.xml +++ b/wop-sdk-okhttp/pom.xml @@ -7,7 +7,7 @@ com.wanlianyida wop-java-sdk - 0.3.0 + 0.3.0-jdk15on.1 wop-sdk-okhttp diff --git a/wop-sdk-unirest/pom.xml b/wop-sdk-unirest/pom.xml index 027c54d..b6a0a43 100644 --- a/wop-sdk-unirest/pom.xml +++ b/wop-sdk-unirest/pom.xml @@ -7,7 +7,7 @@ com.wanlianyida wop-java-sdk - 0.3.0 + 0.3.0-jdk15on.1 wop-sdk-unirest