/
rsconf.c
1591 lines (1409 loc) · 53.5 KB
/
rsconf.c
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
/* rsconf.c - the rsyslog configuration system.
*
* Module begun 2011-04-19 by Rainer Gerhards
*
* Copyright 2011-2020 Adiscon GmbH.
*
* This file is part of the rsyslog runtime library.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* -or-
* see COPYING.ASL20 in the source distribution
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <pwd.h>
#include <grp.h>
#include <stdarg.h>
#include <sys/resource.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/socket.h>
#include "rsyslog.h"
#include "obj.h"
#include "srUtils.h"
#include "ruleset.h"
#include "modules.h"
#include "conf.h"
#include "queue.h"
#include "rsconf.h"
#include "cfsysline.h"
#include "errmsg.h"
#include "action.h"
#include "glbl.h"
#include "unicode-helper.h"
#include "omshell.h"
#include "omusrmsg.h"
#include "omfwd.h"
#include "omfile.h"
#include "ompipe.h"
#include "omdiscard.h"
#include "pmrfc5424.h"
#include "pmrfc3164.h"
#include "smfile.h"
#include "smtradfile.h"
#include "smfwd.h"
#include "smtradfwd.h"
#include "parser.h"
#include "outchannel.h"
#include "threads.h"
#include "datetime.h"
#include "parserif.h"
#include "modules.h"
#include "dirty.h"
#include "template.h"
#include "timezones.h"
extern char* yytext;
/* static data */
DEFobjStaticHelpers
DEFobjCurrIf(ruleset)
DEFobjCurrIf(module)
DEFobjCurrIf(conf)
DEFobjCurrIf(glbl)
DEFobjCurrIf(parser)
DEFobjCurrIf(datetime)
/* exported static data */
rsconf_t *runConf = NULL;/* the currently running config */
rsconf_t *loadConf = NULL;/* the config currently being loaded (no concurrent config load supported!) */
/* hardcoded standard templates (used for defaults) */
static uchar template_DebugFormat[] = "\"Debug line with all properties:\nFROMHOST: '%FROMHOST%', fromhost-ip: "
"'%fromhost-ip%', HOSTNAME: '%HOSTNAME%', PRI: %PRI%,\nsyslogtag '%syslogtag%', programname: '%programname%', "
"APP-NAME: '%APP-NAME%', PROCID: '%PROCID%', MSGID: '%MSGID%',\nTIMESTAMP: '%TIMESTAMP%', "
"STRUCTURED-DATA: '%STRUCTURED-DATA%',\nmsg: '%msg%'\nescaped msg: '%msg:::drop-cc%'\ninputname: %inputname% "
"rawmsg: '%rawmsg%'\n$!:%$!%\n$.:%$.%\n$/:%$/%\n\n\"";
static uchar template_SyslogProtocol23Format[] = "\"<%PRI%>1 %TIMESTAMP:::date-rfc3339% %HOSTNAME% %APP-NAME% "
"%PROCID% %MSGID% %STRUCTURED-DATA% %msg%\n\"";
static uchar template_SyslogRFC5424Format[] = "\"<%PRI%>1 %TIMESTAMP:::date-rfc3339% %HOSTNAME% %APP-NAME% "
"%PROCID% %MSGID% %STRUCTURED-DATA% %msg%\"";
static uchar template_TraditionalFileFormat[] = "=RSYSLOG_TraditionalFileFormat";
static uchar template_FileFormat[] = "=RSYSLOG_FileFormat";
static uchar template_ForwardFormat[] = "=RSYSLOG_ForwardFormat";
static uchar template_TraditionalForwardFormat[] = "=RSYSLOG_TraditionalForwardFormat";
static uchar template_WallFmt[] = "\"\r\n\7Message from syslogd@%HOSTNAME% at %timegenerated% ...\r\n "
"%syslogtag%%msg%\n\r\"";
static uchar template_StdUsrMsgFmt[] = "\" %syslogtag%%msg%\n\r\"";
static uchar template_StdDBFmt[] = "\"insert into SystemEvents (Message, Facility, FromHost, Priority, "
"DeviceReportedTime, ReceivedAt, InfoUnitID, SysLogTag) values ('%msg%', %syslogfacility%, "
"'%HOSTNAME%', %syslogpriority%, '%timereported:::date-mysql%', '%timegenerated:::date-mysql%', %iut%, "
"'%syslogtag%')\",SQL";
static uchar template_StdPgSQLFmt[] = "\"insert into SystemEvents (Message, Facility, FromHost, Priority, "
"DeviceReportedTime, ReceivedAt, InfoUnitID, SysLogTag) values ('%msg%', %syslogfacility%, "
"'%HOSTNAME%', %syslogpriority%, '%timereported:::date-pgsql%', '%timegenerated:::date-pgsql%', %iut%, "
"'%syslogtag%')\",STDSQL";
static uchar template_spoofadr[] = "\"%fromhost-ip%\"";
static uchar template_SysklogdFileFormat[] = "\"%TIMESTAMP% %HOSTNAME% %syslogtag%%msg:::sp-if-no-1st-sp%%msg%\n\"";
static uchar template_StdJSONFmt[] = "\"{\\\"message\\\":\\\"%msg:::json%\\\",\\\"fromhost\\\":\\\""
"%HOSTNAME:::json%\\\",\\\"facility\\\":\\\"%syslogfacility-text%\\\",\\\"priority\\\":\\\""
"%syslogpriority-text%\\\",\\\"timereported\\\":\\\"%timereported:::date-rfc3339%\\\",\\\"timegenerated\\\":\\\""
"%timegenerated:::date-rfc3339%\\\"}\"";
static uchar template_FullJSONFmt[] = "\"{\\\"message\\\":\\\"%msg:::json%\\\","
"\\\"fromhost\\\":\\\"%HOSTNAME:::json%\\\","
"\\\"programname\\\":\\\"%programname%\\\","
"\\\"procid\\\":\\\"%PROCID%\\\","
"\\\"msgid\\\":\\\"%MSGID%\\\","
"\\\"facility\\\":\\\"%syslogfacility-text%\\\","
"\\\"priority\\\":\\\"%syslogpriority-text%\\\","
"\\\"timereported\\\":\\\"%timereported:::date-rfc3339%\\\","
"\\\"timegenerated\\\":\\\"%timegenerated:::date-rfc3339%\\\"}\"";
static uchar template_StdClickHouseFmt[] = "\"INSERT INTO rsyslog.SystemEvents (severity, facility, "
"timestamp, hostname, tag, message) VALUES (%syslogseverity%, %syslogfacility%, "
"'%timereported:::date-unixtimestamp%', '%hostname%', '%syslogtag%', '%msg%')\",STDSQL";
/* end templates */
/* tables for interfacing with the v6 config system (as far as we need to) */
static struct cnfparamdescr inppdescr[] = {
{ "type", eCmdHdlrString, CNFPARAM_REQUIRED }
};
static struct cnfparamblk inppblk =
{ CNFPARAMBLK_VERSION,
sizeof(inppdescr)/sizeof(struct cnfparamdescr),
inppdescr
};
static struct cnfparamdescr parserpdescr[] = {
{ "type", eCmdHdlrString, CNFPARAM_REQUIRED },
{ "name", eCmdHdlrString, CNFPARAM_REQUIRED }
};
static struct cnfparamblk parserpblk =
{ CNFPARAMBLK_VERSION,
sizeof(parserpdescr)/sizeof(struct cnfparamdescr),
parserpdescr
};
/* forward-definitions */
void cnfDoCfsysline(char *ln);
int rsconfNeedDropPriv(rsconf_t *const cnf)
{
return ((cnf->globals.gidDropPriv != 0) || (cnf->globals.uidDropPriv != 0));
}
static void cnfSetDefaults(rsconf_t *pThis)
{
pThis->globals.bAbortOnUncleanConfig = 0;
pThis->globals.bReduceRepeatMsgs = 0;
pThis->globals.bDebugPrintTemplateList = 1;
pThis->globals.bDebugPrintModuleList = 0;
pThis->globals.bDebugPrintCfSysLineHandlerList = 0;
pThis->globals.bLogStatusMsgs = DFLT_bLogStatusMsgs;
pThis->globals.bErrMsgToStderr = 1;
pThis->globals.maxErrMsgToStderr = -1;
pThis->globals.umask = -1;
pThis->globals.gidDropPrivKeepSupplemental = 0;
pThis->globals.abortOnIDResolutionFail = 1;
pThis->templates.root = NULL;
pThis->templates.last = NULL;
pThis->templates.lastStatic = NULL;
pThis->actions.nbrActions = 0;
pThis->actions.iActionNbr = 0;
pThis->globals.pszWorkDir = NULL;
pThis->globals.bDropMalPTRMsgs = 0;
pThis->globals.operatingStateFile = NULL;
pThis->globals.iGnuTLSLoglevel = 0;
pThis->globals.debugOnShutdown = 0;
pThis->globals.pszDfltNetstrmDrvrCAF = NULL;
pThis->globals.pszDfltNetstrmDrvrCertFile = NULL;
pThis->globals.pszDfltNetstrmDrvrKeyFile = NULL;
pThis->globals.pszDfltNetstrmDrvr = NULL;
pThis->globals.oversizeMsgErrorFile = NULL;
pThis->globals.reportOversizeMsg = 1;
pThis->globals.oversizeMsgInputMode = 0;
pThis->globals.reportChildProcessExits = REPORT_CHILD_PROCESS_EXITS_ERRORS;
pThis->globals.bActionReportSuspension = 1;
pThis->globals.bActionReportSuspensionCont = 0;
pThis->globals.janitorInterval = 10;
pThis->globals.reportNewSenders = 0;
pThis->globals.reportGoneAwaySenders = 0;
pThis->globals.senderStatsTimeout = 12 * 60 * 60; /* 12 hr timeout for senders */
pThis->globals.senderKeepTrack = 0;
pThis->globals.inputTimeoutShutdown = 1000;
pThis->globals.iDefPFFamily = PF_UNSPEC;
pThis->globals.ACLAddHostnameOnFail = 0;
pThis->globals.ACLDontResolve = 0;
pThis->globals.bDisableDNS = 0;
pThis->globals.bProcessInternalMessages = 0;
const char *const log_dflt = getenv("RSYSLOG_DFLT_LOG_INTERNAL");
if(log_dflt != NULL && !strcmp(log_dflt, "1"))
pThis->globals.bProcessInternalMessages = 1;
pThis->globals.glblDevOptions = 0;
pThis->globals.intMsgRateLimitItv = 5;
pThis->globals.intMsgRateLimitBurst = 500;
pThis->globals.intMsgsSeverityFilter = DFLT_INT_MSGS_SEV_FILTER;
pThis->globals.permitCtlC = glblPermitCtlC;
pThis->globals.actq_dflt_toQShutdown = 10;
pThis->globals.actq_dflt_toActShutdown = 1000;
pThis->globals.actq_dflt_toEnq = 2000;
pThis->globals.actq_dflt_toWrkShutdown = 60000;
pThis->globals.ruleset_dflt_toQShutdown = 1500;
pThis->globals.ruleset_dflt_toActShutdown = 1000;
pThis->globals.ruleset_dflt_toEnq = 2000;
pThis->globals.ruleset_dflt_toWrkShutdown = 60000;
pThis->globals.dnscacheDefaultTTL = 24 * 60 * 60;
pThis->globals.dnscacheEnableTTL = 0;
pThis->globals.shutdownQueueDoubleSize = 0;
pThis->globals.optionDisallowWarning = 1;
pThis->globals.bSupportCompressionExtension = 1;
#ifdef ENABLE_LIBLOGGING_STDLOG
pThis->globals.stdlog_hdl = stdlog_open("rsyslogd", 0, STDLOG_SYSLOG, NULL);
pThis->globals.stdlog_chanspec = NULL;
#endif
pThis->globals.iMaxLine = 8096;
/* timezone specific*/
pThis->timezones.tzinfos = NULL;
pThis->timezones.ntzinfos = 0;
/* queue params */
pThis->globals.mainQ.iMainMsgQueueSize = 100000;
pThis->globals.mainQ.iMainMsgQHighWtrMark = 80000;
pThis->globals.mainQ.iMainMsgQLowWtrMark = 20000;
pThis->globals.mainQ.iMainMsgQDiscardMark = 98000;
pThis->globals.mainQ.iMainMsgQDiscardSeverity = 8;
pThis->globals.mainQ.iMainMsgQueueNumWorkers = 2;
pThis->globals.mainQ.MainMsgQueType = QUEUETYPE_FIXED_ARRAY;
pThis->globals.mainQ.pszMainMsgQFName = NULL;
pThis->globals.mainQ.iMainMsgQueMaxFileSize = 1024*1024;
pThis->globals.mainQ.iMainMsgQPersistUpdCnt = 0;
pThis->globals.mainQ.bMainMsgQSyncQeueFiles = 0;
pThis->globals.mainQ.iMainMsgQtoQShutdown = 1500;
pThis->globals.mainQ.iMainMsgQtoActShutdown = 1000;
pThis->globals.mainQ.iMainMsgQtoEnq = 2000;
pThis->globals.mainQ.iMainMsgQtoWrkShutdown = 60000;
pThis->globals.mainQ.iMainMsgQWrkMinMsgs = 40000;
pThis->globals.mainQ.iMainMsgQDeqSlowdown = 0;
pThis->globals.mainQ.iMainMsgQueMaxDiskSpace = 0;
pThis->globals.mainQ.iMainMsgQueDeqBatchSize = 256;
pThis->globals.mainQ.bMainMsgQSaveOnShutdown = 1;
pThis->globals.mainQ.iMainMsgQueueDeqtWinFromHr = 0;
pThis->globals.mainQ.iMainMsgQueueDeqtWinToHr = 25;
pThis->pMsgQueue = NULL;
pThis->globals.parser.cCCEscapeChar = '#';
pThis->globals.parser.bDropTrailingLF = 1;
pThis->globals.parser.bEscapeCCOnRcv = 1;
pThis->globals.parser.bSpaceLFOnRcv = 0;
pThis->globals.parser.bEscape8BitChars = 0;
pThis->globals.parser.bEscapeTab = 1;
pThis->globals.parser.bParserEscapeCCCStyle = 0;
pThis->globals.parser.bPermitSlashInProgramname = 0;
pThis->globals.parser.bParseHOSTNAMEandTAG = 1;
pThis->parsers.pDfltParsLst = NULL;
pThis->parsers.pParsLstRoot = NULL;
}
/* Standard-Constructor
*/
BEGINobjConstruct(rsconf) /* be sure to specify the object type also in END macro! */
cnfSetDefaults(pThis);
lookupInitCnf(&pThis->lu_tabs);
CHKiRet(dynstats_initCnf(&pThis->dynstats_buckets));
CHKiRet(perctile_initCnf(&pThis->perctile_buckets));
CHKiRet(llInit(&pThis->rulesets.llRulesets, rulesetDestructForLinkedList,
rulesetKeyDestruct, strcasecmp));
finalize_it:
ENDobjConstruct(rsconf)
/* ConstructionFinalizer
*/
static rsRetVal
rsconfConstructFinalize(rsconf_t __attribute__((unused)) *pThis)
{
DEFiRet;
ISOBJ_TYPE_assert(pThis, rsconf);
RETiRet;
}
/* call freeCnf() module entry points AND free the module entries themselfes.
*/
static void
freeCnf(rsconf_t *pThis)
{
cfgmodules_etry_t *etry, *del;
etry = pThis->modules.root;
while(etry != NULL) {
if(etry->pMod->beginCnfLoad != NULL) {
dbgprintf("calling freeCnf(%p) for module '%s'\n",
etry->modCnf, (char*) module.GetName(etry->pMod));
etry->pMod->freeCnf(etry->modCnf);
}
del = etry;
etry = etry->next;
free(del);
}
}
/* destructor for the rsconf object */
PROTOTYPEobjDestruct(rsconf);
BEGINobjDestruct(rsconf) /* be sure to specify the object type also in END and CODESTART macros! */
CODESTARTobjDestruct(rsconf)
freeCnf(pThis);
tplDeleteAll(pThis);
dynstats_destroyAllBuckets();
perctileBucketsDestruct();
ochDeleteAll();
freeTimezones(pThis);
parser.DestructParserList(&pThis->parsers.pDfltParsLst);
parser.destroyMasterParserList(pThis->parsers.pParsLstRoot);
free(pThis->globals.mainQ.pszMainMsgQFName);
free(pThis->globals.pszConfDAGFile);
free(pThis->globals.pszWorkDir);
free(pThis->globals.operatingStateFile);
free(pThis->globals.pszDfltNetstrmDrvrCAF);
free(pThis->globals.pszDfltNetstrmDrvrCertFile);
free(pThis->globals.pszDfltNetstrmDrvrKeyFile);
free(pThis->globals.pszDfltNetstrmDrvr);
free(pThis->globals.oversizeMsgErrorFile);
#ifdef ENABLE_LIBLOGGING_STDLOG
stdlog_close(pThis->globals.stdlog_hdl);
free(pThis->globals.stdlog_chanspec);
#endif
lookupDestroyCnf();
llDestroy(&(pThis->rulesets.llRulesets));
ENDobjDestruct(rsconf)
/* DebugPrint support for the rsconf object */
PROTOTYPEObjDebugPrint(rsconf);
BEGINobjDebugPrint(rsconf) /* be sure to specify the object type also in END and CODESTART macros! */
cfgmodules_etry_t *modNode;
dbgprintf("configuration object %p\n", pThis);
dbgprintf("Global Settings:\n");
dbgprintf(" bDebugPrintTemplateList.............: %d\n",
pThis->globals.bDebugPrintTemplateList);
dbgprintf(" bDebugPrintModuleList : %d\n",
pThis->globals.bDebugPrintModuleList);
dbgprintf(" bDebugPrintCfSysLineHandlerList.....: %d\n",
pThis->globals.bDebugPrintCfSysLineHandlerList);
dbgprintf(" bLogStatusMsgs : %d\n",
pThis->globals.bLogStatusMsgs);
dbgprintf(" bErrMsgToStderr.....................: %d\n",
pThis->globals.bErrMsgToStderr);
dbgprintf(" drop Msgs with malicious PTR Record : %d\n",
glbl.GetDropMalPTRMsgs(pThis));
ruleset.DebugPrintAll(pThis);
dbgprintf("\n");
if(pThis->globals.bDebugPrintTemplateList)
tplPrintList(pThis);
if(pThis->globals.bDebugPrintModuleList)
module.PrintList();
if(pThis->globals.bDebugPrintCfSysLineHandlerList)
dbgPrintCfSysLineHandlers();
// TODO: The following code needs to be "streamlined", so far just moved over...
dbgprintf("Main queue size %d messages.\n", pThis->globals.mainQ.iMainMsgQueueSize);
dbgprintf("Main queue worker threads: %d, wThread shutdown: %d, Perists every %d updates.\n",
pThis->globals.mainQ.iMainMsgQueueNumWorkers,
pThis->globals.mainQ.iMainMsgQtoWrkShutdown, pThis->globals.mainQ.iMainMsgQPersistUpdCnt);
dbgprintf("Main queue timeouts: shutdown: %d, action completion shutdown: %d, enq: %d\n",
pThis->globals.mainQ.iMainMsgQtoQShutdown,
pThis->globals.mainQ.iMainMsgQtoActShutdown, pThis->globals.mainQ.iMainMsgQtoEnq);
dbgprintf("Main queue watermarks: high: %d, low: %d, discard: %d, discard-severity: %d\n",
pThis->globals.mainQ.iMainMsgQHighWtrMark, pThis->globals.mainQ.iMainMsgQLowWtrMark,
pThis->globals.mainQ.iMainMsgQDiscardMark, pThis->globals.mainQ.iMainMsgQDiscardSeverity);
dbgprintf("Main queue save on shutdown %d, max disk space allowed %lld\n",
pThis->globals.mainQ.bMainMsgQSaveOnShutdown, pThis->globals.mainQ.iMainMsgQueMaxDiskSpace);
/* TODO: add
iActionRetryCount = 0;
iActionRetryInterval = 30000;
static int iMainMsgQtoWrkMinMsgs = 100;
static int iMainMsgQbSaveOnShutdown = 1;
iMainMsgQueMaxDiskSpace = 0;
setQPROP(qqueueSetiMinMsgsPerWrkr, "$MainMsgQueueWorkerThreadMinimumMessages", 100);
setQPROP(qqueueSetbSaveOnShutdown, "$MainMsgQueueSaveOnShutdown", 1);
*/
dbgprintf("Work Directory: '%s'.\n", glbl.GetWorkDir(pThis));
ochPrintList(pThis);
dbgprintf("Modules used in this configuration:\n");
for(modNode = pThis->modules.root ; modNode != NULL ; modNode = modNode->next) {
dbgprintf(" %s\n", module.GetName(modNode->pMod));
}
CODESTARTobjDebugPrint(rsconf)
ENDobjDebugPrint(rsconf)
static rsRetVal
parserProcessCnf(struct cnfobj *o)
{
struct cnfparamvals *pvals;
modInfo_t *pMod;
uchar *cnfModName = NULL;
uchar *parserName = NULL;
int paramIdx;
void *parserInst;
parser_t *myparser;
DEFiRet;
pvals = nvlstGetParams(o->nvlst, &parserpblk, NULL);
if(pvals == NULL) {
ABORT_FINALIZE(RS_RET_CONFIG_ERROR);
}
DBGPRINTF("input param blk after parserProcessCnf:\n");
cnfparamsPrint(&parserpblk, pvals);
paramIdx = cnfparamGetIdx(&parserpblk, "name");
parserName = (uchar*)es_str2cstr(pvals[paramIdx].val.d.estr, NULL);
if(parser.FindParser(loadConf->parsers.pParsLstRoot, &myparser, parserName) != RS_RET_PARSER_NOT_FOUND) {
LogError(0, RS_RET_PARSER_NAME_EXISTS,
"parser module name '%s' already exists", parserName);
ABORT_FINALIZE(RS_RET_PARSER_NAME_EXISTS);
}
paramIdx = cnfparamGetIdx(&parserpblk, "type");
cnfModName = (uchar*)es_str2cstr(pvals[paramIdx].val.d.estr, NULL);
if((pMod = module.FindWithCnfName(loadConf, cnfModName, eMOD_PARSER)) == NULL) {
LogError(0, RS_RET_MOD_UNKNOWN, "parser module name '%s' is unknown", cnfModName);
ABORT_FINALIZE(RS_RET_MOD_UNKNOWN);
}
if(pMod->mod.pm.newParserInst == NULL) {
LogError(0, RS_RET_MOD_NO_PARSER_STMT,
"parser module '%s' does not support parser() statement", cnfModName);
ABORT_FINALIZE(RS_RET_MOD_NO_INPUT_STMT);
}
CHKiRet(pMod->mod.pm.newParserInst(o->nvlst, &parserInst));
/* all well, so let's (try) to add parser to config */
CHKiRet(parserConstructViaModAndName(pMod, parserName, parserInst));
finalize_it:
free(cnfModName);
free(parserName);
cnfparamvalsDestruct(pvals, &parserpblk);
RETiRet;
}
/* Process input() objects */
static rsRetVal
inputProcessCnf(struct cnfobj *o)
{
struct cnfparamvals *pvals;
modInfo_t *pMod;
uchar *cnfModName = NULL;
int typeIdx;
DEFiRet;
pvals = nvlstGetParams(o->nvlst, &inppblk, NULL);
if(pvals == NULL) {
ABORT_FINALIZE(RS_RET_CONFIG_ERROR);
}
DBGPRINTF("input param blk after inputProcessCnf:\n");
cnfparamsPrint(&inppblk, pvals);
typeIdx = cnfparamGetIdx(&inppblk, "type");
cnfModName = (uchar*)es_str2cstr(pvals[typeIdx].val.d.estr, NULL);
if((pMod = module.FindWithCnfName(loadConf, cnfModName, eMOD_IN)) == NULL) {
LogError(0, RS_RET_MOD_UNKNOWN, "input module name '%s' is unknown", cnfModName);
ABORT_FINALIZE(RS_RET_MOD_UNKNOWN);
}
if(pMod->mod.im.newInpInst == NULL) {
LogError(0, RS_RET_MOD_NO_INPUT_STMT,
"input module '%s' does not support input() statement", cnfModName);
ABORT_FINALIZE(RS_RET_MOD_NO_INPUT_STMT);
}
iRet = pMod->mod.im.newInpInst(o->nvlst);
finalize_it:
free(cnfModName);
cnfparamvalsDestruct(pvals, &inppblk);
RETiRet;
}
/*------------------------------ interface to flex/bison parser ------------------------------*/
extern int yylineno;
void
parser_warnmsg(const char *fmt, ...)
{
va_list ap;
char errBuf[1024];
va_start(ap, fmt);
if(vsnprintf(errBuf, sizeof(errBuf), fmt, ap) == sizeof(errBuf))
errBuf[sizeof(errBuf)-1] = '\0';
LogMsg(0, RS_RET_CONF_PARSE_WARNING, LOG_WARNING,
"warning during parsing file %s, on or before line %d: %s",
cnfcurrfn, yylineno, errBuf);
va_end(ap);
}
void
parser_errmsg(const char *fmt, ...)
{
va_list ap;
char errBuf[1024];
va_start(ap, fmt);
if(vsnprintf(errBuf, sizeof(errBuf), fmt, ap) == sizeof(errBuf))
errBuf[sizeof(errBuf)-1] = '\0';
if(cnfcurrfn == NULL) {
LogError(0, RS_RET_CONF_PARSE_ERROR,
"error during config processing: %s", errBuf);
} else {
LogError(0, RS_RET_CONF_PARSE_ERROR,
"error during parsing file %s, on or before line %d: %s",
cnfcurrfn, yylineno, errBuf);
}
va_end(ap);
}
int yyerror(const char *s); /* we need this prototype to make compiler happy */
int
yyerror(const char *s)
{
parser_errmsg("%s on token '%s'", s, yytext);
return 0;
}
void ATTR_NONNULL()
cnfDoObj(struct cnfobj *const o)
{
int bDestructObj = 1;
int bChkUnuse = 1;
assert(o != NULL);
dbgprintf("cnf:global:obj: ");
cnfobjPrint(o);
/* We need to check for object disabling as early as here to cover most
* of them at once and avoid needless initializations
* - jvymazal 2020-02-12
*/
if (nvlstChkDisabled(o->nvlst)) {
dbgprintf("object disabled by configuration\n");
return;
}
switch(o->objType) {
case CNFOBJ_GLOBAL:
glblProcessCnf(o);
break;
case CNFOBJ_TIMEZONE:
glblProcessTimezone(o);
break;
case CNFOBJ_MAINQ:
glblProcessMainQCnf(o);
bDestructObj = 0;
break;
case CNFOBJ_MODULE:
modulesProcessCnf(o);
break;
case CNFOBJ_INPUT:
inputProcessCnf(o);
break;
case CNFOBJ_LOOKUP_TABLE:
lookupTableDefProcessCnf(o);
break;
case CNFOBJ_DYN_STATS:
dynstats_processCnf(o);
break;
case CNFOBJ_PERCTILE_STATS:
perctile_processCnf(o);
break;
case CNFOBJ_PARSER:
parserProcessCnf(o);
break;
case CNFOBJ_TPL:
if(tplProcessCnf(o) != RS_RET_OK)
parser_errmsg("error processing template object");
break;
case CNFOBJ_RULESET:
rulesetProcessCnf(o);
break;
case CNFOBJ_PROPERTY:
case CNFOBJ_CONSTANT:
/* these types are processed at a later stage */
bChkUnuse = 0;
break;
case CNFOBJ_ACTION:
default:
dbgprintf("cnfDoObj program error: unexpected object type %u\n",
o->objType);
break;
}
if(bDestructObj) {
if(bChkUnuse)
nvlstChkUnused(o->nvlst);
cnfobjDestruct(o);
}
}
void cnfDoScript(struct cnfstmt *script)
{
dbgprintf("cnf:global:script\n");
ruleset.AddScript(ruleset.GetCurrent(loadConf), script);
}
void cnfDoCfsysline(char *ln)
{
DBGPRINTF("cnf:global:cfsysline: %s\n", ln);
/* the legacy system needs the "$" stripped */
conf.cfsysline((uchar*) ln+1);
free(ln);
}
void cnfDoBSDTag(char *ln)
{
DBGPRINTF("cnf:global:BSD tag: %s\n", ln);
LogError(0, RS_RET_BSD_BLOCKS_UNSUPPORTED,
"BSD-style blocks are no longer supported in rsyslog, "
"see https://www.rsyslog.com/g/BSD for details and a "
"solution (Block '%s')", ln);
free(ln);
}
void cnfDoBSDHost(char *ln)
{
DBGPRINTF("cnf:global:BSD host: %s\n", ln);
LogError(0, RS_RET_BSD_BLOCKS_UNSUPPORTED,
"BSD-style blocks are no longer supported in rsyslog, "
"see https://www.rsyslog.com/g/BSD for details and a "
"solution (Block '%s')", ln);
free(ln);
}
/*------------------------------ end interface to flex/bison parser ------------------------------*/
/* drop to specified group
* if something goes wrong, the function never returns
*/
static
rsRetVal doDropPrivGid(rsconf_t *cnf)
{
int res;
uchar szBuf[1024];
DEFiRet;
if(!cnf->globals.gidDropPrivKeepSupplemental) {
res = setgroups(0, NULL); /* remove all supplemental group IDs */
if(res) {
LogError(errno, RS_RET_ERR_DROP_PRIV,
"could not remove supplemental group IDs");
ABORT_FINALIZE(RS_RET_ERR_DROP_PRIV);
}
DBGPRINTF("setgroups(0, NULL): %d\n", res);
}
res = setgid(cnf->globals.gidDropPriv);
if(res) {
LogError(errno, RS_RET_ERR_DROP_PRIV,
"could not set requested group id %d", cnf->globals.gidDropPriv);
ABORT_FINALIZE(RS_RET_ERR_DROP_PRIV);
}
DBGPRINTF("setgid(%d): %d\n", cnf->globals.gidDropPriv, res);
snprintf((char*)szBuf, sizeof(szBuf), "rsyslogd's groupid changed to %d",
cnf->globals.gidDropPriv);
logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, szBuf, 0);
finalize_it:
RETiRet;
}
/* drop to specified user
* if something goes wrong, the function never returns
* Note that such an abort can cause damage to on-disk structures, so we should
* re-design the "interface" in the long term. -- rgerhards, 2008-11-19
*/
static void doDropPrivUid(rsconf_t *cnf)
{
int res;
uchar szBuf[1024];
struct passwd *pw;
gid_t gid;
/* Try to set appropriate supplementary groups for this user.
* Failure is not fatal.
*/
pw = getpwuid(cnf->globals.uidDropPriv);
if (pw) {
gid = getgid();
res = initgroups(pw->pw_name, gid);
DBGPRINTF("initgroups(%s, %ld): %d\n", pw->pw_name, (long) gid, res);
} else {
LogError(errno, NO_ERRCODE, "could not get username for userid '%d'",
cnf->globals.uidDropPriv);
}
res = setuid(cnf->globals.uidDropPriv);
if(res) {
/* if we can not set the userid, this is fatal, so let's unconditionally abort */
perror("could not set requested userid");
exit(1);
}
DBGPRINTF("setuid(%d): %d\n", cnf->globals.uidDropPriv, res);
snprintf((char*)szBuf, sizeof(szBuf), "rsyslogd's userid changed to %d", cnf->globals.uidDropPriv);
logmsgInternal(NO_ERRCODE, LOG_SYSLOG|LOG_INFO, szBuf, 0);
}
/* drop privileges. This will drop to the configured privileges, if
* set by the user. After this method has been executed, the previous
* privileges can no be re-gained.
*/
static rsRetVal
dropPrivileges(rsconf_t *cnf)
{
DEFiRet;
if(cnf->globals.gidDropPriv != 0) {
CHKiRet(doDropPrivGid(cnf));
DBGPRINTF("group privileges have been dropped to gid %u\n", (unsigned)
cnf->globals.gidDropPriv);
}
if(cnf->globals.uidDropPriv != 0) {
doDropPrivUid(cnf);
DBGPRINTF("user privileges have been dropped to uid %u\n", (unsigned)
cnf->globals.uidDropPriv);
}
finalize_it:
RETiRet;
}
/* tell the rsysog core (including ourselfs) that the config load is done and
* we need to prepare to move over to activate mode.
*/
static inline rsRetVal
tellCoreConfigLoadDone(void)
{
DBGPRINTF("telling rsyslog core that config load for %p is done\n", loadConf);
return glblDoneLoadCnf();
}
/* Tell input modules that the config parsing stage is over. */
static rsRetVal
tellModulesConfigLoadDone(void)
{
cfgmodules_etry_t *node;
DBGPRINTF("telling modules that config load for %p is done\n", loadConf);
node = module.GetNxtCnfType(loadConf, NULL, eMOD_ANY);
while(node != NULL) {
DBGPRINTF("beginCnfLoad(%p) for module '%s'\n", node->pMod->beginCnfLoad, node->pMod->pszName);
if(node->pMod->beginCnfLoad != NULL) {
DBGPRINTF("calling endCnfLoad() for module '%s'\n", node->pMod->pszName);
node->pMod->endCnfLoad(node->modCnf);
}
node = module.GetNxtCnfType(loadConf, node, eMOD_ANY); // loadConf -> runConf
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* Tell input modules to verify config object */
static rsRetVal
tellModulesCheckConfig(void)
{
cfgmodules_etry_t *node;
rsRetVal localRet;
DBGPRINTF("telling modules to check config %p\n", loadConf);
node = module.GetNxtCnfType(loadConf, NULL, eMOD_ANY);
while(node != NULL) {
if(node->pMod->beginCnfLoad != NULL) {
localRet = node->pMod->checkCnf(node->modCnf);
DBGPRINTF("module %s tells us config can %sbe activated\n",
node->pMod->pszName, (localRet == RS_RET_OK) ? "" : "NOT ");
if(localRet == RS_RET_OK) {
node->canActivate = 1;
} else {
node->canActivate = 0;
}
}
node = module.GetNxtCnfType(loadConf, node, eMOD_ANY); // runConf -> loadConf
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* Tell modules to activate current running config (pre privilege drop) */
static rsRetVal
tellModulesActivateConfigPrePrivDrop(void)
{
cfgmodules_etry_t *node;
rsRetVal localRet;
DBGPRINTF("telling modules to activate config (before dropping privs) %p\n", runConf);
node = module.GetNxtCnfType(runConf, NULL, eMOD_ANY);
while(node != NULL) {
if( node->pMod->beginCnfLoad != NULL
&& node->pMod->activateCnfPrePrivDrop != NULL
&& node->canActivate) {
DBGPRINTF("pre priv drop activating config %p for module %s\n",
runConf, node->pMod->pszName);
localRet = node->pMod->activateCnfPrePrivDrop(node->modCnf);
if(localRet != RS_RET_OK) {
LogError(0, localRet, "activation of module %s failed",
node->pMod->pszName);
node->canActivate = 0; /* in a sense, could not activate... */
}
}
node = module.GetNxtCnfType(runConf, node, eMOD_ANY);
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* Tell modules to activate current running config */
static rsRetVal
tellModulesActivateConfig(void)
{
cfgmodules_etry_t *node;
rsRetVal localRet;
DBGPRINTF("telling modules to activate config %p\n", runConf);
node = module.GetNxtCnfType(runConf, NULL, eMOD_ANY);
while(node != NULL) {
if(node->pMod->beginCnfLoad != NULL && node->canActivate) {
DBGPRINTF("activating config %p for module %s\n",
runConf, node->pMod->pszName);
localRet = node->pMod->activateCnf(node->modCnf);
if(localRet != RS_RET_OK) {
LogError(0, localRet, "activation of module %s failed",
node->pMod->pszName);
node->canActivate = 0; /* in a sense, could not activate... */
}
}
node = module.GetNxtCnfType(runConf, node, eMOD_ANY);
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* Actually run the input modules. This happens after privileges are dropped,
* if that is requested.
*/
static rsRetVal
runInputModules(void)
{
cfgmodules_etry_t *node;
int bNeedsCancel;
node = module.GetNxtCnfType(runConf, NULL, eMOD_IN);
while(node != NULL) {
if(node->canRun) {
bNeedsCancel = (node->pMod->isCompatibleWithFeature(sFEATURENonCancelInputTermination)
== RS_RET_OK) ? 0 : 1;
DBGPRINTF("running module %s with config %p, term mode: %s\n", node->pMod->pszName, node,
bNeedsCancel ? "cancel" : "cooperative/SIGTTIN");
thrdCreate(node->pMod->mod.im.runInput, node->pMod->mod.im.afterRun, bNeedsCancel,
(node->pMod->cnfName == NULL) ? node->pMod->pszName : node->pMod->cnfName);
}
node = module.GetNxtCnfType(runConf, node, eMOD_IN);
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* Make the modules check if they are ready to start.
*/
static rsRetVal
startInputModules(void)
{
DEFiRet;
cfgmodules_etry_t *node;
node = module.GetNxtCnfType(runConf, NULL, eMOD_IN);
while(node != NULL) {
if(node->canActivate) {
iRet = node->pMod->mod.im.willRun();
node->canRun = (iRet == RS_RET_OK);
if(!node->canRun) {
DBGPRINTF("module %s will not run, iRet %d\n", node->pMod->pszName, iRet);
}
} else {
node->canRun = 0;
}
node = module.GetNxtCnfType(runConf, node, eMOD_IN);
}
return RS_RET_OK; /* intentional: we do not care about module errors */
}
/* load the main queue */
static rsRetVal
loadMainQueue(void)
{
DEFiRet;
struct cnfobj *mainqCnfObj;
mainqCnfObj = glbl.GetmainqCnfObj();
DBGPRINTF("loadMainQueue: mainq cnf obj ptr is %p\n", mainqCnfObj);
/* create message queue */
iRet = createMainQueue(&loadConf->pMsgQueue, UCHAR_CONSTANT("main Q"),
(mainqCnfObj == NULL) ? NULL : mainqCnfObj->nvlst);
if (iRet == RS_RET_OK) {
if (runConf != NULL) { /* dynamic config reload */
int areEqual = queuesEqual(loadConf->pMsgQueue, runConf->pMsgQueue);
DBGPRINTF("Comparison of old and new main queues: %d\n", areEqual);
if (areEqual) { /* content of the new main queue is the same as it was in previous conf */
qqueueDestruct(&loadConf->pMsgQueue);
loadConf->pMsgQueue = runConf->pMsgQueue;
}
}
}
if(iRet != RS_RET_OK) {
/* no queue is fatal, we need to give up in that case... */
fprintf(stderr, "fatal error %d: could not create message queue - rsyslogd can not run!\n", iRet);
FINALIZE;
}
finalize_it:
glblDestructMainqCnfObj();
RETiRet;
}
/* activate the main queue */
static rsRetVal
activateMainQueue(void)
{
DEFiRet;
DBGPRINTF("activateMainQueue: will try to activate main queue %p\n", runConf->pMsgQueue);
iRet = startMainQueue(runConf, runConf->pMsgQueue);
if(iRet != RS_RET_OK) {
/* no queue is fatal, we need to give up in that case... */
fprintf(stderr, "fatal error %d: could not create message queue - rsyslogd can not run!\n", iRet);
FINALIZE;
}
if(runConf->globals.mainQ.MainMsgQueType == QUEUETYPE_DIRECT) {
PREFER_STORE_0_TO_INT(&bHaveMainQueue);
} else {
PREFER_STORE_1_TO_INT(&bHaveMainQueue);
}
DBGPRINTF("Main processing queue is initialized and running\n");
finalize_it:
RETiRet;
}
/* set the processes umask (upon configuration request) */
static inline rsRetVal
setUmask(int iUmask)
{
if(iUmask != -1) {
umask(iUmask);
DBGPRINTF("umask set to 0%3.3o.\n", iUmask);
}
return RS_RET_OK;
}
/* Remove resources from previous config */
static void
cleanupOldCnf(rsconf_t *cnf)
{
if (cnf == NULL)
FINALIZE;
if (runConf->pMsgQueue != cnf->pMsgQueue)
qqueueDestruct(&cnf->pMsgQueue);
finalize_it:
return;
}
/* Activate an already-loaded configuration. The configuration will become
* the new running conf (if successful). Note that in theory this method may
* be called when there already is a running conf. In practice, the current