forked from rsyslog/rsyslog
/
imuxsock.c
1702 lines (1517 loc) · 56 KB
/
imuxsock.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
/* imuxsock.c
* This is the implementation of the Unix sockets input module.
*
* NOTE: read comments in module-template.h to understand how this file
* works!
*
* File begun on 2007-12-20 by RGerhards (extracted from syslogd.c)
*
* Copyright 2007-2016 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of rsyslog.
*
* Rsyslog 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 3 of the License, or
* (at your option) any later version.
*
* Rsyslog 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 Rsyslog. If not, see <http://www.gnu.org/licenses/>.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
*/
#include "config.h"
#include "rsyslog.h"
#include <stdlib.h>
#include <stdio.h>
#include <ctype.h>
#include <assert.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/un.h>
#include <sys/socket.h>
#include "dirty.h"
#include "cfsysline.h"
#include "unicode-helper.h"
#include "module-template.h"
#include "srUtils.h"
#include "errmsg.h"
#include "net.h"
#include "glbl.h"
#include "msg.h"
#include "parser.h"
#include "prop.h"
#include "debug.h"
#include "ruleset.h"
#include "unlimited_select.h"
#include "sd-daemon.h"
#include "statsobj.h"
#include "datetime.h"
#include "hashtable.h"
#include "ratelimit.h"
#pragma GCC diagnostic ignored "-Wswitch-enum"
MODULE_TYPE_INPUT
MODULE_TYPE_NOKEEP
MODULE_CNFNAME("imuxsock")
/* defines */
#ifndef _PATH_LOG
#ifdef BSD
#define _PATH_LOG "/var/run/log"
#else
#define _PATH_LOG "/dev/log"
#endif
#endif
#ifndef SYSTEMD_JOURNAL
#define SYSTEMD_JOURNAL "/run/systemd/journal"
#endif
#ifndef SYSTEMD_PATH_LOG
#define SYSTEMD_PATH_LOG SYSTEMD_JOURNAL "/syslog"
#endif
#define UNSET -1 /* to indicate a value has not been configured */
/* forward definitions */
static rsRetVal resetConfigVariables(uchar __attribute__((unused)) *pp, void __attribute__((unused)) *pVal);
/* emulate struct ucred for platforms that do not have it */
#ifndef HAVE_SCM_CREDENTIALS
struct ucred { int pid; uid_t uid; gid_t gid; };
#endif
/* handle some defines missing on more than one platform */
#ifndef SUN_LEN
#define SUN_LEN(su) \
(sizeof(*(su)) - sizeof((su)->sun_path) + strlen((su)->sun_path))
#endif
/* Module static data */
DEF_IMOD_STATIC_DATA
DEFobjCurrIf(errmsg)
DEFobjCurrIf(glbl)
DEFobjCurrIf(prop)
DEFobjCurrIf(net)
DEFobjCurrIf(parser)
DEFobjCurrIf(datetime)
DEFobjCurrIf(statsobj)
DEFobjCurrIf(ruleset)
statsobj_t *modStats;
STATSCOUNTER_DEF(ctrSubmit, mutCtrSubmit)
STATSCOUNTER_DEF(ctrLostRatelimit, mutCtrLostRatelimit)
STATSCOUNTER_DEF(ctrNumRatelimiters, mutCtrNumRatelimiters)
/* a very simple "hash function" for process IDs - we simply use the
* pid itself: it is quite expected that all pids may log some time, but
* from a collision point of view it is likely that long-running daemons
* start early and so will stay right in the top spots of the
* collision list.
*/
static unsigned int
hash_from_key_fn(void *k)
{
return((unsigned) *((pid_t*) k));
}
static int
key_equals_fn(void *key1, void *key2)
{
return *((pid_t*) key1) == *((pid_t*) key2);
}
/* structure to describe a specific listener */
typedef struct lstn_s {
uchar *sockName; /* read-only after startup */
prop_t *hostName; /* host-name override - if set, use this instead of actual name */
int fd; /* read-only after startup */
int flags; /* should parser parse host name? read-only after startup */
int flowCtl; /* flow control settings for this socket */
int ratelimitInterval;
int ratelimitBurst;
ratelimit_t *dflt_ratelimiter;/*ratelimiter to apply if none else is to be used */
intTiny ratelimitSev; /* severity level (and below) for which rate-limiting shall apply */
struct hashtable *ht; /* our hashtable for rate-limiting */
sbool bParseHost; /* should parser parse host name? read-only after startup */
sbool bCreatePath; /* auto-creation of socket directory? */
sbool bUseCreds; /* pull original creator credentials from socket */
sbool bAnnotate; /* annotate events with trusted properties */
sbool bParseTrusted; /* parse trusted properties */
sbool bWritePid; /* write original PID into tag */
sbool bDiscardOwnMsgs; /* discard messages that originated from ourselves */
sbool bUseSysTimeStamp; /* use timestamp from system (instead of from message) */
sbool bUnlink; /* unlink&re-create socket at start and end of processing */
sbool bUseSpecialParser;/* use "canned" log socket parser instead of parser chain? */
ruleset_t *pRuleset;
} lstn_t;
static lstn_t *listeners;
static prop_t *pLocalHostIP = NULL; /* there is only one global IP for all internally-generated messages */
static prop_t *pInputName = NULL; /* our inputName currently is always "imudp", and this will hold it */
static int startIndexUxLocalSockets; /* process fd from that index on (used to
* suppress local logging. rgerhards 2005-08-01
* read-only after startup
*/
static int nfd = 1; /* number of active unix sockets (socket 0 is always reserved for the system
socket, even if it is not enabled. */
static int sd_fds = 0; /* number of systemd activated sockets */
#define DFLT_bCreatePath 0
#define DFLT_ratelimitInterval 0
#define DFLT_ratelimitBurst 200
#define DFLT_ratelimitSeverity 1 /* do not rate-limit emergency messages */
/* config vars for the legacy config system */
static struct configSettings_s {
int bOmitLocalLogging;
uchar *pLogSockName;
uchar *pLogHostName; /* host name to use with this socket */
int bUseFlowCtl; /* use flow control or not (if yes, only LIGHT is used!) */
int bUseFlowCtlSysSock;
int bIgnoreTimestamp; /* ignore timestamps present in the incoming message? */
int bIgnoreTimestampSysSock;
int bUseSysTimeStamp; /* use timestamp from system (rather than from message) */
int bUseSysTimeStampSysSock; /* same, for system log socket */
int bWritePid; /* use credentials from recvmsg() and fixup PID in TAG */
int bWritePidSysSock; /* use credentials from recvmsg() and fixup PID in TAG */
int bCreatePath; /* auto-create socket path? */
int ratelimitInterval; /* interval in seconds, 0 = off */
int ratelimitIntervalSysSock;
int ratelimitBurst; /* max nbr of messages in interval */
int ratelimitBurstSysSock;
int ratelimitSeverity;
int ratelimitSeveritySysSock;
int bAnnotate; /* annotate trusted properties */
int bAnnotateSysSock; /* same, for system log socket */
int bParseTrusted; /* parse trusted properties */
} cs;
/* config vars for the v2 config system (rsyslog v6+) */
struct instanceConf_s {
uchar *sockName;
uchar *pLogHostName; /* host name to use with this socket */
sbool bUseFlowCtl; /* use flow control or not (if yes, only LIGHT is used! */
sbool bIgnoreTimestamp; /* ignore timestamps present in the incoming message? */
sbool bWritePid; /* use credentials from recvmsg() and fixup PID in TAG */
sbool bUseSysTimeStamp; /* use timestamp from system (instead of from message) */
int bCreatePath; /* auto-create socket path? */
int ratelimitInterval; /* interval in seconds, 0 = off */
int ratelimitBurst; /* max nbr of messages in interval */
int ratelimitSeverity;
int bAnnotate; /* annotate trusted properties */
int bParseTrusted; /* parse trusted properties */
sbool bDiscardOwnMsgs; /* discard messages that originated from our own pid? */
sbool bUnlink;
sbool bUseSpecialParser;
sbool bParseHost;
uchar *pszBindRuleset; /* name of ruleset to bind to */
ruleset_t *pBindRuleset; /* ruleset to bind listener to (use system default if unspecified) */
struct instanceConf_s *next;
};
struct modConfData_s {
rsconf_t *pConf; /* our overall config object */
instanceConf_t *root, *tail;
uchar *pLogSockName;
int ratelimitIntervalSysSock;
int ratelimitBurstSysSock;
int ratelimitSeveritySysSock;
int bAnnotateSysSock;
int bParseTrusted;
int bUseSpecialParser;
int bParseHost;
sbool bIgnoreTimestamp; /* ignore timestamps present in the incoming message? */
sbool bUseFlowCtl; /* use flow control or not (if yes, only LIGHT is used! */
sbool bOmitLocalLogging;
sbool bWritePidSysSock;
sbool bUseSysTimeStamp;
sbool bDiscardOwnMsgs;
sbool configSetViaV2Method;
sbool bUnlink;
};
static modConfData_t *loadModConf = NULL;/* modConf ptr to use for the current load process */
static modConfData_t *runModConf = NULL;/* modConf ptr to use for the current load process */
/* module-global parameters */
static struct cnfparamdescr modpdescr[] = {
{ "syssock.use", eCmdHdlrBinary, 0 },
{ "syssock.name", eCmdHdlrGetWord, 0 },
{ "syssock.unlink", eCmdHdlrBinary, 0 },
{ "syssock.ignoretimestamp", eCmdHdlrBinary, 0 },
{ "syssock.ignoreownmessages", eCmdHdlrBinary, 0 },
{ "syssock.flowcontrol", eCmdHdlrBinary, 0 },
{ "syssock.usesystimestamp", eCmdHdlrBinary, 0 },
{ "syssock.annotate", eCmdHdlrBinary, 0 },
{ "syssock.parsetrusted", eCmdHdlrBinary, 0 },
{ "syssock.usespecialparser", eCmdHdlrBinary, 0 },
{ "syssock.parsehostname", eCmdHdlrBinary, 0 },
{ "syssock.usepidfromsystem", eCmdHdlrBinary, 0 },
{ "syssock.ratelimit.interval", eCmdHdlrInt, 0 },
{ "syssock.ratelimit.burst", eCmdHdlrInt, 0 },
{ "syssock.ratelimit.severity", eCmdHdlrInt, 0 }
};
static struct cnfparamblk modpblk =
{ CNFPARAMBLK_VERSION,
sizeof(modpdescr)/sizeof(struct cnfparamdescr),
modpdescr
};
/* input instance parameters */
static struct cnfparamdescr inppdescr[] = {
{ "socket", eCmdHdlrString, CNFPARAM_REQUIRED }, /* legacy: addunixlistensocket */
{ "unlink", eCmdHdlrBinary, 0 },
{ "createpath", eCmdHdlrBinary, 0 },
{ "parsetrusted", eCmdHdlrBinary, 0 },
{ "ignoreownmessages", eCmdHdlrBinary, 0 },
{ "hostname", eCmdHdlrString, 0 },
{ "ignoretimestamp", eCmdHdlrBinary, 0 },
{ "flowcontrol", eCmdHdlrBinary, 0 },
{ "usesystimestamp", eCmdHdlrBinary, 0 },
{ "annotate", eCmdHdlrBinary, 0 },
{ "usespecialparser", eCmdHdlrBinary, 0 },
{ "parsehostname", eCmdHdlrBinary, 0 },
{ "usepidfromsystem", eCmdHdlrBinary, 0 },
{ "ruleset", eCmdHdlrString, 0 },
{ "ratelimit.interval", eCmdHdlrInt, 0 },
{ "ratelimit.burst", eCmdHdlrInt, 0 },
{ "ratelimit.severity", eCmdHdlrInt, 0 }
};
static struct cnfparamblk inppblk =
{ CNFPARAMBLK_VERSION,
sizeof(inppdescr)/sizeof(struct cnfparamdescr),
inppdescr
};
#include "im-helper.h" /* must be included AFTER the type definitions! */
static int bLegacyCnfModGlobalsPermitted;/* are legacy module-global config parameters permitted? */
/* create input instance, set default parameters, and
* add it to the list of instances.
*/
static rsRetVal
createInstance(instanceConf_t **pinst)
{
instanceConf_t *inst;
DEFiRet;
CHKmalloc(inst = MALLOC(sizeof(instanceConf_t)));
inst->sockName = NULL;
inst->pLogHostName = NULL;
inst->pszBindRuleset = NULL;
inst->pBindRuleset = NULL;
inst->ratelimitInterval = DFLT_ratelimitInterval;
inst->ratelimitBurst = DFLT_ratelimitBurst;
inst->ratelimitSeverity = DFLT_ratelimitSeverity;
inst->bUseFlowCtl = 0;
inst->bUseSpecialParser = 1;
inst->bParseHost = UNSET;
inst->bIgnoreTimestamp = 1;
inst->bCreatePath = DFLT_bCreatePath;
inst->bUseSysTimeStamp = 1;
inst->bWritePid = 0;
inst->bAnnotate = 0;
inst->bParseTrusted = 0;
inst->bDiscardOwnMsgs = 1;
inst->bUnlink = 1;
inst->next = NULL;
/* node created, let's add to config */
if(loadModConf->tail == NULL) {
loadModConf->tail = loadModConf->root = inst;
} else {
loadModConf->tail->next = inst;
loadModConf->tail = inst;
}
*pinst = inst;
finalize_it:
RETiRet;
}
/* This function is called when a new listen socket instance shall be added to
* the current config object via the legacy config system. It just shuffles
* all parameters to the listener in-memory instance.
* rgerhards, 2011-05-12
*/
static rsRetVal addInstance(void __attribute__((unused)) *pVal, uchar *pNewVal)
{
instanceConf_t *inst;
DEFiRet;
if(pNewVal == NULL || pNewVal[0] == '\0') {
errmsg.LogError(0, RS_RET_SOCKNAME_MISSING , "imuxsock: socket name must be specified, "
"but is not - listener not created\n");
if(pNewVal != NULL)
free(pNewVal);
ABORT_FINALIZE(RS_RET_SOCKNAME_MISSING);
}
CHKiRet(createInstance(&inst));
inst->sockName = pNewVal;
inst->ratelimitInterval = cs.ratelimitInterval;
inst->pLogHostName = cs.pLogHostName;
inst->ratelimitBurst = cs.ratelimitBurst;
inst->ratelimitSeverity = cs.ratelimitSeverity;
inst->bUseFlowCtl = cs.bUseFlowCtl;
inst->bIgnoreTimestamp = cs.bIgnoreTimestamp;
inst->bCreatePath = cs.bCreatePath;
inst->bUseSysTimeStamp = cs.bUseSysTimeStamp;
inst->bWritePid = cs.bWritePid;
inst->bAnnotate = cs.bAnnotate;
inst->bParseTrusted = cs.bParseTrusted;
inst->bParseHost = UNSET;
inst->next = NULL;
/* reset hostname for next socket */
cs.pLogHostName = NULL;
finalize_it:
RETiRet;
}
/* add an additional listen socket.
* added capability to specify hostname for socket -- rgerhards, 2008-08-01
*/
static rsRetVal
addListner(instanceConf_t *inst)
{
DEFiRet;
if(inst->bParseHost == UNSET) {
if(*inst->sockName == ':') {
listeners[nfd].bParseHost = 1;
} else {
listeners[nfd].bParseHost = 0;
}
} else {
listeners[nfd].bParseHost = inst->bParseHost;
}
if(inst->pLogHostName == NULL) {
listeners[nfd].hostName = NULL;
} else {
CHKiRet(prop.Construct(&(listeners[nfd].hostName)));
CHKiRet(prop.SetString(listeners[nfd].hostName, inst->pLogHostName, ustrlen(inst->pLogHostName)));
CHKiRet(prop.ConstructFinalize(listeners[nfd].hostName));
}
if(inst->ratelimitInterval > 0) {
if((listeners[nfd].ht = create_hashtable(100, hash_from_key_fn, key_equals_fn,
(void(*)(void*))ratelimitDestruct)) == NULL) {
/* in this case, we simply turn off rate-limiting */
DBGPRINTF("imuxsock: turning off rate limiting because we could not "
"create hash table\n");
inst->ratelimitInterval = 0;
}
} else {
listeners[nfd].ht = NULL;
}
listeners[nfd].ratelimitInterval = inst->ratelimitInterval;
listeners[nfd].ratelimitBurst = inst->ratelimitBurst;
listeners[nfd].ratelimitSev = inst->ratelimitSeverity;
listeners[nfd].flowCtl = inst->bUseFlowCtl ? eFLOWCTL_LIGHT_DELAY : eFLOWCTL_NO_DELAY;
listeners[nfd].flags = inst->bIgnoreTimestamp ? IGNDATE : NOFLAG;
listeners[nfd].bCreatePath = inst->bCreatePath;
listeners[nfd].sockName = ustrdup(inst->sockName);
listeners[nfd].bUseCreds = (inst->bDiscardOwnMsgs || inst->bWritePid || inst->ratelimitInterval || inst->bAnnotate || inst->bUseSysTimeStamp) ? 1 : 0;
listeners[nfd].bAnnotate = inst->bAnnotate;
listeners[nfd].bParseTrusted = inst->bParseTrusted;
listeners[nfd].bDiscardOwnMsgs = inst->bDiscardOwnMsgs;
listeners[nfd].bUnlink = inst->bUnlink;
listeners[nfd].bWritePid = inst->bWritePid;
listeners[nfd].bUseSysTimeStamp = inst->bUseSysTimeStamp;
listeners[nfd].bUseSpecialParser = inst->bUseSpecialParser;
listeners[nfd].pRuleset = inst->pBindRuleset;
CHKiRet(ratelimitNew(&listeners[nfd].dflt_ratelimiter, "imuxsock", NULL));
ratelimitSetLinuxLike(listeners[nfd].dflt_ratelimiter,
listeners[nfd].ratelimitInterval,
listeners[nfd].ratelimitBurst);
ratelimitSetSeverity(listeners[nfd].dflt_ratelimiter,
listeners[nfd].ratelimitSev);
nfd++;
finalize_it:
RETiRet;
}
static rsRetVal discardLogSockets(void)
{
int i;
/* Check whether the system socket is in use */
if(startIndexUxLocalSockets == 0) {
/* Clean up rate limiting data for the system socket */
if(listeners[0].ht != NULL) {
hashtable_destroy(listeners[0].ht, 1); /* 1 => free all values automatically */
}
ratelimitDestruct(listeners[0].dflt_ratelimiter);
}
/* Clean up all other sockets */
for (i = 1; i < nfd; i++) {
if(listeners[i].sockName != NULL) {
free(listeners[i].sockName);
listeners[i].sockName = NULL;
}
if(listeners[i].hostName != NULL) {
prop.Destruct(&(listeners[i].hostName));
}
if(listeners[i].ht != NULL) {
hashtable_destroy(listeners[i].ht, 1); /* 1 => free all values automatically */
}
ratelimitDestruct(listeners[i].dflt_ratelimiter);
}
return RS_RET_OK;
}
/* used to create a log socket if NOT passed in via systemd.
*/
static inline rsRetVal
createLogSocket(lstn_t *pLstn)
{
struct sockaddr_un sunx;
DEFiRet;
if(pLstn->bUnlink)
unlink((char*)pLstn->sockName);
memset(&sunx, 0, sizeof(sunx));
sunx.sun_family = AF_UNIX;
if(pLstn->bCreatePath) {
makeFileParentDirs((uchar*)pLstn->sockName, ustrlen(pLstn->sockName), 0755, -1, -1, 0);
}
strncpy(sunx.sun_path, (char*)pLstn->sockName, sizeof(sunx.sun_path));
pLstn->fd = socket(AF_UNIX, SOCK_DGRAM, 0);
if(pLstn->fd < 0 || bind(pLstn->fd, (struct sockaddr *) &sunx, SUN_LEN(&sunx)) < 0 ||
chmod((char*)pLstn->sockName, 0666) < 0) {
errmsg.LogError(errno, NO_ERRCODE, "cannot create '%s'", pLstn->sockName);
DBGPRINTF("cannot create %s (%d).\n", pLstn->sockName, errno);
if(pLstn->fd != -1)
close(pLstn->fd);
pLstn->fd = -1;
ABORT_FINALIZE(RS_RET_ERR_CRE_AFUX);
}
finalize_it:
RETiRet;
}
static inline rsRetVal
openLogSocket(lstn_t *pLstn)
{
DEFiRet;
# if HAVE_SCM_CREDENTIALS
int one;
# endif /* HAVE_SCM_CREDENTIALS */
if(pLstn->sockName[0] == '\0')
return -1;
pLstn->fd = -1;
if (sd_fds > 0) {
/* Check if the current socket is a systemd activated one.
* If so, just use it.
*/
int fd;
for (fd = SD_LISTEN_FDS_START; fd < SD_LISTEN_FDS_START + sd_fds; fd++) {
if( sd_is_socket_unix(fd, SOCK_DGRAM, -1, (const char*) pLstn->sockName, 0) == 1) {
/* ok, it matches -- just use as is */
pLstn->fd = fd;
DBGPRINTF("imuxsock: Acquired UNIX socket '%s' (fd %d) from systemd.\n",
pLstn->sockName, pLstn->fd);
break;
}
/*
* otherwise it either didn't match *this* socket and
* we just continue to check the next one or there was
* an error and we will create a new socket below.
*/
}
}
if (pLstn->fd == -1) {
CHKiRet(createLogSocket(pLstn));
}
# if HAVE_SCM_CREDENTIALS
if(pLstn->bUseCreds) {
one = 1;
if(setsockopt(pLstn->fd, SOL_SOCKET, SO_PASSCRED, &one, (socklen_t) sizeof(one)) != 0) {
errmsg.LogError(errno, NO_ERRCODE, "set SO_PASSCRED failed on '%s'", pLstn->sockName);
pLstn->bUseCreds = 0;
}
// TODO: move to its own #if
if(setsockopt(pLstn->fd, SOL_SOCKET, SO_TIMESTAMP, &one, sizeof(one)) != 0) {
errmsg.LogError(errno, NO_ERRCODE, "set SO_TIMESTAMP failed on '%s'", pLstn->sockName);
}
}
# else /* HAVE_SCM_CREDENTIALS */
pLstn->bUseCreds = 0;
pLstn->bAnnotate = 0;
# endif /* HAVE_SCM_CREDENTIALS */
finalize_it:
if(iRet != RS_RET_OK) {
if(pLstn->fd != -1) {
close(pLstn->fd);
pLstn->fd = -1;
}
}
RETiRet;
}
/* find ratelimiter to use for this message. Currently, we use the
* pid, but may change to cgroup later (probably via a config switch).
* Returns NULL if not found or rate-limiting not activated for this
* listener (the latter being a performance enhancement).
*/
static inline rsRetVal
findRatelimiter(lstn_t *pLstn, struct ucred *cred, ratelimit_t **prl)
{
ratelimit_t *rl = NULL;
int r;
pid_t *keybuf;
char pidbuf[256];
DEFiRet;
if(cred == NULL)
FINALIZE;
#if 0 // TODO: check deactivated?
if(pLstn->ratelimitInterval == 0) {
*prl = NULL;
FINALIZE;
}
#endif
if(pLstn->ht == NULL) {
*prl = NULL;
FINALIZE;
}
rl = hashtable_search(pLstn->ht, &cred->pid);
if(rl == NULL) {
/* we need to add a new ratelimiter, process not seen before! */
DBGPRINTF("imuxsock: no ratelimiter for pid %lu, creating one\n",
(unsigned long) cred->pid);
STATSCOUNTER_INC(ctrNumRatelimiters, mutCtrNumRatelimiters);
snprintf(pidbuf, sizeof(pidbuf), "pid %lu",
(unsigned long) cred->pid);
pidbuf[sizeof(pidbuf)-1] = '\0'; /* to be on safe side */
CHKiRet(ratelimitNew(&rl, "imuxsock", pidbuf));
ratelimitSetLinuxLike(rl, pLstn->ratelimitInterval, pLstn->ratelimitBurst);
ratelimitSetSeverity(rl, pLstn->ratelimitSev);
CHKmalloc(keybuf = malloc(sizeof(pid_t)));
*keybuf = cred->pid;
r = hashtable_insert(pLstn->ht, keybuf, rl);
if(r == 0)
ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY);
}
*prl = rl;
rl = NULL;
finalize_it:
if(rl != NULL)
ratelimitDestruct(rl);
if(*prl == NULL)
*prl = pLstn->dflt_ratelimiter;
RETiRet;
}
/* patch correct pid into tag. bufTAG MUST be CONF_TAG_MAXSIZE long!
*/
static inline void
fixPID(uchar *bufTAG, int *lenTag, struct ucred *cred)
{
int i;
char bufPID[16];
int lenPID;
if(cred == NULL)
return;
lenPID = snprintf(bufPID, sizeof(bufPID), "[%lu]:", (unsigned long) cred->pid);
for(i = *lenTag ; i >= 0 && bufTAG[i] != '[' ; --i)
/*JUST SKIP*/;
if(i < 0)
i = *lenTag - 1; /* go right at end of TAG, pid was not present (-1 for ':') */
if(i + lenPID > CONF_TAG_MAXSIZE)
return; /* do not touch, as things would break */
memcpy(bufTAG + i, bufPID, lenPID);
*lenTag = i + lenPID;
}
/* Get an "trusted property" from the system. Returns an empty string if the
* property can not be obtained. Inspired by similiar functionality inside
* journald. Currently works with Linux /proc filesystem, only.
*/
static rsRetVal
getTrustedProp(struct ucred *cred, const char *propName, uchar *buf, size_t lenBuf, int *lenProp)
{
int fd;
int i;
int lenRead;
char namebuf[1024];
DEFiRet;
if(snprintf(namebuf, sizeof(namebuf), "/proc/%lu/%s", (long unsigned) cred->pid,
propName) >= (int) sizeof(namebuf)) {
ABORT_FINALIZE(RS_RET_ERR);
}
if((fd = open(namebuf, O_RDONLY)) == -1) {
DBGPRINTF("error reading '%s'\n", namebuf);
ABORT_FINALIZE(RS_RET_ERR);
}
if((lenRead = read(fd, buf, lenBuf - 1)) == -1) {
DBGPRINTF("error reading file data for '%s'\n", namebuf);
close(fd);
ABORT_FINALIZE(RS_RET_ERR);
}
/* we strip after the first \n */
for(i = 0 ; i < lenRead ; ++i) {
if(buf[i] == '\n')
break;
else if(iscntrl(buf[i]))
buf[i] = ' ';
}
buf[i] = '\0';
*lenProp = i;
close(fd);
finalize_it:
RETiRet;
}
/* read the exe trusted property path (so far, /proc fs only)
*/
static rsRetVal
getTrustedExe(struct ucred *cred, uchar *buf, size_t lenBuf, int* lenProp)
{
int lenRead;
char namebuf[1024];
DEFiRet;
if(snprintf(namebuf, sizeof(namebuf), "/proc/%lu/exe", (long unsigned) cred->pid)
>= (int) sizeof(namebuf)) {
ABORT_FINALIZE(RS_RET_ERR);
}
if((lenRead = readlink(namebuf, (char*)buf, lenBuf - 1)) == -1) {
DBGPRINTF("error reading link '%s'\n", namebuf);
ABORT_FINALIZE(RS_RET_ERR);
}
buf[lenRead] = '\0';
*lenProp = lenRead;
finalize_it:
RETiRet;
}
/* copy a trusted property in escaped mode. That is, the property can contain
* any character and so it must be properly quoted AND escaped.
* It is assumed the output buffer is large enough. Returns the number of
* characters added.
*/
static inline int
copyescaped(uchar *dstbuf, uchar *inbuf, int inlen)
{
int iDst, iSrc;
*dstbuf = '"';
for(iDst=1, iSrc=0 ; iSrc < inlen ; ++iDst, ++iSrc) {
if(inbuf[iSrc] == '"' || inbuf[iSrc] == '\\') {
dstbuf[iDst++] = '\\';
}
dstbuf[iDst] = inbuf[iSrc];
}
dstbuf[iDst++] = '"';
return iDst;
}
/* submit received message to the queue engine
* We now parse the message according to expected format so that we
* can also mangle it if necessary.
*/
static inline rsRetVal
SubmitMsg(uchar *pRcv, int lenRcv, lstn_t *pLstn, struct ucred *cred, struct timeval *ts)
{
msg_t *pMsg = NULL;
int lenMsg;
int offs;
int i;
uchar *parse;
syslog_pri_t pri;
uchar bufParseTAG[CONF_TAG_MAXSIZE];
struct syslogTime st;
time_t tt;
ratelimit_t *ratelimiter = NULL;
struct syslogTime dummyTS;
DEFiRet;
if(pLstn->bDiscardOwnMsgs && cred != NULL && cred->pid == glblGetOurPid()) {
DBGPRINTF("imuxsock: discarding message from our own pid\n");
FINALIZE;
}
/* TODO: handle format errors?? */
/* we need to parse the pri first, because we need the severity for
* rate-limiting as well.
*/
parse = pRcv;
lenMsg = lenRcv;
offs = 1; /* '<' */
parse++;
pri = 0;
while(offs < lenMsg && isdigit(*parse)) {
pri = pri * 10 + *parse - '0';
++parse;
++offs;
}
findRatelimiter(pLstn, cred, &ratelimiter); /* ignore error, better so than others... */
if(ts == NULL) {
datetime.getCurrTime(&st, &tt, TIME_IN_LOCALTIME);
} else {
datetime.timeval2syslogTime(ts, &st, TIME_IN_LOCALTIME);
tt = ts->tv_sec;
}
#if 0 // TODO: think about stats counters (or wait for request...?)
if(ratelimiter != NULL && !withinRatelimit(ratelimiter, tt, cred->pid)) {
STATSCOUNTER_INC(ctrLostRatelimit, mutCtrLostRatelimit);
FINALIZE;
}
#endif
/* we now create our own message object and submit it to the queue */
CHKiRet(msgConstructWithTime(&pMsg, &st, tt));
/* created trusted properties */
if(cred != NULL && pLstn->bAnnotate) {
uchar propBuf[1024];
int lenProp;
if (pLstn->bParseTrusted) {
struct json_object *json, *jval;
#define CHKjson(operation, toBeFreed) \
if((operation) == NULL) { \
json_object_put(toBeFreed); \
ABORT_FINALIZE(RS_RET_OUT_OF_MEMORY); \
}
CHKmalloc(json = json_object_new_object());
/* create value string, create field, and add it */
CHKjson(jval = json_object_new_int(cred->pid), json);
json_object_object_add(json, "pid", jval);
CHKjson(jval = json_object_new_int(cred->uid), json);
json_object_object_add(json, "uid", jval);
CHKjson(jval = json_object_new_int(cred->gid), json);
json_object_object_add(json, "gid", jval);
if(getTrustedProp(cred, "comm", propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
CHKjson(jval = json_object_new_string((char*)propBuf), json);
json_object_object_add(json, "appname", jval);
}
if(getTrustedExe(cred, propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
CHKjson(jval = json_object_new_string((char*)propBuf), json);
json_object_object_add(json, "exe", jval);
}
if(getTrustedProp(cred, "cmdline", propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
CHKjson(jval = json_object_new_string((char*)propBuf), json);
json_object_object_add(json, "cmd", jval);
}
#undef CHKjson
/* as per lumberjack spec, these properties need to go into
* the CEE root.
*/
msgAddJSON(pMsg, (uchar*)"!", json, 0, 0);
MsgSetRawMsg(pMsg, (char*)pRcv, lenRcv);
} else {
uchar msgbuf[8192];
uchar *pmsgbuf = msgbuf;
int toffs; /* offset for trusted properties */
if((unsigned) (lenRcv + 4096) >= sizeof(msgbuf)) {
CHKmalloc(pmsgbuf = malloc(lenRcv+4096));
}
memcpy(pmsgbuf, pRcv, lenRcv);
memcpy(pmsgbuf+lenRcv, " @[", 3);
toffs = lenRcv + 3; /* next free location */
lenProp = snprintf((char*)propBuf, sizeof(propBuf), "_PID=%lu _UID=%lu _GID=%lu",
(long unsigned) cred->pid, (long unsigned) cred->uid,
(long unsigned) cred->gid);
memcpy(pmsgbuf+toffs, propBuf, lenProp);
toffs = toffs + lenProp;
if(getTrustedProp(cred, "comm", propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
memcpy(pmsgbuf+toffs, " _COMM=", 7);
memcpy(pmsgbuf+toffs+7, propBuf, lenProp);
toffs = toffs + 7 + lenProp;
}
if(getTrustedExe(cred, propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
memcpy(pmsgbuf+toffs, " _EXE=", 6);
memcpy(pmsgbuf+toffs+6, propBuf, lenProp);
toffs = toffs + 6 + lenProp;
}
if(getTrustedProp(cred, "cmdline", propBuf, sizeof(propBuf), &lenProp) == RS_RET_OK) {
memcpy(pmsgbuf+toffs, " _CMDLINE=", 10);
toffs = toffs + 10 +
copyescaped(pmsgbuf+toffs+10, propBuf, lenProp);
}
/* finalize string */
pmsgbuf[toffs] = ']';
pmsgbuf[toffs+1] = '\0';
MsgSetRawMsg(pMsg, (char*)pmsgbuf, toffs + 1);
if (pmsgbuf != msgbuf) {
free(pmsgbuf);
}
}
} else {
/* just add the unmodified message */
MsgSetRawMsg(pMsg, (char*)pRcv, lenRcv);
}
MsgSetFlowControlType(pMsg, pLstn->flowCtl);
MsgSetInputName(pMsg, pInputName);
if(pLstn->bParseHost) {
pMsg->msgFlags = pLstn->flags | PARSE_HOSTNAME;
} else {
pMsg->msgFlags = pLstn->flags;
}
if(pLstn->bUseSpecialParser) {
/* this is the legacy "log socket" parser which was written on the assumption
* that the log socket format would be fixed. While many folks said so, it
* seems to be different in practice, and this is why we now have choices...
* rgerhards, 2015-03-03
*/
parser.SanitizeMsg(pMsg);
lenMsg = pMsg->iLenRawMsg - offs; /* SanitizeMsg() may have changed the size */
msgSetPRI(pMsg, pri);
MsgSetAfterPRIOffs(pMsg, offs);
parse++; lenMsg--; /* '>' */
if(ts == NULL) {
if((pLstn->flags & IGNDATE)) {
/* in this case, we still need to find out if we have a valid
* datestamp or not .. and advance the parse pointer accordingly.
*/
if (datetime.ParseTIMESTAMP3339(&dummyTS, &parse, &lenMsg) != RS_RET_OK) {
datetime.ParseTIMESTAMP3164(&dummyTS, &parse, &lenMsg, NO_PARSE3164_TZSTRING, NO_PERMIT_YEAR_AFTER_TIME);
}
} else {
if(datetime.ParseTIMESTAMP3339(&(pMsg->tTIMESTAMP), &parse, &lenMsg) != RS_RET_OK &&
datetime.ParseTIMESTAMP3164(&(pMsg->tTIMESTAMP), &parse, &lenMsg, NO_PARSE3164_TZSTRING, NO_PERMIT_YEAR_AFTER_TIME) != RS_RET_OK) {
DBGPRINTF("we have a problem, invalid timestamp in msg!\n");
}
}
} else { /* if we pulled the time from the system, we need to update the message text */
uchar *tmpParse = parse; /* just to check correctness of TS */
if(datetime.ParseTIMESTAMP3339(&dummyTS, &tmpParse, &lenMsg) == RS_RET_OK ||
datetime.ParseTIMESTAMP3164(&dummyTS, &tmpParse, &lenMsg, NO_PARSE3164_TZSTRING, NO_PERMIT_YEAR_AFTER_TIME) == RS_RET_OK) {
/* We modify the message only if it contained a valid timestamp,
* otherwise we do not touch it at all. */
datetime.formatTimestamp3164(&st, (char*)parse, 0);
parse[15] = ' '; /* re-write \0 from fromatTimestamp3164 by SP */
/* update "counters" to reflect processed timestamp */
parse += 16;
}
}
/* pull tag */
i = 0;
while(lenMsg > 0 && *parse != ' ' && i < CONF_TAG_MAXSIZE - 1) {
bufParseTAG[i++] = *parse++;
--lenMsg;
}
bufParseTAG[i] = '\0'; /* terminate string */
if(pLstn->bWritePid)
fixPID(bufParseTAG, &i, cred);
MsgSetTAG(pMsg, bufParseTAG, i);
MsgSetMSGoffs(pMsg, pMsg->iLenRawMsg - lenMsg);
} else { /* we are configured to use regular parser chain */
pMsg->msgFlags |= NEEDS_PARSING;
}
MsgSetRcvFrom(pMsg, pLstn->hostName == NULL ? glbl.GetLocalHostNameProp() : pLstn->hostName);
CHKiRet(MsgSetRcvFromIP(pMsg, pLocalHostIP));
MsgSetRuleset(pMsg, pLstn->pRuleset);
ratelimitAddMsg(ratelimiter, NULL, pMsg);
STATSCOUNTER_INC(ctrSubmit, mutCtrSubmit);
finalize_it:
if(iRet != RS_RET_OK) {
if(pMsg != NULL)
msgDestruct(&pMsg);
}
RETiRet;
}
/* This function receives data from a socket indicated to be ready
* to receive and submits the message received for processing.
* rgerhards, 2007-12-20
* Interface changed so that this function is passed the array index
* of the socket which is to be processed. This eases access to the
* growing number of properties. -- rgerhards, 2008-08-01
*/
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wcast-align" /* TODO: how can we fix these warnings? */
/* Problem with the warnings: they seem to stem back from the way the API is structured */
static rsRetVal readSocket(lstn_t *pLstn)
{
DEFiRet;
int iRcvd;