fix(flow): 草稿控制器评审收口——safeBpmnXml+category过滤存量+metaInfo保持回归测试等
评审跟进 7 项(评审者反编译 Flowable 6.8.1 实证):
- I-1(安全):parseGuard convertToBpmnModel 第三参 enableSafeBpmnXml false→true,
启用 flowable 加固解析器(禁外部 DTD/参数实体/DOCTYPE)关 XXE/SSRF 面;javadoc 写明两布尔参语义。
- I-2(列表污染):库里 143 条存量 act_re_model(老 shape+悬空 editorSource)会进草稿列表打不开。
create/from-procdef 建 model 时 setCategory("eip4");list() 改 modelCategory("eip4") 只查本分类。
- I-3(回归契约):加「PUT 只带 name 不带 metaInfo→verify never setMetaInfo」用例,钉住 eip4IdMap
不被普通保存抹掉(T3.1 发布逆向还原原 key 的命根)。
- M-1:class javadoc 补「裸 8089 无鉴权,写端点必须经网关超管门访问(T2.2),生产 8089 不对外」。
- M-2:parseGuard 422 msg 改通用文案「BPMN 解析失败」,原始 e.getMessage 只进 log.warn(防内部细节回显)。
- M-3:POST create 对空白 name/key 返 422(key 是 T3.1 部署资源名/还原依赖),在解析守卫前拦;加测试。
- M-4:补 from-procdef「BPMN 读取为空(getProcessModel null)→found:false 不落库」分支测试。
测试:ProcessModelControllerTest 11→14 例(新增 空白 name/key 422 不落库、只带 name 不改 metaInfo、
BPMN 读空 found:false;既有列表用例补 modelCategory 断言、建草稿/from-procdef 补 setCategory 断言)。
flowable-service 全模块 87 测试绿(新增 3,既有其他模块测试零改动)。
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -38,11 +38,18 @@ import io.swagger.v3.oas.annotations.tags.Tag;
|
|||||||
* 不进部署库;发布(T3.1)时才 restore 中文原 key + 校验门 + deploy。act_re_model 表已有 143 行存量、schema 已在,
|
* 不进部署库;发布(T3.1)时才 restore 中文原 key + 校验门 + deploy。act_re_model 表已有 143 行存量、schema 已在,
|
||||||
* {@code databaseSchemaUpdate=false} 不涉 DDL。</p>
|
* {@code databaseSchemaUpdate=false} 不涉 DDL。</p>
|
||||||
*
|
*
|
||||||
* <p>写入前 XML 一律过 {@link BpmnXMLConverter} 解析守卫(validateSchema=true):坏 XML 返 422 且绝不落库。
|
* <p><b>存量隔离</b>:本控制器建的草稿一律 {@code setCategory("eip4")},{@link #list()} 只查该分类,
|
||||||
|
* 库里 143 条老 shape act_re_model(旧 metaInfo + 可能悬空 editorSource)不进 Modeler 列表、避免打不开。</p>
|
||||||
|
*
|
||||||
|
* <p>写入前 XML 一律过 {@link BpmnXMLConverter} 解析守卫(validateSchema=true + enableSafeBpmnXml=true,
|
||||||
|
* 后者关外部 DTD/实体解析,防 XXE/SSRF):坏 XML 返 422 且绝不落库;422 只回通用文案,原始解析原因仅进日志。
|
||||||
* 守卫异常在本控制器就地 catch 转 422,不逸出到 {@code FlowExceptionHandler}(那里 FlowableException→400,语义不符)。
|
* 守卫异常在本控制器就地 catch 转 422,不逸出到 {@code FlowExceptionHandler}(那里 FlowableException→400,语义不符)。
|
||||||
* {@code from-procdef} 复用「按 procDefId 读部署 BPMN」逻辑(本控制器自带 {@link #readProcessModel} 小方法,
|
* {@code from-procdef} 复用「按 procDefId 读部署 BPMN」逻辑(本控制器自带 {@link #readProcessModel} 小方法,
|
||||||
* 零改动 ProcessDiagramController)→ {@link BpmnIdSanitizer#sanitize} 净化中文 id → 建草稿,
|
* 零改动 ProcessDiagramController)→ {@link BpmnIdSanitizer#sanitize} 净化中文 id → 建草稿,
|
||||||
* 原→净化映射连同源 procDefId/原 key 写进 metaInfo,供发布逆向还原。</p>
|
* 原→净化映射连同源 procDefId/原 key 写进 metaInfo,供发布逆向还原。</p>
|
||||||
|
*
|
||||||
|
* <p><b>鉴权</b>:本控制器随 flowable-service 跑在裸 8089,进程本身无鉴权栈;所有写端点
|
||||||
|
* (POST/PUT/from-procdef)必须经 platform-flow-gateway 的超管门访问(T2.2),生产环境 8089 不对外暴露。</p>
|
||||||
*/
|
*/
|
||||||
@RestController
|
@RestController
|
||||||
@RequestMapping("/api/flow")
|
@RequestMapping("/api/flow")
|
||||||
@@ -51,6 +58,9 @@ public class ProcessModelController {
|
|||||||
|
|
||||||
private static final Logger log = LoggerFactory.getLogger(ProcessModelController.class);
|
private static final Logger log = LoggerFactory.getLogger(ProcessModelController.class);
|
||||||
|
|
||||||
|
/** EIP4 草稿分类:建草稿时打此标,list() 只查此分类,隔离库里 143 条老 shape 存量 act_re_model。 */
|
||||||
|
static final String EIP4_CATEGORY = "eip4";
|
||||||
|
|
||||||
private final RepositoryService repositoryService;
|
private final RepositoryService repositoryService;
|
||||||
private final ObjectMapper objectMapper = new ObjectMapper();
|
private final ObjectMapper objectMapper = new ObjectMapper();
|
||||||
|
|
||||||
@@ -60,9 +70,11 @@ public class ProcessModelController {
|
|||||||
|
|
||||||
@GetMapping("/models")
|
@GetMapping("/models")
|
||||||
@Operation(summary = "草稿列表",
|
@Operation(summary = "草稿列表",
|
||||||
description = "createModelQuery().orderByLastUpdateTime().desc() → {models:[{id,name,key,lastUpdateTime(ISO)}]}。")
|
description = "createModelQuery().modelCategory(\"eip4\").orderByLastUpdateTime().desc() → "
|
||||||
|
+ "{models:[{id,name,key,lastUpdateTime(ISO)}]}。只列 EIP4 建的草稿,隔离存量 act_re_model。")
|
||||||
public ResponseEntity<Map<String, Object>> list() {
|
public ResponseEntity<Map<String, Object>> list() {
|
||||||
List<Map<String, Object>> models = repositoryService.createModelQuery()
|
List<Map<String, Object>> models = repositoryService.createModelQuery()
|
||||||
|
.modelCategory(EIP4_CATEGORY)
|
||||||
.orderByLastUpdateTime().desc().list().stream()
|
.orderByLastUpdateTime().desc().list().stream()
|
||||||
.map(m -> {
|
.map(m -> {
|
||||||
Map<String, Object> row = new LinkedHashMap<>();
|
Map<String, Object> row = new LinkedHashMap<>();
|
||||||
@@ -105,9 +117,13 @@ public class ProcessModelController {
|
|||||||
|
|
||||||
@PostMapping("/models")
|
@PostMapping("/models")
|
||||||
@Operation(summary = "建草稿",
|
@Operation(summary = "建草稿",
|
||||||
description = "body {name,key,bpmnXml,metaInfo?}。XML 先过 BpmnXMLConverter 解析守卫(坏 XML→422 不落库),"
|
description = "body {name,key,bpmnXml,metaInfo?}。name/key 空白→422;XML 过 BpmnXMLConverter 解析守卫"
|
||||||
+ "过门后 newModel+saveModel+addModelEditorSource → {modelId}。")
|
+ "(坏 XML→422 不落库);过门后 newModel+setCategory(eip4)+saveModel+addModelEditorSource → {modelId}。")
|
||||||
public ResponseEntity<Map<String, Object>> create(@RequestBody CreateModelRequest req) {
|
public ResponseEntity<Map<String, Object>> create(@RequestBody CreateModelRequest req) {
|
||||||
|
// key 是 T3.1 部署资源名/中文原 key 还原的依赖,name 用于列表展示:空白一律拒。
|
||||||
|
if (isBlank(req.name) || isBlank(req.key)) {
|
||||||
|
return status(HttpStatus.UNPROCESSABLE_ENTITY, "name 与 key 不能为空");
|
||||||
|
}
|
||||||
ResponseEntity<Map<String, Object>> rejected = parseGuard(req.bpmnXml);
|
ResponseEntity<Map<String, Object>> rejected = parseGuard(req.bpmnXml);
|
||||||
if (rejected != null) {
|
if (rejected != null) {
|
||||||
return rejected;
|
return rejected;
|
||||||
@@ -115,6 +131,7 @@ public class ProcessModelController {
|
|||||||
Model model = repositoryService.newModel();
|
Model model = repositoryService.newModel();
|
||||||
model.setName(req.name);
|
model.setName(req.name);
|
||||||
model.setKey(req.key);
|
model.setKey(req.key);
|
||||||
|
model.setCategory(EIP4_CATEGORY);
|
||||||
if (req.metaInfo != null) {
|
if (req.metaInfo != null) {
|
||||||
model.setMetaInfo(req.metaInfo);
|
model.setMetaInfo(req.metaInfo);
|
||||||
}
|
}
|
||||||
@@ -184,6 +201,7 @@ public class ProcessModelController {
|
|||||||
Model model = repositoryService.newModel();
|
Model model = repositoryService.newModel();
|
||||||
model.setName(def.getName());
|
model.setName(def.getName());
|
||||||
model.setKey(def.getKey());
|
model.setKey(def.getKey());
|
||||||
|
model.setCategory(EIP4_CATEGORY);
|
||||||
model.setMetaInfo(metaInfoJson);
|
model.setMetaInfo(metaInfoJson);
|
||||||
repositoryService.saveModel(model);
|
repositoryService.saveModel(model);
|
||||||
repositoryService.addModelEditorSource(model.getId(), r.xml().getBytes(StandardCharsets.UTF_8));
|
repositoryService.addModelEditorSource(model.getId(), r.xml().getBytes(StandardCharsets.UTF_8));
|
||||||
@@ -195,17 +213,21 @@ public class ProcessModelController {
|
|||||||
/**
|
/**
|
||||||
* BPMN 解析守卫:过则返回 {@code null}(放行),坏 XML 返回 422 ResponseEntity({status:1,msg})。
|
* BPMN 解析守卫:过则返回 {@code null}(放行),坏 XML 返回 422 ResponseEntity({status:1,msg})。
|
||||||
* 就地 catch 一切异常,不让引擎 XMLException/FlowableException 逸出到全局 advice(那里映射成 400,语义不符)。
|
* 就地 catch 一切异常,不让引擎 XMLException/FlowableException 逸出到全局 advice(那里映射成 400,语义不符)。
|
||||||
|
*
|
||||||
|
* <p>{@code convertToBpmnModel(source, validateSchema, enableSafeBpmnXml)} 两布尔参:
|
||||||
|
* {@code validateSchema=true} 走 BPMN 2.0 XSD 校验(拒非法结构);
|
||||||
|
* {@code enableSafeBpmnXml=true} 启用 flowable 加固解析器(禁外部 DTD/参数实体/DOCTYPE),
|
||||||
|
* 关掉 XXE/SSRF 面——校验路径也走加固解析器,不给外部实体注入留口。</p>
|
||||||
|
*
|
||||||
|
* <p>422 只回通用文案;原始解析原因(可能含内部路径/实体细节)仅进 {@code log.warn},不回显给调用方。</p>
|
||||||
*/
|
*/
|
||||||
private ResponseEntity<Map<String, Object>> parseGuard(String xml) {
|
private ResponseEntity<Map<String, Object>> parseGuard(String xml) {
|
||||||
try {
|
try {
|
||||||
new BpmnXMLConverter().convertToBpmnModel(new StringStreamSource(xml), true, false);
|
new BpmnXMLConverter().convertToBpmnModel(new StringStreamSource(xml), true, true);
|
||||||
return null;
|
return null;
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
log.warn("[流程草稿] BPMN 解析守卫拒绝: {}", e.toString());
|
log.warn("[流程草稿] BPMN 解析守卫拒绝: {}", e.toString());
|
||||||
Map<String, Object> body = new LinkedHashMap<>();
|
return status(HttpStatus.UNPROCESSABLE_ENTITY, "BPMN 解析失败");
|
||||||
body.put("status", 1);
|
|
||||||
body.put("msg", "BPMN 解析失败: " + e.getMessage());
|
|
||||||
return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(body);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -240,6 +262,11 @@ public class ProcessModelController {
|
|||||||
return d == null ? null : d.toInstant().toString();
|
return d == null ? null : d.toInstant().toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** null 或纯空白(含全角/半角空格)视为空白。 */
|
||||||
|
private static boolean isBlank(String s) {
|
||||||
|
return s == null || s.isBlank();
|
||||||
|
}
|
||||||
|
|
||||||
/** 建草稿入参。 */
|
/** 建草稿入参。 */
|
||||||
public static class CreateModelRequest {
|
public static class CreateModelRequest {
|
||||||
public String name;
|
public String name;
|
||||||
|
|||||||
@@ -64,13 +64,14 @@ class ProcessModelControllerTest {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void 列表按最近更新降序返回id名key时间() throws Exception {
|
void 列表只查eip4分类并按最近更新降序返回id名key时间() throws Exception {
|
||||||
Model m = Mockito.mock(Model.class);
|
Model m = Mockito.mock(Model.class);
|
||||||
when(m.getId()).thenReturn("m1");
|
when(m.getId()).thenReturn("m1");
|
||||||
when(m.getName()).thenReturn("总包合同交底");
|
when(m.getName()).thenReturn("总包合同交底");
|
||||||
when(m.getKey()).thenReturn("总包合同交底");
|
when(m.getKey()).thenReturn("总包合同交底");
|
||||||
when(m.getLastUpdateTime()).thenReturn(new Date(0L)); // 1970-01-01T00:00:00Z
|
when(m.getLastUpdateTime()).thenReturn(new Date(0L)); // 1970-01-01T00:00:00Z
|
||||||
when(repositoryService.createModelQuery()).thenReturn(modelQuery);
|
when(repositoryService.createModelQuery()).thenReturn(modelQuery);
|
||||||
|
when(modelQuery.modelCategory("eip4")).thenReturn(modelQuery);
|
||||||
when(modelQuery.orderByLastUpdateTime()).thenReturn(modelQuery);
|
when(modelQuery.orderByLastUpdateTime()).thenReturn(modelQuery);
|
||||||
when(modelQuery.desc()).thenReturn(modelQuery);
|
when(modelQuery.desc()).thenReturn(modelQuery);
|
||||||
when(modelQuery.list()).thenReturn(List.of(m));
|
when(modelQuery.list()).thenReturn(List.of(m));
|
||||||
@@ -81,6 +82,9 @@ class ProcessModelControllerTest {
|
|||||||
.andExpect(jsonPath("$.models[0].name").value("总包合同交底"))
|
.andExpect(jsonPath("$.models[0].name").value("总包合同交底"))
|
||||||
.andExpect(jsonPath("$.models[0].key").value("总包合同交底"))
|
.andExpect(jsonPath("$.models[0].key").value("总包合同交底"))
|
||||||
.andExpect(jsonPath("$.models[0].lastUpdateTime").value("1970-01-01T00:00:00Z"));
|
.andExpect(jsonPath("$.models[0].lastUpdateTime").value("1970-01-01T00:00:00Z"));
|
||||||
|
|
||||||
|
// 列表只列 EIP4 建的草稿:隔离库里 143 条老 shape 存量 act_re_model(打不开)
|
||||||
|
verify(modelQuery).modelCategory("eip4");
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
@@ -137,6 +141,7 @@ class ProcessModelControllerTest {
|
|||||||
|
|
||||||
verify(m).setName("新流程");
|
verify(m).setName("新流程");
|
||||||
verify(m).setKey("newproc");
|
verify(m).setKey("newproc");
|
||||||
|
verify(m).setCategory("eip4"); // 建草稿打 EIP4 分类,供 list() 过滤隔离存量
|
||||||
verify(repositoryService).saveModel(m);
|
verify(repositoryService).saveModel(m);
|
||||||
ArgumentCaptor<byte[]> src = ArgumentCaptor.forClass(byte[].class);
|
ArgumentCaptor<byte[]> src = ArgumentCaptor.forClass(byte[].class);
|
||||||
verify(repositoryService).addModelEditorSource(eq("newid"), src.capture());
|
verify(repositoryService).addModelEditorSource(eq("newid"), src.capture());
|
||||||
@@ -144,6 +149,19 @@ class ProcessModelControllerTest {
|
|||||||
new String(src.getValue(), StandardCharsets.UTF_8).contains("<process id=\"p1\""));
|
new String(src.getValue(), StandardCharsets.UTF_8).contains("<process id=\"p1\""));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void 建草稿_空白name或key返422且不落库() throws Exception {
|
||||||
|
// key 是 T3.1 部署资源名/中文原 key 还原的依赖:空白一律拒,在解析守卫之前拦。
|
||||||
|
String body = "{\"name\":\" \",\"key\":\"\",\"bpmnXml\":" + jsonString(VALID_BPMN) + "}";
|
||||||
|
mvc.perform(post("/api/flow/models").contentType(MediaType.APPLICATION_JSON).content(body))
|
||||||
|
.andExpect(status().isUnprocessableEntity())
|
||||||
|
.andExpect(jsonPath("$.status").value(1))
|
||||||
|
.andExpect(jsonPath("$.msg").isNotEmpty());
|
||||||
|
|
||||||
|
verify(repositoryService, never()).newModel();
|
||||||
|
verify(repositoryService, never()).saveModel(any());
|
||||||
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void 建草稿_坏XML返422且不落库() throws Exception {
|
void 建草稿_坏XML返422且不落库() throws Exception {
|
||||||
String body = "{\"name\":\"坏流程\",\"key\":\"bad\",\"bpmnXml\":"
|
String body = "{\"name\":\"坏流程\",\"key\":\"bad\",\"bpmnXml\":"
|
||||||
@@ -187,6 +205,24 @@ class ProcessModelControllerTest {
|
|||||||
verify(repositoryService).addModelEditorSource(eq("m1"), any());
|
verify(repositoryService).addModelEditorSource(eq("m1"), any());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void 更新_只带name不带metaInfo时不改metaInfo() throws Exception {
|
||||||
|
// 草稿的 eip4IdMap 存于 metaInfo,普通保存草稿只发 name+XML 不重发 metaInfo:此时绝不能 setMetaInfo(null)
|
||||||
|
// 抹掉它——这是 T3.1 发布逆向还原原 key 的命根契约。
|
||||||
|
Model m = Mockito.mock(Model.class);
|
||||||
|
when(repositoryService.getModel("m1")).thenReturn(m);
|
||||||
|
|
||||||
|
String body = "{\"name\":\"只改名\",\"bpmnXml\":" + jsonString(VALID_BPMN) + "}";
|
||||||
|
mvc.perform(put("/api/flow/models/m1").contentType(MediaType.APPLICATION_JSON).content(body))
|
||||||
|
.andExpect(status().isOk())
|
||||||
|
.andExpect(jsonPath("$.status").value(0));
|
||||||
|
|
||||||
|
verify(m).setName("只改名");
|
||||||
|
verify(m, never()).setMetaInfo(any());
|
||||||
|
verify(repositoryService).saveModel(m);
|
||||||
|
verify(repositoryService).addModelEditorSource(eq("m1"), any());
|
||||||
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void 更新_坏XML返422且不落库() throws Exception {
|
void 更新_坏XML返422且不落库() throws Exception {
|
||||||
Model m = Mockito.mock(Model.class);
|
Model m = Mockito.mock(Model.class);
|
||||||
@@ -231,6 +267,7 @@ class ProcessModelControllerTest {
|
|||||||
|
|
||||||
verify(m).setName("总包合同交底");
|
verify(m).setName("总包合同交底");
|
||||||
verify(m).setKey("总包合同交底");
|
verify(m).setKey("总包合同交底");
|
||||||
|
verify(m).setCategory("eip4"); // from-procdef 建的草稿同样打 EIP4 分类
|
||||||
// metaInfo:JSON 含 eip4IdMap + sourceProcDefId + 中文 originalKey
|
// metaInfo:JSON 含 eip4IdMap + sourceProcDefId + 中文 originalKey
|
||||||
ArgumentCaptor<String> meta = ArgumentCaptor.forClass(String.class);
|
ArgumentCaptor<String> meta = ArgumentCaptor.forClass(String.class);
|
||||||
verify(m).setMetaInfo(meta.capture());
|
verify(m).setMetaInfo(meta.capture());
|
||||||
@@ -262,6 +299,23 @@ class ProcessModelControllerTest {
|
|||||||
verify(repositoryService, never()).newModel();
|
verify(repositoryService, never()).newModel();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void fromProcDef_BPMN读取为空返found_false不落库() throws Exception {
|
||||||
|
// procDef 存在但部署 BPMN 资源读不出(getProcessModel 返 null)→ 降级 found:false,不建空草稿。
|
||||||
|
ProcessDefinition def = Mockito.mock(ProcessDefinition.class);
|
||||||
|
when(repositoryService.createProcessDefinitionQuery()).thenReturn(processDefinitionQuery);
|
||||||
|
when(processDefinitionQuery.processDefinitionId("def-empty")).thenReturn(processDefinitionQuery);
|
||||||
|
when(processDefinitionQuery.singleResult()).thenReturn(def);
|
||||||
|
when(repositoryService.getProcessModel("def-empty")).thenReturn(null);
|
||||||
|
|
||||||
|
mvc.perform(post("/api/flow/models/from-procdef")
|
||||||
|
.contentType(MediaType.APPLICATION_JSON).content("{\"procDefId\":\"def-empty\"}"))
|
||||||
|
.andExpect(status().isOk())
|
||||||
|
.andExpect(jsonPath("$.found").value(false));
|
||||||
|
|
||||||
|
verify(repositoryService, never()).newModel();
|
||||||
|
}
|
||||||
|
|
||||||
/** 把任意字符串编成 JSON 字符串字面量(转义引号/反斜杠/换行),用于拼请求体。 */
|
/** 把任意字符串编成 JSON 字符串字面量(转义引号/反斜杠/换行),用于拼请求体。 */
|
||||||
private static String jsonString(String s) {
|
private static String jsonString(String s) {
|
||||||
StringBuilder sb = new StringBuilder("\"");
|
StringBuilder sb = new StringBuilder("\"");
|
||||||
|
|||||||
Reference in New Issue
Block a user