Files
Sabu SiyadGitHubTanmoy SarkarTanmoy Sarkargreptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
430c0156bd fix(socketio): short circuit websocket if in frappe cloud (#40312)
* fix(socketio): short circuit websocket if in frappe cloud

* fix(socketio): validate host using `get_site_name`

* fix(socketio): handle redirects

* fix(socketio): redirect should match `fetch` behavior

* fix(socketio): add error handler on request

* fix(socketio): reuse reuse parsed host in case of redirect

* fix(socket): use `redirect.host` instead of `hostname`

* fix(realtime): route auth over loopback with X-Frappe-Site-Name to bypass CDN

* fix(realtime): make web-process host configurable via webserver_host, default to origin

* fix(realtime): normalize webserver_host scheme and port in auth URL builder

* fix(realtime): Fix the port after slash issue

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

* fix(realtime): Fix the port after slash issue

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

---------

Co-authored-by: Tanmoy Sarkar <[email protected]>
Co-authored-by: Tanmoy Sarkar <[email protected]>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2026-06-26 15:57:22 +05:30

110 lines
3.3 KiB
JavaScript

const cookie = require("cookie");
const { get_conf, get_redis_subscriber } = require("../../node_utils");
const { get_url, get_hostname } = require("../utils");
const conf = get_conf();
const redisClient = get_redis_subscriber("redis_queue");
async function getSecretFromRedis() {
if (!redisClient.isOpen) await redisClient.connect();
const val = await redisClient.get("socketio_auth_secret");
return val;
}
function authenticate_with_frappe(socket, next) {
let namespace = socket.nsp.name;
namespace = namespace.slice(1, namespace.length); // remove leading `/`
if (namespace != get_site_name(socket)) {
next(new Error("Invalid namespace"));
}
if (get_hostname(socket.request.headers.host) != get_hostname(socket.request.headers.origin)) {
next(new Error("Invalid origin"));
return;
}
if (!socket.request.headers.cookie && !socket.request.headers.authorization) {
next(
new Error(
"Missing cookie and authorization header. Either one needed for authentication."
)
);
return;
}
let cookies = cookie.parse(socket.request.headers.cookie || "");
let authorization_header = socket.request.headers.authorization;
if (!cookies.sid && !authorization_header) {
next(new Error("No authentication method used. Use cookie or authorization header."));
return;
}
socket.sid = cookies.sid;
socket.authorization_header = authorization_header;
socket.frappe_request = async (path, args = {}, opts = {}) => {
let query_args = new URLSearchParams(args);
if (query_args.toString()) {
path = path + "?" + query_args.toString();
}
let headers = {};
if (socket.authorization_header) {
headers["Authorization"] = socket.authorization_header;
} else if (socket.sid) {
headers["Cookie"] = `sid=${socket.sid}`;
}
const secret = await getSecretFromRedis();
if (secret) {
headers["X-Frappe-Socket-Secret"] = secret;
}
// Carry the tenant so loopback requests route to the right site.
headers["X-Frappe-Site-Name"] = get_site_name(socket);
return fetch(get_url(socket, path), {
...opts,
headers,
});
};
socket
.frappe_request("/api/method/frappe.realtime.get_user_info")
.then((res) => res.json())
.then(async ({ message }) => {
if (socket.user !== "Guest" && !message.installed_apps) {
const retry_res = await socket.frappe_request(
"/api/method/frappe.realtime.get_user_info"
);
const retry_data = await retry_res.json();
message = retry_data.message;
}
socket.user = message.user;
socket.user_type = message.user_type;
socket.installed_apps = message.installed_apps || [];
next();
})
.catch((e) => {
next(new Error(`Unauthorized: ${e}`));
});
}
function get_site_name(socket) {
if (socket.site_name) {
return socket.site_name;
} else if (socket.request.headers["x-frappe-site-name"]) {
socket.site_name = get_hostname(socket.request.headers["x-frappe-site-name"]);
} else if (
conf.default_site &&
["localhost", "127.0.0.1"].indexOf(get_hostname(socket.request.headers.host)) !== -1
) {
socket.site_name = conf.default_site;
} else if (socket.request.headers.origin) {
socket.site_name = get_hostname(socket.request.headers.origin);
} else {
socket.site_name = get_hostname(socket.request.headers.host);
}
return socket.site_name;
}
module.exports = authenticate_with_frappe;