From 19a9f82fe1b740bc9f4aeeae1ac67dcac32d4fac Mon Sep 17 00:00:00 2001 From: "alejandro.campos@artica.es" Date: Mon, 25 Sep 2023 19:08:24 +0200 Subject: [PATCH] gotty changes --- pandora_console/extensions/quick_shell.php | 692 +++++++++++------- .../extras/delete_files/delete_files.txt | 3 +- pandora_console/godmode/menu.php | 2 +- pandora_console/godmode/setup/setup.php | 4 +- .../godmode/setup/setup_websocket_engine.php | 96 +-- pandora_console/pandora_websocket_engine | 175 ----- 6 files changed, 442 insertions(+), 530 deletions(-) delete mode 100755 pandora_console/pandora_websocket_engine diff --git a/pandora_console/extensions/quick_shell.php b/pandora_console/extensions/quick_shell.php index 7e6db3271e..cd863f6b10 100644 --- a/pandora_console/extensions/quick_shell.php +++ b/pandora_console/extensions/quick_shell.php @@ -84,84 +84,38 @@ function quickShell() $method_port = get_parameter('port', null); // Retrieve main IP Address. - $address = agents_get_address($agent_id); + $agent_address = agents_get_address($agent_id); ui_require_css_file('wizard'); ui_require_css_file('discovery'); - // Settings. - // WebSocket host, where client should connect. - if (isset($config['ws_port']) === false) { - config_update_value('ws_port', 8080); + // Initialize Gotty Client. + if ($method === 'ssh') { + // SSH. + $args = '?arg='.$username.'@'.$agent_address; + //$args = '?arg='.$username.'@172.16.0.1'; + $args .= '&arg=-p%20'.$method_port; + } else if ($method == 'telnet') { + // Telnet. + $username = preg_replace('/[^a-zA-Z0-9\-\.]/', '', $username); + $args = '?arg=-l%20'.$username; + $args .= '&arg='.$agent_address; + $args .= '&arg='.$method_port.'&arg=-E'; } - if (empty($config['ws_proxy_url']) === true) { - $ws_url = 'http://'.$_SERVER['SERVER_ADDR'].':'.$config['ws_port']; - } else { - preg_match('/\/\/(.*)/', $config['ws_proxy_url'], $matches); - if (isset($_SERVER['HTTPS']) === true) { - $ws_url = 'https://'.$matches[1]; - } else { - $ws_url = 'http://'.$matches[1]; - } - } - - // Gotty settings. Internal communication (WS). - if (isset($config['gotty_host']) === false) { - config_update_value('gotty_host', '127.0.0.1'); - } - - if (isset($config['gotty_telnet_port']) === false) { - config_update_value('gotty_telnet_port', 8082); - } - - if (isset($config['gotty_ssh_port']) === false) { - config_update_value('gotty_ssh_port', 8081); - } - - // Context to allow self-signed certs. - $context = stream_context_create( - [ - 'http' => [ 'method' => 'GET'], - 'ssl' => [ - 'verify_peer' => false, - 'verify_peer_name' => false, - ], - ] - ); + $method_addr = ($method === 'ssh') ? $config['gotty_ssh_addr'] : $config['gotty_telnet_addr']; + $address = (empty($method_addr) === true) ? $_SERVER['SERVER_ADDR'] : $method_addr; + $use_ssl = ($method === 'ssh') ? $config['gotty_ssh_use_ssl'] : $config['gotty_telnet_use_ssl']; + $protocol = ((bool) $use_ssl === true) ? 'https://' : 'http://'; + $port = ($method === 'ssh') ? $config['gotty_ssh_port'] : $config['gotty_telnet_port']; + $connection_hash = ($method === 'ssh') ? $config['gotty_ssh_connection_hash'] : $config['gotty_telnet_connection_hash']; + $gotty_addr = $protocol.$address.':'.$port.'/'.$connection_hash.'/'.$args; // Username. Retrieve from form. if (empty($username) === true) { // No username provided, ask for it. $wiz = new Wizard(); - $test = curl($ws_url, []); - if ($test === false) { - ui_print_error_message(__('WebService engine has not been started, please check documentation.')); - $wiz->printForm( - [ - 'form' => [ - 'method' => 'POST', - 'action' => '#', - 'id' => 'retry_form', - ], - ] - ); - - html_print_action_buttons( - html_print_submit_button( - __('Retry'), - 'submit', - false, - [ - 'icon' => 'next', - 'form' => 'retry_form', - ], - true - ) - ); - return; - } $wiz->printForm( [ @@ -221,114 +175,25 @@ function quickShell() return; } - // Initialize Gotty Client. - $host = $config['gotty_host']; - if ($method == 'ssh') { - // SSH. - $port = $config['gotty_ssh_port']; - $command_arguments = "var args = '?arg=".$username.'@'.$address; - $command_arguments .= '&arg=-p '.$method_port."';"; - } else if ($method == 'telnet') { - // Telnet. - $port = $config['gotty_telnet_port']; - $username = preg_replace('/[^a-zA-Z0-9\-\.]/', '', $username); - $command_arguments = "var args = '?arg=-l ".$username; - $command_arguments .= '&arg='.$address; - $command_arguments .= '&arg='.$method_port."&arg=-E';"; - } else { - ui_print_error_message(__('Please use SSH or Telnet.')); - return; - } - - // If rediretion is enabled, we will try to connect using - // http:// or https:// endpoint. - $test = get_headers($ws_url, false, $context); - if ($test === false) { - if (empty($wiz) === true) { - $wiz = new Wizard(); - } - - ui_print_error_message(__('WebService engine has not been started, please check documentation.')); - echo $wiz->printGoBackButton('#'); - return; - } - - // Check credentials. - $auth_str = ''; - $gotty_url = $host.':'.$port; - if (empty($config['gotty_user']) === false - && empty($config['gotty_pass']) === false - ) { - $auth_str = io_safe_output($config['gotty_user']); - $auth_str .= ':'.io_output_password($config['gotty_pass']); - $gotty_url = $auth_str.'@'.$host.':'.$port; - } - - $r = file_get_contents('http://'.$gotty_url.'/js/hterm.js'); - if (empty($r) === true) { - if (empty($wiz) === true) { - $wiz = new Wizard(); - } - - ui_print_error_message(__('WebService engine is not working properly, please check documentation.')); - echo $wiz->printGoBackButton('#'); - return; - } - - // Override gotty client settings. - if (empty($auth_str) === true) { - $r .= "var gotty_auth_token = '';"; - } else { - $r .= "var gotty_auth_token = '"; - $r .= $auth_str."';"; - } - - // Set websocket target and method. - $gotty = file_get_contents('http://'.$gotty_url.'/js/gotty.js'); - $url = "var url = (httpsEnabled ? 'wss://' : 'ws://') + window.location.host + window.location.pathname + 'ws';"; - if (empty($config['ws_proxy_url']) === true) { - $new = "var url = (httpsEnabled ? 'wss://' : 'ws://')"; - $new .= " + window.location.host + ':"; - $new .= $config['ws_port'].'/'.$method."';"; - } else { - $new = "var url = '"; - $new .= $config['ws_proxy_url'].'/'.$method."';"; - } - - // Update firefox issue. - $original = ' this.iframe_.src = \'#\';'; - $trick = 'this.iframe_.src = \'javascript:\';'; - - $r = str_replace($original, $trick, $r); - - // Update url. - $gotty = str_replace($url, $new, $gotty); - - // Update websocket arguments. - $args = 'var args = window.location.search;'; - $new = $command_arguments; - - // Update arguments. - $gotty = str_replace($args, $new, $gotty); - ?> -
- - + +
+ 0) { - $msg = __('%d Updated', $changes); - if ($critical > 0) { - $msg = __( - '%d Updated, please restart WebSocket engine service', - $changes - ); - } - - ui_print_success_message($msg); - } - - // Form. Using old style. echo '
'; - echo ''.__('Quickshell').''; + echo ''.__('SSH connection parameters').''; - $t = new StdClass(); - $t->data = []; - $t->width = '100%'; - $t->class = 'filter-table-adv'; - $t->data = []; - $t->style = []; - $t->style[0] = 'width: 50%;'; + $test_start = ''; + $test_start .= ' '; - $t->data[0][] = html_print_label_input_block( - __('Gotty path'), + $ssh_table = new StdClass(); + $ssh_table->data = []; + $ssh_table->width = '100%'; + $ssh_table->class = 'filter-table-adv'; + $ssh_table->data = []; + $ssh_table->style = []; + $ssh_table->style[0] = 'width: 50%;'; + + $ssh_table->data[0][] = html_print_label_input_block( + __('Gotty address'), html_print_input_text( - 'gotty', - $config['gotty'], + 'gotty_ssh_addr', + $config['gotty_ssh_addr'], '', 30, 100, @@ -464,20 +381,8 @@ function quickShellSettings() ) ); - $t->data[0][] = html_print_label_input_block( - __('Gotty host'), - html_print_input_text( - 'gotty_host', - $config['gotty_host'], - '', - 30, - 100, - true - ) - ); - - $t->data[1][] = html_print_label_input_block( - __('Gotty ssh port'), + $ssh_table->data[0][] = html_print_label_input_block( + __('Gotty port'), html_print_input_text( 'gotty_ssh_port', $config['gotty_ssh_port'], @@ -488,8 +393,88 @@ function quickShellSettings() ) ); - $t->data[1][] = html_print_label_input_block( - __('Gotty telnet port'), + $ssh_table->data[1][] = html_print_label_input_block( + __('Gotty user'), + html_print_input_text( + 'gotty_ssh_user', + $config['gotty_ssh_user'], + '', + 30, + 100, + true + ) + ); + + $ssh_table->data[1][] = html_print_label_input_block( + __('Gotty password'), + html_print_input_password( + 'gotty_ssh_pass', + io_output_password($config['gotty_ssh_pass']), + '', + 30, + 100, + true + ) + ); + + $ssh_table->data[2][] = html_print_label_input_block( + __('Use SSL'), + html_print_checkbox_switch( + 'gotty_ssh_use_ssl', + 1, + $config['gotty_ssh_use_ssl'], + true, + $disable_agentaccess + ) + ); + + // Test. + $row = []; + $test_start = ''; + $test_start .= ' '; + + $ssh_table->data[2][] = html_print_button( + __('Test'), + 'test-gotty-ssh', + false, + 'handleTestSSH()', + [ + 'icon' => 'cog', + 'mode' => 'secondary', + 'style' => 'width: 115px;', + ], + true + ).$test_start; + + html_print_table($ssh_table); + + echo '
'; + + echo '
'; + echo ''.__('Telnet connection parameters').''; + + $telnet_table = new StdClass(); + $telnet_table->data = []; + $telnet_table->width = '100%'; + $telnet_table->class = 'filter-table-adv'; + $telnet_table->data = []; + $telnet_table->style = []; + $telnet_table->style[0] = 'width: 50%;'; + + $telnet_table->data[0][] = html_print_label_input_block( + __('Gotty address'), + html_print_input_text( + 'gotty_telnet_addr', + $config['gotty_telnet_addr'], + '', + 30, + 100, + true + ) + ); + + $telnet_table->data[0][] = html_print_label_input_block( + __('Gotty port'), html_print_input_text( 'gotty_telnet_port', $config['gotty_telnet_port'], @@ -500,18 +485,11 @@ function quickShellSettings() ) ); - $hidden = new stdClass(); - $hidden->data = []; - $hidden->width = '100%'; - $hidden->class = 'filter-table-adv'; - $hidden->data = []; - $hidden->style[0] = 'width: 50%;'; - - $hidden->data[0][] = html_print_label_input_block( + $telnet_table->data[1][] = html_print_label_input_block( __('Gotty user'), html_print_input_text( - 'gotty_user', - $config['gotty_user'], + 'gotty_telnet_user', + $config['gotty_telnet_user'], '', 30, 100, @@ -519,11 +497,11 @@ function quickShellSettings() ) ); - $hidden->data[0][] = html_print_label_input_block( + $telnet_table->data[1][] = html_print_label_input_block( __('Gotty password'), html_print_input_password( - 'gotty_pass', - io_output_password($config['gotty_pass']), + 'gotty_telnet_pass', + io_output_password($config['gotty_telnet_pass']), '', 30, 100, @@ -531,24 +509,71 @@ function quickShellSettings() ) ); - html_print_table($t); - - ui_print_toggle( - [ - 'content' => html_print_table($hidden, true), - 'name' => __('Advanced options'), - 'clean' => false, - 'main_class' => 'no-border-imp', - 'container_class' => 'no-border-imp', - ] + $telnet_table->data[2][] = html_print_label_input_block( + __('Use SSL'), + html_print_checkbox_switch( + 'gotty_telnet_use_ssl', + 1, + $config['gotty_telnet_use_ssl'], + true + ) ); - echo '
'; + // Test. + $row = []; + $test_start = ''; + $test_start .= ' '; + $telnet_table->data[2][] = html_print_button( + __('Test'), + 'test-gotty-telnet', + false, + 'handleTestTelnet()', + [ + 'icon' => 'cog', + 'mode' => 'secondary', + 'style' => 'width: 115px;', + ], + true + ).$test_start; + + html_print_table($telnet_table); + html_print_input_hidden('update_config', 1); + + echo ''; } -// This extension is usefull only if the agent has associated IP. +if (is_ajax() === true) { + $address = get_parameter('address'); + + if (isset($address) === true) { + $ch = curl_init($address); + + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + + // Maximum time for the entire request. + curl_setopt($ch, CURLOPT_TIMEOUT, 2); + + // Maximum time to establish a connection. + curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 1); + + curl_exec($ch); + $response_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); + curl_close($ch); + + if ($response_code === 200 || $response_code === 401) { + $result = ['status' => 'success']; + } else { + $result = ['status' => 'error']; + } + + echo json_encode($result); + return; + } +} + +// This extension is useful only if the agent has associated IP. $agent_id = get_parameter('id_agente'); if (empty($agent_id) === false && get_parameter('sec2', '') == 'operation/agentes/ver_agente' @@ -573,4 +598,139 @@ if (empty($agent_id) === false } } +echo ''; + extensions_add_godmode_function('quickShellSettings'); diff --git a/pandora_console/extras/delete_files/delete_files.txt b/pandora_console/extras/delete_files/delete_files.txt index 26eaa93392..d94207a4c9 100644 --- a/pandora_console/extras/delete_files/delete_files.txt +++ b/pandora_console/extras/delete_files/delete_files.txt @@ -1707,4 +1707,5 @@ enterprise/godmode/wizards/Applications.class.php enterprise/godmode/wizards/Cloud.class.php enterprise/images/wizard/applications.png enterprise/images/wizard/cloud.png -enterprise/images/wizard/consoletasks.png \ No newline at end of file +enterprise/images/wizard/consoletasks.png +pandora_websocket_engine \ No newline at end of file diff --git a/pandora_console/godmode/menu.php b/pandora_console/godmode/menu.php index 7cd504c8ac..da06372b8a 100644 --- a/pandora_console/godmode/menu.php +++ b/pandora_console/godmode/menu.php @@ -485,7 +485,7 @@ if ($access_console_node === true) { $sub2['godmode/setup/setup§ion=notifications']['text'] = __('Notifications'); $sub2['godmode/setup/setup§ion=notifications']['refr'] = 0; - $sub2['godmode/setup/setup§ion=websocket_engine']['text'] = __('Websocket Engine'); + $sub2['godmode/setup/setup§ion=websocket_engine']['text'] = __('QuickShell'); $sub2['godmode/setup/setup§ion=websocket_engine']['refr'] = 0; $sub2['godmode/setup/setup§ion=external_tools']['text'] = __('External Tools'); diff --git a/pandora_console/godmode/setup/setup.php b/pandora_console/godmode/setup/setup.php index 7e17f9fe4c..c1cf635d28 100644 --- a/pandora_console/godmode/setup/setup.php +++ b/pandora_console/godmode/setup/setup.php @@ -227,7 +227,7 @@ $buttons['websocket_engine'] = [ 'images/websocket_small.png', true, [ - 'title' => __('Websocket engine'), + 'title' => __('QuickShell'), 'class' => 'invert_filter', ] ).'', @@ -327,7 +327,7 @@ switch ($section) { case 'websocket_engine': $buttons['websocket_engine']['active'] = true; - $subpage = __('Pandora Websocket Engine'); + $subpage = __('QuickShell'); $help_header = 'quickshell_settings'; break; diff --git a/pandora_console/godmode/setup/setup_websocket_engine.php b/pandora_console/godmode/setup/setup_websocket_engine.php index 5ee134e558..bed6a01ee9 100644 --- a/pandora_console/godmode/setup/setup_websocket_engine.php +++ b/pandora_console/godmode/setup/setup_websocket_engine.php @@ -34,92 +34,20 @@ $url = ui_get_full_url( echo '
'; -echo '
'; -echo ''.__('WebSocket settings').''; - -$t = new StdClass(); -$t->data = []; -$t->width = '100%'; -$t->class = 'databox filter-table-adv'; -$t->data = []; - -$t->data[0][] = html_print_label_input_block( - __('Bind address'), - html_print_input_text( - 'ws_bind_address', - $config['ws_bind_address'], - '', - 30, - 100, - true - ) -); - -$t->data[0][] = html_print_label_input_block( - __('Bind port'), - html_print_input_text( - 'ws_port', - $config['ws_port'], - '', - 30, - 100, - true - ) -); - -$t->data[1][] = html_print_label_input_block( - __('WebSocket proxy url'), - html_print_input_text( - 'ws_proxy_url', - $config['ws_proxy_url'], - '', - 30, - 100, - true - ) -); - -html_print_input_hidden('update_config', 1); - -// Test. -$row = []; -$test_start = ''; -$test_start .= ' '; -$row['gotty_test'] = html_print_label_input_block( - __('Test connection'), - html_print_button( - __('Test'), - 'test-gotty', - false, - 'handleTest()', - [ - 'icon' => 'cog', - 'mode' => 'secondary mini', - 'style' => 'width: 115px;', - ], - true - ).$test_start, - ['div_class' => 'inline_flex row'] -); - -$t->data['gotty_test'] = $row; - -html_print_table($t); - -echo '
'; - if (function_exists('quickShellSettings') === true) { quickShellSettings(); } +$action_btns = html_print_submit_button( + __('Update'), + 'update_button', + false, + [ 'icon' => 'update' ], + true +); + html_print_action_buttons( - html_print_submit_button( - __('Update'), - 'update_button', - false, - [ 'icon' => 'update' ], - true - ) + $action_btns ); echo '
'; @@ -186,10 +114,8 @@ $handle_test_js = "var handleTest = function (event) { hideLoadingImage(); showMessage(); }; -} - - -$('#button-test-ehorus').click(handleTest);"; +}"; echo $handle_test_js; echo ''; + diff --git a/pandora_console/pandora_websocket_engine b/pandora_console/pandora_websocket_engine deleted file mode 100755 index 2d4536aae0..0000000000 --- a/pandora_console/pandora_websocket_engine +++ /dev/null @@ -1,175 +0,0 @@ -#!/bin/bash -# Copyright (c) 2005-2023 Pandora FMS -# -# /etc/init.d/websocket -# -# System startup script for Pandora FMS Console websocket engine -# -# Comments to support chkconfig on RedHat Linux -# chkconfig: 2345 90 10 -# description: Pandora FMS Console webscoket engine startup script -# -# Comments to support LSB init script conventions -### BEGIN INIT INFO -# Provides: websocket -# Required-Start: $syslog cron -# Should-Start: $network cron mysql -# Required-Stop: $syslog -# Should-Stop: $network -# Default-Start: 2 3 5 -# Default-Stop: 0 1 6 -# Short-Description: Pandora FMS Console websocket engine startup script -# Description: Pandora FMS Console websocket engine startup script -### END INIT INFO - -if [ -x /lib/lsb/init-functions ]; then -. /lib/lsb/init-functions -fi - -# If you want to run several pandora Console Websocket engines in this machine, just copy -# this script to another name, editing PANDORA_HOME to the new .conf - -export WS_ENGINE="/var/www/html/pandora_console/ws.php" -export PHP=/usr/bin/php -export WS_LOG="/var/log/pandora/web_socket.log" -export GOTTY="/tmp/" - -# Environment variables -if [[ -z ${PANDORA_RB_PRODUCT_NAME} ]]; then - PANDORA_RB_PRODUCT_NAME="Pandora FMS" -fi -if [[ -z ${PANDORA_RB_COPYRIGHT_NOTICE} ]]; then - PANDORA_RB_COPYRIGHT_NOTICE="Pandora FMS" -fi - -export PANDORA_RB_PRODUCT_NAME=$PANDORA_RB_PRODUCT_NAME -export PANDORA_RB_COPYRIGHT_NOTICE=$PANDORA_RB_COPYRIGHT_NOTICE - -# Uses a wait limit before sending a KILL signal, before trying to stop -# Pandora FMS Console Websocket engine nicely. Some big systems need some time before close -# all pending tasks / threads. - -export MAXWAIT=60 - -# Check for SUSE status scripts -if [ -f /etc/rc.status ] -then - . /etc/rc.status - rc_reset -else - # Define part of rc functions for non-suse systems - function rc_status () { - RETVAL=$? - case $1 in - -v) RETVAL=0;; - esac - } - function rc_exit () { exit $RETVAL; } - function rc_failed () { RETVAL=${1:-1}; } - RETVAL=0 -fi - -# This function replace pidof, not working in the same way in different linux distros - -function pidof_pandora () { - # This sets COLUMNS to XXX chars, because if command is run - # in a "strech" term, ps aux don't report more than COLUMNS - # characters and this will not work. - COLUMNS=300 - PANDORA_PID=`ps aux | grep "$PHP $WS_ENGINE" | grep -v grep | tail -1 | awk '{ print $2 }'` - echo $PANDORA_PID -} - -# Main script - -if [ ! -x $GOTTY ] -then - echo "Gotty not found in $GOTTY" - rc_failed 5 # program is not installed - rc_exit -fi - -if [ ! -f $PHP ] -then - echo "$PHP not found, please install version >= 7.0" - rc_failed 5 # program is not installed - rc_exit -fi - -case "$1" in - start) - PANDORA_PID=`pidof_pandora` - if [ ! -z "$PANDORA_PID" ] - then - echo "$PANDORA_RB_PRODUCT_NAME Console Websocket engine is currently running on this machine with PID ($PANDORA_PID)." - rc_exit # running start on a service already running - fi - - export PERL_LWP_SSL_VERIFY_HOSTNAME=0 - $PHP $WS_ENGINE >> $WS_LOG 2>&1 & - sleep 1 - - PANDORA_PID=`pidof_pandora` - - if [ ! -z "$PANDORA_PID" ] - then - echo "$PANDORA_RB_PRODUCT_NAME Console Websocket engine is now running with PID $PANDORA_PID" - rc_status -v - else - echo "Cannot start $PANDORA_RB_PRODUCT_NAME Console Websocket engine. Aborted." - echo "Check $PANDORA_RB_PRODUCT_NAME log files at $WS_LOG" - rc_failed 7 # program is not running - fi - ;; - - stop) - PANDORA_PID=`pidof_pandora` - if [ -z "$PANDORA_PID" ] - then - echo "$PANDORA_RB_PRODUCT_NAME Console Websocket engine is not running, cannot stop it." - rc_exit # running stop on a service already stopped or not running - else - echo "Stopping $PANDORA_RB_PRODUCT_NAME Console Websocket engine" - kill $PANDORA_PID > /dev/null 2>&1 - COUNTER=0 - - while [ $COUNTER -lt $MAXWAIT ] - do - _PID=`pidof_pandora` - if [ "$_PID" != "$PANDORA_PID" ] - then - COUNTER=$MAXWAIT - fi - COUNTER=`expr $COUNTER + 1` - sleep 1 - done - - # Send a KILL -9 signal to process, if it's alive after 60secs, we need - # to be sure is really dead, and not pretending... - if [ "$_PID" = "$PANDORA_PID" ] - then - kill -9 $PANDORA_PID > /dev/null 2>&1 - fi - rc_status -v - fi - ;; - status) - PANDORA_PID=`pidof_pandora` - if [ -z "$PANDORA_PID" ] - then - echo "$PANDORA_RB_PRODUCT_NAME Console Websocket engine is not running." - rc_failed 7 # program is not running - else - echo "$PANDORA_RB_PRODUCT_NAME Console Websocket engine is running with PID $PANDORA_PID." - rc_status - fi - ;; - force-reload|restart) - $0 stop - $0 start - ;; - *) - echo "Usage: $0 { start | stop | restart | status }" - exit 1 -esac -rc_exit