Skip to content

restrict replaceSecretPlaceholder to cors with allowWhitelist #4102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KristjanESPERANTO merged 3 commits into from
Apr 10, 2026
+50 −4
Merged

restrict replaceSecretPlaceholder to cors with allowWhitelist #4102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c52ce23
restrict replaceSecretPlaceholder to cors with allowWhitelist
khassel Apr 10, 2026
5067561
fix spelling errors
khassel Apr 10, 2026
bd00688
use global.config
khassel Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions cspell.config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@
"armv",
"ashishtank",
"autoplay",
"avghumidity",
"avgtemp",
"Autorestart",
"beada",
"Behaviour",
"Beschreibung",
"Binney",
"bluemanos",
"bnitkin",
Expand Down Expand Up @@ -111,6 +114,7 @@
"flopp",
"fontawesome",
"fontface",
"forecastday",
"forecastweather",
"fortawesome",
"frameguard",
Expand Down Expand Up @@ -186,14 +190,18 @@
"luxon",
"lxsession",
"magicmirror",
"mapbox",
"martingron",
"marvai",
"mastermerge",
"matchtype",
"maxentries",
"maxtemp",
"maxwind",
"Meteo",
"michaelteeuw",
"michmich",
"mintemp",
"Midori",
"mirontoli",
"MISSINGLANG",
Expand All @@ -212,7 +220,9 @@
"NEWSFEED",
"newsfeedfetcher",
"newsfetcher",
"newyear",
"newsitems",
"nextdaysrelative",
"nfogal",
"njwilliams",
"nonrepeating",
Expand All @@ -239,8 +249,10 @@
"pmin",
"Português",
"PRECIP",
"precips",
"Problema",
"psieg",
"ptype",
"pubdate",
"radokristof",
"rajniszp",
Expand All @@ -255,12 +267,14 @@
"Rosso",
"Rothfusz",
"rrule",
"sameorigin",
"savvadam",
"sdetweil",
"searchstr",
"sendheaders",
"serveronly",
"sexualized",
"showend",
"Sitecode",
"skpanagiotis",
"SMHI",
Expand Down Expand Up @@ -295,8 +309,11 @@
"timeformat",
"titlereplacestr",
"titlesearchstr",
"TOCTOU",
"todaytemp",
"tomzt",
"totalprecip",
"totalsnow",
"trunc",
"ttlms",
"ukmetoffice",
Expand All @@ -317,6 +334,7 @@
"Vorberechnung",
"vppencilsharpener",
"Wallys",
"weatherapi",
"Weatherbit",
"weathercode",
"WEATHERDATA",
Expand All @@ -336,6 +354,7 @@
"Woolridge",
"worktree",
"Wsymb",
"xhvw",
"xlarge",
"xmark",
"xrandr",
Expand Down
11 changes: 8 additions & 3 deletions js/server_functions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,14 @@ function getStartup (req, res) {
* @returns {string} the input with real variable content
*/
function replaceSecretPlaceholder (input) {
return input.replaceAll(/\*\*(SECRET_[^*]+)\*\*/g, (match, group) => {
return process.env[group];
});
if (global.config.cors === "allowWhitelist") {
return input.replaceAll(/\*\*(SECRET_[^*]+)\*\*/g, (match, group) => {
return process.env[group];
});
} else {
Log.error("Replacing secrets works only with CORS and `allowWhitelist`, you need to set this in `config.js`, set `cors: allowWhitelist`");
return input;
}
}

/**
Expand Down
24 changes: 23 additions & 1 deletion tests/unit/functions/server_functions_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ const undici = require("undici");
const { cors, getUserAgent, replaceSecretPlaceholder } = require("#server_functions");

describe("server_functions tests", () => {
describe("The replaceSecretPlaceholder method", () => {
describe("The replaceSecretPlaceholder method with cors=allowWhitelist", () => {
beforeEach(() => {
global.config = { cors: "allowWhitelist" };
});

it("Calls string without secret placeholder", () => {
const teststring = "test string without secret placeholder";
const result = replaceSecretPlaceholder(teststring);
Expand All @@ -25,6 +29,24 @@ describe("server_functions tests", () => {
});
});

describe("The replaceSecretPlaceholder method with cors=allowAll", () => {
beforeEach(() => {
global.config = { cors: "allowAll" };
});

it("Calls string without secret placeholder", () => {
const teststring = "test string without secret placeholder";
const result = replaceSecretPlaceholder(teststring);
expect(result).toBe(teststring);
});

it("Calls string with 2 secret placeholders", () => {
const teststring = "test string with secret1=**SECRET_ONE** and secret2=**SECRET_TWO**";
const result = replaceSecretPlaceholder(teststring);
expect(result).toBe(teststring);
});
});

describe("The cors method", () => {
let fetchSpy;
let fetchResponseHeadersGet;
Expand Down
Loading