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 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
|
/*
* Copyright (c) 2002-2013 Balabit
* Copyright (c) 1998-2013 Balázs Scheidler
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published
* by the Free Software Foundation, 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 St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#include "syslog-ng.h"
#include "messages.h"
#include "template/templates.h"
#include "patterndb.h"
#include "dbparser.h"
#include "radix.h"
#include "stats/stats-registry.h"
#include "plugin.h"
#include "filter/filter-expr-parser.h"
#include "patternize.h"
#include "pdb-example.h"
#include "pdb-program.h"
#include "pdb-load.h"
#include "pdb-file.h"
#include "apphook.h"
#include "transport/transport-file.h"
#include "logproto/logproto-text-server.h"
#include "reloc.h"
#include "pathutils.h"
#include "resolved-configurable-paths.h"
#include "crypto.h"
#include "compat/openssl_support.h"
#include "scratch-buffers.h"
#include "timeutils/cache.h"
#include "mainloop.h"
#include "msg-format.h"
#include "str-utils.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <locale.h>
#define BOOL(x) ((x) ? "TRUE" : "FALSE")
static const gchar *full_colors[] =
{
"\33[01;34m", /* blue */
"\33[0;33m", /* brown */
"\33[01;32m", /* green */
"\33[01;31m" /* red */
};
static const gchar *empty_colors[] =
{
"", "", "", ""
};
#define COLOR_TRAILING_JUNK 0
#define COLOR_PARSER 1
#define COLOR_LITERAL 2
#define COLOR_PARTIAL 3
static const gchar *no_color = "\33[01;0m";
static const gchar **colors = empty_colors;
static const gchar *patterndb_file = PATH_PATTERNDB_FILE;
static gboolean color_out = FALSE;
static gboolean sort = FALSE;
typedef struct _PdbToolMergeState
{
GString *merged;
gint version;
gboolean in_rule;
} PdbToolMergeState;
void
pdbtool_merge_start_element(GMarkupParseContext *context, const gchar *element_name, const gchar **attribute_names,
const gchar **attribute_values, gpointer user_data, GError **error)
{
PdbToolMergeState *state = (PdbToolMergeState *) user_data;
gchar *buff;
gint i;
if (g_str_equal(element_name, "patterndb"))
{
for (i = 0; attribute_names[i]; i++)
{
if (g_str_equal(attribute_names[i], "version"))
state->version = strtol(attribute_values[i], NULL, 10);
}
return;
}
else if (g_str_equal(element_name, "rule"))
state->in_rule = TRUE;
if (g_str_equal(element_name, "program"))
g_string_append(state->merged, "<ruleset");
else if (state->version == 1 && state->in_rule && g_str_equal(element_name, "pattern"))
g_string_append_printf(state->merged, "<patterns>\n<%s", element_name);
else if (state->version == 1 && state->in_rule && g_str_equal(element_name, "url"))
g_string_append_printf(state->merged, "<urls>\n<%s", element_name);
else
g_string_append_printf(state->merged, "<%s", element_name);
for (i = 0; attribute_names[i]; i++)
{
buff = g_markup_printf_escaped(" %s='%s'", attribute_names[i], attribute_values[i]);
g_string_append_printf(state->merged, "%s", buff);
g_free(buff);
}
g_string_append(state->merged, ">");
}
void
pdbtool_merge_end_element(GMarkupParseContext *context, const gchar *element_name, gpointer user_data, GError **error)
{
PdbToolMergeState *state = (PdbToolMergeState *) user_data;
if (g_str_equal(element_name, "patterndb"))
return;
else if (g_str_equal(element_name, "rule"))
state->in_rule = FALSE;
if (g_str_equal(element_name, "program"))
g_string_append(state->merged, "</ruleset>");
else if (state->version == 1 && state->in_rule && g_str_equal(element_name, "pattern"))
g_string_append_printf(state->merged, "</%s>\n</patterns>", element_name);
else if (state->version == 1 && state->in_rule && g_str_equal(element_name, "url"))
g_string_append_printf(state->merged, "</%s>\n</urls>", element_name);
else
g_string_append_printf(state->merged, "</%s>", element_name);
}
void
pdbtool_merge_text(GMarkupParseContext *context, const gchar *text, gsize text_len, gpointer user_data, GError **error)
{
PdbToolMergeState *state = (PdbToolMergeState *) user_data;
gchar *buff = g_markup_printf_escaped("%s", text);
g_string_append(state->merged, buff);
g_free(buff);
}
GMarkupParser pdbtool_merge_parser =
{
.start_element = pdbtool_merge_start_element,
.end_element = pdbtool_merge_end_element,
.text = pdbtool_merge_text,
.passthrough = NULL,
.error = NULL
};
static gboolean
pdbtool_merge_file(const gchar *filename, GString *merged)
{
GMarkupParseContext *parse_ctx = NULL;
PdbToolMergeState state;
GError *error = NULL;
gboolean success = TRUE;
gchar *buff = NULL;
gsize buff_len;
if (!g_file_get_contents(filename, &buff, &buff_len, &error))
{
fprintf(stderr, "Error reading pattern database file; filename='%s', error='%s'\n",
filename, error ? error->message : "Unknown error");
success = FALSE;
goto error;
}
state.version = 0;
state.merged = merged;
state.in_rule = FALSE;
parse_ctx = g_markup_parse_context_new(&pdbtool_merge_parser, 0, &state, NULL);
if (!g_markup_parse_context_parse(parse_ctx, buff, buff_len, &error))
{
fprintf(stderr, "Error parsing pattern database file; filename='%s', error='%s'\n",
filename, error ? error->message : "Unknown error");
success = FALSE;
goto error;
}
if (!g_markup_parse_context_end_parse(parse_ctx, &error))
{
fprintf(stderr, "Error parsing pattern database file; filename='%s', error='%s'\n",
filename, error ? error->message : "Unknown error");
success = FALSE;
goto error;
}
error:
if (buff)
g_free(buff);
if (parse_ctx)
g_markup_parse_context_free(parse_ctx);
if (error)
g_error_free(error);
return success;
}
static gchar *merge_dir = NULL;
static gchar *merge_glob = NULL;
static gboolean merge_recursive = FALSE;
static gboolean
pdbtool_merge_dir(const gchar *dir, gboolean recursive, GString *merged)
{
GPtrArray *filenames;
GError *error = NULL;
if ((filenames = pdb_get_filenames(dir, recursive, merge_glob, &error)) == NULL)
{
fprintf(stderr, "error getting filenames: %s\n", error->message);
g_clear_error(&error);
return FALSE;
}
if (sort)
pdb_sort_filenames(filenames);
for (guint i = 0; i < filenames->len; ++i)
{
if (!pdbtool_merge_file(g_ptr_array_index(filenames, i), merged))
break;
}
g_ptr_array_free(filenames, TRUE);
return TRUE;
}
static gint
pdbtool_merge(int argc, char *argv[])
{
GDate date;
GError *error = NULL;
GString *merged = NULL;
gchar *buff;
gboolean ok;
if (!merge_dir)
{
fprintf(stderr, "No directory is specified to merge from\n");
return 1;
}
if (!patterndb_file)
{
fprintf(stderr, "No patterndb file is specified to merge to\n");
return 1;
}
merged = g_string_sized_new(4096);
g_date_clear(&date, 1);
g_date_set_time_t(&date, time (NULL));
buff = g_markup_printf_escaped("<?xml version='1.0' encoding='UTF-8'?>\n<patterndb version='6' pub_date='%04d-%02d-%02d'>",
g_date_get_year(&date), g_date_get_month(&date), g_date_get_day(&date));
g_string_append(merged, buff);
g_free(buff);
ok = pdbtool_merge_dir(merge_dir, merge_recursive, merged);
g_string_append(merged, "</patterndb>\n");
if (ok && !g_file_set_contents(patterndb_file, merged->str, merged->len, &error))
{
fprintf(stderr, "Error storing patterndb; filename='%s', errror='%s'\n", patterndb_file,
error ? error->message : "Unknown error");
if (error)
g_error_free(error);
ok = FALSE;
}
g_string_free(merged, TRUE);
return ok ? 0 : 1;
}
static GOptionEntry merge_options[] =
{
{
"pdb", 'p', 0, G_OPTION_ARG_STRING, &patterndb_file,
"Name of the patterndb output file", "<patterndb_file>"
},
{
"recursive", 'r', 0, G_OPTION_ARG_NONE, &merge_recursive,
"Recurse into subdirectories", NULL
},
{
"glob", 'G', 0, G_OPTION_ARG_STRING, &merge_glob,
"Filenames to consider for merging", "<pattern>"
},
{
"directory", 'D', 0, G_OPTION_ARG_STRING, &merge_dir,
"Directory from merge pattern databases", "<directory>"
},
{
"sort", 's', 0, G_OPTION_ARG_NONE, &sort,
"Sort files during merge (alphabetic order, with files first, directories after)", NULL
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static gchar *match_program = NULL;
static gchar *match_message = NULL;
static gchar *match_file = NULL;
static gchar *template_string = NULL;
static gchar *filter_string = NULL;
static gboolean debug_pattern = FALSE;
static gboolean debug_pattern_parse = FALSE;
gboolean
pdbtool_match_values(NVHandle handle, const gchar *name,
const gchar *value, gssize length,
LogMessageValueType type, gpointer user_data)
{
gint *ret = user_data;
printf("%s=%.*s\n", name, (gint) length, value);
if (g_str_equal(name, ".classifier.rule_id") && ret)
*ret = 0;
if (ret && (g_str_equal(name, ".classifier.class") && g_str_equal(value, "unknown")))
*ret = 1;
return FALSE;
}
static void
pdbtool_pdb_emit(LogMessage *msg, gpointer user_data)
{
gpointer *args = (gpointer *) user_data;
FilterExprNode *filter = (FilterExprNode *) args[0];
LogTemplate *template = (LogTemplate *) args[1];
gint *ret = (gint *) args[2];
GString *output = (GString *) args[3];
gboolean matched;
matched = !filter || filter_expr_eval(filter, msg);
if (matched)
{
if (G_UNLIKELY(!template))
{
if (debug_pattern && !debug_pattern_parse)
printf("\nValues:\n");
nv_table_foreach(msg->payload, logmsg_registry, pdbtool_match_values, ret);
g_string_truncate(output, 0);
log_msg_format_tags(msg, output, TRUE);
printf("TAGS=%s\n", output->str);
printf("\n");
}
else
{
log_template_format(template, msg, &DEFAULT_TEMPLATE_EVAL_OPTIONS, output);
printf("%s", output->str);
}
}
}
static gint
pdbtool_match(int argc, char *argv[])
{
PatternDB *patterndb;
GArray *dbg_list = NULL;
RDebugInfo *dbg_info;
gint i = 0, pos = 0;
gint ret = 1;
const gchar *name = NULL;
gssize name_len = 0;
MsgFormatOptions parse_options;
gboolean eof = FALSE;
const guchar *buf = NULL;
gsize buflen;
LogMessage *msg = NULL;
LogTemplate *template = NULL;
GString *output = NULL;
FilterExprNode *filter = NULL;
LogProtoServer *proto = NULL;
LogProtoServerOptions proto_options;
gboolean may_read = TRUE;
gpointer args[4];
memset(&parse_options, 0, sizeof(parse_options));
if (!match_message && !match_file)
{
fprintf(stderr, "Either -M or -f is required to specify which message to match\n");
return ret;
}
if (template_string)
{
GError *error = NULL;
gchar *t = g_strcompress(template_string);
template = log_template_new(configuration, NULL);
if (!log_template_compile(template, t, &error))
{
fprintf(stderr, "Error compiling template: %s, error: %s\n", template->template_str, error->message);
g_clear_error(&error);
g_free(t);
return 1;
}
g_free(t);
}
output = g_string_sized_new(512);
if (filter_string)
{
CfgLexer *lexer;
lexer = cfg_lexer_new_buffer(configuration, filter_string, strlen(filter_string));
if (!cfg_run_parser_with_main_context(configuration, lexer, &filter_expr_parser, (gpointer *) &filter, NULL,
"pdbtool filter expression"))
{
fprintf(stderr, "Error parsing filter expression\n");
return 1;
}
if (!filter_expr_init(filter, configuration))
{
fprintf(stderr, "Error initializing filter expression\n");
return 1;
}
}
msg_format_options_defaults(&parse_options);
/* the syslog protocol parser automatically falls back to RFC3164 format */
parse_options.flags |= LP_SYSLOG_PROTOCOL | LP_EXPECT_HOSTNAME;
msg_format_options_init(&parse_options, configuration);
log_proto_server_options_defaults(&proto_options);
proto_options.max_msg_size = 65536;
log_proto_server_options_init(&proto_options, configuration);
patterndb = pattern_db_new(NULL);
if (!pattern_db_reload_ruleset(patterndb, configuration, patterndb_file))
{
goto error;
}
msg = log_msg_new_empty();
if (!match_file)
{
log_msg_set_value(msg, LM_V_MESSAGE, match_message, strlen(match_message));
if (match_program && match_program[0])
log_msg_set_value(msg, LM_V_PROGRAM, match_program, strlen(match_program));
}
else
{
LogTransport *transport;
gint fd;
if (strcmp(match_file, "-") == 0)
{
fd = 0;
}
else
{
fd = open(match_file, O_RDONLY);
if (fd < 0)
{
fprintf(stderr, "Error opening file to be processed: %s\n", g_strerror(errno));
goto error;
}
}
transport = log_transport_file_new(fd);
proto = log_proto_text_server_new(transport, &proto_options);
LogProtoStatus status = log_proto_server_fetch(proto, &buf, &buflen, &may_read, NULL, NULL);
eof = status != (LPS_SUCCESS && status != LPS_AGAIN);
}
if (!debug_pattern)
{
args[0] = filter;
args[1] = template;
args[2] = &ret;
args[3] = output;
pattern_db_set_emit_func(patterndb, pdbtool_pdb_emit, args);
}
else
{
dbg_list = g_array_new(FALSE, FALSE, sizeof(RDebugInfo));
}
ret = 0;
while (!eof && (buf || match_message))
{
invalidate_cached_realtime();
if (G_LIKELY(proto))
{
log_msg_unref(msg);
msg = msg_format_parse(&parse_options, buf, buflen);
}
if (G_UNLIKELY(debug_pattern))
{
const gchar *msg_string;
pattern_db_debug_ruleset(patterndb, msg, dbg_list);
msg_string = log_msg_get_value(msg, LM_V_MESSAGE, NULL);
pos = 0;
if (!debug_pattern_parse)
{
printf("Pattern matching part:\n");
for (i = 0; i < dbg_list->len; i++)
{
dbg_info = &g_array_index(dbg_list, RDebugInfo, i);
pos += dbg_info->i;
if (dbg_info->pnode)
{
name = nv_registry_get_handle_name(logmsg_registry, dbg_info->pnode->handle, &name_len);
printf("%s@%s:%s=%.*s@%s",
colors[COLOR_PARSER],
r_parser_type_name(dbg_info->pnode->parser_type),
name_len ? name : "",
name_len ? dbg_info->match_len : 0,
name_len ? msg_string + dbg_info->match_off : "",
no_color
);
}
else if (dbg_info->i == dbg_info->node->keylen)
{
printf("%s%s%s", colors[COLOR_LITERAL], dbg_info->node->key, no_color);
}
else
{
printf("%s%.*s%s", colors[COLOR_PARTIAL], dbg_info->node->key ? dbg_info->i : 0,
dbg_info->node->key ? (gchar *) dbg_info->node->key : "", no_color);
}
}
printf("%s%s%s", colors[COLOR_TRAILING_JUNK], msg_string + pos, no_color);
printf("\nMatching part:\n");
}
if (debug_pattern_parse)
printf("PDBTOOL_HEADER=i:len:key;keylen:match_off;match_len:parser_type:parser_name\n");
pos = 0;
for (i = 0; i < dbg_list->len; i++)
{
/* NOTE: if i is smaller than node->keylen than we did not match the full node
* so matching failed on this node, we need to highlight it somehow
*/
dbg_info = &g_array_index(dbg_list, RDebugInfo, i);
if (debug_pattern_parse)
{
if (dbg_info->pnode)
name = nv_registry_get_handle_name(logmsg_registry, dbg_info->pnode->handle, &name_len);
printf("PDBTOOL_DEBUG=%d:%d:%d:%d:%d:%s:%s\n",
i, dbg_info->i, dbg_info->node->keylen, dbg_info->match_off, dbg_info->match_len,
dbg_info->pnode ? r_parser_type_name(dbg_info->pnode->parser_type) : "",
dbg_info->pnode && name_len ? name : ""
);
}
else
{
if (dbg_info->i == dbg_info->node->keylen || dbg_info->pnode)
printf("%s%.*s%s", dbg_info->pnode ? colors[COLOR_PARSER] : colors[COLOR_LITERAL], dbg_info->i, msg_string + pos,
no_color);
else
printf("%s%.*s%s", colors[COLOR_PARTIAL], dbg_info->i, msg_string + pos, no_color);
pos += dbg_info->i;
}
}
g_array_set_size(dbg_list, 0);
dbg_info = NULL;
{
gpointer nulls[] = { NULL, NULL, &ret, output };
pdbtool_pdb_emit(msg, nulls);
}
}
else
{
pattern_db_process(patterndb, msg);
pdbtool_pdb_emit(msg, args);
}
if (G_LIKELY(proto))
{
buf = NULL;
LogProtoStatus status = log_proto_server_fetch(proto, &buf, &buflen, &may_read, NULL, NULL);
eof = (status != LPS_SUCCESS && status != LPS_AGAIN);
}
else
{
eof = TRUE;
}
}
pattern_db_expire_state(patterndb);
error:
if (proto)
log_proto_server_free(proto);
if (template)
log_template_unref(template);
if (output)
g_string_free(output, TRUE);
pattern_db_free(patterndb);
if (msg)
log_msg_unref(msg);
msg_format_options_destroy(&parse_options);
return ret;
}
static GOptionEntry match_options[] =
{
{
"pdb", 'p', 0, G_OPTION_ARG_STRING, &patterndb_file,
"Name of the patterndb file", "<patterndb_file>"
},
{
"program", 'P', 0, G_OPTION_ARG_STRING, &match_program,
"Program name to match as $PROGRAM", "<program>"
},
{
"message", 'M', 0, G_OPTION_ARG_STRING, &match_message,
"Message to match as $MSG", "<message>"
},
{
"debug-pattern", 'D', 0, G_OPTION_ARG_NONE, &debug_pattern,
"Print debugging information on pattern matching", NULL
},
{
"debug-csv", 'C', 0, G_OPTION_ARG_NONE, &debug_pattern_parse,
"Output debugging information in parseable format", NULL
},
{
"color-out", 'c', 0, G_OPTION_ARG_NONE, &color_out,
"Color terminal output", NULL
},
{
"template", 'T', 0, G_OPTION_ARG_STRING, &template_string,
"Template string to be used to format the output", "template"
},
{
"file", 'f', 0, G_OPTION_ARG_STRING, &match_file,
"Read the messages from the file specified", NULL
},
{
"filter", 'F', 0, G_OPTION_ARG_STRING, &filter_string,
"Only print messages matching the specified syslog-ng filter", "expr"
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static gboolean test_validate = FALSE;
static gchar *test_ruleid = NULL;
static gboolean
pdbtool_test_value(LogMessage *msg, const gchar *name, const gchar *test_value, const gchar *test_type)
{
const gchar *value;
gssize value_len;
LogMessageValueType t, test_t;
gboolean ret = TRUE;
value = log_msg_get_value_by_name_with_type(msg, name, &value_len, &t);
if (!test_type)
{
/* not interested in validating the type */
test_t = t;
}
else
{
if (!log_msg_value_type_from_str(test_type, &test_t))
{
printf(" Unknown type name specified in test_value, name='%s', expected_type='%s'\n", name, test_type);
return FALSE;
}
}
if (!(value && strncmp(value, test_value, value_len) == 0 && value_len == strlen(test_value)
&& t == test_t))
{
if (value)
printf(" Wrong match name='%s', value='%.*s', type='%s', expected='%s', expected_type='%s'\n", name, (gint) value_len,
value, log_msg_value_type_to_str(t), test_value, log_msg_value_type_to_str(test_t));
else
printf(" No value to match name='%s', expected='%s'\n", name, test_value);
ret = FALSE;
}
else if (verbose_flag)
printf(" Match name='%s', value='%.*s', type='%s%s', expected='%s'\n", name, (gint) value_len, value,
log_msg_value_type_to_str(t), test_type ? "" : "[unchecked]", test_value);
return ret;
}
static void
pdbtool_test_find_conflicts(PatternDB *patterndb, LogMessage *msg)
{
const gchar *program;
const gchar *message;
RNode *node;
program = log_msg_get_value(msg, LM_V_PROGRAM, NULL);
message = log_msg_get_value(msg, LM_V_MESSAGE, NULL);
node = r_find_node(pattern_db_get_ruleset(patterndb)->programs, (gchar *) program, strlen(program), NULL);
if (node)
{
PDBProgram *program_rules = (PDBProgram *) node->value;
gchar **matching_ids;
gint matching_ids_len;
matching_ids = r_find_all_applicable_nodes(program_rules->rules, (gchar *) message, strlen(message),
(RNodeGetValueFunc) pdb_rule_get_name);
matching_ids_len = g_strv_length(matching_ids);
if (matching_ids_len > 1)
{
gint i;
printf(" Rule conflict! Multiple rules match this message, list of IDs follow\n");
for (i = 0; matching_ids[i]; i++)
{
printf(" %s\n", matching_ids[i]);
}
}
g_strfreev(matching_ids);
}
}
gboolean
pdbtool_test_value_type_callback(NVHandle handle, const gchar *name,
const gchar *value, gssize length,
LogMessageValueType type, gpointer user_data)
{
gboolean *value_types_are_correct = (gboolean *) user_data;
gint64 i64;
gdouble d;
gboolean b;
UnixTime ut;
gboolean valid;
GError *error = NULL;
APPEND_ZERO(value, value, length);
switch (type)
{
case LM_VT_NULL:
case LM_VT_STRING:
case LM_VT_JSON:
case LM_VT_BYTES:
case LM_VT_PROTOBUF:
case LM_VT_LIST:
default:
valid = TRUE;
break;
case LM_VT_DATETIME:
valid = type_cast_to_datetime_unixtime(value, length, &ut, &error);
break;
case LM_VT_INTEGER:
valid = type_cast_to_int64(value, length, &i64, &error);
break;
case LM_VT_DOUBLE:
valid = type_cast_to_double(value, length, &d, &error);
break;
case LM_VT_BOOLEAN:
valid = type_cast_to_boolean(value, length, &b, &error);
break;
}
if (!valid)
{
printf(" Value type validation failed, ${%s} did not validate: %s\n",
name, error->message);
g_clear_error(&error);
*value_types_are_correct = FALSE;
}
return FALSE;
}
static gboolean
pdbtool_test_value_types(LogMessage *msg)
{
gboolean result = TRUE;
log_msg_values_foreach(msg, pdbtool_test_value_type_callback, &result);
return result;
}
static gint
pdbtool_test(int argc, char *argv[])
{
PatternDB *patterndb;
PDBExample *example;
LogMessage *msg;
GList *examples = NULL;
gint i, arg_pos;
gboolean failed_to_load = FALSE;
gboolean failed_to_match = FALSE;
gboolean failed_to_validate = FALSE;
gboolean failed_to_find_id = TRUE;
for (arg_pos = 1; arg_pos < argc; arg_pos++)
{
if (access(argv[arg_pos], R_OK) == -1)
{
fprintf(stderr, "%s: Unable to access the patterndb file\n", argv[arg_pos]);
failed_to_validate = TRUE;
continue;
}
if (test_validate)
{
GError *error = NULL;
if (!pdb_file_validate(argv[arg_pos], &error))
{
fprintf(stderr, "%s: error validating pdb file: %s\n", argv[arg_pos], error->message);
g_clear_error(&error);
failed_to_validate = TRUE;
continue;
}
}
patterndb = pattern_db_new(NULL);
if (!pdb_rule_set_load(pattern_db_get_ruleset(patterndb), configuration, argv[arg_pos], &examples))
{
failed_to_load = TRUE;
continue;
}
while (examples)
{
example = examples->data;
if (example->message && example->program)
{
if (test_ruleid)
{
if (strcmp(example->rule->rule_id, test_ruleid) != 0)
{
pdb_example_free(example);
examples = g_list_delete_link(examples, examples);
continue;
}
else
failed_to_find_id = FALSE;
}
msg = log_msg_new_empty();
log_msg_set_value(msg, LM_V_MESSAGE, example->message, strlen(example->message));
if (example->program && example->program[0])
log_msg_set_value(msg, LM_V_PROGRAM, example->program, strlen(example->program));
printf("Testing message: program='%s' message='%s'\n", example->program, example->message);
pdbtool_test_find_conflicts(patterndb, msg);
pattern_db_process(patterndb, msg);
if (!pdbtool_test_value(msg, ".classifier.rule_id", example->rule->rule_id, "string"))
{
failed_to_match = TRUE;
if (debug_pattern)
{
match_message = example->message;
match_program = example->program;
patterndb_file = argv[arg_pos];
pdbtool_match(0, NULL);
}
}
for (i = 0; example->values && i < example->values->len; i++)
{
gchar **nv = g_ptr_array_index(example->values, i);
if (!pdbtool_test_value(msg, nv[0], nv[1], nv[2]))
failed_to_match = TRUE;
}
if (!pdbtool_test_value_types(msg))
failed_to_match = TRUE;
log_msg_unref(msg);
}
else if (!example->program && example->message)
{
printf("NOT Testing message as program is unset: message='%s'\n", example->message);
}
else if (example->program && !example->message)
{
printf("NOT Testing message as message is unset: program='%s'\n", example->program);
}
pdb_example_free(example);
examples = g_list_delete_link(examples, examples);
}
pattern_db_free(patterndb);
}
if (failed_to_load || failed_to_validate)
return 1;
if (failed_to_match)
return 2;
if (failed_to_find_id && test_ruleid)
{
printf("Could not find the specified ID, or the defined rule doesn't have an example message.\n");
return 3;
}
return 0;
}
static GOptionEntry test_options[] =
{
{
"validate", 0, 0, G_OPTION_ARG_NONE, &test_validate,
"Validate the pdb file against the xsd (requires xmllint from libxml2)", NULL
},
{
"rule-id", 'r', 0, G_OPTION_ARG_STRING, &test_ruleid,
"Rule ID of the patterndb rule to be tested against its example", NULL
},
{
"debug", 'D', 0, G_OPTION_ARG_NONE, &debug_pattern,
"Print debugging information on non-matching patterns", NULL
},
{
"color-out", 'c', 0, G_OPTION_ARG_NONE, &color_out,
"Color terminal output", NULL
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static gboolean dump_program_tree = FALSE;
void
pdbtool_walk_tree(RNode *root, gint level, gboolean program)
{
gint i;
printf("[%d]\t", level);
for (i = 0; i < level; i++)
printf(" ");
if (root->parser)
printf("@%s:%s@ [%s]",
r_parser_type_name(root->parser->parser_type),
log_msg_get_value_name(root->parser->handle, NULL),
root->pdb_location ? : "");
printf("'%s' ", root->key ? (gchar *) root->key : "");
if (root->value)
{
if (!program)
printf("rule_id='%s'", ((PDBRule *) root->value)->rule_id);
else
printf("RULES");
}
printf("\n");
for (i = 0; i < root->num_children; i++)
pdbtool_walk_tree(root->children[i], level + 1, program);
for (i = 0; i < root->num_pchildren; i++)
pdbtool_walk_tree(root->pchildren[i], level + 1, program);
}
static gint
pdbtool_dump(int argc, char *argv[])
{
PatternDB *patterndb;
patterndb = pattern_db_new(NULL);
if (!pattern_db_reload_ruleset(patterndb, configuration, patterndb_file))
return 1;
if (dump_program_tree)
pdbtool_walk_tree(pattern_db_get_ruleset(patterndb)->programs, 0, TRUE);
else if (match_program)
{
RNode *ruleset = r_find_node(pattern_db_get_ruleset(patterndb)->programs, match_program, strlen(match_program), NULL);
if (ruleset && ruleset->value)
{
RNode *root = ((PDBProgram *) ruleset->value)->rules;
if (root)
pdbtool_walk_tree(root, 0, FALSE);
}
}
else
{
fprintf(stderr, "Neither --program-tree nor --program was specified, doing nothing\n");
}
pattern_db_free(patterndb);
return 0;
}
static GOptionEntry dump_options[] =
{
{
"pdb", 'p', 0, G_OPTION_ARG_STRING, &patterndb_file,
"Name of the patterndb file", "<patterndb_file>"
},
{
"program", 'P', 0, G_OPTION_ARG_STRING, &match_program,
"Program name ($PROGRAM) to dump", "<program>"
},
{
"program-tree", 'T', 0, G_OPTION_ARG_NONE, &dump_program_tree,
"Dump the program ($PROGRAM) tree", NULL
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static gboolean dictionary_tags = FALSE;
static void
pdbtool_dictionary_walk(RNode *root, const gchar *progname)
{
gint i;
if (root->parser && root->parser->handle && !dictionary_tags)
printf("%s\n", log_msg_get_value_name(root->parser->handle, NULL));
if (root->value)
{
if (!progname)
{
pdbtool_dictionary_walk(((PDBProgram *)root->value)->rules, (gchar *)root->key);
}
else
{
PDBRule *rule = (PDBRule *)root->value;
guint tag_id;
if (!dictionary_tags && rule->msg.values)
{
for (i = 0; i < rule->msg.values->len; i++)
{
SyntheticMessageValue *smv = synthetic_message_values_index(&rule->msg, i);
printf("%s\n", smv->name);
}
}
if (dictionary_tags && rule->msg.tags)
{
for (i = 0; i < rule->msg.tags->len; i++)
{
tag_id = synthetic_message_tags_index(&rule->msg, i);
printf("%s\n", log_tags_get_by_id(tag_id));
}
}
}
}
for (i = 0; i < root->num_children; i++)
pdbtool_dictionary_walk(root->children[i], progname);
for (i = 0; i < root->num_pchildren; i++)
pdbtool_dictionary_walk(root->pchildren[i], progname);
}
static GOptionEntry dictionary_options[] =
{
{
"pdb", 'p', 0, G_OPTION_ARG_STRING, &patterndb_file,
"Name of the patterndb file", "<patterndb_file>"
},
{
"program", 'P', 0, G_OPTION_ARG_STRING, &match_program,
"Program name ($PROGRAM) to dump", "<program>"
},
{
"dump-tags", 'T', 0, G_OPTION_ARG_NONE, &dictionary_tags,
"Dump the tags in the rules instead of the value names", NULL
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static gint
pdbtool_dictionary(int argc, char *argv[])
{
PDBRuleSet rule_set;
memset(&rule_set, 0x0, sizeof(PDBRuleSet));
if (!pdb_rule_set_load(&rule_set, configuration, patterndb_file, NULL))
return 1;
if (match_program)
{
RNode *ruleset = r_find_node(rule_set.programs, match_program, strlen(match_program), NULL);
if (ruleset && ruleset->value)
pdbtool_dictionary_walk(((PDBProgram *)ruleset->value)->rules, (gchar *)ruleset->key);
}
else
pdbtool_dictionary_walk(rule_set.programs, NULL);
return 0;
}
static gboolean
pdbtool_load_module(const gchar *option_name, const gchar *value, gpointer data, GError **error)
{
return cfg_load_module(configuration, value);
}
static gchar *input_logfile = NULL;
static gboolean no_parse = FALSE;
static gdouble support_treshold = 4.0;
static gboolean iterate_outliers = FALSE;
static gboolean named_parsers = FALSE;
static gint num_of_samples = 1;
static const gchar *delimiters = " :&~?![]=,;()'\"";
static gint
pdbtool_patternize(int argc, char *argv[])
{
Patternizer *ptz;
GHashTable *clusters;
guint iterate = PTZ_ITERATE_NONE;
gint i;
GError *error = NULL;
GString *delimcheck = g_string_new(" "); /* delims should always include a space */
gint ret = 0;
if (iterate_outliers)
iterate = PTZ_ITERATE_OUTLIERS;
/* make sure that every character is unique in the delimiter list */
for (i = 0; delimiters[i]; i++)
{
if (strchr(delimcheck->str, delimiters[i]) == NULL)
g_string_append_c(delimcheck, delimiters[i]);
}
delimiters = g_strdup(delimcheck->str);
g_string_free(delimcheck, TRUE);
if (!(ptz = ptz_new(support_treshold, PTZ_ALGO_SLCT, iterate, num_of_samples, delimiters)))
{
return 1;
}
argv[0] = input_logfile;
for (i = 0; i < argc; i++)
{
if (argv[i] && !ptz_load_file(ptz, argv[i], no_parse, &error))
{
fprintf(stderr, "Error adding log file as patternize input: %s\n", error->message);
g_clear_error(&error);
ret = 1;
goto exit;
}
}
clusters = ptz_find_clusters(ptz);
ptz_print_patterndb(clusters, delimiters, named_parsers);
g_hash_table_destroy(clusters);
exit:
ptz_free(ptz);
return ret;
}
static GOptionEntry patternize_options[] =
{
{
"file", 'f', 0, G_OPTION_ARG_STRING, &input_logfile,
"Logfile to create pattern database from, use '-' for stdin", "<path>"
},
{
"no-parse", 'p', 0, G_OPTION_ARG_NONE, &no_parse,
"Do try to parse the input file, consider the whole lines as the message part of the log", NULL
},
{
"support", 'S', 0, G_OPTION_ARG_DOUBLE, &support_treshold,
"Percentage of lines that have to support a pattern (default: 4.0)", "<support>"
},
{
"iterate-outliers", 'o', 0, G_OPTION_ARG_NONE, &iterate_outliers,
"Recursively iterate on the log lines that do not make it into a cluster in the previous step", NULL
},
{
"named-parsers", 'n', 0, G_OPTION_ARG_NONE, &named_parsers,
"Give the parsers a name in the patterns, eg.: .dict.string1, .dict.string2... (default: no)", NULL
},
{
"delimiters", 'd', 0, G_OPTION_ARG_STRING, &delimiters,
"Set of characters based on which the log messages are tokenized, defaults to :&~?![]=,;()'\"", "<delimiters>"
},
{
"samples", 0, 0, G_OPTION_ARG_INT, &num_of_samples,
"Number of example lines to add for the patterns (default: 1)", "<samples>"
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
const gchar *
pdbtool_mode(int *argc, char **argv[])
{
gint i;
const gchar *mode;
for (i = 1; i < (*argc); i++)
{
if ((*argv)[i][0] != '-')
{
mode = (*argv)[i];
memmove(&(*argv)[i], &(*argv)[i+1], ((*argc) - i) * sizeof(gchar *));
(*argc)--;
return mode;
}
}
return NULL;
}
static GOptionEntry pdbtool_options[] =
{
{
"debug", 'd', 0, G_OPTION_ARG_NONE, &debug_flag,
"Enable debug/diagnostic messages on stderr", NULL
},
{
"verbose", 'v', 0, G_OPTION_ARG_NONE, &verbose_flag,
"Enable verbose messages on stderr", NULL
},
{
"trace", 't', 0, G_OPTION_ARG_NONE, &trace_flag,
"Enable trace messages on stderr", NULL
},
{
"module", 0, 0, G_OPTION_ARG_CALLBACK, pdbtool_load_module,
"Load the module specified as parameter", "<module>"
},
{
"module-path", 0, 0, G_OPTION_ARG_STRING, &resolved_configurable_paths.initial_module_path,
"Set the list of colon separated directories to search for modules, default=" SYSLOG_NG_MODULE_PATH, "<path>"
},
{ NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL }
};
static struct
{
const gchar *mode;
const GOptionEntry *options;
const gchar *description;
gint (*main)(gint argc, gchar *argv[]);
} modes[] =
{
{ "match", match_options, "Match a message against the pattern database", pdbtool_match },
{ "dump", dump_options, "Dump pattern datebase tree", pdbtool_dump },
{ "merge", merge_options, "Merge pattern databases", pdbtool_merge },
{ "test", test_options, "Test pattern databases", pdbtool_test },
{ "patternize", patternize_options, "Create a pattern database from logs", pdbtool_patternize },
{ "dictionary", dictionary_options, "Dump pattern dictionary", pdbtool_dictionary },
{ NULL, NULL },
};
void
usage(void)
{
gint mode;
fprintf(stderr, "Syntax: pdbtool <command> [options]\nPossible commands are:\n");
for (mode = 0; modes[mode].mode; mode++)
{
fprintf(stderr, " %-12s %s\n", modes[mode].mode, modes[mode].description);
}
}
int
main(int argc, char *argv[])
{
const gchar *mode_string;
GOptionContext *ctx;
gint mode, ret = 0;
GError *error = NULL;
mode_string = pdbtool_mode(&argc, &argv);
if (!mode_string)
{
usage();
return 1;
}
ctx = NULL;
for (mode = 0; modes[mode].mode; mode++)
{
if (strcmp(modes[mode].mode, mode_string) == 0)
{
ctx = g_option_context_new(mode_string);
g_option_context_set_summary(ctx, modes[mode].description);
g_option_context_add_main_entries(ctx, modes[mode].options, NULL);
g_option_context_add_main_entries(ctx, pdbtool_options, NULL);
msg_add_option_group(ctx);
break;
}
}
if (!ctx)
{
fprintf(stderr, "Unknown command\n");
usage();
return 1;
}
setlocale(LC_ALL, "");
msg_init(TRUE);
resolved_configurable_paths_init(&resolved_configurable_paths);
patterndb_file = get_installation_path_for(patterndb_file);
app_startup();
pattern_db_global_init();
configuration = cfg_new_snippet();
if (!g_option_context_parse(ctx, &argc, &argv, &error))
{
fprintf(stderr, "Error parsing command line arguments: %s\n", error ? error->message : "Invalid arguments");
g_clear_error(&error);
g_option_context_free(ctx);
return 1;
}
g_option_context_free(ctx);
cfg_load_module(configuration, "syslogformat");
cfg_load_module(configuration, "basicfuncs");
if (color_out)
colors = full_colors;
ret = modes[mode].main(argc, argv);
cfg_free(configuration);
configuration = NULL;
app_shutdown();
return ret;
}
|