Fabio/webssh2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: lint ./app/server/socket.js #242

Browse source
This commit is contained in:
Bill Church 2021-05-17 06:43:28 -04:00
parent 3d7e1d68cd
commit 545d503e91
1 changed files with 136 additions and 129 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

265
app/server/socket.js
View file

@ -1,136 +1,172 @@
/* eslint-disable complexity */ /* eslint-disable complexity */
'use strict' /* eslint no-unused-expressions: ["error", { "allowShortCircuit": true, "allowTernary": true }],
no-console: ["error", { allow: ["warn", "error"] }] */
/* jshint esversion: 6, asi: true, node: true */ /* jshint esversion: 6, asi: true, node: true */
// socket.js // socket.js
// private // private
var debug = require('debug') const debug = require('debug');
var debugWebSSH2 = require('debug')('WebSSH2') const debugWebSSH2 = require('debug')('WebSSH2');
var SSH = require('ssh2').Client const SSH = require('ssh2').Client;
var CIDRMatcher = require('cidr-matcher') const CIDRMatcher = require('cidr-matcher');
// var fs = require('fs') // var fs = require('fs')
// var hostkeys = JSON.parse(fs.readFileSync('./hostkeyhashes.json', 'utf8')) // var hostkeys = JSON.parse(fs.readFileSync('./hostkeyhashes.json', 'utf8'))
var termCols, termRows let termCols;
var menuData = '<a id="logBtn"><i class="fas fa-clipboard fa-fw"></i> Start Log</a>' + let termRows;
'<a id="downloadLogBtn"><i class="fas fa-download fa-fw"></i> Download Log</a>' const menuData = '<a id="logBtn"><i class="fas fa-clipboard fa-fw"></i> Start Log</a>'
+ '<a id="downloadLogBtn"><i class="fas fa-download fa-fw"></i> Download Log</a>';
// public // public
module.exports = function socket (socket) { module.exports = function appSocket(socket) {
// if websocket connection arrives without an express session, kill it // if websocket connection arrives without an express session, kill it
if (!socket.request.session) { if (!socket.request.session) {
socket.emit('401 UNAUTHORIZED') socket.emit('401 UNAUTHORIZED');
debugWebSSH2('SOCKET: No Express Session / REJECTED') debugWebSSH2('SOCKET: No Express Session / REJECTED');
socket.disconnect(true) socket.disconnect(true);
return return;
} }
function SSHerror(myFunc, err) {
let theError;
if (socket.request.session) {
// we just want the first error of the session to pass to the client
const firstError = (socket.request.session.error)
|| ((err) ? err.message : undefined);
theError = (firstError) ? `: ${firstError}` : '';
// log unsuccessful login attempt
if (err && (err.level === 'client-authentication')) {
console.error(`WebSSH2 ${'error: Authentication failure'.red.bold
} user=${socket.request.session.username.yellow.bold.underline
} from=${socket.handshake.address.yellow.bold.underline}`);
socket.emit('allowreauth', socket.request.session.ssh.allowreauth);
socket.emit('reauth');
} else {
// eslint-disable-next-line no-console
console.log(`WebSSH2 Logout: user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host} port=${socket.request.session.ssh.port} sessionID=${socket.request.sessionID}/${socket.id} allowreplay=${socket.request.session.ssh.allowreplay} term=${socket.request.session.ssh.term}`);
if (err) {
theError = (err) ? `: ${err.message}` : '';
console.error(`WebSSH2 error${theError}`);
}
}
socket.emit('ssherror', `SSH ${myFunc}${theError}`);
socket.request.session.destroy();
socket.disconnect(true);
} else {
theError = (err) ? `: ${err.message}` : '';
socket.disconnect(true);
}
debugWebSSH2(`SSHerror ${myFunc}${theError}`);
}
// If configured, check that requsted host is in a permitted subnet // If configured, check that requsted host is in a permitted subnet
if ((((socket.request.session || {}).ssh || {}).allowedSubnets || {}).length && (socket.request.session.ssh.allowedSubnets.length > 0)) { if ((((socket.request.session || {}).ssh || {}).allowedSubnets || {}).length
var matcher = new CIDRMatcher(socket.request.session.ssh.allowedSubnets) && (socket.request.session.ssh.allowedSubnets.length > 0)) {
const matcher = new CIDRMatcher(socket.request.session.ssh.allowedSubnets);
if (!matcher.contains(socket.request.session.ssh.host)) { if (!matcher.contains(socket.request.session.ssh.host)) {
console.log('WebSSH2 ' + 'error: Requested host outside configured subnets / REJECTED'.red.bold + console.error(`WebSSH2 ${'error: Requested host outside configured subnets / REJECTED'.red.bold
' user=' + socket.request.session.username.yellow.bold.underline + } user=${socket.request.session.username.yellow.bold.underline
' from=' + socket.handshake.address.yellow.bold.underline) } from=${socket.handshake.address.yellow.bold.underline}`);
socket.emit('ssherror', '401 UNAUTHORIZED') socket.emit('ssherror', '401 UNAUTHORIZED');
socket.disconnect(true) socket.disconnect(true);
return return;
} }
} }
var conn = new SSH() const conn = new SSH();
socket.on('geometry', function socketOnGeometry (cols, rows) { socket.on('geometry', (cols, rows) => {
termCols = cols termCols = cols;
termRows = rows termRows = rows;
}) });
conn.on('banner', function connOnBanner (data) { conn.on('banner', (data) => {
// need to convert to cr/lf for proper formatting // need to convert to cr/lf for proper formatting
data = data.replace(/\r?\n/g, '\r\n') socket.emit('data', data.replace(/\r?\n/g, '\r\n').toString('utf-8'));
socket.emit('data', data.toString('utf-8')) });
})
conn.on('ready', function connOnReady () { conn.on('ready', () => {
console.log('WebSSH2 Login: user=' + socket.request.session.username + ' from=' + socket.handshake.address + ' host=' + socket.request.session.ssh.host + ' port=' + socket.request.session.ssh.port + ' sessionID=' + socket.request.sessionID + '/' + socket.id + ' mrhsession=' + socket.request.session.ssh.mrhsession + ' allowreplay=' + socket.request.session.ssh.allowreplay + ' term=' + socket.request.session.ssh.term) debugWebSSH2(`WebSSH2 Login: user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host} port=${socket.request.session.ssh.port} sessionID=${socket.request.sessionID}/${socket.id} mrhsession=${socket.request.session.ssh.mrhsession} allowreplay=${socket.request.session.ssh.allowreplay} term=${socket.request.session.ssh.term}`);
socket.emit('menu', menuData) socket.emit('menu', menuData);
socket.emit('allowreauth', socket.request.session.ssh.allowreauth) socket.emit('allowreauth', socket.request.session.ssh.allowreauth);
socket.emit('setTerminalOpts', socket.request.session.ssh.terminal) socket.emit('setTerminalOpts', socket.request.session.ssh.terminal);
socket.emit('title', 'ssh://' + socket.request.session.ssh.host) socket.emit('title', `ssh://${socket.request.session.ssh.host}`);
if (socket.request.session.ssh.header.background) socket.emit('headerBackground', socket.request.session.ssh.header.background) if (socket.request.session.ssh.header.background) socket.emit('headerBackground', socket.request.session.ssh.header.background);
if (socket.request.session.ssh.header.name) socket.emit('header', socket.request.session.ssh.header.name) if (socket.request.session.ssh.header.name) socket.emit('header', socket.request.session.ssh.header.name);
socket.emit('footer', 'ssh://' + socket.request.session.username + '@' + socket.request.session.ssh.host + ':' + socket.request.session.ssh.port) socket.emit('footer', `ssh://${socket.request.session.username}@${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`);
socket.emit('status', 'SSH CONNECTION ESTABLISHED') socket.emit('status', 'SSH CONNECTION ESTABLISHED');
socket.emit('statusBackground', 'green') socket.emit('statusBackground', 'green');
socket.emit('allowreplay', socket.request.session.ssh.allowreplay) socket.emit('allowreplay', socket.request.session.ssh.allowreplay);
conn.shell({ conn.shell({
term: socket.request.session.ssh.term, term: socket.request.session.ssh.term,
cols: termCols, cols: termCols,
rows: termRows rows: termRows,
}, function connShell (err, stream) { }, (err, stream) => {
if (err) { if (err) {
SSHerror('EXEC ERROR' + err) SSHerror(`EXEC ERROR${err}`);
conn.end() conn.end();
return return;
} }
// poc to log commands from client // poc to log commands from client
if (socket.request.session.ssh.serverlog.client) var dataBuffer // if (socket.request.session.ssh.serverlog.client) var dataBuffer;
socket.on('data', function socketOnData (data) { socket.on('data', (data) => {
stream.write(data) stream.write(data);
// poc to log commands from client // poc to log commands from client
if (socket.request.session.ssh.serverlog.client) { /* if (socket.request.session.ssh.serverlog.client) {
if (data === '\r') { if (data === '\r') {
console.log('serverlog.client: ' + socket.request.session.id + '/' + socket.id + ' host: ' + socket.request.session.ssh.host + ' command: ' + dataBuffer) console.log(`serverlog.client: ${socket.request.session.id}/${socket.id}
dataBuffer = undefined host: ${socket.request.session.ssh.host} command: ${dataBuffer}`);
dataBuffer = undefined;
} else { } else {
dataBuffer = (dataBuffer) ? dataBuffer + data : data dataBuffer = (dataBuffer) ? dataBuffer + data : data;
} }
} } */
}) });
socket.on('control', function socketOnControl (controlData) { socket.on('control', (controlData) => {
switch (controlData) { switch (controlData) {
case 'replayCredentials': case 'replayCredentials':
if (socket.request.session.ssh.allowreplay) { if (socket.request.session.ssh.allowreplay) {
stream.write(socket.request.session.userpassword + '\n') stream.write(`${socket.request.session.userpassword}\n`);
} }
/* falls through */ /* falls through */
default: default:
console.log('controlData: ' + controlData) debugWebSSH2(`controlData: ${controlData}`);
} }
}) });
socket.on('resize', function socketOnResize (data) { socket.on('resize', (data) => {
stream.setWindow(data.rows, data.cols) stream.setWindow(data.rows, data.cols);
}) });
socket.on('disconnecting', function socketOnDisconnecting (reason) { debugWebSSH2('SOCKET DISCONNECTING: ' + reason) }) socket.on('disconnecting', (reason) => { debugWebSSH2(`SOCKET DISCONNECTING: ${reason}`); });
socket.on('disconnect', function socketOnDisconnect (reason) { socket.on('disconnect', (reason) => {
debugWebSSH2('SOCKET DISCONNECT: ' + reason) debugWebSSH2(`SOCKET DISCONNECT: ${reason}`);
err = { message: reason } const errMsg = { message: reason };
SSHerror('CLIENT SOCKET DISCONNECT', err) SSHerror('CLIENT SOCKET DISCONNECT', errMsg);
conn.end() conn.end();
// socket.request.session.destroy() // socket.request.session.destroy()
}) });
socket.on('error', function socketOnError (err) { socket.on('error', (errMsg) => {
SSHerror('SOCKET ERROR', err) SSHerror('SOCKET ERROR', errMsg);
conn.end() conn.end();
}) });
stream.on('data', function streamOnData (data) { socket.emit('data', data.toString('utf-8')) }) stream.on('data', (data) => { socket.emit('data', data.toString('utf-8')); });
stream.on('close', function streamOnClose (code, signal) { stream.on('close', (code, signal) => {
err = { message: ((code || signal) ? (((code) ? 'CODE: ' + code : '') + ((code && signal) ? ' ' : '') + ((signal) ? 'SIGNAL: ' + signal : '')) : undefined) } const errMsg = { message: ((code || signal) ? (((code) ? `CODE: ${code}` : '') + ((code && signal) ? ' ' : '') + ((signal) ? `SIGNAL: ${signal}` : '')) : undefined) };
SSHerror('STREAM CLOSE', err) SSHerror('STREAM CLOSE', errMsg);
conn.end() conn.end();
}) });
stream.stderr.on('data', function streamStderrOnData (data) { stream.stderr.on('data', (data) => {
console.log('STDERR: ' + data) console.error(`STDERR: ${data}`);
}) });
}) });
}) });
conn.on('end', function connOnEnd (err) { SSHerror('CONN END BY HOST', err) }) conn.on('end', (err) => { SSHerror('CONN END BY HOST', err); });
conn.on('close', function connOnClose (err) { SSHerror('CONN CLOSE', err) }) conn.on('close', (err) => { SSHerror('CONN CLOSE', err); });
conn.on('error', function connOnError (err) { SSHerror('CONN ERROR', err) }) conn.on('error', (err) => { SSHerror('CONN ERROR', err); });
conn.on('keyboard-interactive', function connOnKeyboardInteractive (name, instructions, instructionsLang, prompts, finish) { conn.on('keyboard-interactive', (name, instructions, instructionsLang, prompts, finish) => {
debugWebSSH2('conn.on(\'keyboard-interactive\')') debugWebSSH2('conn.on(\'keyboard-interactive\')');
finish([socket.request.session.userpassword]) finish([socket.request.session.userpassword]);
}) });
if (socket.request.session.username && (socket.request.session.userpassword || socket.request.session.privatekey) && socket.request.session.ssh) { if (socket.request.session.username
&& (socket.request.session.userpassword || socket.request.session.privatekey)
&& socket.request.session.ssh) {
// console.log('hostkeys: ' + hostkeys[0].[0]) // console.log('hostkeys: ' + hostkeys[0].[0])
conn.connect({ conn.connect({
host: socket.request.session.ssh.host, host: socket.request.session.ssh.host,
@ -145,13 +181,13 @@ module.exports = function socket (socket) {
readyTimeout: socket.request.session.ssh.readyTimeout, readyTimeout: socket.request.session.ssh.readyTimeout,
keepaliveInterval: socket.request.session.ssh.keepaliveInterval, keepaliveInterval: socket.request.session.ssh.keepaliveInterval,
keepaliveCountMax: socket.request.session.ssh.keepaliveCountMax, keepaliveCountMax: socket.request.session.ssh.keepaliveCountMax,
debug: debug('ssh2') debug: debug('ssh2'),
}) });
} else { } else {
debugWebSSH2('Attempt to connect without session.username/password or session varialbles defined, potentially previously abandoned client session. disconnecting websocket client.\r\nHandshake information: \r\n ' + JSON.stringify(socket.handshake)) debugWebSSH2(`Attempt to connect without session.username/password or session varialbles defined, potentially previously abandoned client session. disconnecting websocket client.\r\nHandshake information: \r\n ${JSON.stringify(socket.handshake)}`);
socket.emit('ssherror', 'WEBSOCKET ERROR - Refresh the browser and try again') socket.emit('ssherror', 'WEBSOCKET ERROR - Refresh the browser and try again');
socket.request.session.destroy() socket.request.session.destroy();
socket.disconnect(true) socket.disconnect(true);
} }
/** /**
@ -161,33 +197,4 @@ module.exports = function socket (socket) {
* @param {object} err error object or error message * @param {object} err error object or error message
*/ */
// eslint-disable-next-line complexity // eslint-disable-next-line complexity
function SSHerror (myFunc, err) { };
var theError
if (socket.request.session) {
// we just want the first error of the session to pass to the client
socket.request.session.error = (socket.request.session.error) || ((err) ? err.message : undefined)
theError = (socket.request.session.error) ? ': ' + socket.request.session.error : ''
// log unsuccessful login attempt
if (err && (err.level === 'client-authentication')) {
console.log('WebSSH2 ' + 'error: Authentication failure'.red.bold +
' user=' + socket.request.session.username.yellow.bold.underline +
' from=' + socket.handshake.address.yellow.bold.underline)
socket.emit('allowreauth', socket.request.session.ssh.allowreauth)
socket.emit('reauth')
} else {
console.log('WebSSH2 Logout: user=' + socket.request.session.username + ' from=' + socket.handshake.address + ' host=' + socket.request.session.ssh.host + ' port=' + socket.request.session.ssh.port + ' sessionID=' + socket.request.sessionID + '/' + socket.id + ' allowreplay=' + socket.request.session.ssh.allowreplay + ' term=' + socket.request.session.ssh.term)
if (err) {
theError = (err) ? ': ' + err.message : ''
console.log('WebSSH2 error' + theError)
}
}
socket.emit('ssherror', 'SSH ' + myFunc + theError)
socket.request.session.destroy()
socket.disconnect(true)
} else {
theError = (err) ? ': ' + err.message : ''
socket.disconnect(true)
}
debugWebSSH2('SSHerror ' + myFunc + theError)
}
}