Copilot commented on code in PR #707: URL: https://github.com/apache/shenyu-dashboard/pull/707#discussion_r4259619726
########## src/utils/regExpRule.js: ########## @@ -0,0 +1,112 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Plugin handle metadata (extObj.rule) stores optional validation rules as +// regular expression literals such as "/^(true|false)$/" or "/^[a-z]+$/i". +// The value is admin-editable data, so it must be parsed, never evaluated. +const VALID_FLAGS = /^[dgimsuvy]*$/; + +// JavaScript line terminators: LF, CR, LINE SEPARATOR, PARAGRAPH SEPARATOR. +const LINE_TERMINATOR = /[\n\r\u2028\u2029]/; + +// Splits "/source/flags" at the first "/" that closes the literal, following +// JavaScript regular expression literal rules: "\/" and "/" inside a +// character class do not end the literal, and a line terminator (escaped or +// not) is not allowed anywhere in the literal. +function splitRegExpLiteral(literal) { + if (literal[0] !== "/") { + return null; + } + let inClass = false; + for (let i = 1; i < literal.length; i += 1) { + const char = literal[i]; + if (LINE_TERMINATOR.test(char)) { + return null; + } + if (char === "\\") { + i += 1; + if (LINE_TERMINATOR.test(literal[i])) { + return null; + } + } else if (char === "[") { + inClass = true; + } else if (char === "]") { + inClass = false; + } else if (char === "/" && !inClass) { + return { source: literal.slice(1, i), flags: literal.slice(i + 1) }; + } + } + return null; +} + +/** + * Converts a stored check rule into a RegExp without executing it as code. + * + * @param {*} rule rule in "/source/flags" form + * @returns {RegExp|undefined} the parsed RegExp, or undefined when the rule + * is empty or is not a valid regular expression literal + */ +export function parseRegExpRule(rule) { + if (typeof rule !== "string") { + return undefined; + } + const literal = splitRegExpLiteral(rule.trim()); + if (!literal || !literal.source || !VALID_FLAGS.test(literal.flags)) { + return undefined; + } + try { + return new RegExp(literal.source, literal.flags); + } catch (e) { + // Invalid pattern or flag combination (e.g. duplicated flags). + return undefined; + } +} + +const reportedInvalidRules = new Set(); Review Comment: reportedInvalidRules` can grow unbounded over the lifetime of the page if many distinct invalid rule strings are encountered (e.g., from repeatedly editing metadata or loading lots of handles). Consider adding a small cap (drop/clear after N entries) or a bounded/LRU strategy so logging-dedup doesn’t become a long-lived memory sink. ########## src/utils/regExpRule.test.js: ########## @@ -0,0 +1,158 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { checkRulePattern, parseRegExpRule } from "./regExpRule"; + +describe("parseRegExpRule", () => { + afterEach(() => { + delete global.pwned; + }); + + it("parses the rule formats shipped in ShenYu plugin handle data", () => { + const booleanRule = parseRegExpRule("/^(true|false)$/"); + expect(booleanRule).toBeInstanceOf(RegExp); + expect(booleanRule.source).toBe("^(true|false)$"); + expect(booleanRule.test("true")).toBe(true); + expect(booleanRule.test("yes")).toBe(false); + + const bitRule = parseRegExpRule("/^[01]$/"); + expect(bitRule.test("1")).toBe(true); + expect(bitRule.test("2")).toBe(false); + }); + + it("keeps valid flags", () => { + const rule = parseRegExpRule("/^abc$/i"); + expect(rule.flags).toBe("i"); + expect(rule.test("ABC")).toBe(true); + expect(parseRegExpRule("/^a.b$/ms").flags).toBe("ms"); + }); + + it("matches the same values as the equivalent regular expression literal", () => { + expect(parseRegExpRule(" /^\\d+$/ ").source).toBe(/^\d+$/.source); + expect(parseRegExpRule("/^a\\/b$/").test("a/b")).toBe(true); + expect(parseRegExpRule("/^[/]+$/").test("//")).toBe(true); + }); + + it.each(["/abc/x", "/abc/gg", "/abc/I", "/abc/ i"])( + "rejects invalid flags: %s", + (rule) => { + expect(parseRegExpRule(rule)).toBeUndefined(); + }, + ); + + it.each([ + undefined, + null, + 1, + {}, + "", + "//", + "/", + "abc", + "^\\d+$", + "/(/", + "/abc", + "/a/b/", + ])( + "returns undefined for a value that is not a valid literal: %p", + (rule) => { + expect(parseRegExpRule(rule)).toBeUndefined(); + }, + ); + + // JavaScript rejects these as regular expression literals (SyntaxError). + it.each([ + ["LF", "/a\nb/"], + ["CR", "/a\rb/"], + ["LINE SEPARATOR", "/a\u2028b/"], + ["PARAGRAPH SEPARATOR", "/a\u2029b/"], + ["LF in a character class", "/[\n]/"], + ["escaped LF", "/a\\\nb/"], + ["escaped LINE SEPARATOR", "/a\\\u2028b/"], + ])("rejects a line terminator inside the literal: %s", (name, rule) => { + expect(parseRegExpRule(rule)).toBeUndefined(); + }); + + it("ignores line terminators around the literal", () => { + expect(parseRegExpRule("\n/^a$/i\r\n").test("A")).toBe(true); + expect(parseRegExpRule("\u2028/^a$/\u2029").test("a")).toBe(true); + }); + + it("accepts an escaped line terminator written as an escape sequence", () => { + expect(parseRegExpRule("/^a\\nb$/").test("a\nb")).toBe(true); + expect(parseRegExpRule("/^a\\u2028b$/").test("a\u2028b")).toBe(true); + }); + + it.each([ + "alert(1)", + "(()=>{globalThis.pwned=1})()", + "/x/,globalThis.pwned=1", + "/x/;globalThis.pwned=1", + "/x/.constructor.constructor('globalThis.pwned=1')()", + "globalThis.pwned=1,/x/", + ])("does not execute code stored in the rule: %s", (rule) => { + expect(parseRegExpRule(rule)).toBeUndefined(); + expect(global.pwned).toBeUndefined(); + }); +}); + +describe("checkRulePattern", () => { + it.each([undefined, null, "", " ", "\t\r\n"])( + "adds no pattern for an empty rule: %p", + (rule) => { + const error = jest.spyOn(console, "error").mockImplementation(() => {}); + expect(checkRulePattern(rule)).toBeUndefined(); + expect(error).not.toHaveBeenCalled(); + }, + ); Review Comment: jest.spyOn(console, "error")` is never restored, so `console.error` remains mocked for the rest of the Jest run and can interfere with unrelated test suites. Add an `afterEach(() => jest.restoreAllMocks())` (or restore the specific spy via `error.mockRestore()`/`mockReset()`) inside the `describe("checkRulePattern")` block (and similarly for the other tests that spy on `console.error`). ########## src/routes/System/Plugin/AddModal.js: ########## @@ -174,10 +175,10 @@ class AddModal extends Component { message: getIntlContent("SHENYU.COMMON.PLEASEINPUT"), }); } - if (checkRule) { + let checkPattern = checkRulePattern(checkRule); + if (checkPattern) { rules.push({ - // eslint-disable-next-line no-eval - pattern: eval(checkRule), + pattern: checkPattern, message: `${getIntlContent( Review Comment: checkPattern` is not reassigned, so it should be declared with `const` instead of `let` to better reflect intent and prevent accidental reassignment. The same pattern appears in the other updated call sites as well. ########## src/utils/regExpRule.js: ########## @@ -0,0 +1,112 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Plugin handle metadata (extObj.rule) stores optional validation rules as +// regular expression literals such as "/^(true|false)$/" or "/^[a-z]+$/i". +// The value is admin-editable data, so it must be parsed, never evaluated. +const VALID_FLAGS = /^[dgimsuvy]*$/; + +// JavaScript line terminators: LF, CR, LINE SEPARATOR, PARAGRAPH SEPARATOR. +const LINE_TERMINATOR = /[\n\r\u2028\u2029]/; + +// Splits "/source/flags" at the first "/" that closes the literal, following +// JavaScript regular expression literal rules: "\/" and "/" inside a +// character class do not end the literal, and a line terminator (escaped or +// not) is not allowed anywhere in the literal. +function splitRegExpLiteral(literal) { + if (literal[0] !== "/") { + return null; + } + let inClass = false; + for (let i = 1; i < literal.length; i += 1) { + const char = literal[i]; + if (LINE_TERMINATOR.test(char)) { + return null; + } + if (char === "\\") { + i += 1; + if (LINE_TERMINATOR.test(literal[i])) { + return null; + } + } else if (char === "[") { + inClass = true; + } else if (char === "]") { + inClass = false; + } else if (char === "/" && !inClass) { + return { source: literal.slice(1, i), flags: literal.slice(i + 1) }; + } + } + return null; +} + +/** + * Converts a stored check rule into a RegExp without executing it as code. + * + * @param {*} rule rule in "/source/flags" form + * @returns {RegExp|undefined} the parsed RegExp, or undefined when the rule + * is empty or is not a valid regular expression literal + */ +export function parseRegExpRule(rule) { + if (typeof rule !== "string") { + return undefined; + } + const literal = splitRegExpLiteral(rule.trim()); + if (!literal || !literal.source || !VALID_FLAGS.test(literal.flags)) { + return undefined; + } + try { + return new RegExp(literal.source, literal.flags); + } catch (e) { + // Invalid pattern or flag combination (e.g. duplicated flags). + return undefined; + } +} + +const reportedInvalidRules = new Set(); + +/** + * Returns the pattern a form field should be validated against for a stored + * check rule. + * + * An empty rule means the field has no pattern check. A rule that is not a + * valid regular expression literal used to make eval() throw while the form + * rendered; it now produces a pattern that matches nothing, so any non-empty + * value fails validation with the rule shown in the message, and the problem + * is reported once in the console instead of validation being skipped. + * + * @param {*} rule rule in "/source/flags" form + * @returns {RegExp|undefined} the pattern to validate against, or undefined + * when the rule is empty + */ +export function checkRulePattern(rule) { + if (!rule || (typeof rule === "string" && !rule.trim())) { + return undefined; + } + const pattern = parseRegExpRule(rule); + if (pattern) { + return pattern; + } + if (!reportedInvalidRules.has(String(rule))) { + reportedInvalidRules.add(String(rule)); + // eslint-disable-next-line no-console + console.error( + "Invalid plugin handle check rule, expected a /pattern/flags literal:", + rule, + ); + } + return /(?!)/; +} Review Comment: reportedInvalidRules` can grow unbounded over the lifetime of the page if many distinct invalid rule strings are encountered (e.g., from repeatedly editing metadata or loading lots of handles). Consider adding a small cap (drop/clear after N entries) or a bounded/LRU strategy so logging-dedup doesn’t become a long-lived memory sink. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
