mirror of https://github.com/keeweb/keeweb
moved browser socket connection management to the main process
antelle
2 years ago
parent
e06e9ac1f8
commit
4280b84459
@ -1,4 +1,298 @@
|
||||
const { ipcMain } = require('electron');
|
||||
const os = require('os');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const net = require('net');
|
||||
const { ipcMain, app } = require('electron');
|
||||
const { Logger } = require('../logger');
|
||||
|
||||
ipcMain.handle('browserExtensionConnectorStart', () => {});
|
||||
ipcMain.handle('browserExtensionConnectorStop', () => {});
|
||||
ipcMain.handle('browserExtensionConnectorStart', browserExtensionConnectorStart);
|
||||
ipcMain.handle('browserExtensionConnectorStop', browserExtensionConnectorStop);
|
||||
ipcMain.handle('browserExtensionConnectorSocketResult', browserExtensionConnectorSocketResult);
|
||||
ipcMain.handle('browserExtensionConnectorSocketEvent', browserExtensionConnectorSocketEvent);
|
||||
|
||||
const logger = new Logger('browser-extension-connector');
|
||||
|
||||
const MaxIncomingDataLength = 10_000;
|
||||
|
||||
let connectedSockets = new Map();
|
||||
let connectedSocketState = new WeakMap();
|
||||
let server;
|
||||
let socketId = 0;
|
||||
|
||||
async function browserExtensionConnectorStart(e, config) {
|
||||
await prepareBrowserExtensionSocket(config);
|
||||
const sockName = getBrowserExtensionSocketName(config);
|
||||
|
||||
if (isSocketNameTooLong(sockName)) {
|
||||
logger.error(
|
||||
"Socket name is too long, browser connection won't be possible, probably OS username is very long.",
|
||||
sockName
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
server = net.createServer((socket) => {
|
||||
socketId++;
|
||||
|
||||
logger.info(`New connection with socket ${socketId}`);
|
||||
|
||||
connectedSockets.set(socketId, socket);
|
||||
connectedSocketState.set(socket, { socketId });
|
||||
|
||||
checkSocketIdentity(socket);
|
||||
|
||||
socket.on('data', (data) => onSocketData(socket, data));
|
||||
socket.on('close', () => onSocketClose(socket));
|
||||
});
|
||||
server.listen(sockName);
|
||||
|
||||
logger.info('Started');
|
||||
}
|
||||
|
||||
function browserExtensionConnectorStop() {
|
||||
for (const socket of connectedSockets.values()) {
|
||||
socket.destroy();
|
||||
}
|
||||
if (server) {
|
||||
server.close();
|
||||
server = null;
|
||||
}
|
||||
connectedSockets = new Map();
|
||||
connectedSocketState = new WeakMap();
|
||||
logger.info('Stopped');
|
||||
}
|
||||
|
||||
function browserExtensionConnectorSocketResult(e, socketId, result) {
|
||||
sendResultToSocket(socketId, result);
|
||||
}
|
||||
|
||||
function browserExtensionConnectorSocketEvent(e, data) {
|
||||
sendEventToAllSockets(data);
|
||||
}
|
||||
|
||||
function getBrowserExtensionSocketName(config) {
|
||||
const { username, uid } = os.userInfo();
|
||||
if (process.platform === 'darwin') {
|
||||
const appleTeamId = config.appleTeamId;
|
||||
return `/Users/${username}/Library/Group Containers/${appleTeamId}.keeweb/conn.sock`;
|
||||
} else if (process.platform === 'win32') {
|
||||
return `\\\\.\\pipe\\keeweb-connect-${username}`;
|
||||
} else {
|
||||
const sockFileName = `keeweb-connect-${uid}.sock`;
|
||||
return path.join(app.getPath('temp'), sockFileName);
|
||||
}
|
||||
}
|
||||
|
||||
function prepareBrowserExtensionSocket(config) {
|
||||
return new Promise((resolve) => {
|
||||
if (process.platform === 'darwin') {
|
||||
const sockName = getBrowserExtensionSocketName(config);
|
||||
fs.access(sockName, fs.constants.F_OK, (err) => {
|
||||
if (err) {
|
||||
const dir = path.dirname(sockName);
|
||||
fs.mkdir(dir, () => resolve());
|
||||
} else {
|
||||
fs.unlink(sockName, () => resolve());
|
||||
}
|
||||
});
|
||||
} else if (process.platform === 'win32') {
|
||||
return resolve();
|
||||
} else {
|
||||
fs.unlink(getBrowserExtensionSocketName(config), () => resolve());
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function isSocketNameTooLong(socketName) {
|
||||
const maxLength = process.platform === 'win32' ? 256 : 104;
|
||||
return socketName.length > maxLength;
|
||||
}
|
||||
|
||||
function checkSocketIdentity(socket) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (!state) {
|
||||
return;
|
||||
}
|
||||
|
||||
// TODO: implement this
|
||||
|
||||
state.active = true;
|
||||
state.appName = 'TODO';
|
||||
state.extensionName = 'TODO';
|
||||
state.pid = 0;
|
||||
state.supportsNotifications = state.appName !== 'Safari';
|
||||
|
||||
logger.info(
|
||||
`Socket ${state.socketId} activated`,
|
||||
`app: ${state.appName}`,
|
||||
`extension: ${state.extensionName}`,
|
||||
`pid: ${state.pid}`
|
||||
);
|
||||
|
||||
sendToRenderer('browserExtensionSocketConnected', state.socketId, {
|
||||
connectionId: state.socketId,
|
||||
appName: state.appName,
|
||||
extensionName: state.extensionName,
|
||||
pid: state.pid,
|
||||
supportsNotifications: state.supportsNotifications
|
||||
});
|
||||
|
||||
processPendingSocketData(socket);
|
||||
}
|
||||
|
||||
function onSocketClose(socket) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
connectedSocketState.delete(socket);
|
||||
|
||||
if (state?.socketId) {
|
||||
connectedSockets.delete(state.socketId);
|
||||
sendToRenderer('browserExtensionSocketClosed', state.socketId);
|
||||
}
|
||||
|
||||
logger.info(`Socket ${state?.socketId} closed`);
|
||||
}
|
||||
|
||||
function onSocketData(socket, data) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (!state) {
|
||||
logger.warn('Received data without connection state');
|
||||
return;
|
||||
}
|
||||
|
||||
if (data.byteLength > MaxIncomingDataLength) {
|
||||
logger.warn(`Too many bytes rejected from socket ${state.socketId}`, data.byteLength);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
if (state.pendingData) {
|
||||
state.pendingData = Buffer.concat([state.pendingData, data]);
|
||||
} else {
|
||||
state.pendingData = data;
|
||||
}
|
||||
processPendingSocketData(socket);
|
||||
}
|
||||
|
||||
async function processPendingSocketData(socket) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (!state?.active) {
|
||||
return;
|
||||
}
|
||||
if (!state.pendingData || state.processingData) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (state.pendingData.length < 4) {
|
||||
return;
|
||||
}
|
||||
|
||||
const lengthBuffer = state.pendingData.buffer.slice(
|
||||
state.pendingData.byteOffset,
|
||||
state.pendingData.byteOffset + 4
|
||||
);
|
||||
const length = new Uint32Array(lengthBuffer)[0];
|
||||
|
||||
if (length > MaxIncomingDataLength) {
|
||||
logger.warn(`Large message rejected from socket ${state.socketId}`, length);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
|
||||
if (state.pendingData.byteLength < length + 4) {
|
||||
return;
|
||||
}
|
||||
|
||||
const messageBytes = state.pendingData.slice(4, length + 4);
|
||||
if (state.pendingData.byteLength > length + 4) {
|
||||
state.pendingData = state.pendingData.slice(length + 4);
|
||||
} else {
|
||||
state.pendingData = null;
|
||||
}
|
||||
|
||||
const str = messageBytes.toString();
|
||||
let request;
|
||||
try {
|
||||
request = JSON.parse(str);
|
||||
} catch {
|
||||
logger.warn(`Failed to parse message from socket ${state.socketId}`, str);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
|
||||
logger.debug(`Extension[${state.socketId}] -> KeeWeb`, request);
|
||||
|
||||
if (!request) {
|
||||
logger.warn(`Empty request for socket ${state.socketId}`, request);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
|
||||
if (request.clientID) {
|
||||
const clientId = request.clientID;
|
||||
if (!state.clientId) {
|
||||
state.clientId = clientId;
|
||||
} else if (state.clientId !== clientId) {
|
||||
logger.warn(
|
||||
`Changing client ID for socket ${state.socketId} is not allowed`,
|
||||
`${state.clientId} => ${clientId}`
|
||||
);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
} else {
|
||||
if (request.action !== 'ping') {
|
||||
logger.warn(`Empty client ID in socket request ${state.socketId}`, request);
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
state.processingData = true;
|
||||
|
||||
sendToRenderer('browserExtensionSocketRequest', state.socketId, request);
|
||||
}
|
||||
|
||||
function sendResultToSocket(socketId, result) {
|
||||
const socket = connectedSockets.get(socketId);
|
||||
if (socket) {
|
||||
sendMessageToSocket(socket, result);
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (state.processingData) {
|
||||
state.processingData = false;
|
||||
processPendingSocketData(socket);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function sendEventToAllSockets(data) {
|
||||
for (const socket of connectedSockets.values()) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (state?.active && state?.supportsNotifications) {
|
||||
sendMessageToSocket(socket, data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function sendMessageToSocket(socket, message) {
|
||||
const state = connectedSocketState.get(socket);
|
||||
if (!state) {
|
||||
logger.warn('Ignoring a socket message without connection state');
|
||||
return;
|
||||
}
|
||||
if (!state.active) {
|
||||
logger.warn(`Ignoring a message to inactive socket ${state.socketId}`);
|
||||
return;
|
||||
}
|
||||
|
||||
logger.debug(`KeeWeb -> Extension[${state.socketId}]`, message);
|
||||
|
||||
const responseData = Buffer.from(JSON.stringify(message));
|
||||
const lengthBuf = Buffer.from(new Uint32Array([responseData.byteLength]).buffer);
|
||||
const lengthBytes = Buffer.from(lengthBuf);
|
||||
const data = Buffer.concat([lengthBytes, responseData]);
|
||||
|
||||
socket.write(data);
|
||||
}
|
||||
|
||||
function sendToRenderer(event, socketId, data) {
|
||||
app.getMainWindow().webContents.send(event, socketId, data);
|
||||
}
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
const { app } = require('electron');
|
||||
|
||||
function log(name, level, ...args) {
|
||||
const mainWindow = app.getMainWindow();
|
||||
mainWindow.webContents.send('log', name, level, ...args);
|
||||
}
|
||||
|
||||
class Logger {
|
||||
constructor(name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
debug(...args) {
|
||||
log(this.name, 'debug', ...args);
|
||||
}
|
||||
|
||||
info(...args) {
|
||||
log(this.name, 'info', ...args);
|
||||
}
|
||||
|
||||
warn(...args) {
|
||||
log(this.name, 'warn', ...args);
|
||||
}
|
||||
|
||||
error(...args) {
|
||||
log(this.name, 'error', ...args);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { Logger };
|
||||
Loading…
Reference in New Issue