plugins-evert/debug/plugin.ts

117 lines
3.3 KiB
TypeScript
Raw Normal View History

2020-12-05 10:00:00 +00:00
import util from 'util';
import cprog from 'child_process';
import {
Plugin,
Configurable,
EventListener,
DependencyLoad
} from '@squeebot/core/lib/plugin';
2020-12-13 10:16:49 +00:00
import { IMessage, MessageResolver } from '@squeebot/core/lib/types';
2020-12-05 10:00:00 +00:00
import { ISqueebotCore, logger } from '@squeebot/core/lib/core';
function addCommands(plugin: UtilityPlugin, commands: any): void {
const cmds = [{
plugin: plugin.manifest.name,
name: 'evaljs',
2020-12-13 10:16:49 +00:00
execute: async (msg: IMessage, msr: MessageResolver, spec: any, prefix: string, ...simplified: any[]): Promise<boolean> => {
2020-12-05 10:00:00 +00:00
if (!simplified[0]) {
return true;
}
2020-12-05 16:14:35 +00:00
const script = simplified.join(' ');
2020-12-05 10:00:00 +00:00
// Disallow child_process when shell is disallowed
if ((script.indexOf('child_process') !== -1 ||
script.indexOf('cprog') !== -1 ||
script.indexOf('fork') !== -1) &&
!plugin.config.config.allowShell) {
msg.resolve('Error: child_process is not allowed in evaljs due to security reasons.');
return true;
}
try {
const mesh = eval(script);
if (mesh === undefined) {
return true;
}
msg.resolve(util.format(mesh));
} catch (e: any) {
2020-12-05 10:00:00 +00:00
msg.resolve('Error: ' + e.message);
}
return true;
},
usage: '<javascript>',
description: 'Execute JavaScript in a command context',
permissions: ['system_execute'],
hidden: true
}];
if (plugin.config.config.allowShell) {
logger.warn('WARNING! Shell command execution is enabled! Make absolutely sure that there is proper authentication!');
if (process.getuid && process.getuid() === 0) {
logger.warn('NEVER run Squeebot as root! Run `useradd squeebot`! We are not responsible for possible security leaks!');
}
cmds.push({
plugin: plugin.manifest.name,
name: 'sh',
2020-12-13 10:16:49 +00:00
execute: async (msg: IMessage, msr: MessageResolver, spec: any, prefix: string, ...simplified: any[]): Promise<boolean> => {
2020-12-05 10:00:00 +00:00
const stripnl = (simplified[0] !== '-n');
const cmd = simplified.slice(stripnl ? 0 : 1).join(' ');
if (!cmd) {
msg.resolve('Nothing to execute!');
return true;
}
cprog.exec(cmd, {shell: '/bin/bash'}, (error, stdout, stderr) => {
if (stdout) {
if (stripnl) { stdout = stdout.replace(/\n/g, ' ;; '); }
return msg.resolve(stdout);
}
msg.resolve('Error executing command.');
logger.error(stderr || error);
});
return true;
},
description: 'Run raw shell command',
usage: '<shell>',
hidden: true,
permissions: ['system_shell'],
});
}
commands.registerCommand(cmds);
}
@Configurable({
allowShell: false,
})
class UtilityPlugin extends Plugin {
public core: ISqueebotCore | null = null;
@DependencyLoad('simplecommands')
addCommands(cmd: any): void {
addCommands(this, cmd);
}
@EventListener('pluginUnload')
public unloadEventHandler(plugin: string | Plugin): void {
if (plugin === this.name || plugin === this) {
2021-10-02 09:31:46 +00:00
this.emit('pluginUnloaded', this);
2020-12-05 10:00:00 +00:00
}
}
initialize(): void {
this.on('core', (c: ISqueebotCore) => this.core = c);
this.emitTo('core', 'request-core', this.name);
}
}
module.exports = UtilityPlugin;