中国 帮助

密钥与签名

这一页解决三件事:密钥放在哪、怎么生成与签名、换钥要同时做哪三件事。 签名回答的唯一问题是:这个包是不是我签发的、上传之后有没有被改过。 它不判断代码好坏。为什么必须有签名(以及白名单管的是另一件事)见 [包安全与签名](/docs/wu

密钥与签名
封面

> 本文整理自平台文档 docs/wujies/5.x/platform/package/signing.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-f3748b8cdfa7-cover.svg)

这一页解决三件事:密钥放在哪、怎么生成与签名、换钥要同时做哪三件事。

签名回答的唯一问题是:这个包是不是我签发的、上传之后有没有被改过。 它不判断代码好坏。为什么必须有签名(以及白名单管的是另一件事)见 [包安全与签名](/docs/wujies/5.x/platform/package/security);off / warn / enforce 三种模式和「现在能不能切 enforce」见 [安全校验模式](/docs/wujies/5.x/platform/package/security-modes)。

---

四样东西,别混

东西位置 / 名字谁读它
私钥<该应用仓库>/keys/private.pem(每个仓库一份)只有打包时的 PackageSignerMain sign 读它
公钥与私钥同目录的 public.pem打包后的自查(verify);以及和宿主配置比对
配置项(两端各一份,必须是同一把)app-market.security.public-key:平台侧在 wujies-platform/wujies-admin/src/main/resources/application.yml,中心侧在 wujies-market/src/main/resources/application.ymlPackageSecurityInspector(上传/下载校验)、SignatureReadinessService(自检)
包内签名文件包根 signature.txt校验侧 PackageSecurityInspector.parseSignatureFile

一句话记住:私钥只签名、公钥只验签;-SigningKey 只是私钥路径,签名是打包时算出来的产物(包根 signature.txt),不是某个"打开签名"的开关。

---

密钥放在哪

每个应用仓库自己带一份 keys/:private.pem + public.pem,就在该仓库根的 <仓库根>\keys\(11 个仓库都有)。该目录在每个仓库的 .gitignore 里都被忽略,所以它只存在于发布方本机 —— 换电脑时必须手工把 private.pem 拷过去,或者重新 keygen + 同步公钥 + 重建宿主。目录结构见 [仓库结构](/docs/wujies/5.x/platform/architecture/repo-layout)。

不带 -SigningKey 时,package.ps1 的 Find-SigningKey 按下面的顺序找第一个存在的私钥($pluginsRoot 就是脚本所在目录,也就是这个应用的仓库根):

顺序位置
1环境变量 WUJIES_SIGNING_KEY
2<脚本所在仓库>/keys/private.pem(即上表主用位置)
3<平台仓库>/plugins/keys/private.pem(拆仓库前的历史位置)
4<平台仓库>/keys/private.pem

package.ps1 的 -Keygen 不传 -SigningKey 时,看脚本所在仓库根有没有 app.json:应用仓库根就是这个应用(有 app.json),所以生成到 <仓库根>\keys\ —— 正是打正式包时 Find-SigningKey 会自动发现的那个位置。

所以直接打 package.ps1 的仓库里,一条命令就落在打包时会自动发现的位置,不需要额外传参:

# 在 wujies\plugins\wujies-gallery-plugin\ 里执行
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -Keygen

# 要生成到别处,显式给一个以 private.pem 结尾的路径
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -Keygen -SigningKey D:\release\keys\private.pem

(-Keygen 要求路径以 private.pem 结尾,否则直接报错 —— keygen 固定产出 private.pem / public.pem。)

---

生成密钥(keygen)

# 在该应用仓库根执行;目录不存在会自动建,落点见上面那节
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -Keygen

底层就是 PackageSignerMain keygen 这一条纯 JDK 命令(脚本只是把 keygen + 公钥比对 + 提示串起来):

# 在平台仓库根 wujies-platform/ 执行;第二个参数换成你要生成密钥的那个 keys 目录
java -cp wujies-modules\wujies-market-core\target\classes `
    cn.wujies.appmarket.security.PackageSignerMain keygen ..\plugins\wujies-gallery-plugin\keys

产出与格式(PackageSignerMain.keygen / writePem):

项值
算法与长度RSA 2048(KeyPairGenerator.getInstance("RSA").initialize(2048))
私钥PEM,标签 -----BEGIN PRIVATE KEY-----(PKCS#8)
公钥PEM,标签 -----BEGIN PUBLIC KEY-----(X.509 SubjectPublicKeyInfo)
文件名写死 private.pem / public.pem,每行 64 字符

目录里已经有 private.pem 时,-Keygen 直接报错:

目录里已经有 private.pem:<该仓库>\keys。换钥会让旧钥签过的包全部作废,请先手工备份并移走它,或加 -KeygenForce(脚本自动备份后重新生成)。

加上 -KeygenForce 才会继续,而且先备份再重生成 —— private.pem、public.pem、signature.txt 整份移进 <该仓库>\keys\backup\<yyyyMMdd-HHmmss>\,然后才生成新钥:

# 换钥:旧钥自动备份;-SyncPublicKey 顺手把新公钥写进宿主 application.yml
powershell -NoProfile -ExecutionPolicy Bypass -File package.ps1 -Keygen -KeygenForce -SyncPublicKey

覆盖密钥等于让所有已签发的包失效,所以这一条必须是显式动作。(底层的 PackageSignerMain keygen 更严:private.pem 或 public.pem 任一存在就报「密钥已存在,拒绝覆盖: <目录>」—— 直接敲 java 命令时没有 -KeygenForce 这个出口。)

签名工具随应用市场模块一起编译。target/classes 里没有那个 class 时报:

找不到签名工具类: <平台仓库>\wujies-modules\wujies-market-core\target\classes\cn\wujies\appmarket\security\PackageSignerMain.class
签名工具随应用市场模块一起编译,请先构建平台:
    mvn -pl wujies-admin -am -B install -DskipTests

生成成功后,keygen 会直接打印一段可以粘贴进 yml 的片段(mode 是提示文字,按你的实际模式填):

app-market:
  security:
    mode: enforce            # 确认所有包都能通过后,从 warn 切到 enforce
    public-key: |
      -----BEGIN PUBLIC KEY-----
      <你的公钥内容>
      -----END PUBLIC KEY-----

配置项位置与生效时机见 [配置参考](/docs/wujies/5.x/deploy/configuration):public-key 是启动期读入的 @Value(PackageSecurityInspector 的 @Value("${app-market.security.public-key:}")),改完必须重建宿主 + 重启;中心服务那份 yml 里的公钥要同步换,两边不是同一把就会出现

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-f3748b8cdfa7-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容