Files
pangolin/server/routers/badger/verifySession.test.ts
kshitijshresth b136bd2246 Escape regex metacharacters in PATH rule wildcard matching
isValidUrlGlobPattern accepts characters like ( ) [ ] { } | . + ^ $ in PATH rule values, but isPathAllowed converted wildcard segments to regex without escaping them. A rule value such as /(api* produced an invalid regex and threw on every request to the resource, surfacing as a 500 from verifySession. Literal characters like . and + also changed matching semantics. isPathAllowed is extracted to server/lib/pathMatch.ts as a pure module, metacharacters are escaped before wildcard substitution, compiled segment regexes are cached, and the test suite now imports the real implementation instead of a stale copy, with added coverage for special characters.
2026-06-12 11:21:21 +03:00

423 lines
11 KiB
TypeScript

import { assertEquals } from "@test/assert";
import { REGIONS } from "@server/db/regions";
import { isPathAllowed } from "@server/lib/pathMatch";
function isIpInRegion(
ipCountryCode: string | undefined,
checkRegionCode: string
): boolean {
if (!ipCountryCode) {
return false;
}
const upperCode = ipCountryCode.toUpperCase();
for (const region of REGIONS) {
// Check if it's a top-level region (continent)
if (region.id === checkRegionCode) {
for (const subregion of region.includes) {
if (subregion.countries.includes(upperCode)) {
return true;
}
}
return false;
}
// Check subregions
for (const subregion of region.includes) {
if (subregion.id === checkRegionCode) {
return subregion.countries.includes(upperCode);
}
}
}
return false;
}
function runTests() {
console.log("Running path matching tests...");
// Test exact matching
assertEquals(
isPathAllowed("foo", "foo"),
true,
"Exact match should be allowed"
);
assertEquals(
isPathAllowed("foo", "bar"),
false,
"Different segments should not match"
);
assertEquals(
isPathAllowed("foo/bar", "foo/bar"),
true,
"Exact multi-segment match should be allowed"
);
assertEquals(
isPathAllowed("foo/bar", "foo/baz"),
false,
"Partial multi-segment match should not be allowed"
);
// Test with leading and trailing slashes
assertEquals(
isPathAllowed("/foo", "foo"),
true,
"Pattern with leading slash should match"
);
assertEquals(
isPathAllowed("foo/", "foo"),
true,
"Pattern with trailing slash should match"
);
assertEquals(
isPathAllowed("/foo/", "foo"),
true,
"Pattern with both leading and trailing slashes should match"
);
assertEquals(
isPathAllowed("foo", "/foo/"),
true,
"Path with leading and trailing slashes should match"
);
// Test simple wildcard matching
assertEquals(
isPathAllowed("*", "foo"),
true,
"Single wildcard should match any single segment"
);
assertEquals(
isPathAllowed("*", "foo/bar"),
true,
"Single wildcard should match multiple segments"
);
assertEquals(
isPathAllowed("*/bar", "foo/bar"),
true,
"Wildcard prefix should match"
);
assertEquals(
isPathAllowed("foo/*", "foo/bar"),
true,
"Wildcard suffix should match"
);
assertEquals(
isPathAllowed("foo/*/baz", "foo/bar/baz"),
true,
"Wildcard in middle should match"
);
// Test multiple wildcards
assertEquals(
isPathAllowed("*/*", "foo/bar"),
true,
"Multiple wildcards should match corresponding segments"
);
assertEquals(
isPathAllowed("*/*/*", "foo/bar/baz"),
true,
"Three wildcards should match three segments"
);
assertEquals(
isPathAllowed("foo/*/*", "foo/bar/baz"),
true,
"Specific prefix with wildcards should match"
);
assertEquals(
isPathAllowed("*/*/baz", "foo/bar/baz"),
true,
"Wildcards with specific suffix should match"
);
// Test wildcard consumption behavior
assertEquals(
isPathAllowed("*", ""),
true,
"Wildcard should optionally consume segments"
);
assertEquals(
isPathAllowed("foo/*", "foo"),
true,
"Trailing wildcard should be optional"
);
assertEquals(
isPathAllowed("*/*", "foo"),
true,
"Multiple wildcards can match fewer segments"
);
assertEquals(
isPathAllowed("*/*/*", "foo/bar"),
true,
"Extra wildcards can be skipped"
);
// Test complex nested paths
assertEquals(
isPathAllowed("api/*/users", "api/v1/users"),
true,
"API versioning pattern should match"
);
assertEquals(
isPathAllowed("api/*/users/*", "api/v1/users/123"),
true,
"API resource pattern should match"
);
assertEquals(
isPathAllowed("api/*/users/*/profile", "api/v1/users/123/profile"),
true,
"Nested API pattern should match"
);
// Test for the requested padbootstrap* pattern
assertEquals(
isPathAllowed("padbootstrap*", "padbootstrap"),
true,
"padbootstrap* should match padbootstrap"
);
assertEquals(
isPathAllowed("padbootstrap*", "padbootstrapv1"),
true,
"padbootstrap* should match padbootstrapv1"
);
assertEquals(
isPathAllowed("padbootstrap*", "padbootstrap/files"),
false,
"padbootstrap* should not match padbootstrap/files"
);
assertEquals(
isPathAllowed("padbootstrap*/*", "padbootstrap/files"),
true,
"padbootstrap*/* should match padbootstrap/files"
);
assertEquals(
isPathAllowed("padbootstrap*/files", "padbootstrapv1/files"),
true,
"padbootstrap*/files should not match padbootstrapv1/files (wildcard is segment-based, not partial)"
);
// Test wildcard edge cases
assertEquals(
isPathAllowed("*/*/*/*/*/*", "a/b"),
true,
"Many wildcards can match few segments"
);
assertEquals(
isPathAllowed("a/*/b/*/c", "a/anything/b/something/c"),
true,
"Multiple wildcards in pattern should match corresponding segments"
);
// Test patterns with partial segment matches
assertEquals(
isPathAllowed("padbootstrap*", "padbootstrap-123"),
true,
"Wildcards in isPathAllowed should be segment-based, not character-based"
);
assertEquals(
isPathAllowed("test*", "testuser"),
true,
"Asterisk as part of segment name is treated as a literal, not a wildcard"
);
assertEquals(
isPathAllowed("my*app", "myapp"),
true,
"Asterisk in middle of segment name is treated as a literal, not a wildcard"
);
assertEquals(
isPathAllowed("/", "/"),
true,
"Root path should match root path"
);
assertEquals(
isPathAllowed("/", "/test"),
false,
"Root path should not match non-root path"
);
console.log("All path matching tests passed!");
}
function runSpecialCharacterTests() {
console.log("\nRunning special character tests...");
let threw = false;
try {
isPathAllowed("(api*", "anything");
isPathAllowed("a(b*", "a(bc");
isPathAllowed("c[d*", "c[de");
isPathAllowed("x{2}*", "x{2}y");
isPathAllowed("a|b*", "a|bc");
isPathAllowed("back\\slash*", "back\\slashed");
} catch (e) {
threw = true;
console.error(
"Patterns accepted by isValidUrlGlobPattern crashed the matcher:",
e instanceof Error ? e.message : e
);
}
assertEquals(
threw,
false,
"Patterns with regex metacharacters must not throw"
);
assertEquals(
isPathAllowed("(api*", "(api-v1"),
true,
"Parenthesis should be treated as a literal character"
);
assertEquals(
isPathAllowed("(api*", "xapi-v1"),
false,
"Parenthesis should not match other characters"
);
assertEquals(
isPathAllowed("a(b)*", "a(b)c"),
true,
"Parentheses pair should be treated as literal characters"
);
assertEquals(
isPathAllowed("*.png", "image.png"),
true,
"Dot should match a literal dot"
);
assertEquals(
isPathAllowed("*.png", "imageXpng"),
false,
"Dot should not act as a regex wildcard"
);
assertEquals(
isPathAllowed("v1.0*", "v1.0.1"),
true,
"Version-like literal should match itself"
);
assertEquals(
isPathAllowed("v1.0*", "v1x0-beta"),
false,
"Version-like literal should not match arbitrary characters"
);
assertEquals(
isPathAllowed("a+b*", "a+bc"),
true,
"Plus should be treated as a literal character"
);
assertEquals(
isPathAllowed("a+b*", "aaabc"),
false,
"Plus should not act as a regex quantifier"
);
assertEquals(
isPathAllowed("$ref*", "$refs"),
true,
"Dollar sign should be treated as a literal character"
);
assertEquals(
isPathAllowed("price$*", "price$100"),
true,
"Dollar sign mid-pattern should be treated as a literal character"
);
assertEquals(
isPathAllowed("^start*", "^started"),
true,
"Caret should be treated as a literal character"
);
assertEquals(
isPathAllowed("a|b*", "a|bc"),
true,
"Pipe should be treated as a literal character"
);
assertEquals(
isPathAllowed("a|b*", "a"),
false,
"Pipe should not act as regex alternation"
);
assertEquals(
isPathAllowed("file?*", "fileX"),
true,
"Question mark should still act as a single-character wildcard"
);
assertEquals(
isPathAllowed("api/*", "api/" + "x/".repeat(50)),
true,
"Deeply nested paths should still match"
);
console.log("All special character tests passed!");
}
function runRegionTests() {
console.log("\nRunning isIpInRegion tests...");
// Test undefined country code
assertEquals(
isIpInRegion(undefined, "150"),
false,
"Undefined country code should return false"
);
// Test subregion matching (Western Europe)
assertEquals(
isIpInRegion("DE", "155"),
true,
"Country should match its subregion"
);
assertEquals(
isIpInRegion("GB", "155"),
false,
"Country should NOT match wrong subregion"
);
// Test continent matching (Europe)
assertEquals(
isIpInRegion("DE", "150"),
true,
"Country should match its continent"
);
assertEquals(
isIpInRegion("GB", "150"),
true,
"Different European country should match Europe"
);
assertEquals(
isIpInRegion("US", "150"),
false,
"Non-European country should NOT match Europe"
);
// Test case insensitivity
assertEquals(
isIpInRegion("de", "155"),
true,
"Lowercase country code should work"
);
// Test invalid region code
assertEquals(
isIpInRegion("DE", "999"),
false,
"Invalid region code should return false"
);
console.log("All region tests passed!");
}
// Run all tests
try {
runTests();
runSpecialCharacterTests();
runRegionTests();
console.log("\n✅ All tests passed!");
} catch (error) {
console.error("❌ Test failed:", error);
process.exit(1);
}