/** * This is the Socket.IO Router. It routes the Messages between the * components of the Server. The components are at the moment: pad and timeslider */ /* * 2011 Peter 'Pita' Martischka (Primary Technology Ltd) * * Licensed 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. */ var log4js = require('log4js'); var messageLogger = log4js.getLogger("message"); var securityManager = require("../db/SecurityManager"); var readOnlyManager = require("../db/ReadOnlyManager"); var remoteAddress = require("../utils/RemoteAddress").remoteAddress; var settings = require('../utils/Settings'); /** * Saves all components * key is the component name * value is the component module */ var components = {}; var socket; /** * adds a component */ exports.addComponent = function(moduleName, module) { // save the component components[moduleName] = module; // give the module the socket module.setSocketIO(socket); } /** * sets the socket.io and adds event functions for routing */ exports.setSocketIO = function(_socket) { // save this socket internaly socket = _socket; socket.sockets.on('connection', function(client) { // Broken: See http://stackoverflow.com/questions/4647348/send-message-to-specific-client-with-socket-io-and-node-js // Fixed by having a persistant object, ideally this would actually be in the database layer // TODO move to database layer if (settings.trustProxy && client.handshake.headers['x-forwarded-for'] !== undefined) { remoteAddress[client.id] = client.handshake.headers['x-forwarded-for']; } else { remoteAddress[client.id] = client.handshake.address; } var clientAuthorized = false; // wrap the original send function to log the messages client._send = client.send; client.send = function(message) { messageLogger.debug("to " + client.id + ": " + stringifyWithoutPassword(message)); client._send(message); } // tell all components about this connect for (let i in components) { components[i].handleConnect(client); } client.on('message', async function(message) { if (message.protocolVersion && message.protocolVersion != 2) { messageLogger.warn("Protocolversion header is not correct:" + stringifyWithoutPassword(message)); return; } if (clientAuthorized) { // client is authorized, everything ok handleMessage(client, message); } else { // try to authorize the client if (message.padId !== undefined && message.sessionID !== undefined && message.token !== undefined && message.password !== undefined) { // check for read-only pads let padId = message.padId; if (padId.indexOf("r.") === 0) { padId = await readOnlyManager.getPadId(message.padId); } let { accessStatus } = await securityManager.checkAccess(padId, message.sessionID, message.token, message.password); if (accessStatus === "grant") { // access was granted, mark the client as authorized and handle the message clientAuthorized = true; handleMessage(client, message); } else { // no access, send the client a message that tells him why messageLogger.warn("Authentication try failed:" + stringifyWithoutPassword(message)); client.json.send({ accessStatus }); } } else { // drop message messageLogger.warn("Dropped message because of bad permissions:" + stringifyWithoutPassword(message)); } } }); client.on('disconnect', function() { // tell all components about this disconnect for (let i in components) { components[i].handleDisconnect(client); } }); }); } // try to handle the message of this client function handleMessage(client, message) { if (message.component && components[message.component]) { // check if component is registered in the components array if (components[message.component]) { messageLogger.debug("from " + client.id + ": " + stringifyWithoutPassword(message)); components[message.component].handleMessage(client, message); } } else { messageLogger.error("Can't route the message:" + stringifyWithoutPassword(message)); } } // returns a stringified representation of a message, removes the password // this ensures there are no passwords in the log function stringifyWithoutPassword(message) { let newMessage = Object.assign({}, message); if (newMessage.password != null) { newMessage.password = "xxx"; } return JSON.stringify(newMessage); }