feat: consistent logs

[billchurch]

logging is somewhat inconsistent throughout the code, working to make things more consistent

[billchurch]

log messages to be prefixed with:

WebSSH2 (<express session id>/<socket.io session id>) (<type>): <message>

Example:

WebSSH2 (48C6PpHh4efNC2nK9S8BhM8xA8tGLTq8/ZN5nZc2gsZEBQTVFAAAF) AUDIT: LOGIN user=root from=127.0.0.1 host=192.168.0.1:22

[billchurch]

Debug messages planned to follow similar format

  WebSSH2 (DUN2aRdg2k7zLWMrQfPR3iWs3sNOVWZI/dAnsjbLTgOakVC2UAAAB) SOCKET DISCONNECTING: server namespace disconnect +0ms
  WebSSH2 (DUN2aRdg2k7zLWMrQfPR3iWs3sNOVWZI/dAnsjbLTgOakVC2UAAAB) CONN END BY HOST +0ms
  WebSSH2 (DUN2aRdg2k7zLWMrQfPR3iWs3sNOVWZI/dAnsjbLTgOakVC2UAAAB) CONN CLOSE +0ms

[billchurch]

reworked client js to generate reauth control message to signify termination in order to support a "LOGOUT" log event.

Client:

webssh2/app/client/src/js/index.ts

Lines 63 to 68 in 50cfcb9

	function reauthSession () { // eslint-disable-line
	debug('re-authenticating');
	socket.emit('control', 'reauth');
	window.location.href = '/ssh/reauth';
	return false;
	}

Server:

webssh2/app/server/socket.js

Lines 172 to 184 in 50cfcb9

	socket.on('control', (controlData) => {
	if (controlData === 'replayCredentials' && socket.request.session.ssh.allowreplay) {
	stream.write(`${socket.request.session.userpassword}\n`);
	}
	if (controlData === 'reauth' && socket.request.session.username && login === true) {
	auditLog(
	socket,
	`LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
	);
	login = false;
	conn.end();
	socket.disconnect(true);
	}

[billchurch]

Addition of login variable to track the state of the users login. Mostly to prevent multiple LOGOUT log entries as a "logout" can come from different events depending on how the session is terminated.

webssh2/app/server/socket.js

Line 77 in 78dafeb

let login = false;

webssh2/app/server/socket.js

Lines 84 to 92 in 78dafeb

	socket.once('disconnecting', (reason) => {
	webssh2debug(socket, `SOCKET DISCONNECTING: ${reason}`);
	if (login === true) {
	auditLog(
	socket,
	`LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
	);
	login = false;
	}

webssh2/app/server/socket.js

Lines 116 to 125 in 78dafeb

	conn.on('ready', () => {
	webssh2debug(
	socket,
	`CONN READY: LOGIN: user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host} port=${socket.request.session.ssh.port} allowreplay=${socket.request.session.ssh.allowreplay} term=${socket.request.session.ssh.term}`
	);
	auditLog(
	socket,
	`LOGIN user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
	);
	login = true;

webssh2/app/server/socket.js

Lines 169 to 177 in 78dafeb

	if (controlData === 'reauth' && socket.request.session.username && login === true) {
	auditLog(
	socket,
	`LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
	);
	login = false;
	conn.end();
	socket.disconnect(true);
	}

webssh2/app/server/socket.js

Lines 190 to 203 in 78dafeb

	stream.on('close', (code, signal) => {
	webssh2debug(socket, `STREAM CLOSE: ${util.inspect([code, signal])}`);
	if (socket.request.session?.username && login === true) {
	auditLog(
	socket,
	`LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
	);
	login = false;
	}
	if (code !== 0 && typeof code !== 'undefined')
	logError(socket, 'STREAM CLOSE', util.inspect({ message: [code, signal] }));
	socket.disconnect(true);
	conn.end();
	});

[billchurch]

While, I have the logging "consistent" for the messages that are output. It's maybe not industry standard of any sort.

Feedback welcome for the format... For reference: https://www.graylog.org/post/log-formats-a-complete-guide