feat(客户端凭据): 新增 /api/client/credentials 下发口,客户端不再随包携带凭据

4.0.43 客户端因 exe 内置默认值被清空而断供(zn_password/mysql_password/
internal_token 三把同时缺)。这三把不再进客户端静态副本,改为登录态按需领取:

- ClientCredentialProperties(aiimage.client-credentials.*)+ PropertiesConfig 注册;
- GET /api/client/credentials:requireUser(JWT),返回 internalToken + 紫鸟账号 +
  mysqlPassword;服务端未配紫鸟账号时显式 500 并点名配置项,不返回空值让客户端猜;
- AdminAuthSupport.currentInternalToken():下发的必须是当前值(不含过渡期旧值);
- /api/admin/shop-manages/credential 放行登录态通道(令牌通道原样保留,存量客户端不受影响)。

本批无数据库迁移;单测 ClientCredentialControllerTest(6) + ShopManageCredentialAuthTest(3)。
This commit is contained in:
2026-10-03 16:47:20 +08:00
parent 4b7405895d
commit 56ac8f635e
8 changed files with 349 additions and 6 deletions
@@ -199,13 +199,25 @@ public class AdminAuthSupport {
return false;
}
/** 当前值优先;当前值为空才用令牌文件;过渡期旧值(逗号分隔)始终并入,重复值剔除。 */
private List<String> acceptedInternalTokens() {
List<String> accepted = new ArrayList<>();
/**
* 当前生效的内部令牌(配置优先,配置为空才用令牌文件;**不含过渡期旧值**)。
*
* <p>供客户端引导端点下发用:客户端不再随包携带令牌,改为登录后领取,
* 所以下发的必须是"当前应使用的那一把",把旧值给出去只会让轮换多铺一轮。
* 未配置时返回空串,调用方自行决定是拒绝还是降级。</p>
*/
public String currentInternalToken() {
String configured = internalToken == null ? "" : internalToken.trim();
if (configured.isEmpty()) {
configured = readInternalTokenFile().trim();
}
return configured;
}
/** 当前值优先;当前值为空才用令牌文件;过渡期旧值(逗号分隔)始终并入,重复值剔除。 */
private List<String> acceptedInternalTokens() {
List<String> accepted = new ArrayList<>();
String configured = currentInternalToken();
if (!configured.isEmpty()) {
accepted.add(configured);
}
@@ -0,0 +1,32 @@
package com.nanri.aiimage.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* 桌面客户端运行期凭据的服务端来源。
*
* <p>客户端 exe 不再内置、随包 .env 也不再携带这些值;客户端登录后用 JWT 调
* {@code GET /api/client/credentials} 领取,只驻进程内存。值放主机 {@code /.env}
* (环境变量 {@code AIIMAGE_CLIENT_CREDENTIALS_ZINIAO_*}),轮换 = 改 env + 重启容器。</p>
*/
@Data
@ConfigurationProperties(prefix = "aiimage.client-credentials")
public class ClientCredentialProperties {
/** 紫鸟自动化账号所属公司(客户端登录本地紫鸟客户端用)。 */
private String ziniaoCompany;
/** 紫鸟自动化账号用户名。 */
private String ziniaoUsername;
/** 紫鸟自动化账号口令。 */
private String ziniaoPassword;
/**
* MySQL 业务账号口令(客户端仍有少量直连库的读取路径)。
* 未配置时下发空串:客户端那条路径会显式报"未取得 MySQL 口令"并点名本配置项,
* 不在这里硬失败,避免"暂时没配"把整次领取(连同紫鸟账号)一起打掉。
*/
private String mysqlPassword;
}
@@ -4,6 +4,6 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties({OssProperties.class, TransientStorageProperties.class, StorageProperties.class, BrandProgressProperties.class, DeleteBrandProgressProperties.class, BrandCheckProperties.class, ZiniaoProperties.class, ModuleCleanupProperties.class, TaskPressureProperties.class, TaskImageCacheCleanupProperties.class, AppearancePatentProperties.class, SimilarAsinProperties.class, ImageVideoProperties.class, InstanceRoutingProperties.class, CapacityPlanProperties.class, UserSecretProperties.class, NotificationProperties.class, DeviceLogOssProperties.class, CollectDataBrandRecheckProperties.class})
@EnableConfigurationProperties({OssProperties.class, TransientStorageProperties.class, StorageProperties.class, BrandProgressProperties.class, DeleteBrandProgressProperties.class, BrandCheckProperties.class, ZiniaoProperties.class, ModuleCleanupProperties.class, TaskPressureProperties.class, TaskImageCacheCleanupProperties.class, AppearancePatentProperties.class, SimilarAsinProperties.class, ImageVideoProperties.class, InstanceRoutingProperties.class, CapacityPlanProperties.class, UserSecretProperties.class, NotificationProperties.class, DeviceLogOssProperties.class, CollectDataBrandRecheckProperties.class, ClientCredentialProperties.class})
public class PropertiesConfig {
}
@@ -0,0 +1,64 @@
package com.nanri.aiimage.modules.client.controller;
import com.nanri.aiimage.common.api.ApiResponse;
import com.nanri.aiimage.common.exception.BusinessException;
import com.nanri.aiimage.common.model.entity.AdminUserEntity;
import com.nanri.aiimage.common.security.AdminAuthSupport;
import com.nanri.aiimage.config.ClientCredentialProperties;
import com.nanri.aiimage.modules.client.model.vo.ClientCredentialVo;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 桌面客户端启动后的凭据领取口。
*
* <p>客户端 exe 与升级包都不再携带这些凭据(此前内置在 config.py 默认值里,反编译即得;
* 随包 .env 也是公开可下载的),改为运行时按登录态 JWT 领取、只驻进程内存。</p>
*/
@Slf4j
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/client")
@Tag(name = "客户端引导", description = "桌面客户端领取运行期凭据")
public class ClientCredentialController {
private final AdminAuthSupport adminAuthSupport;
private final ClientCredentialProperties clientCredentialProperties;
@GetMapping("/credentials")
@Operation(summary = "领取运行期凭据",
description = "以登录态 JWT 换取内部令牌与紫鸟自动化账号;客户端不得落盘。"
+ "服务端未配置紫鸟账号时返回 500 并点名配置项,不返回空值让客户端自行猜。")
public ApiResponse<ClientCredentialVo> credentials(HttpServletRequest request) {
AdminUserEntity user = adminAuthSupport.requireUser(request);
String company = blankToEmpty(clientCredentialProperties.getZiniaoCompany());
String username = blankToEmpty(clientCredentialProperties.getZiniaoUsername());
String password = blankToEmpty(clientCredentialProperties.getZiniaoPassword());
if (company.isEmpty() || username.isEmpty() || password.isEmpty()) {
// 空值必须显式失败:客户端拿空口令去登录紫鸟,会被紫鸟回一句「账号密码错误」,
// 把服务端配置缺项伪装成账号问题(这正是本次改造要消灭的形态)。
throw new BusinessException(500, "服务端未配置紫鸟自动化账号:aiimage.client-credentials.ziniao-company/username/password");
}
ClientCredentialVo vo = new ClientCredentialVo();
vo.setInternalToken(adminAuthSupport.currentInternalToken());
vo.setZiniaoCompany(company);
vo.setZiniaoUsername(username);
vo.setZiniaoPassword(password);
// MySQL 口令是次要路径,缺席不下发空串即可:客户端用到时才显式失败并点名配置项
vo.setMysqlPassword(blankToEmpty(clientCredentialProperties.getMysqlPassword()));
// 只记身份不记值:便于事后回答"哪个账号在哪台机器上领过紫鸟口令"
log.info("[client-credentials] 下发凭据 userId={} username={} deviceId={}",
user.getId(), user.getUsername(), adminAuthSupport.currentDeviceId(request));
return ApiResponse.success(vo);
}
private static String blankToEmpty(String value) {
return value == null ? "" : value.trim();
}
}
@@ -0,0 +1,24 @@
package com.nanri.aiimage.modules.client.model.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Data
@Schema(description = "桌面客户端运行期凭据(登录后领取,仅驻客户端进程内存)")
public class ClientCredentialVo {
@Schema(description = "内部接口令牌(结果回传/心跳/店铺凭据查询用);服务端未配置时为空串")
private String internalToken;
@Schema(description = "紫鸟自动化账号所属公司")
private String ziniaoCompany;
@Schema(description = "紫鸟自动化账号用户名")
private String ziniaoUsername;
@Schema(description = "紫鸟自动化账号口令")
private String ziniaoPassword;
@Schema(description = "MySQL 业务账号口令(客户端直连库用);服务端未配置时为空串")
private String mysqlPassword;
}
@@ -22,6 +22,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
@@ -34,6 +35,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
@RequiredArgsConstructor
@RequestMapping("/api/admin/shop-manages")
@@ -152,12 +154,18 @@ public class ShopManageController {
}
@GetMapping("/credential")
@Operation(summary = "按店铺名获取明文凭据(内部)", description = "仅供 Python 自动化内部调用,需要传 X-Internal-Token")
@Operation(summary = "按店铺名获取明文凭据(内部)",
description = "供 Python 自动化调用:带 X-Internal-Token,或带登录态 JWT"
+ "(客户端 4.0.44 起不再随包携带内部令牌,改用登录态领取)")
public ApiResponse<ShopManageCredentialVo> getCredentialByShopName(
HttpServletRequest request,
@RequestParam("shopName") String shopName,
@RequestHeader(value = "X-Internal-Token", required = false) String token) {
if (!adminAuthSupport.isTrustedSuppliedToken(token)) {
throw new com.nanri.aiimage.common.exception.BusinessException("无权访问凭据");
// 令牌通道保持原样(存量客户端不受影响);登录态通道按"已认证用户"放行,
// 可见范围与令牌通道等价(该令牌此前随每个客户端安装包分发)。
AdminUserEntity caller = adminAuthSupport.requireUser(request);
log.info("[shop-credential] 以登录态读取店铺凭据 userId={} shopName={}", caller.getId(), shopName);
}
return ApiResponse.success(shopManageService.getCredentialByShopName(shopName));
}
@@ -0,0 +1,130 @@
package com.nanri.aiimage.modules.client.controller;
import com.nanri.aiimage.common.api.ApiResponse;
import com.nanri.aiimage.common.exception.BusinessException;
import com.nanri.aiimage.common.model.entity.AdminUserEntity;
import com.nanri.aiimage.common.security.AdminAuthSupport;
import com.nanri.aiimage.config.ClientCredentialProperties;
import com.nanri.aiimage.modules.client.model.vo.ClientCredentialVo;
import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
/**
* 客户端凭据领取口的鉴权与配置缺项行为。
*
* <p>两条底线:未登录不得领取(这是"客户机不再随包带凭据"之后的唯一来源);
* 服务端没配紫鸟账号时必须显式失败并点名配置项,不能下发空口令让紫鸟回一句
* "账号密码错误"把配置缺项伪装成账号问题。</p>
*/
class ClientCredentialControllerTest {
private final AdminAuthSupport adminAuthSupport = mock(AdminAuthSupport.class);
private final ClientCredentialProperties properties = new ClientCredentialProperties();
private final HttpServletRequest request = mock(HttpServletRequest.class);
private ClientCredentialController newController() {
return new ClientCredentialController(adminAuthSupport, properties);
}
private void configureAll() {
properties.setZiniaoCompany("company-x");
properties.setZiniaoUsername("user-x");
properties.setZiniaoPassword("password-x");
properties.setMysqlPassword("mysql-pass-x");
}
@Test
void rejectsAnonymousCaller() {
when(adminAuthSupport.requireUser(any())).thenThrow(new BusinessException(401, "未登录"));
configureAll();
assertThatThrownBy(() -> newController().credentials(request))
.isInstanceOf(BusinessException.class)
.hasMessageContaining("未登录");
verify(adminAuthSupport, never()).currentInternalToken();
}
@Test
void failsLoudlyWhenZiniaoAccountIsNotConfigured() {
AdminUserEntity user = new AdminUserEntity();
user.setId(7L);
when(adminAuthSupport.requireUser(any())).thenReturn(user);
assertThatThrownBy(() -> newController().credentials(request))
.isInstanceOf(BusinessException.class)
.hasMessageContaining("ziniao-company");
}
@Test
void rejectsPartiallyConfiguredAccount() {
AdminUserEntity user = new AdminUserEntity();
user.setId(7L);
when(adminAuthSupport.requireUser(any())).thenReturn(user);
properties.setZiniaoCompany("company-x");
properties.setZiniaoUsername("user-x");
// 口令留空:正是 4.0.43 事故里客户端遇到的那种"看起来配了"的状态
assertThatThrownBy(() -> newController().credentials(request))
.isInstanceOf(BusinessException.class)
.hasMessageContaining("ziniao");
}
@Test
void handsOutCredentialsWithInternalTokenForLoggedInUser() {
AdminUserEntity user = new AdminUserEntity();
user.setId(7L);
user.setUsername("operator");
when(adminAuthSupport.requireUser(any())).thenReturn(user);
when(adminAuthSupport.currentInternalToken()).thenReturn("token-x");
configureAll();
ApiResponse<ClientCredentialVo> response = newController().credentials(request);
assertThat(response.isSuccess()).isTrue();
ClientCredentialVo vo = response.getData();
assertThat(vo.getInternalToken()).isEqualTo("token-x");
assertThat(vo.getZiniaoCompany()).isEqualTo("company-x");
assertThat(vo.getZiniaoUsername()).isEqualTo("user-x");
assertThat(vo.getZiniaoPassword()).isEqualTo("password-x");
assertThat(vo.getMysqlPassword()).isEqualTo("mysql-pass-x");
}
@Test
void deliversEmptyMysqlPasswordWithoutFailingTheWholeResponse() {
AdminUserEntity user = new AdminUserEntity();
user.setId(7L);
when(adminAuthSupport.requireUser(any())).thenReturn(user);
when(adminAuthSupport.currentInternalToken()).thenReturn("token-x");
configureAll();
properties.setMysqlPassword(" ");
// MySQL 口令缺席不该把紫鸟账号的下发一起打掉:客户端只在用到库的那一刻显式失败
ClientCredentialVo vo = newController().credentials(request).getData();
assertThat(vo.getMysqlPassword()).isEmpty();
assertThat(vo.getZiniaoPassword()).isEqualTo("password-x");
}
@Test
void trimsConfiguredValues() {
AdminUserEntity user = new AdminUserEntity();
user.setId(7L);
when(adminAuthSupport.requireUser(any())).thenReturn(user);
properties.setZiniaoCompany(" company-x ");
properties.setZiniaoUsername("user-x\n");
properties.setZiniaoPassword(" password-x ");
ClientCredentialVo vo = newController().credentials(request).getData();
assertThat(vo.getZiniaoCompany()).isEqualTo("company-x");
assertThat(vo.getZiniaoUsername()).isEqualTo("user-x");
assertThat(vo.getZiniaoPassword()).isEqualTo("password-x");
}
}
@@ -0,0 +1,73 @@
package com.nanri.aiimage.modules.shopkey.controller;
import com.nanri.aiimage.common.api.ApiResponse;
import com.nanri.aiimage.common.exception.BusinessException;
import com.nanri.aiimage.common.model.entity.AdminUserEntity;
import com.nanri.aiimage.common.security.AdminAuthSupport;
import com.nanri.aiimage.modules.shopkey.model.vo.ShopManageCredentialVo;
import com.nanri.aiimage.modules.shopkey.service.ShopManageGroupService;
import com.nanri.aiimage.modules.shopkey.service.ShopManageService;
import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
/**
* 按店铺名取明文凭据的两条通道。
*
* <p>存量客户端(4.0.42 及更早)随包带着内部令牌,走令牌通道;4.0.44 起不再携带,
* 改用登录态 JWT —— 放开 JWT 通道时不能把令牌通道收掉,否则线上没升级的机器当场断。</p>
*/
class ShopManageCredentialAuthTest {
private final ShopManageService shopManageService = mock(ShopManageService.class);
private final ShopManageGroupService shopManageGroupService = mock(ShopManageGroupService.class);
private final AdminAuthSupport adminAuthSupport = mock(AdminAuthSupport.class);
private final HttpServletRequest request = mock(HttpServletRequest.class);
private ShopManageController newController() {
return new ShopManageController(shopManageService, shopManageGroupService, adminAuthSupport);
}
@Test
void trustedInternalTokenStillWorksWithoutJwt() {
when(adminAuthSupport.isTrustedSuppliedToken("tok")).thenReturn(true);
when(shopManageService.getCredentialByShopName("魏振峰")).thenReturn(new ShopManageCredentialVo());
ApiResponse<ShopManageCredentialVo> response = newController().getCredentialByShopName(request, "魏振峰", "tok");
assertThat(response.isSuccess()).isTrue();
verify(adminAuthSupport, never()).requireUser(any());
}
@Test
void loggedInUserCanReadCredentialWithoutToken() {
when(adminAuthSupport.isTrustedSuppliedToken(any())).thenReturn(false);
AdminUserEntity caller = new AdminUserEntity();
caller.setId(9L);
when(adminAuthSupport.requireUser(request)).thenReturn(caller);
when(shopManageService.getCredentialByShopName("魏振峰")).thenReturn(new ShopManageCredentialVo());
ApiResponse<ShopManageCredentialVo> response = newController().getCredentialByShopName(request, "魏振峰", null);
assertThat(response.isSuccess()).isTrue();
verify(adminAuthSupport).requireUser(request);
}
@Test
void anonymousCallerIsRejected() {
when(adminAuthSupport.isTrustedSuppliedToken(any())).thenReturn(false);
when(adminAuthSupport.requireUser(request)).thenThrow(new BusinessException(401, "未登录"));
assertThatThrownBy(() -> newController().getCredentialByShopName(request, "魏振峰", null))
.isInstanceOf(BusinessException.class);
verify(shopManageService, never()).getCredentialByShopName(eq("魏振峰"));
}
}