1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
/*
** Zabbix
** Copyright (C) 2001-2021 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "common.h"
#include "../poller/checks_agent.h"
#include "../ipmi/ipmi.h"
#include "../poller/checks_ssh.h"
#include "../poller/checks_telnet.h"
#include "zbxexec.h"
#include "zbxserver.h"
#include "db.h"
#include "log.h"
#include "zbxtasks.h"
#include "scripts.h"
#include "zbxjson.h"
#include "zbxembed.h"
#include "../events.h"
extern int CONFIG_TRAPPER_TIMEOUT;
extern int CONFIG_IPMIPOLLER_FORKS;
static int zbx_execute_script_on_agent(const DC_HOST *host, const char *command, char **result,
char *error, size_t max_error_len)
{
int ret;
AGENT_RESULT agent_result;
char *param = NULL, *port = NULL;
DC_ITEM item;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __func__);
*error = '\0';
memset(&item, 0, sizeof(item));
memcpy(&item.host, host, sizeof(item.host));
if (SUCCEED != (ret = DCconfig_get_interface_by_type(&item.interface, host->hostid, INTERFACE_TYPE_AGENT)))
{
zbx_snprintf(error, max_error_len, "Zabbix agent interface is not defined for host [%s]", host->host);
goto fail;
}
port = zbx_strdup(port, item.interface.port_orig);
substitute_simple_macros(NULL, NULL, NULL, NULL, &host->hostid, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
&port, MACRO_TYPE_COMMON, NULL, 0);
if (SUCCEED != (ret = is_ushort(port, &item.interface.port)))
{
zbx_snprintf(error, max_error_len, "Invalid port number [%s]", item.interface.port_orig);
goto fail;
}
param = zbx_strdup(param, command);
if (SUCCEED != (ret = quote_key_param(¶m, 0)))
{
zbx_snprintf(error, max_error_len, "Invalid param [%s]", param);
goto fail;
}
item.key = zbx_dsprintf(item.key, "system.run[%s%s]", param, NULL == result ? ",nowait" : "");
item.value_type = ITEM_VALUE_TYPE_TEXT;
init_result(&agent_result);
zbx_alarm_on(CONFIG_TIMEOUT);
if (SUCCEED != (ret = get_value_agent(&item, &agent_result)))
{
if (ISSET_MSG(&agent_result))
zbx_strlcpy(error, agent_result.msg, max_error_len);
ret = FAIL;
}
else if (NULL != result && ISSET_TEXT(&agent_result))
*result = zbx_strdup(*result, agent_result.text);
zbx_alarm_off();
free_result(&agent_result);
zbx_free(item.key);
fail:
zbx_free(port);
zbx_free(param);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
static int zbx_execute_script_on_terminal(const DC_HOST *host, const zbx_script_t *script, char **result,
char *error, size_t max_error_len)
{
int ret = FAIL, i;
AGENT_RESULT agent_result;
DC_ITEM item;
int (*function)(DC_ITEM *, AGENT_RESULT *);
#if defined(HAVE_SSH2) || defined(HAVE_SSH)
assert(ZBX_SCRIPT_TYPE_SSH == script->type || ZBX_SCRIPT_TYPE_TELNET == script->type);
#else
assert(ZBX_SCRIPT_TYPE_TELNET == script->type);
#endif
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __func__);
*error = '\0';
memset(&item, 0, sizeof(item));
memcpy(&item.host, host, sizeof(item.host));
for (i = 0; INTERFACE_TYPE_COUNT > i; i++)
{
if (SUCCEED == (ret = DCconfig_get_interface_by_type(&item.interface, host->hostid,
INTERFACE_TYPE_PRIORITY[i])))
{
break;
}
}
if (FAIL == ret)
{
zbx_snprintf(error, max_error_len, "No interface defined for host [%s]", host->host);
goto fail;
}
switch (script->type)
{
case ZBX_SCRIPT_TYPE_SSH:
item.authtype = script->authtype;
item.publickey = script->publickey;
item.privatekey = script->privatekey;
ZBX_FALLTHROUGH;
case ZBX_SCRIPT_TYPE_TELNET:
item.username = script->username;
item.password = script->password;
break;
}
#if defined(HAVE_SSH2) || defined(HAVE_SSH)
if (ZBX_SCRIPT_TYPE_SSH == script->type)
{
item.key = zbx_dsprintf(item.key, "ssh.run[,,%s]", script->port);
function = get_value_ssh;
}
else
{
#endif
item.key = zbx_dsprintf(item.key, "telnet.run[,,%s]", script->port);
function = get_value_telnet;
#if defined(HAVE_SSH2) || defined(HAVE_SSH)
}
#endif
item.value_type = ITEM_VALUE_TYPE_TEXT;
item.params = zbx_strdup(item.params, script->command);
init_result(&agent_result);
zbx_alarm_on(CONFIG_TIMEOUT);
if (SUCCEED != (ret = function(&item, &agent_result)))
{
if (ISSET_MSG(&agent_result))
zbx_strlcpy(error, agent_result.msg, max_error_len);
ret = FAIL;
}
else if (NULL != result && ISSET_TEXT(&agent_result))
*result = zbx_strdup(*result, agent_result.text);
zbx_alarm_off();
free_result(&agent_result);
zbx_free(item.params);
zbx_free(item.key);
fail:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
int zbx_check_script_permissions(zbx_uint64_t groupid, zbx_uint64_t hostid)
{
DB_RESULT result;
int ret = SUCCEED;
zbx_vector_uint64_t groupids;
char *sql = NULL;
size_t sql_alloc = 0, sql_offset = 0;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() groupid:" ZBX_FS_UI64 " hostid:" ZBX_FS_UI64, __func__, groupid, hostid);
if (0 == groupid)
goto exit;
zbx_vector_uint64_create(&groupids);
zbx_dc_get_nested_hostgroupids(&groupid, 1, &groupids);
zbx_snprintf_alloc(&sql, &sql_alloc, &sql_offset,
"select hostid"
" from hosts_groups"
" where hostid=" ZBX_FS_UI64
" and",
hostid);
DBadd_condition_alloc(&sql, &sql_alloc, &sql_offset, "groupid", groupids.values,
groupids.values_num);
result = DBselect("%s", sql);
zbx_free(sql);
zbx_vector_uint64_destroy(&groupids);
if (NULL == DBfetch(result))
ret = FAIL;
DBfree_result(result);
exit:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
int zbx_check_script_user_permissions(zbx_uint64_t userid, zbx_uint64_t hostid, zbx_script_t *script)
{
int ret = SUCCEED;
DB_RESULT result;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() userid:" ZBX_FS_UI64 " hostid:" ZBX_FS_UI64 " scriptid:" ZBX_FS_UI64,
__func__, userid, hostid, script->scriptid);
result = DBselect(
"select null"
" from hosts_groups hg,rights r,users_groups ug"
" where hg.groupid=r.id"
" and r.groupid=ug.usrgrpid"
" and hg.hostid=" ZBX_FS_UI64
" and ug.userid=" ZBX_FS_UI64
" group by hg.hostid"
" having min(r.permission)>%d"
" and max(r.permission)>=%d",
hostid,
userid,
PERM_DENY,
script->host_access);
if (NULL == DBfetch(result))
ret = FAIL;
DBfree_result(result);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
void zbx_script_init(zbx_script_t *script)
{
memset(script, 0, sizeof(zbx_script_t));
}
void zbx_script_clean(zbx_script_t *script)
{
zbx_free(script->port);
zbx_free(script->username);
zbx_free(script->publickey);
zbx_free(script->privatekey);
zbx_free(script->password);
zbx_free(script->command);
zbx_free(script->command_orig);
}
/******************************************************************************
* *
* Function: zbx_webhook_params_pack_json *
* *
* Purpose: pack webhook script parameters into JSON *
* *
* Parameters: params - [IN] vector of pairs of pointers to parameter *
* names and values *
* params_json - [OUT] JSON string *
* *
******************************************************************************/
void zbx_webhook_params_pack_json(const zbx_vector_ptr_pair_t *params, char **params_json)
{
struct zbx_json json_data;
int i;
zbx_json_init(&json_data, ZBX_JSON_STAT_BUF_LEN);
for (i = 0; i < params->values_num; i++)
{
zbx_ptr_pair_t pair = params->values[i];
zbx_json_addstring(&json_data, pair.first, pair.second, ZBX_JSON_TYPE_STRING);
}
zbx_json_close(&json_data);
*params_json = zbx_strdup(*params_json, json_data.buffer);
zbx_json_free(&json_data);
}
/***********************************************************************************
* *
* Function: zbx_script_prepare *
* *
* Purpose: prepares user script *
* *
* Parameters: script - [IN] the script to prepare *
* host - [IN] the host the script will be executed on *
* error - [OUT] the error message buffer *
* max_error_len - [IN] the size of error message output buffer *
* *
* Return value: SUCCEED - the script has been prepared successfully *
* FAIL - otherwise, error contains error message *
* *
* Comments: This function prepares script for execution by loading global *
* script/expanding macros (except in script body). *
* Prepared scripts must be always freed with zbx_script_clean() *
* function. *
* *
***********************************************************************************/
int zbx_script_prepare(zbx_script_t *script, const zbx_uint64_t *hostid, char *error, size_t max_error_len)
{
int ret = FAIL;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __func__);
switch (script->type)
{
case ZBX_SCRIPT_TYPE_SSH:
substitute_simple_macros(NULL, NULL, NULL, NULL, hostid, NULL, NULL, NULL, NULL, NULL, NULL,
NULL, &script->publickey, MACRO_TYPE_COMMON, NULL, 0);
substitute_simple_macros(NULL, NULL, NULL, NULL, hostid, NULL, NULL, NULL, NULL, NULL, NULL,
NULL, &script->privatekey, MACRO_TYPE_COMMON, NULL, 0);
ZBX_FALLTHROUGH;
case ZBX_SCRIPT_TYPE_TELNET:
substitute_simple_macros(NULL, NULL, NULL, NULL, hostid, NULL, NULL, NULL, NULL, NULL, NULL,
NULL, &script->port, MACRO_TYPE_COMMON, NULL, 0);
if ('\0' != *script->port && SUCCEED != (ret = is_ushort(script->port, NULL)))
{
zbx_snprintf(error, max_error_len, "Invalid port number \"%s\"", script->port);
goto out;
}
substitute_simple_macros_unmasked(NULL, NULL, NULL, NULL, hostid, NULL, NULL, NULL, NULL, NULL,
NULL, NULL, &script->username, MACRO_TYPE_COMMON, NULL, 0);
substitute_simple_macros_unmasked(NULL, NULL, NULL, NULL, hostid, NULL, NULL, NULL, NULL, NULL,
NULL, NULL, &script->password, MACRO_TYPE_COMMON, NULL, 0);
break;
case ZBX_SCRIPT_TYPE_CUSTOM_SCRIPT:
dos2unix(script->command); /* CR+LF (Windows) => LF (Unix) */
break;
case ZBX_SCRIPT_TYPE_WEBHOOK:
case ZBX_SCRIPT_TYPE_IPMI:
break;
default:
zbx_snprintf(error, max_error_len, "Invalid command type \"%d\".", (int)script->type);
goto out;
}
ret = SUCCEED;
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: DBfetch_webhook_params *
* *
* Purpose: fetch webhook parameters *
* *
* Parameters: scriptid - [IN] the id of script to be executed *
* params - [OUT] parameters name-value pairs *
* error - [IN/OUT] the error message *
* error_len - [IN] the maximum error length *
* *
* Return value: SUCCEED - processed successfully *
* FAIL - an error occurred *
* *
******************************************************************************/
int DBfetch_webhook_params(zbx_uint64_t scriptid, zbx_vector_ptr_pair_t *params, char *error, size_t error_len)
{
int ret = SUCCEED;
DB_RESULT result;
DB_ROW row;
zbx_ptr_pair_t pair;
zabbix_log(LOG_LEVEL_DEBUG, "In %s() scriptid:" ZBX_FS_UI64, __func__, scriptid);
result = DBselect("select name,value from script_param where scriptid=" ZBX_FS_UI64, scriptid);
if (NULL == result)
{
zbx_strlcpy(error, "Database error, cannot get webhook script parameters.", error_len);
ret = FAIL;
goto out;
}
while (NULL != (row = DBfetch(result)))
{
pair.first = zbx_strdup(NULL, row[0]);
pair.second = zbx_strdup(NULL, row[1]);
zbx_vector_ptr_pair_append(params, pair);
}
DBfree_result(result);
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: zbx_script_execute *
* *
* Purpose: executing user scripts or remote commands *
* *
* Parameters: script - [IN] the script to be executed *
* host - [IN] the host the script will be executed on *
* params - [IN] parameters for the script *
* result - [OUT] the result of a script execution *
* error - [OUT] the error reported by the script *
* max_error_len - [IN] the maximum error length *
* debug - [OUT] the debug data (optional) *
* *
* Return value: SUCCEED - processed successfully *
* FAIL - an error occurred *
* TIMEOUT_ERROR - a timeout occurred *
* *
******************************************************************************/
int zbx_script_execute(const zbx_script_t *script, const DC_HOST *host, const char *params, char **result,
char *error, size_t max_error_len, char **debug)
{
int ret = FAIL;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __func__);
*error = '\0';
switch (script->type)
{
case ZBX_SCRIPT_TYPE_WEBHOOK:
ret = zbx_es_execute_command(script->command, params, script->timeout, result, error,
max_error_len, debug);
break;
case ZBX_SCRIPT_TYPE_CUSTOM_SCRIPT:
switch (script->execute_on)
{
case ZBX_SCRIPT_EXECUTE_ON_AGENT:
ret = zbx_execute_script_on_agent(host, script->command, result, error,
max_error_len);
break;
case ZBX_SCRIPT_EXECUTE_ON_SERVER:
case ZBX_SCRIPT_EXECUTE_ON_PROXY:
ret = zbx_execute(script->command, result, error, max_error_len,
CONFIG_TRAPPER_TIMEOUT, ZBX_EXIT_CODE_CHECKS_ENABLED, NULL);
break;
default:
zbx_snprintf(error, max_error_len, "Invalid 'Execute on' option \"%d\".",
(int)script->execute_on);
}
break;
case ZBX_SCRIPT_TYPE_IPMI:
#ifdef HAVE_OPENIPMI
if (0 == CONFIG_IPMIPOLLER_FORKS)
{
zbx_strlcpy(error, "Cannot perform IPMI request: configuration parameter"
" \"StartIPMIPollers\" is 0.", max_error_len);
break;
}
if (SUCCEED == (ret = zbx_ipmi_execute_command(host, script->command, error, max_error_len)))
{
if (NULL != result)
*result = zbx_strdup(*result, "IPMI command successfully executed.");
}
#else
zbx_strlcpy(error, "Support for IPMI commands was not compiled in.", max_error_len);
#endif
break;
case ZBX_SCRIPT_TYPE_SSH:
#if !defined(HAVE_SSH2) && !defined(HAVE_SSH)
zbx_strlcpy(error, "Support for SSH script was not compiled in.", max_error_len);
break;
#endif
case ZBX_SCRIPT_TYPE_TELNET:
ret = zbx_execute_script_on_terminal(host, script, result, error, max_error_len);
break;
default:
zbx_snprintf(error, max_error_len, "Invalid command type \"%d\".", (int)script->type);
}
if (SUCCEED != ret && NULL != result)
*result = zbx_strdup(*result, "");
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __func__, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: zbx_script_create_task *
* *
* Purpose: creates remote command task from a script *
* *
* Return value: the identifier of the created task or 0 in the case of *
* error *
* *
******************************************************************************/
zbx_uint64_t zbx_script_create_task(const zbx_script_t *script, const DC_HOST *host, zbx_uint64_t alertid, int now)
{
zbx_tm_task_t *task;
unsigned short port;
zbx_uint64_t taskid;
if (NULL != script->port && '\0' != script->port[0])
is_ushort(script->port, &port);
else
port = 0;
DBbegin();
taskid = DBget_maxid("task");
task = zbx_tm_task_create(taskid, ZBX_TM_TASK_REMOTE_COMMAND, ZBX_TM_STATUS_NEW, now,
ZBX_REMOTE_COMMAND_TTL, host->proxy_hostid);
task->data = zbx_tm_remote_command_create(script->type, script->command, script->execute_on, port,
script->authtype, script->username, script->password, script->publickey, script->privatekey,
taskid, host->hostid, alertid);
if (FAIL == zbx_tm_save_task(task))
taskid = 0;
DBcommit();
zbx_tm_task_free(task);
return taskid;
}
|