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
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
|
/*-
* Copyright 2016 Vsevolod Stakhov
*
* 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
*
* 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 "logger.h"
#include "rspamd.h"
#include "map.h"
#include "map_helpers.h"
#include "ottery.h"
#include "unix-std.h"
#ifdef HAVE_SYSLOG_H
#include <syslog.h>
#endif
/* How much message should be repeated before it is count to be repeated one */
#define REPEATS_MIN 3
#define REPEATS_MAX 300
#define LOG_ID 6
#define LOGBUF_LEN 8192
struct rspamd_log_module {
gchar *mname;
guint id;
};
struct rspamd_log_modules {
guchar *bitset;
guint bitset_len; /* Number of BITS used in bitset */
guint bitset_allocated; /* Size of bitset allocated in BYTES */
GHashTable *modules;
};
struct rspamd_logger_error_elt {
gint completed;
GQuark ptype;
pid_t pid;
gdouble ts;
gchar id[LOG_ID + 1];
gchar module[9];
gchar message[];
};
struct rspamd_logger_error_log {
struct rspamd_logger_error_elt *elts;
rspamd_mempool_t *pool;
guint32 max_elts;
guint32 elt_len;
/* Avoid false cache sharing */
guchar __padding[64 - sizeof(gpointer) * 2 - sizeof(guint64)];
guint cur_row;
};
/**
* Static structure that store logging parameters
* It is NOT shared between processes and is created by main process
*/
struct rspamd_logger_s {
rspamd_log_func_t log_func;
struct rspamd_config *cfg;
struct rspamd_logger_error_log *errlog;
struct rspamd_cryptobox_pubkey *pk;
struct rspamd_cryptobox_keypair *keypair;
struct {
guint32 size;
guint32 used;
u_char *buf;
} io_buf;
gint fd;
guint flags;
gboolean is_buffered;
gboolean enabled;
gboolean is_debug;
gboolean throttling;
gboolean no_lock;
gboolean opened;
time_t throttling_time;
enum rspamd_log_type type;
pid_t pid;
guint32 repeats;
GQuark process_type;
struct rspamd_radix_map_helper *debug_ip;
guint64 last_line_cksum;
gchar *saved_message;
gchar *saved_function;
gchar *saved_module;
gchar *saved_id;
rspamd_mempool_mutex_t *mtx;
guint saved_loglevel;
guint64 log_cnt[4];
};
static const gchar lf_chr = '\n';
static rspamd_logger_t *default_logger = NULL;
static struct rspamd_log_modules *log_modules = NULL;
static void syslog_log_function (const gchar *module,
const gchar *id, const gchar *function,
gint log_level, const gchar *message,
gpointer arg);
static void file_log_function (const gchar *module,
const gchar *id, const gchar *function,
gint log_level, const gchar *message,
gpointer arg);
guint rspamd_task_log_id = (guint)-1;
RSPAMD_CONSTRUCTOR(rspamd_task_log_init)
{
rspamd_task_log_id = rspamd_logger_add_debug_module("task");
}
/**
* Calculate checksum for log line (used for repeating logic)
*/
static inline guint64
rspamd_log_calculate_cksum (const gchar *message, size_t mlen)
{
return rspamd_cryptobox_fast_hash (message, mlen, rspamd_hash_seed ());
}
/*
* Write a line to log file (unbuffered)
*/
static void
direct_write_log_line (rspamd_logger_t *rspamd_log,
void *data,
gsize count,
gboolean is_iov,
gint level_flags)
{
gchar errmsg[128];
struct iovec *iov;
const gchar *line;
glong r;
gint fd;
if (rspamd_log->type == RSPAMD_LOG_CONSOLE) {
if (rspamd_log->flags & RSPAMD_LOG_FLAG_RSPAMADM) {
fd = STDOUT_FILENO;
if (level_flags & G_LOG_LEVEL_CRITICAL) {
fd = STDERR_FILENO;
}
}
else {
fd = STDERR_FILENO;
}
}
else {
fd = rspamd_log->fd;
}
if (!rspamd_log->no_lock) {
#ifndef DISABLE_PTHREAD_MUTEX
if (rspamd_log->mtx) {
rspamd_mempool_lock_mutex (rspamd_log->mtx);
}
else {
rspamd_file_lock (fd, FALSE);
}
#else
rspamd_file_lock (fd, FALSE);
#endif
}
if (is_iov) {
iov = (struct iovec *) data;
r = writev (fd, iov, count);
}
else {
line = (const gchar *) data;
r = write (fd, line, count);
}
if (!rspamd_log->no_lock) {
#ifndef DISABLE_PTHREAD_MUTEX
if (rspamd_log->mtx) {
rspamd_mempool_unlock_mutex (rspamd_log->mtx);
}
else {
rspamd_file_unlock (fd, FALSE);
}
#else
rspamd_file_unlock (fd, FALSE);
#endif
}
if (r == -1) {
/* We cannot write message to file, so we need to detect error and make decision */
if (errno == EINTR) {
/* Try again */
direct_write_log_line (rspamd_log, data, count, is_iov, level_flags);
return;
}
r = rspamd_snprintf (errmsg,
sizeof (errmsg),
"direct_write_log_line: cannot write log line: %s",
strerror (errno));
if (errno == EFAULT || errno == EINVAL || errno == EFBIG ||
errno == ENOSPC) {
/* Rare case */
rspamd_log->throttling = TRUE;
rspamd_log->throttling_time = time (NULL);
}
else if (errno == EPIPE || errno == EBADF) {
/* We write to some pipe and it disappears, disable logging or we has opened bad file descriptor */
rspamd_log->enabled = FALSE;
}
}
else if (rspamd_log->throttling) {
rspamd_log->throttling = FALSE;
}
}
static void
rspamd_escape_log_string (gchar *str)
{
guchar *p = (guchar *) str;
while (*p) {
if ((*p & 0x80) || !g_ascii_isprint (*p)) {
*p = '?';
}
else if (*p == '\n' || *p == '\r') {
*p = ' ';
}
p++;
}
}
/* Logging utility functions */
gint
rspamd_log_open_priv (rspamd_logger_t *rspamd_log, uid_t uid, gid_t gid)
{
if (!rspamd_log->opened) {
switch (rspamd_log->cfg->log_type) {
case RSPAMD_LOG_CONSOLE:
/* Do nothing with console */
rspamd_log->fd = -1;
break;
case RSPAMD_LOG_SYSLOG:
#ifdef HAVE_SYSLOG_H
openlog ("rspamd", LOG_NDELAY | LOG_PID,
rspamd_log->cfg->log_facility);
#endif
break;
case RSPAMD_LOG_FILE:
rspamd_log->fd = open (rspamd_log->cfg->log_file,
O_CREAT | O_WRONLY | O_APPEND,
S_IWUSR | S_IRUSR | S_IRGRP | S_IROTH);
if (rspamd_log->fd == -1) {
fprintf (stderr,
"open_log: cannot open desired log file: %s, %s",
rspamd_log->cfg->log_file, strerror (errno));
return -1;
}
if (fchown (rspamd_log->fd, uid, gid) == -1) {
fprintf (stderr,
"open_log: cannot chown desired log file: %s, %s",
rspamd_log->cfg->log_file, strerror (errno));
close (rspamd_log->fd);
return -1;
}
break;
default:
return -1;
}
rspamd_log->opened = TRUE;
rspamd_log->enabled = TRUE;
}
return 0;
}
void
rspamd_log_close_priv (rspamd_logger_t *rspamd_log, uid_t uid, gid_t gid)
{
gchar tmpbuf[256];
rspamd_log_flush (rspamd_log);
if (rspamd_log->opened) {
switch (rspamd_log->type) {
case RSPAMD_LOG_CONSOLE:
/* Do nothing special */
break;
case RSPAMD_LOG_SYSLOG:
#ifdef HAVE_SYSLOG_H
closelog ();
#endif
break;
case RSPAMD_LOG_FILE:
if (rspamd_log->repeats > REPEATS_MIN) {
rspamd_snprintf (tmpbuf,
sizeof (tmpbuf),
"Last message repeated %ud times",
rspamd_log->repeats);
rspamd_log->repeats = 0;
if (rspamd_log->saved_message) {
file_log_function (rspamd_log->saved_module,
rspamd_log->saved_id,
rspamd_log->saved_function,
rspamd_log->saved_loglevel | RSPAMD_LOG_FORCED,
rspamd_log->saved_message,
rspamd_log);
g_free (rspamd_log->saved_message);
g_free (rspamd_log->saved_function);
g_free (rspamd_log->saved_module);
g_free (rspamd_log->saved_id);
rspamd_log->saved_message = NULL;
rspamd_log->saved_function = NULL;
rspamd_log->saved_module = NULL;
rspamd_log->saved_id = NULL;
}
/* It is safe to use temporary buffer here as it is not static */
file_log_function (NULL, NULL,
G_STRFUNC,
rspamd_log->saved_loglevel | RSPAMD_LOG_FORCED,
tmpbuf,
rspamd_log);
}
if (rspamd_log->fd != -1) {
if (fsync (rspamd_log->fd) == -1) {
msg_err ("error syncing log file: %s", strerror (errno));
}
close (rspamd_log->fd);
}
break;
}
rspamd_log->enabled = FALSE;
rspamd_log->opened = FALSE;
}
}
gint
rspamd_log_reopen_priv (rspamd_logger_t *rspamd_log, uid_t uid, gid_t gid)
{
rspamd_log_close_priv (rspamd_log, uid, gid);
if (rspamd_log_open_priv (rspamd_log, uid, gid) == 0) {
msg_info ("log file reopened");
return 0;
}
return -1;
}
/**
* Open log file or initialize other structures
*/
gint
rspamd_log_open (rspamd_logger_t *logger)
{
return rspamd_log_open_priv (logger, -1, -1);
}
/**
* Close log file or destroy other structures
*/
void
rspamd_log_close (rspamd_logger_t *logger)
{
rspamd_log_close_priv (logger, -1, -1);
}
/**
* Close and open log again
*/
gint
rspamd_log_reopen (rspamd_logger_t *logger)
{
return rspamd_log_reopen_priv (logger, -1, -1);
}
/*
* Setup logger
*/
void
rspamd_set_logger (struct rspamd_config *cfg,
GQuark ptype,
rspamd_logger_t **plogger,
rspamd_mempool_t *pool)
{
rspamd_logger_t *logger;
if (plogger == NULL || *plogger == NULL) {
logger = g_malloc0 (sizeof (rspamd_logger_t));
if (cfg->log_error_elts > 0 && pool) {
logger->errlog = rspamd_mempool_alloc0_shared (pool,
sizeof (*logger->errlog));
logger->errlog->pool = pool;
logger->errlog->max_elts = cfg->log_error_elts;
logger->errlog->elt_len = cfg->log_error_elt_maxlen;
logger->errlog->elts = rspamd_mempool_alloc0_shared (pool,
sizeof (struct rspamd_logger_error_elt) * cfg->log_error_elts +
cfg->log_error_elt_maxlen * cfg->log_error_elts);
}
if (pool) {
logger->mtx = rspamd_mempool_get_mutex (pool);
}
if (plogger) {
*plogger = logger;
}
}
else {
logger = *plogger;
}
logger->type = cfg->log_type;
logger->pid = getpid ();
logger->process_type = ptype;
switch (cfg->log_type) {
case RSPAMD_LOG_CONSOLE:
logger->log_func = file_log_function;
logger->fd = -1;
break;
case RSPAMD_LOG_SYSLOG:
logger->log_func = syslog_log_function;
break;
case RSPAMD_LOG_FILE:
logger->log_func = file_log_function;
break;
}
logger->cfg = cfg;
logger->flags = cfg->log_flags;
/* Set up buffer */
if (cfg->log_buffered) {
if (cfg->log_buf_size != 0) {
logger->io_buf.size = cfg->log_buf_size;
}
else {
logger->io_buf.size = LOGBUF_LEN;
}
logger->is_buffered = TRUE;
logger->io_buf.buf = g_malloc (logger->io_buf.size);
}
/* Set up conditional logging */
if (cfg->debug_ip_map != NULL) {
/* Try to add it as map first of all */
if (logger->debug_ip) {
rspamd_map_helper_destroy_radix (logger->debug_ip);
}
logger->debug_ip = NULL;
rspamd_config_radix_from_ucl (cfg,
cfg->debug_ip_map,
"IP addresses for which debug logs are enabled",
&logger->debug_ip, NULL);
}
else if (logger->debug_ip) {
rspamd_map_helper_destroy_radix (logger->debug_ip);
logger->debug_ip = NULL;
}
if (logger->pk) {
rspamd_pubkey_unref (logger->pk);
}
logger->pk = NULL;
if (logger->keypair) {
rspamd_keypair_unref (logger->keypair);
}
logger->keypair = NULL;
if (cfg->log_encryption_key) {
logger->pk = rspamd_pubkey_ref (cfg->log_encryption_key);
logger->keypair = rspamd_keypair_new (RSPAMD_KEYPAIR_KEX,
RSPAMD_CRYPTOBOX_MODE_25519);
rspamd_pubkey_calculate_nm (logger->pk, logger->keypair);
}
default_logger = logger;
}
/**
* Used after fork() for updating structure params
*/
void
rspamd_log_update_pid (GQuark ptype, rspamd_logger_t *rspamd_log)
{
rspamd_log->pid = getpid ();
rspamd_log->process_type = ptype;
/* We also need to clear all messages pending */
if (rspamd_log->repeats > 0) {
rspamd_log->repeats = 0;
if (rspamd_log->saved_message) {
g_free (rspamd_log->saved_message);
g_free (rspamd_log->saved_function);
g_free (rspamd_log->saved_module);
g_free (rspamd_log->saved_id);
rspamd_log->saved_message = NULL;
rspamd_log->saved_function = NULL;
rspamd_log->saved_module = NULL;
rspamd_log->saved_id = NULL;
}
}
}
/**
* Flush logging buffer
*/
void
rspamd_log_flush (rspamd_logger_t *rspamd_log)
{
if (rspamd_log->is_buffered &&
(rspamd_log->type == RSPAMD_LOG_CONSOLE ||
rspamd_log->type == RSPAMD_LOG_FILE)) {
direct_write_log_line (rspamd_log,
rspamd_log->io_buf.buf,
rspamd_log->io_buf.used,
FALSE, rspamd_log->cfg->log_level);
rspamd_log->io_buf.used = 0;
}
}
static inline gboolean
rspamd_logger_need_log (rspamd_logger_t *rspamd_log, GLogLevelFlags log_level,
guint module_id)
{
g_assert (rspamd_log != NULL);
if (log_level <= rspamd_log->cfg->log_level) {
return TRUE;
}
if (module_id != (guint)-1 && isset (log_modules->bitset, module_id)) {
return TRUE;
}
return FALSE;
}
static gchar *
rspamd_log_encrypt_message (const gchar *begin, const gchar *end,
rspamd_logger_t *rspamd_log)
{
guchar *out;
gchar *b64;
guchar *p, *nonce, *mac;
const guchar *comp;
guint len, inlen;
g_assert (end > begin);
/* base64 (pubkey | nonce | message) */
inlen = rspamd_cryptobox_nonce_bytes (RSPAMD_CRYPTOBOX_MODE_25519) +
rspamd_cryptobox_pk_bytes (RSPAMD_CRYPTOBOX_MODE_25519) +
rspamd_cryptobox_mac_bytes (RSPAMD_CRYPTOBOX_MODE_25519) +
(end - begin);
out = g_malloc (inlen);
p = out;
comp = rspamd_pubkey_get_pk (rspamd_log->pk, &len);
memcpy (p, comp, len);
p += len;
ottery_rand_bytes (p, rspamd_cryptobox_nonce_bytes (RSPAMD_CRYPTOBOX_MODE_25519));
nonce = p;
p += rspamd_cryptobox_nonce_bytes (RSPAMD_CRYPTOBOX_MODE_25519);
mac = p;
p += rspamd_cryptobox_mac_bytes (RSPAMD_CRYPTOBOX_MODE_25519);
memcpy (p, begin, end - begin);
comp = rspamd_pubkey_get_nm (rspamd_log->pk, rspamd_log->keypair);
g_assert (comp != NULL);
rspamd_cryptobox_encrypt_nm_inplace (p, end - begin, nonce, comp, mac,
RSPAMD_CRYPTOBOX_MODE_25519);
b64 = rspamd_encode_base64 (out, inlen, 0, NULL);
g_free (out);
return b64;
}
static void
rspamd_log_write_ringbuffer (rspamd_logger_t *rspamd_log,
const gchar *module, const gchar *id,
const gchar *data, glong len)
{
guint32 row_num;
struct rspamd_logger_error_log *elog;
struct rspamd_logger_error_elt *elt;
if (!rspamd_log->errlog) {
return;
}
elog = rspamd_log->errlog;
g_atomic_int_compare_and_exchange (&elog->cur_row, elog->max_elts, 0);
#if ((GLIB_MAJOR_VERSION == 2) && (GLIB_MINOR_VERSION > 30))
row_num = g_atomic_int_add (&elog->cur_row, 1);
#else
row_num = g_atomic_int_exchange_and_add (&elog->cur_row, 1);
#endif
if (row_num < elog->max_elts) {
elt = (struct rspamd_logger_error_elt *)(((guchar *)elog->elts) +
(sizeof (*elt) + elog->elt_len) * row_num);
g_atomic_int_set (&elt->completed, 0);
}
else {
/* Race condition */
elog->cur_row = 0;
return;
}
elt->pid = rspamd_log->pid;
elt->ptype = rspamd_log->process_type;
elt->ts = rspamd_get_calendar_ticks ();
if (id) {
rspamd_strlcpy (elt->id, id, sizeof (elt->id));
}
else {
rspamd_strlcpy (elt->id, "", sizeof (elt->id));
}
if (module) {
rspamd_strlcpy (elt->module, module, sizeof (elt->module));
}
else {
rspamd_strlcpy (elt->module, "", sizeof (elt->module));
}
rspamd_strlcpy (elt->message, data, MIN (len + 1, elog->elt_len));
g_atomic_int_set (&elt->completed, 1);
}
void
rspamd_common_logv (rspamd_logger_t *rspamd_log, gint level_flags,
const gchar *module, const gchar *id, const gchar *function,
const gchar *fmt, va_list args)
{
gchar logbuf[RSPAMD_LOGBUF_SIZE], *end;
gint level = level_flags & (RSPAMD_LOG_LEVEL_MASK & G_LOG_LEVEL_MASK);
if (G_UNLIKELY (rspamd_log == NULL)) {
rspamd_log = default_logger;
}
if (G_UNLIKELY (rspamd_log == NULL)) {
/* Just fprintf message to stderr */
if (level >= G_LOG_LEVEL_INFO) {
rspamd_vsnprintf (logbuf, sizeof (logbuf), fmt, args);
fprintf (stderr, "%s\n", logbuf);
}
}
else {
if (rspamd_logger_need_log (rspamd_log, level, -1)) {
end = rspamd_vsnprintf (logbuf, sizeof (logbuf), fmt, args);
if ((level_flags & RSPAMD_LOG_ENCRYPTED) && rspamd_log->pk) {
gchar *encrypted;
encrypted = rspamd_log_encrypt_message (logbuf, end, rspamd_log);
rspamd_log->log_func (module, id,
function,
level_flags,
encrypted,
rspamd_log);
g_free (encrypted);
}
else {
rspamd_log->log_func (module, id,
function,
level_flags,
logbuf,
rspamd_log);
}
switch (level) {
case G_LOG_LEVEL_CRITICAL:
rspamd_log->log_cnt[0] ++;
rspamd_log_write_ringbuffer (rspamd_log, module, id, logbuf,
end - logbuf);
break;
case G_LOG_LEVEL_WARNING:
rspamd_log->log_cnt[1]++;
break;
case G_LOG_LEVEL_INFO:
rspamd_log->log_cnt[2]++;
break;
case G_LOG_LEVEL_DEBUG:
rspamd_log->log_cnt[3]++;
break;
default:
break;
}
}
}
}
/**
* This log functions select real logger and write message if level is less or equal to configured log level
*/
void
rspamd_common_log_function (rspamd_logger_t *rspamd_log,
gint level_flags,
const gchar *module, const gchar *id,
const gchar *function,
const gchar *fmt,
...)
{
va_list vp;
va_start (vp, fmt);
rspamd_common_logv (rspamd_log, level_flags, module, id, function, fmt, vp);
va_end (vp);
}
void
rspamd_default_logv (gint level_flags, const gchar *module, const gchar *id,
const gchar *function,
const gchar *fmt, va_list args)
{
rspamd_common_logv (NULL, level_flags, module, id, function, fmt, args);
}
void
rspamd_default_log_function (gint level_flags,
const gchar *module, const gchar *id,
const gchar *function, const gchar *fmt, ...)
{
va_list vp;
va_start (vp, fmt);
rspamd_default_logv (level_flags, module, id, function, fmt, vp);
va_end (vp);
}
/**
* Fill buffer with message (limits must be checked BEFORE this call)
*/
static void
fill_buffer (rspamd_logger_t *rspamd_log, const struct iovec *iov, gint iovcnt)
{
gint i;
for (i = 0; i < iovcnt; i++) {
memcpy (rspamd_log->io_buf.buf + rspamd_log->io_buf.used,
iov[i].iov_base,
iov[i].iov_len);
rspamd_log->io_buf.used += iov[i].iov_len;
}
}
/*
* Write message to buffer or to file (using direct_write_log_line function)
*/
static void
file_log_helper (rspamd_logger_t *rspamd_log,
const struct iovec *iov,
guint iovcnt,
gint level_flags)
{
size_t len = 0;
guint i;
if (!rspamd_log->is_buffered) {
/* Write string directly */
direct_write_log_line (rspamd_log, (void *) iov, iovcnt, TRUE, level_flags);
}
else {
/* Calculate total length */
for (i = 0; i < iovcnt; i++) {
len += iov[i].iov_len;
}
/* Fill buffer */
if (rspamd_log->io_buf.size < len) {
/* Buffer is too small to hold this string, so write it directly */
rspamd_log_flush (rspamd_log);
direct_write_log_line (rspamd_log, (void *) iov, iovcnt, TRUE, level_flags);
}
else if (rspamd_log->io_buf.used + len >= rspamd_log->io_buf.size) {
/* Buffer is full, try to write it directly */
rspamd_log_flush (rspamd_log);
fill_buffer (rspamd_log, iov, iovcnt);
}
else {
/* Copy incoming string to buffer */
fill_buffer (rspamd_log, iov, iovcnt);
}
}
}
/**
* Syslog interface for logging
*/
static void
syslog_log_function (const gchar *module, const gchar *id,
const gchar *function,
gint level_flags,
const gchar *message,
gpointer arg)
{
rspamd_logger_t *rspamd_log = arg;
#ifdef HAVE_SYSLOG_H
struct {
GLogLevelFlags glib_level;
gint syslog_level;
} levels_match[] = {
{G_LOG_LEVEL_DEBUG, LOG_DEBUG},
{G_LOG_LEVEL_INFO, LOG_INFO},
{G_LOG_LEVEL_WARNING, LOG_WARNING},
{G_LOG_LEVEL_CRITICAL, LOG_ERR}
};
unsigned i;
gint syslog_level;
if (!(level_flags & RSPAMD_LOG_FORCED) && !rspamd_log->enabled) {
return;
}
/* Detect level */
syslog_level = LOG_DEBUG;
for (i = 0; i < G_N_ELEMENTS (levels_match); i ++) {
if (level_flags & levels_match[i].glib_level) {
syslog_level = levels_match[i].syslog_level;
break;
}
}
syslog (syslog_level, "<%.*s>; %s; %s: %s",
LOG_ID, id != NULL ? id : "",
module != NULL ? module : "",
function != NULL ? function : "",
message);
#endif
}
/**
* Main file interface for logging
*/
static void
file_log_function (const gchar *module, const gchar *id,
const gchar *function,
gint level_flags,
const gchar *message,
gpointer arg)
{
static gchar timebuf[64], modulebuf[64];
gchar tmpbuf[256];
gchar *m;
gdouble now;
struct tm tms;
struct iovec iov[5];
gulong r = 0, mr = 0;
guint64 cksum;
size_t mlen, mremain;
const gchar *cptype = NULL;
gboolean got_time = FALSE;
rspamd_logger_t *rspamd_log = arg;
if (!(level_flags & RSPAMD_LOG_FORCED) && !rspamd_log->enabled) {
return;
}
/* Check throttling due to write errors */
if (!(level_flags & RSPAMD_LOG_FORCED) && rspamd_log->throttling) {
now = rspamd_get_calendar_ticks ();
if (rspamd_log->throttling_time != now) {
rspamd_log->throttling_time = now;
got_time = TRUE;
}
else {
/* Do not try to write to file too often while throttling */
return;
}
}
if (!(rspamd_log->flags & RSPAMD_LOG_FLAG_RSPAMADM)) {
/* Check repeats */
mlen = strlen (message);
cksum = rspamd_log_calculate_cksum (message, mlen);
if (cksum == rspamd_log->last_line_cksum) {
rspamd_log->repeats++;
if (rspamd_log->repeats > REPEATS_MIN && rspamd_log->repeats <
REPEATS_MAX) {
/* Do not log anything */
if (rspamd_log->saved_message == NULL) {
rspamd_log->saved_message = g_strdup (message);
rspamd_log->saved_function = g_strdup (function);
if (module) {
rspamd_log->saved_module = g_strdup (module);
}
if (id) {
rspamd_log->saved_id = g_strdup (id);
}
rspamd_log->saved_loglevel = level_flags;
}
return;
}
else if (rspamd_log->repeats > REPEATS_MAX) {
rspamd_snprintf (tmpbuf,
sizeof (tmpbuf),
"Last message repeated %ud times",
rspamd_log->repeats);
rspamd_log->repeats = 0;
/* It is safe to use temporary buffer here as it is not static */
if (rspamd_log->saved_message) {
file_log_function (rspamd_log->saved_module,
rspamd_log->saved_id,
rspamd_log->saved_function,
rspamd_log->saved_loglevel,
rspamd_log->saved_message,
arg);
g_free (rspamd_log->saved_message);
g_free (rspamd_log->saved_function);
g_free (rspamd_log->saved_module);
g_free (rspamd_log->saved_id);
rspamd_log->saved_message = NULL;
rspamd_log->saved_function = NULL;
rspamd_log->saved_module = NULL;
rspamd_log->saved_id = NULL;
}
file_log_function ("logger", NULL,
G_STRFUNC,
rspamd_log->saved_loglevel,
tmpbuf,
arg);
file_log_function (module, id,
function,
level_flags,
message,
arg);
rspamd_log->repeats = REPEATS_MIN + 1;
return;
}
}
else {
/* Reset counter if new message differs from saved message */
rspamd_log->last_line_cksum = cksum;
if (rspamd_log->repeats > REPEATS_MIN) {
rspamd_snprintf (tmpbuf,
sizeof (tmpbuf),
"Last message repeated %ud times",
rspamd_log->repeats);
rspamd_log->repeats = 0;
if (rspamd_log->saved_message) {
file_log_function (rspamd_log->saved_module,
rspamd_log->saved_id,
rspamd_log->saved_function,
rspamd_log->saved_loglevel,
rspamd_log->saved_message,
arg);
g_free (rspamd_log->saved_message);
g_free (rspamd_log->saved_function);
g_free (rspamd_log->saved_module);
g_free (rspamd_log->saved_id);
rspamd_log->saved_message = NULL;
rspamd_log->saved_function = NULL;
rspamd_log->saved_module = NULL;
rspamd_log->saved_id = NULL;
}
file_log_function ("logger", NULL,
G_STRFUNC,
level_flags,
tmpbuf,
arg);
/* It is safe to use temporary buffer here as it is not static */
file_log_function (module, id,
function,
level_flags,
message,
arg);
return;
}
else {
rspamd_log->repeats = 0;
}
}
if (!got_time) {
now = rspamd_get_calendar_ticks ();
}
/* Format time */
if (!(rspamd_log->flags & RSPAMD_LOG_FLAG_SYSTEMD)) {
time_t sec = now;
gsize r;
rspamd_localtime (sec, &tms);
r = strftime (timebuf, sizeof (timebuf), "%F %H:%M:%S", &tms);
if (rspamd_log->flags & RSPAMD_LOG_FLAG_USEC) {
gchar usec_buf[16];
rspamd_snprintf (usec_buf, sizeof (usec_buf), "%.5f",
now - (gdouble)sec);
rspamd_snprintf (timebuf + r, sizeof (timebuf) - r,
"%s", usec_buf + 1);
}
}
cptype = g_quark_to_string (rspamd_log->process_type);
if (rspamd_log->flags & RSPAMD_LOG_FLAG_COLOR) {
if (level_flags & (G_LOG_LEVEL_INFO|G_LOG_LEVEL_MESSAGE)) {
/* White */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[0;37m");
}
else if (level_flags & G_LOG_LEVEL_WARNING) {
/* Magenta */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[0;32m");
}
else if (level_flags & G_LOG_LEVEL_CRITICAL) {
/* Red */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[1;31m");
}
}
else {
r = 0;
}
if (!(rspamd_log->flags & RSPAMD_LOG_FLAG_SYSTEMD)) {
r += rspamd_snprintf (tmpbuf + r,
sizeof (tmpbuf) - r,
"%s #%P(%s) ",
timebuf,
rspamd_log->pid,
cptype);
}
else {
r += rspamd_snprintf (tmpbuf + r,
sizeof (tmpbuf) - r,
"(%s) ",
cptype);
}
modulebuf[0] = '\0';
mremain = sizeof (modulebuf);
m = modulebuf;
if (id != NULL) {
guint slen = strlen (id);
slen = MIN (LOG_ID, slen);
mr = rspamd_snprintf (m, mremain, "<%*.s>; ", slen,
id);
m += mr;
mremain -= mr;
}
if (module != NULL) {
mr = rspamd_snprintf (m, mremain, "%s; ", module);
m += mr;
mremain -= mr;
}
if (function != NULL) {
mr = rspamd_snprintf (m, mremain, "%s: ", function);
m += mr;
mremain -= mr;
}
else {
mr = rspamd_snprintf (m, mremain, ": ");
m += mr;
mremain -= mr;
}
/* Construct IOV for log line */
iov[0].iov_base = tmpbuf;
iov[0].iov_len = r;
iov[1].iov_base = modulebuf;
iov[1].iov_len = m - modulebuf;
iov[2].iov_base = (void *) message;
iov[2].iov_len = mlen;
iov[3].iov_base = (void *) &lf_chr;
iov[3].iov_len = 1;
if (rspamd_log->flags & RSPAMD_LOG_FLAG_COLOR) {
iov[4].iov_base = "\033[0m";
iov[4].iov_len = sizeof ("\033[0m") - 1;
/* Call helper (for buffering) */
file_log_helper (rspamd_log, iov, 5, level_flags);
}
else {
/* Call helper (for buffering) */
file_log_helper (rspamd_log, iov, 4, level_flags);
}
}
else {
/* Rspamadm logging version */
mlen = strlen (message);
if (rspamd_log->flags & RSPAMD_LOG_FLAG_COLOR) {
if (level_flags & (G_LOG_LEVEL_INFO|G_LOG_LEVEL_MESSAGE)) {
/* White */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[0;37m");
}
else if (level_flags & G_LOG_LEVEL_WARNING) {
/* Magenta */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[0;32m");
}
else if (level_flags & G_LOG_LEVEL_CRITICAL) {
/* Red */
r = rspamd_snprintf (tmpbuf, sizeof (tmpbuf), "\033[1;31m");
}
iov[0].iov_base = (void *) tmpbuf;
iov[0].iov_len = r;
iov[1].iov_base = (void *) message;
iov[1].iov_len = mlen;
r = 2;
}
else {
iov[0].iov_base = (void *) message;
iov[0].iov_len = mlen;
r = 1;
}
iov[r].iov_base = (void *) &lf_chr;
iov[r++].iov_len = 1;
if (rspamd_log->flags & RSPAMD_LOG_FLAG_COLOR) {
iov[r].iov_base = "\033[0m";
iov[r++].iov_len = sizeof ("\033[0m") - 1;
/* Call helper (for buffering) */
file_log_helper (rspamd_log, iov, r, level_flags);
}
else {
/* Call helper (for buffering) */
file_log_helper (rspamd_log, iov, r, level_flags);
}
}
}
/**
* Write log line depending on ip
*/
void
rspamd_conditional_debug (rspamd_logger_t *rspamd_log,
rspamd_inet_addr_t *addr, const gchar *module, const gchar *id,
const gchar *function, const gchar *fmt, ...)
{
static gchar logbuf[LOGBUF_LEN];
va_list vp;
gchar *end;
guint mod_id;
if (rspamd_log == NULL) {
rspamd_log = default_logger;
}
mod_id = rspamd_logger_add_debug_module (module);
if (rspamd_logger_need_log (rspamd_log, G_LOG_LEVEL_DEBUG, mod_id) ||
rspamd_log->is_debug) {
if (rspamd_log->debug_ip && addr != NULL) {
if (rspamd_match_radix_map_addr (rspamd_log->debug_ip,
addr) == NULL) {
return;
}
}
va_start (vp, fmt);
end = rspamd_vsnprintf (logbuf, sizeof (logbuf), fmt, vp);
*end = '\0';
va_end (vp);
rspamd_log->log_func (module, id,
function,
G_LOG_LEVEL_DEBUG | RSPAMD_LOG_FORCED,
logbuf,
rspamd_log);
}
}
void
rspamd_conditional_debug_fast (rspamd_logger_t *rspamd_log,
rspamd_inet_addr_t *addr,
guint mod_id, const gchar *module, const gchar *id,
const gchar *function, const gchar *fmt, ...)
{
static gchar logbuf[LOGBUF_LEN];
va_list vp;
gchar *end;
if (rspamd_log == NULL) {
rspamd_log = default_logger;
}
if (rspamd_logger_need_log (rspamd_log, G_LOG_LEVEL_DEBUG, mod_id) ||
rspamd_log->is_debug) {
if (rspamd_log->debug_ip && addr != NULL) {
if (rspamd_match_radix_map_addr (rspamd_log->debug_ip, addr)
== NULL) {
return;
}
}
va_start (vp, fmt);
end = rspamd_vsnprintf (logbuf, sizeof (logbuf), fmt, vp);
*end = '\0';
va_end (vp);
rspamd_log->log_func (module, id,
function,
G_LOG_LEVEL_DEBUG | RSPAMD_LOG_FORCED,
logbuf,
rspamd_log);
}
}
/**
* Wrapper for glib logger
*/
void
rspamd_glib_log_function (const gchar *log_domain,
GLogLevelFlags log_level,
const gchar *message,
gpointer arg)
{
rspamd_logger_t *rspamd_log = arg;
if (rspamd_log->enabled &&
rspamd_logger_need_log (rspamd_log, log_level, -1)) {
rspamd_log->log_func ("glib", NULL,
NULL,
log_level,
message,
rspamd_log);
}
}
void
rspamd_glib_printerr_function (const gchar *message)
{
rspamd_common_log_function (NULL, G_LOG_LEVEL_CRITICAL, "glib",
NULL, G_STRFUNC,
"%s", message);
}
/**
* Temporary turn on debugging
*/
void
rspamd_log_debug (rspamd_logger_t *rspamd_log)
{
rspamd_log->is_debug = TRUE;
}
/**
* Turn off temporary debugging
*/
void
rspamd_log_nodebug (rspamd_logger_t *rspamd_log)
{
rspamd_log->is_debug = FALSE;
}
const guint64 *
rspamd_log_counters (rspamd_logger_t *logger)
{
if (logger) {
return logger->log_cnt;
}
return NULL;
}
void
rspamd_log_nolock (rspamd_logger_t *logger)
{
if (logger) {
logger->no_lock = TRUE;
}
}
void
rspamd_log_lock (rspamd_logger_t *logger)
{
if (logger) {
logger->no_lock = FALSE;
}
}
static gint
rspamd_log_errlog_cmp (const ucl_object_t **o1, const ucl_object_t **o2)
{
const ucl_object_t *ts1, *ts2;
ts1 = ucl_object_lookup (*o1, "ts");
ts2 = ucl_object_lookup (*o2, "ts");
if (ts1 && ts2) {
gdouble t1 = ucl_object_todouble (ts1), t2 = ucl_object_todouble (ts2);
if (t1 > t2) {
return -1;
}
else if (t2 > t1) {
return 1;
}
}
return 0;
}
ucl_object_t *
rspamd_log_errorbuf_export (const rspamd_logger_t *logger)
{
struct rspamd_logger_error_elt *cpy, *cur;
ucl_object_t *top = ucl_object_typed_new (UCL_ARRAY);
guint i;
if (logger->errlog == NULL) {
return top;
}
cpy = g_malloc0_n (logger->errlog->max_elts,
sizeof (*cpy) + logger->errlog->elt_len);
memcpy (cpy, logger->errlog->elts, logger->errlog->max_elts *
(sizeof (*cpy) + logger->errlog->elt_len));
for (i = 0; i < logger->errlog->max_elts; i ++) {
cur = (struct rspamd_logger_error_elt *)((guchar *)cpy +
i * ((sizeof (*cpy) + logger->errlog->elt_len)));
if (cur->completed) {
ucl_object_t *obj = ucl_object_typed_new (UCL_OBJECT);
ucl_object_insert_key (obj, ucl_object_fromdouble (cur->ts),
"ts", 0, false);
ucl_object_insert_key (obj, ucl_object_fromint (cur->pid),
"pid", 0, false);
ucl_object_insert_key (obj,
ucl_object_fromstring (g_quark_to_string (cur->ptype)),
"type", 0, false);
ucl_object_insert_key (obj, ucl_object_fromstring (cur->id),
"id", 0, false);
ucl_object_insert_key (obj, ucl_object_fromstring (cur->module),
"module", 0, false);
ucl_object_insert_key (obj, ucl_object_fromstring (cur->message),
"message", 0, false);
ucl_array_append (top, obj);
}
}
ucl_object_array_sort (top, rspamd_log_errlog_cmp);
g_free (cpy);
return top;
}
static guint
rspamd_logger_allocate_mod_bit (void)
{
if (log_modules->bitset_allocated * NBBY > log_modules->bitset_len + 1) {
log_modules->bitset_len ++;
return log_modules->bitset_len - 1;
}
else {
/* Need to expand */
log_modules->bitset_allocated *= 2;
log_modules->bitset = g_realloc (log_modules->bitset,
log_modules->bitset_allocated);
return rspamd_logger_allocate_mod_bit ();
}
}
guint
rspamd_logger_add_debug_module (const gchar *mname)
{
struct rspamd_log_module *m;
if (mname == NULL) {
return (guint)-1;
}
if (log_modules == NULL) {
log_modules = g_malloc0 (sizeof (*log_modules));
log_modules->modules = g_hash_table_new (rspamd_strcase_hash,
rspamd_strcase_equal);
log_modules->bitset_allocated = 16;
log_modules->bitset_len = 0;
log_modules->bitset = g_malloc0 (log_modules->bitset_allocated);
}
if ((m = g_hash_table_lookup (log_modules->modules, mname)) == NULL) {
m = g_malloc0 (sizeof (*m));
m->mname = g_strdup (mname);
m->id = rspamd_logger_allocate_mod_bit ();
clrbit (log_modules->bitset, m->id);
g_hash_table_insert (log_modules->modules, m->mname, m);
}
return m->id;
}
void
rspamd_logger_configure_modules (GHashTable *mods_enabled)
{
GHashTableIter it;
gpointer k, v;
guint id;
/* On first iteration, we go through all modules enabled and add missing ones */
g_hash_table_iter_init (&it, mods_enabled);
while (g_hash_table_iter_next (&it, &k, &v)) {
rspamd_logger_add_debug_module ((const gchar *)k);
}
g_hash_table_iter_init (&it, mods_enabled);
while (g_hash_table_iter_next (&it, &k, &v)) {
id = rspamd_logger_add_debug_module ((const gchar *)k);
if (isclr (log_modules->bitset, id)) {
msg_info ("enable debugging for module %s (%d)", (const gchar *) k,
id);
setbit (log_modules->bitset, id);
}
}
}
|