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
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
|
/*
* Copyright 2024 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.
*/
/*
* Rspamd fuzzy storage server
*/
#include "config.h"
#include "libserver/fuzzy_wire.h"
#include "util.h"
#include "rspamd.h"
#include "libserver/maps/map.h"
#include "libserver/maps/map_helpers.h"
#include "libserver/fuzzy_backend/fuzzy_backend.h"
#include "ottery.h"
#include "ref.h"
#include "xxhash.h"
#include "libserver/worker_util.h"
#include "libserver/rspamd_control.h"
#include "libcryptobox/cryptobox.h"
#include "libcryptobox/keypairs_cache.h"
#include "libcryptobox/keypair.h"
#include "libutil/hash.h"
#include "libserver/maps/map_private.h"
#include "contrib/uthash/utlist.h"
#include "lua/lua_common.h"
#include "unix-std.h"
#include <math.h>
/* Resync value in seconds */
#define DEFAULT_SYNC_TIMEOUT 60.0
#define DEFAULT_KEYPAIR_CACHE_SIZE 512
#define DEFAULT_MASTER_TIMEOUT 10.0
#define DEFAULT_UPDATES_MAXFAIL 3
#define DEFAULT_MAX_BUCKETS 2000
#define DEFAULT_BUCKET_TTL 3600
#define DEFAULT_BUCKET_MASK 24
/* Update stats on keys each 1 hour */
#define KEY_STAT_INTERVAL 3600.0
static const char *local_db_name = "local";
/* Init functions */
gpointer init_fuzzy(struct rspamd_config *cfg);
void start_fuzzy(struct rspamd_worker *worker);
worker_t fuzzy_worker = {
"fuzzy", /* Name */
init_fuzzy, /* Init function */
start_fuzzy, /* Start function */
RSPAMD_WORKER_HAS_SOCKET | RSPAMD_WORKER_NO_STRICT_CONFIG,
RSPAMD_WORKER_SOCKET_UDP, /* UDP socket */
RSPAMD_WORKER_VER /* Version info */
};
struct fuzzy_global_stat {
uint64_t fuzzy_hashes;
/**< number of fuzzy hashes stored */
uint64_t fuzzy_hashes_expired;
/**< number of fuzzy hashes expired */
uint64_t fuzzy_hashes_checked[RSPAMD_FUZZY_EPOCH_MAX];
/**< amount of check requests for each epoch */
uint64_t fuzzy_shingles_checked[RSPAMD_FUZZY_EPOCH_MAX];
/**< amount of shingle check requests for each epoch */
uint64_t fuzzy_hashes_found[RSPAMD_FUZZY_EPOCH_MAX];
/**< amount of invalid requests */
uint64_t invalid_requests;
/**< amount of delayed hashes found */
uint64_t delayed_hashes;
};
struct fuzzy_key_stat {
uint64_t checked;
uint64_t matched;
uint64_t added;
uint64_t deleted;
uint64_t errors;
/* Store averages for checked/matched per minute */
struct rspamd_counter_data checked_ctr;
struct rspamd_counter_data matched_ctr;
double last_checked_time;
uint64_t last_checked_count;
uint64_t last_matched_count;
struct rspamd_cryptobox_keypair *keypair;
rspamd_lru_hash_t *last_ips;
ref_entry_t ref;
};
struct rspamd_leaky_bucket_elt {
rspamd_inet_addr_t *addr;
double last;
double cur;
};
static const uint64_t rspamd_fuzzy_storage_magic = 0x291a3253eb1b3ea5ULL;
static int64_t
fuzzy_kp_hash(const unsigned char *p)
{
int64_t res;
memcpy(&res, p, sizeof(res));
return res;
}
static bool
fuzzy_kp_equal(gconstpointer a, gconstpointer b)
{
const unsigned char *pa = a, *pb = b;
return (memcmp(pa, pb, RSPAMD_FUZZY_KEYLEN) == 0);
}
KHASH_SET_INIT_INT(fuzzy_key_ids_set);
KHASH_INIT(fuzzy_key_flag_stat, int, struct fuzzy_key_stat, 1, kh_int_hash_func,
kh_int_hash_equal);
struct fuzzy_key {
char *name;
struct rspamd_cryptobox_keypair *key;
struct rspamd_cryptobox_pubkey *pk;
struct fuzzy_key_stat *stat;
khash_t(fuzzy_key_flag_stat) * flags_stat;
khash_t(fuzzy_key_ids_set) * forbidden_ids;
struct rspamd_leaky_bucket_elt *rl_bucket;
double burst;
double rate;
ev_tstamp expire;
bool expired;
ref_entry_t ref;
};
KHASH_INIT(rspamd_fuzzy_keys_hash,
const unsigned char *, struct fuzzy_key *, 1,
fuzzy_kp_hash, fuzzy_kp_equal);
struct rspamd_fuzzy_storage_ctx {
uint64_t magic;
/* Events base */
struct ev_loop *event_loop;
/* DNS resolver */
struct rspamd_dns_resolver *resolver;
/* Config */
struct rspamd_config *cfg;
/* END OF COMMON PART */
struct fuzzy_global_stat stat;
double expire;
double sync_timeout;
double delay;
struct rspamd_radix_map_helper *update_ips;
struct rspamd_hash_map_helper *update_keys;
struct rspamd_radix_map_helper *blocked_ips;
struct rspamd_radix_map_helper *ratelimit_whitelist;
struct rspamd_radix_map_helper *delay_whitelist;
const ucl_object_t *update_map;
const ucl_object_t *update_keys_map;
const ucl_object_t *delay_whitelist_map;
const ucl_object_t *blocked_map;
const ucl_object_t *ratelimit_whitelist_map;
const ucl_object_t *dynamic_keys_map;
unsigned int keypair_cache_size;
ev_timer stat_ev;
ev_io peer_ev;
/* Local keypair */
struct rspamd_cryptobox_keypair *default_keypair; /* Bad clash, need for parse keypair */
struct fuzzy_key *default_key;
khash_t(rspamd_fuzzy_keys_hash) * keys;
/* Those are loaded via map */
khash_t(rspamd_fuzzy_keys_hash) * dynamic_keys;
gboolean encrypted_only;
gboolean read_only;
gboolean dedicated_update_worker;
struct rspamd_keypair_cache *keypair_cache;
struct rspamd_http_context *http_ctx;
rspamd_lru_hash_t *errors_ips;
rspamd_lru_hash_t *ratelimit_buckets;
struct rspamd_fuzzy_backend *backend;
GArray *updates_pending;
unsigned int updates_failed;
unsigned int updates_maxfail;
/* Used to send data between workers */
int peer_fd;
/* Ratelimits */
unsigned int leaky_bucket_ttl;
unsigned int leaky_bucket_mask;
unsigned int max_buckets;
gboolean ratelimit_log_only;
double leaky_bucket_burst;
double leaky_bucket_rate;
struct rspamd_worker *worker;
const ucl_object_t *skip_map;
struct rspamd_hash_map_helper *skip_hashes;
int lua_pre_handler_cbref;
int lua_post_handler_cbref;
int lua_blacklist_cbref;
khash_t(fuzzy_key_ids_set) * default_forbidden_ids;
/* Ids that should not override other ids */
khash_t(fuzzy_key_ids_set) * weak_ids;
};
enum fuzzy_cmd_type {
CMD_NORMAL,
CMD_SHINGLE,
CMD_ENCRYPTED_NORMAL,
CMD_ENCRYPTED_SHINGLE
};
struct fuzzy_session {
struct rspamd_worker *worker;
rspamd_inet_addr_t *addr;
struct rspamd_fuzzy_storage_ctx *ctx;
struct rspamd_fuzzy_shingle_cmd cmd; /* Can handle both shingles and non-shingles */
struct rspamd_fuzzy_encrypted_reply reply; /* Again: contains everything */
struct fuzzy_key_stat *ip_stat;
enum rspamd_fuzzy_epoch epoch;
enum fuzzy_cmd_type cmd_type;
int fd;
ev_tstamp timestamp;
struct ev_io io;
ref_entry_t ref;
struct fuzzy_key *key;
struct rspamd_fuzzy_cmd_extension *extensions;
unsigned char nm[rspamd_cryptobox_MAX_NMBYTES];
};
struct fuzzy_peer_request {
ev_io io_ev;
struct fuzzy_peer_cmd cmd;
};
struct rspamd_updates_cbdata {
GArray *updates_pending;
struct rspamd_fuzzy_storage_ctx *ctx;
char *source;
gboolean final;
};
static void rspamd_fuzzy_write_reply(struct fuzzy_session *session);
static gboolean rspamd_fuzzy_process_updates_queue(struct rspamd_fuzzy_storage_ctx *ctx,
const char *source, gboolean final);
static gboolean rspamd_fuzzy_check_client(struct rspamd_fuzzy_storage_ctx *ctx,
rspamd_inet_addr_t *addr);
static void rspamd_fuzzy_maybe_call_blacklisted(struct rspamd_fuzzy_storage_ctx *ctx,
rspamd_inet_addr_t *addr,
const char *reason);
static struct fuzzy_key *fuzzy_add_keypair_from_ucl(struct rspamd_config *cfg,
const ucl_object_t *obj,
khash_t(rspamd_fuzzy_keys_hash) * target);
struct fuzzy_keymap_ucl_buf {
rspamd_fstring_t *buf;
struct rspamd_fuzzy_storage_ctx *ctx;
};
/* Callbacks for reading json dynamic rules */
static char *
ucl_keymap_read_cb(char *chunk,
int len,
struct map_cb_data *data,
gboolean final)
{
struct fuzzy_keymap_ucl_buf *jb, *pd;
pd = data->prev_data;
g_assert(pd != NULL);
if (data->cur_data == NULL) {
jb = g_malloc0(sizeof(*jb));
jb->ctx = pd->ctx;
data->cur_data = jb;
}
else {
jb = data->cur_data;
}
if (jb->buf == NULL) {
/* Allocate memory for buffer */
jb->buf = rspamd_fstring_sized_new(MAX(len, 4096));
}
jb->buf = rspamd_fstring_append(jb->buf, chunk, len);
return NULL;
}
static void
ucl_keymap_fin_cb(struct map_cb_data *data, void **target)
{
struct fuzzy_keymap_ucl_buf *jb;
ucl_object_t *top;
struct ucl_parser *parser;
struct rspamd_config *cfg;
/* Now parse ucl */
if (data->cur_data) {
jb = data->cur_data;
cfg = jb->ctx->cfg;
}
else {
msg_err("no cur data in the map! might be a bug");
return;
}
if (jb->buf->len == 0) {
msg_err_config("no data read");
return;
}
parser = ucl_parser_new(UCL_PARSER_NO_FILEVARS);
if (!ucl_parser_add_chunk(parser, jb->buf->str, jb->buf->len)) {
msg_err_config("cannot load ucl data: parse error %s",
ucl_parser_get_error(parser));
ucl_parser_free(parser);
return;
}
top = ucl_parser_get_object(parser);
ucl_parser_free(parser);
if (ucl_object_type(top) != UCL_ARRAY) {
ucl_object_unref(top);
msg_err_config("loaded ucl is not an array");
return;
}
if (target) {
*target = data->cur_data;
}
if (data->prev_data) {
jb = data->prev_data;
/* Clean prev data */
if (jb->buf) {
rspamd_fstring_free(jb->buf);
}
/* Clean the existing keys */
struct fuzzy_key *key;
kh_foreach_value(jb->ctx->dynamic_keys, key, {
REF_RELEASE(key);
});
kh_clear(rspamd_fuzzy_keys_hash, jb->ctx->dynamic_keys);
/* Insert new keys */
const ucl_object_t *cur;
ucl_object_iter_t it = NULL;
int success = 0;
while ((cur = ucl_object_iterate(top, &it, true)) != NULL) {
struct fuzzy_key *nk;
nk = fuzzy_add_keypair_from_ucl(cfg, cur, jb->ctx->dynamic_keys);
if (nk == NULL) {
msg_warn_config("cannot add dynamic keypair");
}
success++;
}
msg_info_config("loaded %d dynamic keypairs", success);
g_free(jb);
}
ucl_object_unref(top);
}
static void
ucl_keymap_dtor_cb(struct map_cb_data *data)
{
struct fuzzy_keymap_ucl_buf *jb;
if (data->cur_data) {
jb = data->cur_data;
/* Clean prev data */
if (jb->buf) {
rspamd_fstring_free(jb->buf);
}
struct fuzzy_key *key;
kh_foreach_value(jb->ctx->dynamic_keys, key, {
REF_RELEASE(key);
});
kh_destroy(rspamd_fuzzy_keys_hash, jb->ctx->dynamic_keys);
g_free(jb);
}
}
enum rspamd_ratelimit_check_result {
ratelimit_pass,
ratelimit_new,
ratelimit_existing,
};
enum rspamd_ratelimit_check_policy {
ratelimit_policy_permanent,
ratelimit_policy_normal,
};
static enum rspamd_ratelimit_check_result
rspamd_fuzzy_check_ratelimit_bucket(struct fuzzy_session *session, struct rspamd_leaky_bucket_elt *elt,
enum rspamd_ratelimit_check_policy policy, double max_burst, double max_rate)
{
gboolean ratelimited = FALSE, new_ratelimit = FALSE;
if (isnan(elt->cur)) {
/* There is an issue with the previous logic: the TTL is updated each time
* we see that new bucket. Hence, we need to check the `last` and act accordingly
*/
if (elt->last < session->timestamp && session->timestamp - elt->last >= session->ctx->leaky_bucket_ttl) {
/*
* We reset bucket to it's 90% capacity to allow some requests
* This should cope with the issue when we block an IP network for some burst and never unblock it
*/
elt->cur = max_burst * 0.9;
elt->last = session->timestamp;
}
else {
ratelimited = TRUE;
}
}
else {
/* Update bucket: leak some elements */
if (elt->last < session->timestamp) {
elt->cur -= max_rate * (session->timestamp - elt->last);
elt->last = session->timestamp;
if (elt->cur < 0) {
elt->cur = 0;
}
}
else {
elt->last = session->timestamp;
}
/* Check the bucket */
if (elt->cur >= max_burst) {
if (policy == ratelimit_policy_permanent) {
elt->cur = NAN;
}
new_ratelimit = TRUE;
ratelimited = TRUE;
}
else {
elt->cur++; /* Allow one more request */
}
}
if (ratelimited) {
rspamd_fuzzy_maybe_call_blacklisted(session->ctx, session->addr, "ratelimit");
}
if (new_ratelimit) {
return ratelimit_new;
}
return ratelimited ? ratelimit_existing : ratelimit_pass;
}
static gboolean
rspamd_fuzzy_check_ratelimit(struct fuzzy_session *session)
{
rspamd_inet_addr_t *masked;
struct rspamd_leaky_bucket_elt *elt;
if (!session->addr) {
return TRUE;
}
if (session->ctx->ratelimit_whitelist != NULL) {
if (rspamd_match_radix_map_addr(session->ctx->ratelimit_whitelist,
session->addr) != NULL) {
return TRUE;
}
}
/*
if (rspamd_inet_address_is_local (session->addr, TRUE)) {
return TRUE;
}
*/
masked = rspamd_inet_address_copy(session->addr, NULL);
if (rspamd_inet_address_get_af(masked) == AF_INET) {
rspamd_inet_address_apply_mask(masked,
MIN(session->ctx->leaky_bucket_mask, 32));
}
else {
/* Must be at least /64 */
rspamd_inet_address_apply_mask(masked,
MIN(MAX(session->ctx->leaky_bucket_mask * 4, 64), 128));
}
elt = rspamd_lru_hash_lookup(session->ctx->ratelimit_buckets, masked,
(time_t) session->timestamp);
if (elt) {
enum rspamd_ratelimit_check_result res = rspamd_fuzzy_check_ratelimit_bucket(session, elt,
ratelimit_policy_permanent,
session->ctx->leaky_bucket_burst,
session->ctx->leaky_bucket_rate);
if (res == ratelimit_new) {
msg_info("ratelimiting %s (%s), %.1f max elts",
rspamd_inet_address_to_string(session->addr),
rspamd_inet_address_to_string(masked),
session->ctx->leaky_bucket_burst);
struct rspamd_srv_command srv_cmd;
srv_cmd.type = RSPAMD_SRV_FUZZY_BLOCKED;
srv_cmd.cmd.fuzzy_blocked.af = rspamd_inet_address_get_af(masked);
if (srv_cmd.cmd.fuzzy_blocked.af == AF_INET || srv_cmd.cmd.fuzzy_blocked.af == AF_INET6) {
socklen_t slen;
struct sockaddr *sa = rspamd_inet_address_get_sa(masked, &slen);
if (slen <= sizeof(srv_cmd.cmd.fuzzy_blocked.addr)) {
memcpy(&srv_cmd.cmd.fuzzy_blocked.addr, sa, slen);
msg_debug("propagating blocked address to other workers");
rspamd_srv_send_command(session->worker, session->ctx->event_loop, &srv_cmd, -1, NULL, NULL);
}
else {
msg_err("bad address length: %d, expected to be %d", (int) slen, (int) sizeof(srv_cmd.cmd.fuzzy_blocked.addr));
}
}
rspamd_fuzzy_maybe_call_blacklisted(session->ctx, session->addr, "ratelimit");
}
else if (res == ratelimit_existing) {
rspamd_fuzzy_maybe_call_blacklisted(session->ctx, session->addr, "ratelimit");
}
rspamd_inet_address_free(masked);
return res == ratelimit_pass;
}
else {
/* New bucket */
elt = g_malloc(sizeof(*elt));
elt->addr = masked; /* transfer ownership */
elt->cur = 1;
elt->last = session->timestamp;
rspamd_lru_hash_insert(session->ctx->ratelimit_buckets,
masked,
elt,
session->timestamp,
session->ctx->leaky_bucket_ttl);
}
return TRUE;
}
static void
rspamd_fuzzy_maybe_call_blacklisted(struct rspamd_fuzzy_storage_ctx *ctx,
rspamd_inet_addr_t *addr,
const char *reason)
{
if (ctx->lua_blacklist_cbref != -1) {
lua_State *L = ctx->cfg->lua_state;
int err_idx, ret;
lua_pushcfunction(L, &rspamd_lua_traceback);
err_idx = lua_gettop(L);
lua_rawgeti(L, LUA_REGISTRYINDEX, ctx->lua_blacklist_cbref);
/* client IP */
rspamd_lua_ip_push(L, addr);
/* block reason */
lua_pushstring(L, reason);
if ((ret = lua_pcall(L, 2, 0, err_idx)) != 0) {
msg_err("call to lua_blacklist_cbref "
"script failed (%d): %s",
ret, lua_tostring(L, -1));
}
lua_settop(L, 0);
}
}
static gboolean
rspamd_fuzzy_check_client(struct rspamd_fuzzy_storage_ctx *ctx,
rspamd_inet_addr_t *addr)
{
if (ctx->blocked_ips != NULL) {
if (rspamd_match_radix_map_addr(ctx->blocked_ips,
addr) != NULL) {
rspamd_fuzzy_maybe_call_blacklisted(ctx, addr, "blacklisted");
return FALSE;
}
}
return TRUE;
}
static gboolean
rspamd_fuzzy_check_write(struct fuzzy_session *session)
{
if (session->ctx->read_only) {
return FALSE;
}
if (session->ctx->update_ips != NULL && session->addr) {
if (rspamd_inet_address_get_af(session->addr) == AF_UNIX) {
return TRUE;
}
if (rspamd_match_radix_map_addr(session->ctx->update_ips,
session->addr) == NULL) {
return FALSE;
}
else {
return TRUE;
}
}
if (session->ctx->update_keys != NULL && session->key->stat && session->key->key) {
static char base32_buf[rspamd_cryptobox_HASHBYTES * 2 + 1];
unsigned int raw_len;
const unsigned char *pk_raw = rspamd_keypair_component(session->key->key,
RSPAMD_KEYPAIR_COMPONENT_ID, &raw_len);
int encoded_len = rspamd_encode_base32_buf(pk_raw, raw_len,
base32_buf, sizeof(base32_buf),
RSPAMD_BASE32_DEFAULT);
if (rspamd_match_hash_map(session->ctx->update_keys, base32_buf, encoded_len)) {
return TRUE;
}
}
return FALSE;
}
static void
fuzzy_key_stat_dtor(gpointer p)
{
struct fuzzy_key_stat *st = p;
if (st->last_ips) {
rspamd_lru_hash_destroy(st->last_ips);
}
if (st->keypair) {
rspamd_keypair_unref(st->keypair);
}
g_free(st);
}
static void
fuzzy_key_stat_unref(gpointer p)
{
struct fuzzy_key_stat *st = p;
REF_RELEASE(st);
}
static void
fuzzy_key_dtor(gpointer p)
{
struct fuzzy_key *key = p;
if (key) {
if (key->stat) {
REF_RELEASE(key->stat);
}
if (key->flags_stat) {
kh_destroy(fuzzy_key_flag_stat, key->flags_stat);
}
if (key->forbidden_ids) {
kh_destroy(fuzzy_key_ids_set, key->forbidden_ids);
}
if (key->rl_bucket) {
/* TODO: save bucket stats */
g_free(key->rl_bucket);
}
if (key->name) {
g_free(key->name);
}
g_free(key);
}
}
static void
fuzzy_hash_table_dtor(khash_t(rspamd_fuzzy_keys_hash) * hash)
{
struct fuzzy_key *key;
kh_foreach_value(hash, key, {
REF_RELEASE(key);
});
kh_destroy(rspamd_fuzzy_keys_hash, hash);
}
static void
fuzzy_count_callback(uint64_t count, void *ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
ctx->stat.fuzzy_hashes = count;
}
static void
fuzzy_rl_bucket_free(gpointer p)
{
struct rspamd_leaky_bucket_elt *elt = (struct rspamd_leaky_bucket_elt *) p;
rspamd_inet_address_free(elt->addr);
g_free(elt);
}
static void
fuzzy_stat_count_callback(uint64_t count, void *ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
ev_timer_again(ctx->event_loop, &ctx->stat_ev);
ctx->stat.fuzzy_hashes = count;
}
static void
rspamd_fuzzy_stat_callback(EV_P_ ev_timer *w, int revents)
{
struct rspamd_fuzzy_storage_ctx *ctx =
(struct rspamd_fuzzy_storage_ctx *) w->data;
rspamd_fuzzy_backend_count(ctx->backend, fuzzy_stat_count_callback, ctx);
}
static void
fuzzy_update_version_callback(uint64_t ver, void *ud)
{
}
static void
rspamd_fuzzy_updates_cb(gboolean success,
unsigned int nadded,
unsigned int ndeleted,
unsigned int nextended,
unsigned int nignored,
void *ud)
{
struct rspamd_updates_cbdata *cbdata = ud;
struct rspamd_fuzzy_storage_ctx *ctx;
const char *source;
ctx = cbdata->ctx;
source = cbdata->source;
if (success) {
rspamd_fuzzy_backend_count(ctx->backend, fuzzy_count_callback, ctx);
msg_info("successfully updated fuzzy storage %s: %d updates in queue; "
"%d pending currently; "
"%d added; %d deleted; %d extended; %d duplicates",
ctx->worker->cf->bind_conf ? ctx->worker->cf->bind_conf->bind_line : "unknown",
cbdata->updates_pending->len,
ctx->updates_pending->len,
nadded, ndeleted, nextended, nignored);
rspamd_fuzzy_backend_version(ctx->backend, source,
fuzzy_update_version_callback, NULL);
ctx->updates_failed = 0;
if (cbdata->final || ctx->worker->state != rspamd_worker_state_running) {
/* Plan exit */
ev_break(ctx->event_loop, EVBREAK_ALL);
}
}
else {
if (++ctx->updates_failed > ctx->updates_maxfail) {
msg_err("cannot commit update transaction to fuzzy backend %s, discard "
"%ud updates after %d retries",
ctx->worker->cf->bind_conf ? ctx->worker->cf->bind_conf->bind_line : "unknown",
cbdata->updates_pending->len,
ctx->updates_maxfail);
ctx->updates_failed = 0;
if (cbdata->final || ctx->worker->state != rspamd_worker_state_running) {
/* Plan exit */
ev_break(ctx->event_loop, EVBREAK_ALL);
}
}
else {
if (ctx->updates_pending) {
msg_err("cannot commit update transaction to fuzzy backend %s; "
"%ud updates are still left; %ud currently pending;"
" %d retries remaining",
ctx->worker->cf->bind_conf ? ctx->worker->cf->bind_conf->bind_line : "unknown",
cbdata->updates_pending->len,
ctx->updates_pending->len,
ctx->updates_maxfail - ctx->updates_failed);
/* Move the remaining updates to ctx queue */
g_array_append_vals(ctx->updates_pending,
cbdata->updates_pending->data,
cbdata->updates_pending->len);
if (cbdata->final) {
/* Try one more time */
rspamd_fuzzy_process_updates_queue(cbdata->ctx, cbdata->source,
cbdata->final);
}
}
else {
/* We have lost our ctx, so it is a race condition case */
msg_err("cannot commit update transaction to fuzzy backend %s; "
"%ud updates are still left; no more retries: a worker is terminated",
ctx->worker->cf->bind_conf ? ctx->worker->cf->bind_conf->bind_line : "unknown",
cbdata->updates_pending->len);
}
}
}
g_array_free(cbdata->updates_pending, TRUE);
g_free(cbdata->source);
g_free(cbdata);
}
static gboolean
rspamd_fuzzy_process_updates_queue(struct rspamd_fuzzy_storage_ctx *ctx,
const char *source, gboolean final)
{
struct rspamd_updates_cbdata *cbdata;
if (ctx->updates_pending->len > 0) {
cbdata = g_malloc(sizeof(*cbdata));
cbdata->ctx = ctx;
cbdata->final = final;
cbdata->updates_pending = ctx->updates_pending;
ctx->updates_pending = g_array_sized_new(FALSE, FALSE,
sizeof(struct fuzzy_peer_cmd),
MAX(cbdata->updates_pending->len, 1024));
cbdata->source = g_strdup(source);
rspamd_fuzzy_backend_process_updates(ctx->backend,
cbdata->updates_pending,
source, rspamd_fuzzy_updates_cb, cbdata);
return TRUE;
}
else if (final) {
/* No need to sync */
ev_break(ctx->event_loop, EVBREAK_ALL);
}
return FALSE;
}
static void
rspamd_fuzzy_reply_io(EV_P_ ev_io *w, int revents)
{
struct fuzzy_session *session = (struct fuzzy_session *) w->data;
ev_io_stop(EV_A_ w);
rspamd_fuzzy_write_reply(session);
REF_RELEASE(session);
}
static void
rspamd_fuzzy_write_reply(struct fuzzy_session *session)
{
gssize r;
gsize len;
gconstpointer data;
if (session->cmd_type == CMD_ENCRYPTED_NORMAL ||
session->cmd_type == CMD_ENCRYPTED_SHINGLE) {
/* Encrypted reply */
data = &session->reply;
if (session->epoch > RSPAMD_FUZZY_EPOCH10) {
len = sizeof(session->reply);
}
else {
len = sizeof(session->reply.hdr) + sizeof(session->reply.rep.v1);
}
}
else {
data = &session->reply.rep;
if (session->epoch > RSPAMD_FUZZY_EPOCH10) {
len = sizeof(session->reply.rep);
}
else {
len = sizeof(session->reply.rep.v1);
}
}
r = rspamd_inet_address_sendto(session->fd, data, len, 0,
session->addr);
if (r == -1) {
if (errno == EINTR || errno == EWOULDBLOCK || errno == EAGAIN) {
/* Grab reference to avoid early destruction */
REF_RETAIN(session);
session->io.data = session;
ev_io_init(&session->io,
rspamd_fuzzy_reply_io, session->fd, EV_WRITE);
ev_io_start(session->ctx->event_loop, &session->io);
}
else {
msg_err("error while writing reply: %s", strerror(errno));
}
}
}
static void
rspamd_fuzzy_update_key_stat(gboolean matched,
struct fuzzy_key_stat *key_stat,
unsigned int cmd,
struct rspamd_fuzzy_reply *res,
ev_tstamp timestamp)
{
if (!matched && res->v1.value != 0) {
key_stat->errors++;
}
else {
if (cmd == FUZZY_CHECK) {
key_stat->checked++;
if (matched) {
key_stat->matched++;
}
if (G_UNLIKELY(key_stat->last_checked_time == 0.0)) {
key_stat->last_checked_time = timestamp;
key_stat->last_checked_count = key_stat->checked;
key_stat->last_matched_count = key_stat->matched;
}
else if (G_UNLIKELY(timestamp > key_stat->last_checked_time + KEY_STAT_INTERVAL)) {
uint64_t nchecked = key_stat->checked - key_stat->last_checked_count;
uint64_t nmatched = key_stat->matched - key_stat->last_matched_count;
rspamd_set_counter_ema(&key_stat->checked_ctr, nchecked, 0.5f);
rspamd_set_counter_ema(&key_stat->matched_ctr, nmatched, 0.5f);
key_stat->last_checked_time = timestamp;
key_stat->last_checked_count = key_stat->checked;
key_stat->last_matched_count = key_stat->matched;
}
}
else if (cmd == FUZZY_WRITE) {
key_stat->added++;
}
else if (cmd == FUZZY_DEL) {
key_stat->deleted++;
}
}
}
static void
rspamd_fuzzy_update_stats(struct rspamd_fuzzy_storage_ctx *ctx,
enum rspamd_fuzzy_epoch epoch,
gboolean matched,
gboolean is_shingle,
gboolean is_delayed,
struct fuzzy_key *key,
struct fuzzy_key_stat *ip_stat,
unsigned int cmd,
struct rspamd_fuzzy_reply *res,
ev_tstamp timestamp)
{
ctx->stat.fuzzy_hashes_checked[epoch]++;
if (matched) {
ctx->stat.fuzzy_hashes_found[epoch]++;
}
if (is_shingle) {
ctx->stat.fuzzy_shingles_checked[epoch]++;
}
if (is_delayed) {
ctx->stat.delayed_hashes++;
}
if (key) {
rspamd_fuzzy_update_key_stat(matched, key->stat, cmd, res, timestamp);
if (matched || ((cmd == FUZZY_WRITE || cmd == FUZZY_DEL) && res->v1.value == 0)) {
/* Update per flag stats */
khiter_t k;
struct fuzzy_key_stat *flag_stat;
k = kh_get(fuzzy_key_flag_stat, key->flags_stat, res->v1.flag);
if (k == kh_end(key->flags_stat)) {
/* Insert new flag */
int r;
k = kh_put(fuzzy_key_flag_stat, key->flags_stat, res->v1.flag, &r);
memset(&kh_value(key->flags_stat, k), 0, sizeof(struct fuzzy_key_stat));
}
flag_stat = &kh_value(key->flags_stat, k);
rspamd_fuzzy_update_key_stat(matched, flag_stat, cmd, res, timestamp);
}
}
if (ip_stat) {
if (!matched && res->v1.value != 0) {
ip_stat->errors++;
}
else {
if (cmd == FUZZY_CHECK) {
ip_stat->checked++;
if (matched) {
ip_stat->matched++;
}
}
else if (cmd == FUZZY_WRITE) {
ip_stat->added++;
}
else if (cmd == FUZZY_DEL) {
ip_stat->deleted++;
}
}
}
}
enum rspamd_fuzzy_reply_flags {
RSPAMD_FUZZY_REPLY_ENCRYPTED = 0x1u << 0u,
RSPAMD_FUZZY_REPLY_SHINGLE = 0x1u << 1u,
RSPAMD_FUZZY_REPLY_DELAY = 0x1u << 2u,
};
static void
rspamd_fuzzy_make_reply(struct rspamd_fuzzy_cmd *cmd,
struct rspamd_fuzzy_reply *result,
struct fuzzy_session *session,
int flags)
{
gsize len;
if (cmd) {
result->v1.tag = cmd->tag;
memcpy(&session->reply.rep, result, sizeof(*result));
if (flags & RSPAMD_FUZZY_REPLY_DELAY) {
/* Hash is too fresh, need to delay it */
session->reply.rep.ts = 0;
session->reply.rep.v1.prob = 0.0f;
session->reply.rep.v1.value = 0;
}
bool default_disabled = false;
{
khiter_t k;
k = kh_get(fuzzy_key_ids_set, session->ctx->default_forbidden_ids, session->reply.rep.v1.flag);
if (k != kh_end(session->ctx->default_forbidden_ids)) {
/* Hash is from a forbidden flag by default */
default_disabled = true;
}
}
if (flags & RSPAMD_FUZZY_REPLY_ENCRYPTED) {
if (session->reply.rep.v1.prob > 0 && session->key && session->key->forbidden_ids) {
khiter_t k;
k = kh_get(fuzzy_key_ids_set, session->key->forbidden_ids, session->reply.rep.v1.flag);
if (k != kh_end(session->key->forbidden_ids)) {
/* Hash is from a forbidden flag for this key */
session->reply.rep.ts = 0;
session->reply.rep.v1.prob = 0.0f;
session->reply.rep.v1.value = 0;
session->reply.rep.v1.flag = 0;
}
}
else if (default_disabled) {
/* Hash is from a forbidden flag by default */
session->reply.rep.ts = 0;
session->reply.rep.v1.prob = 0.0f;
session->reply.rep.v1.value = 0;
session->reply.rep.v1.flag = 0;
}
/* We need also to encrypt reply */
ottery_rand_bytes(session->reply.hdr.nonce,
sizeof(session->reply.hdr.nonce));
/*
* For old replies we need to encrypt just old part, otherwise
* decryption would fail due to mac verification mistake
*/
if (session->epoch > RSPAMD_FUZZY_EPOCH10) {
len = sizeof(session->reply.rep);
}
else {
len = sizeof(session->reply.rep.v1);
}
/* Update stats before encryption */
if (cmd->cmd != FUZZY_STAT && cmd->cmd <= FUZZY_CLIENT_MAX) {
rspamd_fuzzy_update_stats(session->ctx,
session->epoch,
session->reply.rep.v1.prob > 0.5f,
flags & RSPAMD_FUZZY_REPLY_SHINGLE,
flags & RSPAMD_FUZZY_REPLY_DELAY,
session->key,
session->ip_stat,
cmd->cmd,
&session->reply.rep,
session->timestamp);
}
rspamd_cryptobox_encrypt_nm_inplace((unsigned char *) &session->reply.rep,
len,
session->reply.hdr.nonce,
session->nm,
session->reply.hdr.mac);
}
else if (default_disabled) {
/* Hash is from a forbidden flag by default, and there is no encryption override */
session->reply.rep.ts = 0;
session->reply.rep.v1.prob = 0.0f;
session->reply.rep.v1.value = 0;
session->reply.rep.v1.flag = 0;
}
if (!(flags & RSPAMD_FUZZY_REPLY_ENCRYPTED)) {
if (cmd->cmd != FUZZY_STAT && cmd->cmd <= FUZZY_CLIENT_MAX) {
rspamd_fuzzy_update_stats(session->ctx,
session->epoch,
session->reply.rep.v1.prob > 0.5f,
flags & RSPAMD_FUZZY_REPLY_SHINGLE,
flags & RSPAMD_FUZZY_REPLY_DELAY,
session->key,
session->ip_stat,
cmd->cmd,
&session->reply.rep,
session->timestamp);
}
}
}
rspamd_fuzzy_write_reply(session);
}
static gboolean
fuzzy_peer_try_send(int fd, struct fuzzy_peer_request *up_req)
{
gssize r;
r = write(fd, &up_req->cmd, sizeof(up_req->cmd));
if (r != sizeof(up_req->cmd)) {
return FALSE;
}
return TRUE;
}
static void
fuzzy_peer_send_io(EV_P_ ev_io *w, int revents)
{
struct fuzzy_peer_request *up_req = (struct fuzzy_peer_request *) w->data;
if (!fuzzy_peer_try_send(w->fd, up_req)) {
msg_err("cannot send update request to the peer: %s", strerror(errno));
}
ev_io_stop(EV_A_ w);
g_free(up_req);
}
static void
rspamd_fuzzy_extensions_tolua(lua_State *L,
struct fuzzy_session *session)
{
struct rspamd_fuzzy_cmd_extension *ext;
rspamd_inet_addr_t *addr;
lua_createtable(L, 0, 0);
LL_FOREACH(session->extensions, ext)
{
switch (ext->ext) {
case RSPAMD_FUZZY_EXT_SOURCE_DOMAIN:
lua_pushlstring(L, ext->payload, ext->length);
lua_setfield(L, -2, "domain");
break;
case RSPAMD_FUZZY_EXT_SOURCE_IP4:
addr = rspamd_inet_address_new(AF_INET, ext->payload);
rspamd_lua_ip_push(L, addr);
rspamd_inet_address_free(addr);
lua_setfield(L, -2, "ip");
break;
case RSPAMD_FUZZY_EXT_SOURCE_IP6:
addr = rspamd_inet_address_new(AF_INET6, ext->payload);
rspamd_lua_ip_push(L, addr);
rspamd_inet_address_free(addr);
lua_setfield(L, -2, "ip");
break;
}
}
}
static void
rspamd_fuzzy_check_callback(struct rspamd_fuzzy_reply *result, void *ud)
{
struct fuzzy_session *session = ud;
gboolean is_shingle = FALSE, __attribute__((unused)) encrypted = FALSE;
struct rspamd_fuzzy_cmd *cmd = NULL;
const struct rspamd_shingle *shingle = NULL;
struct rspamd_shingle sgl_cpy;
int send_flags = 0;
switch (session->cmd_type) {
case CMD_ENCRYPTED_NORMAL:
encrypted = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_ENCRYPTED;
/* Fallthrough */
case CMD_NORMAL:
cmd = &session->cmd.basic;
break;
case CMD_ENCRYPTED_SHINGLE:
encrypted = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_ENCRYPTED;
/* Fallthrough */
case CMD_SHINGLE:
cmd = &session->cmd.basic;
memcpy(&sgl_cpy, &session->cmd.sgl, sizeof(sgl_cpy));
shingle = &sgl_cpy;
is_shingle = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_SHINGLE;
break;
}
if (session->ctx->lua_post_handler_cbref != -1) {
/* Start lua post handler */
lua_State *L = session->ctx->cfg->lua_state;
int err_idx, ret;
lua_pushcfunction(L, &rspamd_lua_traceback);
err_idx = lua_gettop(L);
/* Preallocate stack (small opt) */
lua_checkstack(L, err_idx + 9);
/* function */
lua_rawgeti(L, LUA_REGISTRYINDEX, session->ctx->lua_post_handler_cbref);
/* client IP */
if (session->addr) {
rspamd_lua_ip_push(L, session->addr);
}
else {
lua_pushnil(L);
}
/* client command */
lua_pushinteger(L, cmd->cmd);
/* command value (push as rspamd_text) */
(void) lua_new_text(L, result->digest, sizeof(result->digest), FALSE);
/* is shingle */
lua_pushboolean(L, is_shingle);
/* result value */
lua_pushinteger(L, result->v1.value);
/* result probability */
lua_pushnumber(L, result->v1.prob);
/* result flag */
lua_pushinteger(L, result->v1.flag);
/* result timestamp */
lua_pushinteger(L, result->ts);
/* TODO: add additional data maybe (encryption, pubkey, etc) */
rspamd_fuzzy_extensions_tolua(L, session);
if ((ret = lua_pcall(L, 9, LUA_MULTRET, err_idx)) != 0) {
msg_err("call to lua_post_handler lua "
"script failed (%d): %s",
ret, lua_tostring(L, -1));
}
else {
/* Return values order:
* the first reply will be on err_idx + 1
* if it is true, then we need to read the former ones:
* 2-nd will be reply code
* 3-rd will be probability (or 0.0 if missing)
* 4-th value is flag (or default flag if missing)
*/
ret = lua_toboolean(L, err_idx + 1);
if (ret) {
/* Artificial reply */
result->v1.value = lua_tointeger(L, err_idx + 2);
if (lua_isnumber(L, err_idx + 3)) {
result->v1.prob = lua_tonumber(L, err_idx + 3);
}
else {
result->v1.prob = 0.0f;
}
if (lua_isnumber(L, err_idx + 4)) {
result->v1.flag = lua_tointeger(L, err_idx + 4);
}
lua_settop(L, 0);
rspamd_fuzzy_make_reply(cmd, result, session, send_flags);
REF_RELEASE(session);
return;
}
}
lua_settop(L, 0);
}
if (!isnan(session->ctx->delay) &&
rspamd_match_radix_map_addr(session->ctx->delay_whitelist,
session->addr) == NULL) {
double hash_age = rspamd_get_calendar_ticks() - result->ts;
double jittered_age = rspamd_time_jitter(session->ctx->delay,
session->ctx->delay / 2.0);
if (hash_age < jittered_age) {
send_flags |= RSPAMD_FUZZY_REPLY_DELAY;
}
}
/* Refresh hash if found with strong confidence */
if (result->v1.prob > 0.9 && !session->ctx->read_only) {
struct fuzzy_peer_cmd up_cmd;
struct fuzzy_peer_request *up_req;
if (session->worker->index == 0) {
/* Just add to the queue */
memset(&up_cmd, 0, sizeof(up_cmd));
up_cmd.is_shingle = is_shingle;
memcpy(up_cmd.cmd.normal.digest, result->digest,
sizeof(up_cmd.cmd.normal.digest));
up_cmd.cmd.normal.flag = result->v1.flag;
up_cmd.cmd.normal.cmd = FUZZY_REFRESH;
up_cmd.cmd.normal.shingles_count = cmd->shingles_count;
if (is_shingle && shingle) {
memcpy(&up_cmd.cmd.shingle.sgl, shingle,
sizeof(up_cmd.cmd.shingle.sgl));
}
g_array_append_val(session->ctx->updates_pending, up_cmd);
}
else {
/* We need to send request to the peer */
up_req = g_malloc0(sizeof(*up_req));
up_req->cmd.is_shingle = is_shingle;
memcpy(up_req->cmd.cmd.normal.digest, result->digest,
sizeof(up_req->cmd.cmd.normal.digest));
up_req->cmd.cmd.normal.flag = result->v1.flag;
up_req->cmd.cmd.normal.cmd = FUZZY_REFRESH;
up_req->cmd.cmd.normal.shingles_count = cmd->shingles_count;
if (is_shingle && shingle) {
memcpy(&up_req->cmd.cmd.shingle.sgl, shingle,
sizeof(up_req->cmd.cmd.shingle.sgl));
}
if (!fuzzy_peer_try_send(session->ctx->peer_fd, up_req)) {
up_req->io_ev.data = up_req;
ev_io_init(&up_req->io_ev, fuzzy_peer_send_io,
session->ctx->peer_fd, EV_WRITE);
ev_io_start(session->ctx->event_loop, &up_req->io_ev);
}
else {
g_free(up_req);
}
}
}
rspamd_fuzzy_make_reply(cmd, result, session, send_flags);
REF_RELEASE(session);
}
static void
rspamd_fuzzy_process_command(struct fuzzy_session *session)
{
gboolean is_shingle = FALSE, __attribute__((unused)) encrypted = FALSE;
struct rspamd_fuzzy_cmd *cmd = NULL;
struct rspamd_fuzzy_reply result;
struct fuzzy_peer_cmd up_cmd;
struct fuzzy_peer_request *up_req;
struct fuzzy_key_stat *ip_stat = NULL;
char hexbuf[rspamd_cryptobox_HASHBYTES * 2 + 1];
rspamd_inet_addr_t *naddr;
gpointer ptr;
gsize up_len = 0;
int send_flags = 0;
cmd = &session->cmd.basic;
switch (session->cmd_type) {
case CMD_NORMAL:
up_len = sizeof(session->cmd.basic);
break;
case CMD_SHINGLE:
up_len = sizeof(session->cmd);
is_shingle = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_SHINGLE;
break;
case CMD_ENCRYPTED_NORMAL:
up_len = sizeof(session->cmd.basic);
encrypted = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_ENCRYPTED;
break;
case CMD_ENCRYPTED_SHINGLE:
up_len = sizeof(session->cmd);
encrypted = TRUE;
is_shingle = TRUE;
send_flags |= RSPAMD_FUZZY_REPLY_SHINGLE | RSPAMD_FUZZY_REPLY_ENCRYPTED;
break;
default:
msg_err("invalid command type: %d", session->cmd_type);
return;
}
memset(&result, 0, sizeof(result));
memcpy(result.digest, cmd->digest, sizeof(result.digest));
result.v1.flag = cmd->flag;
result.v1.tag = cmd->tag;
if (session->ctx->lua_pre_handler_cbref != -1) {
/* Start lua pre handler */
lua_State *L = session->ctx->cfg->lua_state;
int err_idx, ret;
lua_pushcfunction(L, &rspamd_lua_traceback);
err_idx = lua_gettop(L);
/* Preallocate stack (small opt) */
lua_checkstack(L, err_idx + 5);
/* function */
lua_rawgeti(L, LUA_REGISTRYINDEX, session->ctx->lua_pre_handler_cbref);
/* client IP */
rspamd_lua_ip_push(L, session->addr);
/* client command */
lua_pushinteger(L, cmd->cmd);
/* command value (push as rspamd_text) */
(void) lua_new_text(L, cmd->digest, sizeof(cmd->digest), FALSE);
/* is shingle */
lua_pushboolean(L, is_shingle);
/* TODO: add additional data maybe (encryption, pubkey, etc) */
rspamd_fuzzy_extensions_tolua(L, session);
if ((ret = lua_pcall(L, 5, LUA_MULTRET, err_idx)) != 0) {
msg_err("call to lua_pre_handler lua "
"script failed (%d): %s",
ret, lua_tostring(L, -1));
}
else {
/* Return values order:
* the first reply will be on err_idx + 1
* if it is true, then we need to read the former ones:
* 2-nd will be reply code
* 3-rd will be probability (or 0.0 if missing)
*/
ret = lua_toboolean(L, err_idx + 1);
if (ret) {
/* Artificial reply */
result.v1.value = lua_tointeger(L, err_idx + 2);
if (lua_isnumber(L, err_idx + 3)) {
result.v1.prob = lua_tonumber(L, err_idx + 3);
}
else {
result.v1.prob = 0.0f;
}
lua_settop(L, 0);
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
return;
}
}
lua_settop(L, 0);
}
if (G_UNLIKELY(cmd == NULL || up_len == 0)) {
result.v1.value = 500;
result.v1.prob = 0.0f;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
return;
}
if (session->ctx->encrypted_only && !encrypted) {
/* Do not accept unencrypted commands */
result.v1.value = 415;
result.v1.prob = 0.0f;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
return;
}
if (!rspamd_fuzzy_check_client(session->ctx, session->addr)) {
result.v1.value = 503;
result.v1.prob = 0.0f;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
return;
}
if (session->key && session->addr) {
ip_stat = rspamd_lru_hash_lookup(session->key->stat->last_ips,
session->addr, -1);
if (ip_stat == NULL) {
naddr = rspamd_inet_address_copy(session->addr, NULL);
ip_stat = g_malloc0(sizeof(*ip_stat));
REF_INIT_RETAIN(ip_stat, fuzzy_key_stat_dtor);
rspamd_lru_hash_insert(session->key->stat->last_ips,
naddr, ip_stat, -1, 0);
}
REF_RETAIN(ip_stat);
session->ip_stat = ip_stat;
}
if (cmd->cmd == FUZZY_CHECK) {
bool is_rate_allowed = true;
if (session->ctx->ratelimit_buckets) {
if (session->ctx->ratelimit_log_only) {
(void) rspamd_fuzzy_check_ratelimit(session); /* Check but ignore */
}
else {
is_rate_allowed = rspamd_fuzzy_check_ratelimit(session);
}
}
if (session->key && session->key->rl_bucket) {
/* Check per-key bucket */
enum rspamd_ratelimit_check_result res = rspamd_fuzzy_check_ratelimit_bucket(session, session->key->rl_bucket,
ratelimit_policy_normal,
session->key->burst,
session->key->rate);
if (res == ratelimit_new) {
msg_info("ratelimiting key %s %.1f max elts",
session->key->name ? session->key->name : "unknown",
session->key->burst);
struct rspamd_srv_command srv_cmd;
srv_cmd.type = RSPAMD_SRV_FUZZY_BLOCKED;
srv_cmd.cmd.fuzzy_blocked.af = rspamd_inet_address_get_af(session->addr);
if (srv_cmd.cmd.fuzzy_blocked.af == AF_INET || srv_cmd.cmd.fuzzy_blocked.af == AF_INET6) {
socklen_t slen;
struct sockaddr *sa = rspamd_inet_address_get_sa(session->addr, &slen);
if (slen <= sizeof(srv_cmd.cmd.fuzzy_blocked.addr)) {
memcpy(&srv_cmd.cmd.fuzzy_blocked.addr, sa, slen);
msg_debug("propagating blocked address to other workers");
rspamd_srv_send_command(session->worker,
session->ctx->event_loop,
&srv_cmd, -1, NULL, NULL);
}
else {
msg_err("bad address length: %d, expected to be %d",
(int) slen, (int) sizeof(srv_cmd.cmd.fuzzy_blocked.addr));
}
}
rspamd_fuzzy_maybe_call_blacklisted(session->ctx, session->addr, "ratelimit");
is_rate_allowed = session->ctx->ratelimit_log_only ? true : false;
}
else if (res == ratelimit_existing) {
rspamd_fuzzy_maybe_call_blacklisted(session->ctx, session->addr, "ratelimit");
is_rate_allowed = session->ctx->ratelimit_log_only ? true : false;
}
}
if (session->key && !isnan(session->key->expire)) {
/* Check expire */
static ev_tstamp today = NAN;
if (isnan(today)) {
today = ev_time();
}
else if (rspamd_random_uint64_fast() > 0xFFFF000000000000ULL) {
today = ev_time();
}
if (today > session->key->expire) {
if (!session->key->expired) {
msg_info("key %s is expired", session->key->name);
session->key->expired = true;
}
result.v1.value = 503;
result.v1.prob = 0.0f;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
return;
}
}
if (is_rate_allowed) {
REF_RETAIN(session);
rspamd_fuzzy_backend_check(session->ctx->backend, cmd,
rspamd_fuzzy_check_callback, session);
}
else {
/* Should be 429 but we keep compatibility */
result.v1.value = 403;
result.v1.prob = 0.0f;
result.v1.flag = 0;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
}
}
else if (cmd->cmd == FUZZY_STAT) {
/* Store approximation (if needed) */
result.v1.prob = session->ctx->stat.fuzzy_hashes;
/* Store high qword in value and low qword in flag */
result.v1.value = (int32_t) ((uint64_t) session->ctx->stat.fuzzy_hashes >> 32);
result.v1.flag = (uint32_t) (session->ctx->stat.fuzzy_hashes & G_MAXUINT32);
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
}
else if (cmd->cmd == FUZZY_PING) {
result.v1.prob = 1.0f;
result.v1.value = cmd->value;
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
}
else {
if (rspamd_fuzzy_check_write(session)) {
/* Check whitelist */
if (session->ctx->skip_hashes && cmd->cmd == FUZZY_WRITE) {
rspamd_encode_hex_buf(cmd->digest, sizeof(cmd->digest),
hexbuf, sizeof(hexbuf) - 1);
hexbuf[sizeof(hexbuf) - 1] = '\0';
if (rspamd_match_hash_map(session->ctx->skip_hashes,
hexbuf, sizeof(hexbuf) - 1)) {
result.v1.value = 401;
result.v1.prob = 0.0f;
goto reply;
}
}
if (session->ctx->weak_ids && kh_get(fuzzy_key_ids_set, session->ctx->weak_ids, cmd->flag) != kh_end(session->ctx->weak_ids)) {
/* Flag command as weak */
cmd->version |= RSPAMD_FUZZY_FLAG_WEAK;
}
if (session->worker->index == 0 || session->ctx->peer_fd == -1) {
/* Just add to the queue */
up_cmd.is_shingle = is_shingle;
ptr = is_shingle ? (gpointer) &up_cmd.cmd.shingle : (gpointer) &up_cmd.cmd.normal;
memcpy(ptr, cmd, up_len);
g_array_append_val(session->ctx->updates_pending, up_cmd);
}
else {
/* We need to send request to the peer */
up_req = g_malloc0(sizeof(*up_req));
up_req->cmd.is_shingle = is_shingle;
ptr = is_shingle ? (gpointer) &up_req->cmd.cmd.shingle : (gpointer) &up_req->cmd.cmd.normal;
memcpy(ptr, cmd, up_len);
if (!fuzzy_peer_try_send(session->ctx->peer_fd, up_req)) {
up_req->io_ev.data = up_req;
ev_io_init(&up_req->io_ev, fuzzy_peer_send_io,
session->ctx->peer_fd, EV_WRITE);
ev_io_start(session->ctx->event_loop, &up_req->io_ev);
}
else {
g_free(up_req);
}
}
result.v1.value = 0;
result.v1.prob = 1.0f;
}
else {
result.v1.value = 503;
result.v1.prob = 0.0f;
}
reply:
rspamd_fuzzy_make_reply(cmd, &result, session, send_flags);
}
}
static enum rspamd_fuzzy_epoch
rspamd_fuzzy_command_valid(struct rspamd_fuzzy_cmd *cmd, int r)
{
enum rspamd_fuzzy_epoch ret = RSPAMD_FUZZY_EPOCH_MAX;
switch (cmd->version & RSPAMD_FUZZY_VERSION_MASK) {
case 4:
if (cmd->shingles_count > 0) {
if (r >= sizeof(struct rspamd_fuzzy_shingle_cmd)) {
ret = RSPAMD_FUZZY_EPOCH11;
}
}
else {
if (r >= sizeof(*cmd)) {
ret = RSPAMD_FUZZY_EPOCH11;
}
}
break;
case 3:
if (cmd->shingles_count > 0) {
if (r == sizeof(struct rspamd_fuzzy_shingle_cmd)) {
ret = RSPAMD_FUZZY_EPOCH10;
}
}
else {
if (r == sizeof(*cmd)) {
ret = RSPAMD_FUZZY_EPOCH10;
}
}
break;
default:
break;
}
return ret;
}
static gboolean
rspamd_fuzzy_decrypt_command(struct fuzzy_session *s, unsigned char *buf, gsize buflen)
{
struct rspamd_fuzzy_encrypted_req_hdr hdr;
struct rspamd_cryptobox_pubkey *rk;
struct fuzzy_key *key = NULL;
if (s->ctx->default_key == NULL && s->ctx->dynamic_keys == NULL) {
msg_warn("received encrypted request when encryption is not enabled");
return FALSE;
}
if (buflen < sizeof(hdr)) {
msg_warn("XXX: should not be reached");
return FALSE;
}
memcpy(&hdr, buf, sizeof(hdr));
buf += sizeof(hdr);
buflen -= sizeof(hdr);
/* Try to find the desired key */
khiter_t k = kh_get(rspamd_fuzzy_keys_hash, s->ctx->keys, hdr.key_id);
if (k == kh_end(s->ctx->keys)) {
key = s->ctx->default_key;
/* Check dynamic keys */
if (s->ctx->dynamic_keys) {
k = kh_get(rspamd_fuzzy_keys_hash, s->ctx->dynamic_keys, hdr.key_id);
if (k != kh_end(s->ctx->keys)) {
key = kh_val(s->ctx->dynamic_keys, k);
}
}
}
else {
key = kh_val(s->ctx->keys, k);
}
if (key == NULL) {
/* Cannot find any suitable decryption key */
msg_debug("cannot find suitable decryption key");
return FALSE;
}
/* Now process the remote pubkey */
rk = rspamd_pubkey_from_bin(hdr.pubkey, sizeof(hdr.pubkey), RSPAMD_KEYPAIR_KEX);
if (rk == NULL) {
msg_err("bad key; ip=%s",
rspamd_inet_address_to_string(s->addr));
return FALSE;
}
/* Try to get the cached NM */
rspamd_keypair_cache_process(s->ctx->keypair_cache, key->key, rk);
/* Now decrypt request */
if (!rspamd_cryptobox_decrypt_nm_inplace(buf, buflen, hdr.nonce,
rspamd_pubkey_get_nm(rk, key->key),
hdr.mac)) {
msg_err("decryption failed; ip=%s",
rspamd_inet_address_to_string(s->addr));
rspamd_pubkey_unref(rk);
return FALSE;
}
s->key = key;
REF_RETAIN(key);
memcpy(s->nm, rspamd_pubkey_get_nm(rk, key->key), sizeof(s->nm));
rspamd_pubkey_unref(rk);
return TRUE;
}
static gboolean
rspamd_fuzzy_extensions_from_wire(struct fuzzy_session *s, unsigned char *buf, gsize buflen)
{
struct rspamd_fuzzy_cmd_extension *ext, *prev_ext;
unsigned char *storage, *p = buf, *end = buf + buflen;
gsize st_len = 0, n_ext = 0;
/* Read number of extensions to allocate array */
while (p < end) {
unsigned char cmd = *p++;
if (p < end) {
if (cmd == RSPAMD_FUZZY_EXT_SOURCE_DOMAIN) {
/* Next byte is buf length */
unsigned char dom_len = *p++;
if (dom_len <= (end - p)) {
st_len += dom_len;
n_ext++;
}
else {
/* Truncation */
return FALSE;
}
p += dom_len;
}
else if (cmd == RSPAMD_FUZZY_EXT_SOURCE_IP4) {
if (end - p >= sizeof(in_addr_t)) {
n_ext++;
st_len += sizeof(in_addr_t);
}
else {
/* Truncation */
return FALSE;
}
p += sizeof(in_addr_t);
}
else if (cmd == RSPAMD_FUZZY_EXT_SOURCE_IP6) {
if (end - p >= sizeof(struct in6_addr)) {
n_ext++;
st_len += sizeof(struct in6_addr);
}
else {
/* Truncation */
return FALSE;
}
p += sizeof(struct in6_addr);
}
else {
/* Invalid command */
return FALSE;
}
}
else {
/* Truncated extension */
return FALSE;
}
}
if (n_ext > 0) {
p = buf;
/*
* Memory layout: n_ext of struct rspamd_fuzzy_cmd_extension
* payload for each extension in a continuous data segment
*/
storage = g_malloc(n_ext * sizeof(struct rspamd_fuzzy_cmd_extension) +
st_len);
unsigned char *data_buf = storage +
n_ext * sizeof(struct rspamd_fuzzy_cmd_extension);
ext = (struct rspamd_fuzzy_cmd_extension *) storage;
/* All validation has been done, so we can just go further */
while (p < end) {
prev_ext = ext;
unsigned char cmd = *p++;
if (cmd == RSPAMD_FUZZY_EXT_SOURCE_DOMAIN) {
/* Next byte is buf length */
unsigned char dom_len = *p++;
unsigned char *dest = data_buf;
ext->ext = RSPAMD_FUZZY_EXT_SOURCE_DOMAIN;
ext->next = ext + 1;
ext->length = dom_len;
ext->payload = dest;
memcpy(dest, p, dom_len);
p += dom_len;
data_buf += dom_len;
ext = ext->next;
}
else if (cmd == RSPAMD_FUZZY_EXT_SOURCE_IP4) {
unsigned char *dest = data_buf;
ext->ext = RSPAMD_FUZZY_EXT_SOURCE_IP4;
ext->next = ext + 1;
ext->length = sizeof(in_addr_t);
ext->payload = dest;
memcpy(dest, p, sizeof(in_addr_t));
p += sizeof(in_addr_t);
data_buf += sizeof(in_addr_t);
ext = ext->next;
}
else if (cmd == RSPAMD_FUZZY_EXT_SOURCE_IP6) {
unsigned char *dest = data_buf;
ext->ext = RSPAMD_FUZZY_EXT_SOURCE_IP6;
ext->next = ext + 1;
ext->length = sizeof(struct in6_addr);
ext->payload = dest;
memcpy(dest, p, sizeof(struct in6_addr));
p += sizeof(struct in6_addr);
data_buf += sizeof(struct in6_addr);
ext = ext->next;
}
else {
g_assert_not_reached();
}
}
/* Last next should be NULL */
prev_ext->next = NULL;
/* Rewind to the begin */
ext = (struct rspamd_fuzzy_cmd_extension *) storage;
s->extensions = ext;
}
return TRUE;
}
static gboolean
rspamd_fuzzy_cmd_from_wire(unsigned char *buf, unsigned int buflen, struct fuzzy_session *s)
{
enum rspamd_fuzzy_epoch epoch;
gboolean encrypted = FALSE;
if (buflen < sizeof(struct rspamd_fuzzy_cmd)) {
msg_debug("truncated fuzzy command of size %d received", buflen);
return FALSE;
}
/* Now check encryption */
if (buflen >= sizeof(struct rspamd_fuzzy_encrypted_cmd)) {
if (memcmp(buf, fuzzy_encrypted_magic, sizeof(fuzzy_encrypted_magic)) == 0) {
/* Encrypted command */
encrypted = TRUE;
}
}
if (encrypted) {
/* Decrypt first */
if (!rspamd_fuzzy_decrypt_command(s, buf, buflen)) {
return FALSE;
}
else {
/*
* Advance buffer to skip encrypted header.
* Note that after rspamd_fuzzy_decrypt_command buf is unencrypted
*/
buf += sizeof(struct rspamd_fuzzy_encrypted_req_hdr);
buflen -= sizeof(struct rspamd_fuzzy_encrypted_req_hdr);
}
}
/* Fill the normal command */
if (buflen < sizeof(s->cmd.basic)) {
msg_debug("truncated normal fuzzy command of size %d received", buflen);
return FALSE;
}
memcpy(&s->cmd.basic, buf, sizeof(s->cmd.basic));
epoch = rspamd_fuzzy_command_valid(&s->cmd.basic, buflen);
if (epoch == RSPAMD_FUZZY_EPOCH_MAX) {
msg_debug("invalid fuzzy command of size %d received", buflen);
return FALSE;
}
s->epoch = epoch;
/* Advance buf */
buf += sizeof(s->cmd.basic);
buflen -= sizeof(s->cmd.basic);
if (s->cmd.basic.shingles_count > 0) {
if (buflen >= sizeof(s->cmd.sgl)) {
/* Copy the shingles part */
memcpy(&s->cmd.sgl, buf, sizeof(s->cmd.sgl));
}
else {
/* Truncated stuff */
msg_debug("truncated fuzzy shingles command of size %d received", buflen);
return FALSE;
}
buf += sizeof(s->cmd.sgl);
buflen -= sizeof(s->cmd.sgl);
if (encrypted) {
s->cmd_type = CMD_ENCRYPTED_SHINGLE;
}
else {
s->cmd_type = CMD_SHINGLE;
}
}
else {
if (encrypted) {
s->cmd_type = CMD_ENCRYPTED_NORMAL;
}
else {
s->cmd_type = CMD_NORMAL;
}
}
if (buflen > 0) {
/* Process possible extensions */
if (!rspamd_fuzzy_extensions_from_wire(s, buf, buflen)) {
msg_debug("truncated fuzzy shingles command of size %d received", buflen);
return FALSE;
}
}
return TRUE;
}
static void
fuzzy_session_destroy(gpointer d)
{
struct fuzzy_session *session = d;
rspamd_inet_address_free(session->addr);
rspamd_explicit_memzero(session->nm, sizeof(session->nm));
session->worker->nconns--;
if (session->ip_stat) {
REF_RELEASE(session->ip_stat);
}
if (session->extensions) {
g_free(session->extensions);
}
if (session->key) {
REF_RELEASE(session->key);
}
g_free(session);
}
#define FUZZY_INPUT_BUFLEN 1024
#ifdef HAVE_RECVMMSG
#define MSGVEC_LEN 16
#else
#define MSGVEC_LEN 1
#endif
union sa_union {
struct sockaddr sa;
struct sockaddr_in s4;
struct sockaddr_in6 s6;
struct sockaddr_un su;
struct sockaddr_storage ss;
};
/*
* Accept new connection and construct task
*/
static void
accept_fuzzy_socket(EV_P_ ev_io *w, int revents)
{
struct rspamd_worker *worker = (struct rspamd_worker *) w->data;
struct rspamd_fuzzy_storage_ctx *ctx;
struct fuzzy_session *session;
gssize r, msg_len;
uint64_t *nerrors;
struct iovec iovs[MSGVEC_LEN];
uint8_t bufs[MSGVEC_LEN][FUZZY_INPUT_BUFLEN];
union sa_union peer_sa[MSGVEC_LEN];
socklen_t salen = sizeof(peer_sa[0]);
#ifdef HAVE_RECVMMSG
#define MSG_FIELD(msg, field) msg.msg_hdr.field
struct mmsghdr msg[MSGVEC_LEN];
#else
#define MSG_FIELD(msg, field) msg.field
struct msghdr msg[MSGVEC_LEN];
#endif
memset(msg, 0, sizeof(*msg) * MSGVEC_LEN);
ctx = (struct rspamd_fuzzy_storage_ctx *) worker->ctx;
/* Prepare messages to receive */
for (int i = 0; i < MSGVEC_LEN; i++) {
/* Prepare msghdr structs */
iovs[i].iov_base = bufs[i];
iovs[i].iov_len = sizeof(bufs[i]);
MSG_FIELD(msg[i], msg_name) = (void *) &peer_sa[i];
MSG_FIELD(msg[i], msg_namelen) = salen;
MSG_FIELD(msg[i], msg_iov) = &iovs[i];
MSG_FIELD(msg[i], msg_iovlen) = 1;
}
/* Got some data */
if (revents == EV_READ) {
ev_now_update_if_cheap(ctx->event_loop);
for (;;) {
#ifdef HAVE_RECVMMSG
r = recvmmsg(w->fd, msg, MSGVEC_LEN, 0, NULL);
#else
r = recvmsg(w->fd, msg, 0);
#endif
if (r == -1) {
if (errno == EINTR) {
continue;
}
else if (errno == EAGAIN || errno == EWOULDBLOCK) {
return;
}
msg_err("got error while reading from socket: %d, %s",
errno,
strerror(errno));
return;
}
#ifndef HAVE_RECVMMSG
msg_len = r; /* Save real length in bytes here */
r = 1; /* Assume that we have received a single message */
#endif
for (int i = 0; i < r; i++) {
rspamd_inet_addr_t *client_addr;
if (MSG_FIELD(msg[i], msg_namelen) >= sizeof(struct sockaddr)) {
client_addr = rspamd_inet_address_from_sa(MSG_FIELD(msg[i], msg_name),
MSG_FIELD(msg[i], msg_namelen));
}
else {
client_addr = NULL;
}
session = g_malloc0(sizeof(*session));
REF_INIT_RETAIN(session, fuzzy_session_destroy);
session->worker = worker;
session->fd = w->fd;
session->ctx = ctx;
session->timestamp = ev_now(ctx->event_loop);
session->addr = client_addr;
worker->nconns++;
/* Each message can have its length in case of recvmmsg */
#ifdef HAVE_RECVMMSG
msg_len = msg[i].msg_len;
#endif
if (rspamd_fuzzy_cmd_from_wire(iovs[i].iov_base,
msg_len, session)) {
/* Check shingles count sanity */
rspamd_fuzzy_process_command(session);
}
else {
/* Discard input */
session->ctx->stat.invalid_requests++;
msg_debug("invalid fuzzy command of size %z received", r);
if (session->addr) {
nerrors = rspamd_lru_hash_lookup(session->ctx->errors_ips,
session->addr, -1);
if (nerrors == NULL) {
nerrors = g_malloc(sizeof(*nerrors));
*nerrors = 1;
rspamd_lru_hash_insert(session->ctx->errors_ips,
rspamd_inet_address_copy(session->addr, NULL),
nerrors, -1, -1);
}
else {
*nerrors = *nerrors + 1;
}
}
}
REF_RELEASE(session);
}
#ifdef HAVE_RECVMMSG
/* Stop reading as we are using recvmmsg instead of recvmsg */
break;
#endif
}
}
}
static gboolean
rspamd_fuzzy_storage_periodic_callback(void *ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
if (ctx->updates_pending->len > 0) {
rspamd_fuzzy_process_updates_queue(ctx, local_db_name, FALSE);
return TRUE;
}
return FALSE;
}
static gboolean
rspamd_fuzzy_storage_sync(struct rspamd_main *rspamd_main,
struct rspamd_worker *worker, int fd,
int attached_fd,
struct rspamd_control_command *cmd,
gpointer ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
struct rspamd_control_reply rep;
rep.reply.fuzzy_sync.status = 0;
rep.type = RSPAMD_CONTROL_FUZZY_SYNC;
if (ctx->backend && worker->index == 0) {
rspamd_fuzzy_process_updates_queue(ctx, local_db_name, FALSE);
rspamd_fuzzy_backend_start_update(ctx->backend, ctx->sync_timeout,
rspamd_fuzzy_storage_periodic_callback, ctx);
}
if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
msg_err("cannot write reply to the control socket: %s",
strerror(errno));
}
return TRUE;
}
static gboolean
rspamd_fuzzy_control_blocked(struct rspamd_main *rspamd_main,
struct rspamd_worker *worker, int fd,
int attached_fd,
struct rspamd_control_command *cmd,
gpointer ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = (struct rspamd_fuzzy_storage_ctx *) ud;
struct rspamd_control_reply rep;
struct rspamd_leaky_bucket_elt *elt;
ev_tstamp now = ev_now(ctx->event_loop);
rspamd_inet_addr_t *addr = NULL;
rep.type = RSPAMD_CONTROL_FUZZY_BLOCKED;
rep.reply.fuzzy_blocked.status = 0;
if (cmd->cmd.fuzzy_blocked.af == AF_INET) {
addr = rspamd_inet_address_from_sa(&cmd->cmd.fuzzy_blocked.addr.sa,
sizeof(struct sockaddr_in));
}
else if (cmd->cmd.fuzzy_blocked.af == AF_INET6) {
addr = rspamd_inet_address_from_sa(&cmd->cmd.fuzzy_blocked.addr.sa,
sizeof(struct sockaddr_in6));
}
else {
msg_err("invalid address family: %d", cmd->cmd.fuzzy_blocked.af);
rep.reply.fuzzy_blocked.status = -1;
}
if (addr) {
elt = rspamd_lru_hash_lookup(ctx->ratelimit_buckets, addr,
(time_t) now);
if (elt) {
if (isnan(elt->cur)) {
/* Already ratelimited, ignore */
}
else {
elt->last = now;
elt->cur = NAN;
msg_info("propagating ratelimiting %s, %.1f max elts",
rspamd_inet_address_to_string(addr),
ctx->leaky_bucket_burst);
rspamd_fuzzy_maybe_call_blacklisted(ctx, addr, "ratelimit");
}
rspamd_inet_address_free(addr);
}
else {
/* New bucket */
elt = g_malloc(sizeof(*elt));
elt->addr = addr; /* transfer ownership */
elt->cur = NAN;
elt->last = now;
rspamd_lru_hash_insert(ctx->ratelimit_buckets,
addr,
elt,
(time_t) now,
ctx->leaky_bucket_ttl);
msg_info("propagating ratelimiting %s, %.1f max elts",
rspamd_inet_address_to_string(addr),
ctx->leaky_bucket_burst);
rspamd_fuzzy_maybe_call_blacklisted(ctx, addr, "ratelimit");
}
}
if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
msg_err("cannot write reply to the control socket: %s",
strerror(errno));
}
return TRUE;
}
static gboolean
rspamd_fuzzy_storage_reload(struct rspamd_main *rspamd_main,
struct rspamd_worker *worker, int fd,
int attached_fd,
struct rspamd_control_command *cmd,
gpointer ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
GError *err = NULL;
struct rspamd_control_reply rep;
msg_info("reloading fuzzy storage after receiving reload command");
if (ctx->backend) {
/* Close backend and reopen it one more time */
rspamd_fuzzy_backend_close(ctx->backend);
}
memset(&rep, 0, sizeof(rep));
rep.type = RSPAMD_CONTROL_RELOAD;
if ((ctx->backend = rspamd_fuzzy_backend_create(ctx->event_loop,
worker->cf->options, rspamd_main->cfg,
&err)) == NULL) {
msg_err("cannot open backend after reload: %e", err);
rep.reply.reload.status = err->code;
g_error_free(err);
}
else {
rep.reply.reload.status = 0;
}
if (ctx->backend && worker->index == 0) {
rspamd_fuzzy_backend_start_update(ctx->backend, ctx->sync_timeout,
rspamd_fuzzy_storage_periodic_callback, ctx);
}
if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
msg_err("cannot write reply to the control socket: %s",
strerror(errno));
}
return TRUE;
}
static ucl_object_t *
rspamd_fuzzy_storage_stat_key(const struct fuzzy_key_stat *key_stat)
{
ucl_object_t *res;
res = ucl_object_typed_new(UCL_OBJECT);
ucl_object_insert_key(res, ucl_object_fromint(key_stat->checked),
"checked", 0, false);
ucl_object_insert_key(res, ucl_object_fromdouble(key_stat->checked_ctr.mean),
"checked_per_hour", 0, false);
ucl_object_insert_key(res, ucl_object_fromint(key_stat->matched),
"matched", 0, false);
ucl_object_insert_key(res, ucl_object_fromdouble(key_stat->matched_ctr.mean),
"matched_per_hour", 0, false);
ucl_object_insert_key(res, ucl_object_fromint(key_stat->added),
"added", 0, false);
ucl_object_insert_key(res, ucl_object_fromint(key_stat->deleted),
"deleted", 0, false);
ucl_object_insert_key(res, ucl_object_fromint(key_stat->errors),
"errors", 0, false);
return res;
}
static void
rspamd_fuzzy_key_stat_iter(const unsigned char *pk_iter, struct fuzzy_key *fuzzy_key, ucl_object_t *keys_obj, gboolean ip_stat)
{
struct fuzzy_key_stat *key_stat = fuzzy_key->stat;
char keyname[17];
if (key_stat) {
rspamd_snprintf(keyname, sizeof(keyname), "%8bs", pk_iter);
ucl_object_t *elt = rspamd_fuzzy_storage_stat_key(key_stat);
if (key_stat->last_ips && ip_stat) {
int i = 0;
ucl_object_t *ip_elt = ucl_object_typed_new(UCL_OBJECT);
gpointer k, v;
while ((i = rspamd_lru_hash_foreach(key_stat->last_ips,
i, &k, &v)) != -1) {
ucl_object_t *ip_cur = rspamd_fuzzy_storage_stat_key(v);
ucl_object_insert_key(ip_elt, ip_cur,
rspamd_inet_address_to_string(k), 0, true);
}
ucl_object_insert_key(elt, ip_elt, "ips", 0, false);
}
int flag;
struct fuzzy_key_stat *flag_stat;
ucl_object_t *flags_ucl = ucl_object_typed_new(UCL_OBJECT);
kh_foreach_key_value_ptr(fuzzy_key->flags_stat, flag, flag_stat, {
char intbuf[16];
rspamd_snprintf(intbuf, sizeof(intbuf), "%d", flag);
ucl_object_insert_key(flags_ucl, rspamd_fuzzy_storage_stat_key(flag_stat),
intbuf, 0, true);
});
ucl_object_insert_key(elt, flags_ucl, "flags", 0, false);
ucl_object_insert_key(elt,
rspamd_keypair_to_ucl(fuzzy_key->key, RSPAMD_KEYPAIR_DUMP_NO_SECRET | RSPAMD_KEYPAIR_DUMP_FLATTENED),
"keypair", 0, false);
ucl_object_insert_key(keys_obj, elt, keyname, 0, true);
}
}
static ucl_object_t *
rspamd_fuzzy_stat_to_ucl(struct rspamd_fuzzy_storage_ctx *ctx, gboolean ip_stat)
{
struct fuzzy_key *fuzzy_key;
ucl_object_t *obj, *keys_obj, *elt, *ip_elt;
const unsigned char *pk_iter;
obj = ucl_object_typed_new(UCL_OBJECT);
keys_obj = ucl_object_typed_new(UCL_OBJECT);
kh_foreach(ctx->keys, pk_iter, fuzzy_key, {
rspamd_fuzzy_key_stat_iter(pk_iter, fuzzy_key, keys_obj, ip_stat);
});
ucl_object_insert_key(obj, keys_obj, "keys", 0, false);
/* Now generic stats */
ucl_object_insert_key(obj,
ucl_object_fromint(ctx->stat.fuzzy_hashes),
"fuzzy_stored",
0,
false);
ucl_object_insert_key(obj,
ucl_object_fromint(ctx->stat.fuzzy_hashes_expired),
"fuzzy_expired",
0,
false);
ucl_object_insert_key(obj,
ucl_object_fromint(ctx->stat.invalid_requests),
"invalid_requests",
0,
false);
ucl_object_insert_key(obj,
ucl_object_fromint(ctx->stat.delayed_hashes),
"delayed_hashes",
0,
false);
if (ctx->errors_ips && ip_stat) {
gpointer k, v;
int i = 0;
ip_elt = ucl_object_typed_new(UCL_OBJECT);
while ((i = rspamd_lru_hash_foreach(ctx->errors_ips, i, &k, &v)) != -1) {
ucl_object_insert_key(ip_elt,
ucl_object_fromint(*(uint64_t *) v),
rspamd_inet_address_to_string(k), 0, true);
}
ucl_object_insert_key(obj,
ip_elt,
"errors_ips",
0,
false);
}
/* Checked by epoch */
elt = ucl_object_typed_new(UCL_ARRAY);
for (int i = RSPAMD_FUZZY_EPOCH10; i < RSPAMD_FUZZY_EPOCH_MAX; i++) {
ucl_array_append(elt,
ucl_object_fromint(ctx->stat.fuzzy_hashes_checked[i]));
}
ucl_object_insert_key(obj, elt, "fuzzy_checked", 0, false);
/* Shingles by epoch */
elt = ucl_object_typed_new(UCL_ARRAY);
for (int i = RSPAMD_FUZZY_EPOCH10; i < RSPAMD_FUZZY_EPOCH_MAX; i++) {
ucl_array_append(elt,
ucl_object_fromint(ctx->stat.fuzzy_shingles_checked[i]));
}
ucl_object_insert_key(obj, elt, "fuzzy_shingles", 0, false);
/* Matched by epoch */
elt = ucl_object_typed_new(UCL_ARRAY);
for (int i = RSPAMD_FUZZY_EPOCH10; i < RSPAMD_FUZZY_EPOCH_MAX; i++) {
ucl_array_append(elt,
ucl_object_fromint(ctx->stat.fuzzy_hashes_found[i]));
}
ucl_object_insert_key(obj, elt, "fuzzy_found", 0, false);
return obj;
}
static void
rspamd_fuzzy_maybe_load_ratelimits(struct rspamd_fuzzy_storage_ctx *ctx)
{
char path[PATH_MAX];
rspamd_snprintf(path, sizeof(path), "%s" G_DIR_SEPARATOR_S "fuzzy_ratelimits.ucl",
RSPAMD_DBDIR);
if (access(path, R_OK) != -1) {
struct ucl_parser *parser = ucl_parser_new(UCL_PARSER_NO_IMPLICIT_ARRAYS | UCL_PARSER_DISABLE_MACRO);
if (ucl_parser_add_file(parser, path)) {
ucl_object_t *obj = ucl_parser_get_object(parser);
int loaded = 0;
if (ucl_object_type(obj) == UCL_ARRAY) {
ucl_object_iter_t it = NULL;
const ucl_object_t *cur;
while ((cur = ucl_object_iterate(obj, &it, true)) != NULL) {
const ucl_object_t *ip, *value, *last;
const char *ip_str;
double limit_val, last_val;
ip = ucl_object_find_key(cur, "ip");
value = ucl_object_find_key(cur, "value");
last = ucl_object_find_key(cur, "last");
if (ip == NULL || value == NULL || last == NULL) {
msg_err("invalid ratelimit object");
continue;
}
ip_str = ucl_object_tostring(ip);
limit_val = ucl_object_todouble(value);
last_val = ucl_object_todouble(last);
if (ip_str == NULL || isnan(last_val)) {
msg_err("invalid ratelimit object");
continue;
}
rspamd_inet_addr_t *addr;
if (rspamd_parse_inet_address(&addr, ip_str, strlen(ip_str),
RSPAMD_INET_ADDRESS_PARSE_NO_UNIX | RSPAMD_INET_ADDRESS_PARSE_NO_PORT)) {
struct rspamd_leaky_bucket_elt *elt = g_malloc(sizeof(*elt));
elt->cur = limit_val;
elt->last = last_val;
elt->addr = addr;
rspamd_lru_hash_insert(ctx->ratelimit_buckets, addr, elt, elt->last, ctx->leaky_bucket_ttl);
loaded++;
}
else {
msg_err("invalid ratelimit ip: %s", ip_str);
continue;
}
}
msg_info("loaded %d ratelimit objects", loaded);
}
ucl_object_unref(obj);
}
ucl_parser_free(parser);
}
}
static void
rspamd_fuzzy_maybe_save_ratelimits(struct rspamd_fuzzy_storage_ctx *ctx)
{
char path[PATH_MAX];
rspamd_snprintf(path, sizeof(path), "%s" G_DIR_SEPARATOR_S "fuzzy_ratelimits.ucl.new",
RSPAMD_DBDIR);
FILE *f = fopen(path, "w");
if (f != NULL) {
ucl_object_t *top = ucl_object_typed_new(UCL_ARRAY);
int it = 0;
gpointer k, v;
ucl_object_reserve(top, rspamd_lru_hash_size(ctx->ratelimit_buckets));
while ((it = rspamd_lru_hash_foreach(ctx->ratelimit_buckets, it, &k, &v)) != -1) {
ucl_object_t *cur = ucl_object_typed_new(UCL_OBJECT);
struct rspamd_leaky_bucket_elt *elt = (struct rspamd_leaky_bucket_elt *) v;
ucl_object_insert_key(cur, ucl_object_fromdouble(elt->cur), "value", 0, false);
ucl_object_insert_key(cur, ucl_object_fromdouble(elt->last), "last", 0, false);
ucl_object_insert_key(cur, ucl_object_fromstring(rspamd_inet_address_to_string(elt->addr)), "ip", 0, false);
ucl_array_append(top, cur);
}
if (ucl_object_emit_full(top, UCL_EMIT_JSON_COMPACT, ucl_object_emit_file_funcs(f), NULL)) {
char npath[PATH_MAX];
fflush(f);
rspamd_snprintf(npath, sizeof(npath), "%s" G_DIR_SEPARATOR_S "fuzzy_ratelimits.ucl",
RSPAMD_DBDIR);
if (rename(path, npath) == -1) {
msg_warn("cannot rename %s to %s: %s", path, npath, strerror(errno));
}
else {
msg_info("saved %d ratelimits in %s", rspamd_lru_hash_size(ctx->ratelimit_buckets), npath);
}
}
else {
msg_warn("cannot serialize ratelimit buckets to %s: %s", path, strerror(errno));
}
fclose(f);
ucl_object_unref(top);
}
else {
msg_warn("cannot save ratelimit buckets to %s: %s", path, strerror(errno));
}
}
static int
lua_fuzzy_add_pre_handler(lua_State *L)
{
struct rspamd_worker *wrk, **pwrk = (struct rspamd_worker **)
rspamd_lua_check_udata(L, 1, rspamd_worker_classname);
struct rspamd_fuzzy_storage_ctx *ctx;
if (!pwrk) {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
wrk = *pwrk;
if (wrk && lua_isfunction(L, 2)) {
ctx = (struct rspamd_fuzzy_storage_ctx *) wrk->ctx;
if (ctx->lua_pre_handler_cbref != -1) {
/* Should not happen */
luaL_unref(L, LUA_REGISTRYINDEX, ctx->lua_pre_handler_cbref);
}
lua_pushvalue(L, 2);
ctx->lua_pre_handler_cbref = luaL_ref(L, LUA_REGISTRYINDEX);
}
else {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
return 0;
}
static int
lua_fuzzy_add_post_handler(lua_State *L)
{
struct rspamd_worker *wrk, **pwrk = (struct rspamd_worker **)
rspamd_lua_check_udata(L, 1, rspamd_worker_classname);
struct rspamd_fuzzy_storage_ctx *ctx;
if (!pwrk) {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
wrk = *pwrk;
if (wrk && lua_isfunction(L, 2)) {
ctx = (struct rspamd_fuzzy_storage_ctx *) wrk->ctx;
if (ctx->lua_post_handler_cbref != -1) {
/* Should not happen */
luaL_unref(L, LUA_REGISTRYINDEX, ctx->lua_post_handler_cbref);
}
lua_pushvalue(L, 2);
ctx->lua_post_handler_cbref = luaL_ref(L, LUA_REGISTRYINDEX);
}
else {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
return 0;
}
static int
lua_fuzzy_add_blacklist_handler(lua_State *L)
{
struct rspamd_worker *wrk, **pwrk = (struct rspamd_worker **)
rspamd_lua_check_udata(L, 1, rspamd_worker_classname);
struct rspamd_fuzzy_storage_ctx *ctx;
if (!pwrk) {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
wrk = *pwrk;
if (wrk && lua_isfunction(L, 2)) {
ctx = (struct rspamd_fuzzy_storage_ctx *) wrk->ctx;
if (ctx->lua_blacklist_cbref != -1) {
/* Should not happen */
luaL_unref(L, LUA_REGISTRYINDEX, ctx->lua_blacklist_cbref);
}
lua_pushvalue(L, 2);
ctx->lua_blacklist_cbref = luaL_ref(L, LUA_REGISTRYINDEX);
}
else {
return luaL_error(L, "invalid arguments, worker + function are expected");
}
return 0;
}
static gboolean
rspamd_fuzzy_storage_stat(struct rspamd_main *rspamd_main,
struct rspamd_worker *worker, int fd,
int attached_fd,
struct rspamd_control_command *cmd,
gpointer ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
struct rspamd_control_reply rep;
ucl_object_t *obj;
struct ucl_emitter_functions *emit_subr;
unsigned char fdspace[CMSG_SPACE(sizeof(int))];
struct iovec iov;
struct msghdr msg;
struct cmsghdr *cmsg;
int outfd = -1;
char tmppath[PATH_MAX];
memset(&rep, 0, sizeof(rep));
rep.type = RSPAMD_CONTROL_FUZZY_STAT;
rspamd_snprintf(tmppath, sizeof(tmppath), "%s%c%s-XXXXXXXXXX",
rspamd_main->cfg->temp_dir, G_DIR_SEPARATOR, "fuzzy-stat");
if ((outfd = mkstemp(tmppath)) == -1) {
rep.reply.fuzzy_stat.status = errno;
msg_info_main("cannot make temporary stat file for fuzzy stat: %s",
strerror(errno));
}
else {
rep.reply.fuzzy_stat.status = 0;
memcpy(rep.reply.fuzzy_stat.storage_id,
rspamd_fuzzy_backend_id(ctx->backend),
sizeof(rep.reply.fuzzy_stat.storage_id));
obj = rspamd_fuzzy_stat_to_ucl(ctx, TRUE);
emit_subr = ucl_object_emit_fd_funcs(outfd);
ucl_object_emit_full(obj, UCL_EMIT_JSON_COMPACT, emit_subr, NULL);
ucl_object_emit_funcs_free(emit_subr);
ucl_object_unref(obj);
/* Rewind output file */
close(outfd);
outfd = open(tmppath, O_RDONLY);
unlink(tmppath);
}
/* Now we can send outfd and status message */
memset(&msg, 0, sizeof(msg));
/* Attach fd to the message */
if (outfd != -1) {
memset(fdspace, 0, sizeof(fdspace));
msg.msg_control = fdspace;
msg.msg_controllen = sizeof(fdspace);
cmsg = CMSG_FIRSTHDR(&msg);
if (cmsg) {
cmsg->cmsg_level = SOL_SOCKET;
cmsg->cmsg_type = SCM_RIGHTS;
cmsg->cmsg_len = CMSG_LEN(sizeof(int));
memcpy(CMSG_DATA(cmsg), &outfd, sizeof(int));
}
}
iov.iov_base = &rep;
iov.iov_len = sizeof(rep);
msg.msg_iov = &iov;
msg.msg_iovlen = 1;
if (sendmsg(fd, &msg, 0) == -1) {
msg_err_main("cannot send fuzzy stat: %s", strerror(errno));
}
if (outfd != -1) {
close(outfd);
}
return TRUE;
}
static gboolean
fuzzy_parse_ids(rspamd_mempool_t *pool,
const ucl_object_t *obj,
gpointer ud,
struct rspamd_rcl_section *section,
GError **err)
{
struct rspamd_rcl_struct_parser *pd = (struct rspamd_rcl_struct_parser *) ud;
khash_t(fuzzy_key_ids_set) * target;
target = *(khash_t(fuzzy_key_ids_set) **) ((char *) pd->user_struct + pd->offset);
if (ucl_object_type(obj) == UCL_ARRAY) {
const ucl_object_t *cur;
ucl_object_iter_t it = NULL;
uint64_t id;
while ((cur = ucl_object_iterate(obj, &it, true)) != NULL) {
if (ucl_object_toint_safe(cur, &id)) {
int r;
kh_put(fuzzy_key_ids_set, target, id, &r);
}
else {
return FALSE;
}
}
return TRUE;
}
else if (ucl_object_type(obj) == UCL_INT) {
int r;
kh_put(fuzzy_key_ids_set, target, ucl_object_toint(obj), &r);
return TRUE;
}
return FALSE;
}
static struct fuzzy_key *
fuzzy_add_keypair_from_ucl(struct rspamd_config *cfg, const ucl_object_t *obj,
khash_t(rspamd_fuzzy_keys_hash) * target)
{
struct rspamd_cryptobox_keypair *kp = rspamd_keypair_from_ucl(obj);
if (kp == NULL) {
return NULL;
}
if (rspamd_keypair_type(kp) != RSPAMD_KEYPAIR_KEX) {
return FALSE;
}
struct fuzzy_key *key = g_malloc0(sizeof(*key));
REF_INIT_RETAIN(key, fuzzy_key_dtor);
key->key = kp;
struct fuzzy_key_stat *keystat = g_malloc0(sizeof(*keystat));
REF_INIT_RETAIN(keystat, fuzzy_key_stat_dtor);
/* Hash of ip -> fuzzy_key_stat */
keystat->last_ips = rspamd_lru_hash_new_full(1024,
(GDestroyNotify) rspamd_inet_address_free,
fuzzy_key_stat_unref,
rspamd_inet_address_hash, rspamd_inet_address_equal);
key->stat = keystat;
key->flags_stat = kh_init(fuzzy_key_flag_stat);
key->burst = NAN;
key->rate = NAN;
key->expire = NAN;
key->rl_bucket = NULL;
/* Preallocate some space for flags */
kh_resize(fuzzy_key_flag_stat, key->flags_stat, 8);
const unsigned char *pk = rspamd_keypair_component(kp, RSPAMD_KEYPAIR_COMPONENT_PK,
NULL);
keystat->keypair = rspamd_keypair_ref(kp);
/* We map entries by pubkey in binary form for faster lookup */
khiter_t k;
int r;
k = kh_put(rspamd_fuzzy_keys_hash, target, pk, &r);
if (r == 0) {
msg_err("duplicate keypair found: pk=%*bs",
32, pk);
REF_RELEASE(key);
return FALSE;
}
else if (r == -1) {
msg_err("hash insertion error: pk=%*bs",
32, pk);
REF_RELEASE(key);
return FALSE;
}
kh_val(target, k) = key;
const ucl_object_t *extensions = rspamd_keypair_get_extensions(kp);
if (extensions) {
lua_State *L = RSPAMD_LUA_CFG_STATE(cfg);
const ucl_object_t *forbidden_ids = ucl_object_lookup(extensions, "forbidden_ids");
if (forbidden_ids && ucl_object_type(forbidden_ids) == UCL_ARRAY) {
key->forbidden_ids = kh_init(fuzzy_key_ids_set);
const ucl_object_t *cur;
ucl_object_iter_t it = NULL;
while ((cur = ucl_object_iterate(forbidden_ids, &it, true)) != NULL) {
if (ucl_object_type(cur) == UCL_INT || ucl_object_type(cur) == UCL_FLOAT) {
int id = ucl_object_toint(cur);
int r;
kh_put(fuzzy_key_ids_set, key->forbidden_ids, id, &r);
}
}
}
const ucl_object_t *ratelimit = ucl_object_lookup(extensions, "ratelimit");
static int ratelimit_lua_id = -1;
if (ratelimit_lua_id == -1) {
/* Load ratelimit parsing function */
if (!rspamd_lua_require_function(L, "plugins/ratelimit", "parse_limit")) {
msg_err_config("cannot load ratelimit parser from ratelimit plugin");
}
else {
ratelimit_lua_id = luaL_ref(L, LUA_REGISTRYINDEX);
}
}
if (ratelimit && ratelimit_lua_id != -1) {
lua_rawgeti(L, LUA_REGISTRYINDEX, ratelimit_lua_id);
lua_pushstring(L, "fuzzy_key_ratelimit");
ucl_object_push_lua(L, ratelimit, false);
if (lua_pcall(L, 2, 1, 0) != 0) {
msg_err_config("cannot call ratelimit parser from ratelimit plugin");
}
else {
if (lua_type(L, -1) == LUA_TTABLE) {
/*
* The returned table is in form { rate = xx, burst = yy }
*/
lua_getfield(L, -1, "rate");
key->rate = lua_tonumber(L, -1);
lua_pop(L, 1);
lua_getfield(L, -1, "burst");
key->burst = lua_tonumber(L, -1);
lua_pop(L, 1);
key->rl_bucket = g_malloc0(sizeof(*key->rl_bucket));
}
}
lua_settop(L, 0);
}
const ucl_object_t *expire = ucl_object_lookup(extensions, "expire");
if (expire && ucl_object_type(expire) == UCL_STRING) {
struct tm tm;
/* DD-MM-YYYY */
char *end = strptime(ucl_object_tostring(expire), "%d-%m-%Y", &tm);
if (end != NULL && *end != '\0') {
msg_err_config("cannot parse expire date: %s", ucl_object_tostring(expire));
}
else {
key->expire = mktime(&tm);
}
}
const ucl_object_t *name = ucl_object_lookup(extensions, "name");
if (name && ucl_object_type(name) == UCL_STRING) {
key->name = g_strdup(ucl_object_tostring(name));
}
}
msg_debug("loaded keypair %*bs; expire=%f; rate=%f; burst=%s", crypto_box_publickeybytes(), pk,
key->expire, key->rate, key->burst);
return key;
}
static gboolean
fuzzy_parse_keypair(rspamd_mempool_t *pool,
const ucl_object_t *obj,
gpointer ud,
struct rspamd_rcl_section *section,
GError **err)
{
struct rspamd_rcl_struct_parser *pd = ud;
struct rspamd_fuzzy_storage_ctx *ctx;
struct fuzzy_key *key;
const ucl_object_t *cur;
ucl_object_iter_t it = NULL;
gboolean ret;
ctx = pd->user_struct;
pd->offset = G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, default_keypair);
/*
* Single key
*/
if (ucl_object_type(obj) == UCL_STRING || ucl_object_type(obj) == UCL_OBJECT) {
ret = rspamd_rcl_parse_struct_keypair(pool, obj, pd, section, err);
if (!ret) {
return ret;
}
key = fuzzy_add_keypair_from_ucl(ctx->cfg, obj, ctx->keys);
if (key == NULL) {
return FALSE;
}
/* Use the last one ? */
ctx->default_key = key;
}
else if (ucl_object_type(obj) == UCL_ARRAY) {
while ((cur = ucl_object_iterate(obj, &it, true)) != NULL) {
if (!fuzzy_parse_keypair(pool, cur, pd, section, err)) {
msg_err_pool("cannot parse keypair");
}
}
}
return TRUE;
}
gpointer
init_fuzzy(struct rspamd_config *cfg)
{
struct rspamd_fuzzy_storage_ctx *ctx;
GQuark type;
type = g_quark_try_string("fuzzy");
ctx = rspamd_mempool_alloc0(cfg->cfg_pool,
sizeof(struct rspamd_fuzzy_storage_ctx));
ctx->magic = rspamd_fuzzy_storage_magic;
ctx->sync_timeout = DEFAULT_SYNC_TIMEOUT;
ctx->keypair_cache_size = DEFAULT_KEYPAIR_CACHE_SIZE;
ctx->lua_pre_handler_cbref = -1;
ctx->lua_post_handler_cbref = -1;
ctx->lua_blacklist_cbref = -1;
ctx->keys = kh_init(rspamd_fuzzy_keys_hash);
rspamd_mempool_add_destructor(cfg->cfg_pool,
(rspamd_mempool_destruct_t) fuzzy_hash_table_dtor, ctx->keys);
ctx->errors_ips = rspamd_lru_hash_new_full(1024,
(GDestroyNotify) rspamd_inet_address_free, g_free,
rspamd_inet_address_hash, rspamd_inet_address_equal);
rspamd_mempool_add_destructor(cfg->cfg_pool,
(rspamd_mempool_destruct_t) rspamd_lru_hash_destroy, ctx->errors_ips);
ctx->cfg = cfg;
ctx->updates_maxfail = DEFAULT_UPDATES_MAXFAIL;
ctx->leaky_bucket_mask = DEFAULT_BUCKET_MASK;
ctx->leaky_bucket_ttl = DEFAULT_BUCKET_TTL;
ctx->max_buckets = DEFAULT_MAX_BUCKETS;
ctx->leaky_bucket_burst = NAN;
ctx->leaky_bucket_rate = NAN;
ctx->delay = NAN;
ctx->default_forbidden_ids = kh_init(fuzzy_key_ids_set);
ctx->weak_ids = kh_init(fuzzy_key_ids_set);
rspamd_rcl_register_worker_option(cfg,
type,
"sync",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx,
sync_timeout),
RSPAMD_CL_FLAG_TIME_FLOAT,
"Time to perform database sync, default: " G_STRINGIFY(DEFAULT_SYNC_TIMEOUT) " seconds");
rspamd_rcl_register_worker_option(cfg,
type,
"expire",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx,
expire),
RSPAMD_CL_FLAG_TIME_FLOAT,
"Default expire time for hashes, default: " G_STRINGIFY(DEFAULT_EXPIRE) " seconds");
rspamd_rcl_register_worker_option(cfg,
type,
"delay",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx,
delay),
RSPAMD_CL_FLAG_TIME_FLOAT,
"Default delay time for hashes, default: not enabled");
rspamd_rcl_register_worker_option(cfg,
type,
"allow_update",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, update_map),
0,
"Allow modifications from the following IP addresses");
rspamd_rcl_register_worker_option(cfg,
type,
"allow_update_keys",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, update_keys_map),
0,
"Allow modifications for those using specific public keys");
rspamd_rcl_register_worker_option(cfg,
type,
"delay_whitelist",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, delay_whitelist_map),
0,
"Disable delay check for the following IP addresses");
rspamd_rcl_register_worker_option(cfg,
type,
"keypair",
fuzzy_parse_keypair,
ctx,
0,
RSPAMD_CL_FLAG_MULTIPLE,
"Encryption keypair (can be repeated for different keys)");
rspamd_rcl_register_worker_option(cfg,
type,
"dynamic_keys_map",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, dynamic_keys_map),
0,
"Dynamic encryption keypairs (can be repeated for different keys)");
rspamd_rcl_register_worker_option(cfg,
type,
"forbidden_ids",
fuzzy_parse_ids,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, default_forbidden_ids),
0,
"Deny specific flags by default");
rspamd_rcl_register_worker_option(cfg,
type,
"weak_ids",
fuzzy_parse_ids,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, weak_ids),
0,
"Treat these flags as weak (i.e. they do not overwrite strong flags)");
rspamd_rcl_register_worker_option(cfg,
type,
"keypair_cache_size",
rspamd_rcl_parse_struct_integer,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx,
keypair_cache_size),
RSPAMD_CL_FLAG_UINT,
"Size of keypairs cache, default: " G_STRINGIFY(DEFAULT_KEYPAIR_CACHE_SIZE));
rspamd_rcl_register_worker_option(cfg,
type,
"encrypted_only",
rspamd_rcl_parse_struct_boolean,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, encrypted_only),
0,
"Allow encrypted requests only (and forbid all unknown keys or plaintext requests)");
rspamd_rcl_register_worker_option(cfg,
type,
"dedicated_update_worker",
rspamd_rcl_parse_struct_boolean,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, dedicated_update_worker),
0,
"Use worker 0 for updates only");
rspamd_rcl_register_worker_option(cfg,
type,
"read_only",
rspamd_rcl_parse_struct_boolean,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, read_only),
0,
"Work in read only mode");
rspamd_rcl_register_worker_option(cfg,
type,
"blocked",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, blocked_map),
0,
"Block requests from specific networks");
rspamd_rcl_register_worker_option(cfg,
type,
"updates_maxfail",
rspamd_rcl_parse_struct_integer,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, updates_maxfail),
RSPAMD_CL_FLAG_UINT,
"Maximum number of updates to be failed before discarding");
rspamd_rcl_register_worker_option(cfg,
type,
"skip_hashes",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, skip_map),
0,
"Skip specific hashes from the map");
/* Ratelimits */
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_whitelist",
rspamd_rcl_parse_struct_ucl,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, ratelimit_whitelist_map),
0,
"Skip specific addresses from rate limiting");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_max_buckets",
rspamd_rcl_parse_struct_integer,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, max_buckets),
RSPAMD_CL_FLAG_UINT,
"Maximum number of leaky buckets (default: " G_STRINGIFY(DEFAULT_MAX_BUCKETS) ")");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_network_mask",
rspamd_rcl_parse_struct_integer,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, leaky_bucket_mask),
RSPAMD_CL_FLAG_UINT,
"Network mask to apply for IPv4 rate addresses (default: " G_STRINGIFY(DEFAULT_BUCKET_MASK) ")");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_bucket_ttl",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, leaky_bucket_ttl),
RSPAMD_CL_FLAG_TIME_INTEGER,
"Time to live for ratelimit element (default: " G_STRINGIFY(DEFAULT_BUCKET_TTL) ")");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_rate",
rspamd_rcl_parse_struct_double,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, leaky_bucket_rate),
0,
"Leak rate in requests per second");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_burst",
rspamd_rcl_parse_struct_double,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, leaky_bucket_burst),
0,
"Peak value for ratelimit bucket");
rspamd_rcl_register_worker_option(cfg,
type,
"ratelimit_log_only",
rspamd_rcl_parse_struct_boolean,
ctx,
G_STRUCT_OFFSET(struct rspamd_fuzzy_storage_ctx, ratelimit_log_only),
0,
"Don't really ban on ratelimit reaching, just log");
return ctx;
}
static void
rspamd_fuzzy_peer_io(EV_P_ ev_io *w, int revents)
{
struct fuzzy_peer_cmd cmd;
struct rspamd_fuzzy_storage_ctx *ctx =
(struct rspamd_fuzzy_storage_ctx *) w->data;
gssize r;
for (;;) {
r = read(w->fd, &cmd, sizeof(cmd));
if (r != sizeof(cmd)) {
if (errno == EINTR) {
continue;
}
if (errno != EAGAIN) {
msg_err("cannot read command from peers: %s", strerror(errno));
}
break;
}
else {
g_array_append_val(ctx->updates_pending, cmd);
}
}
}
static void
fuzzy_peer_rep(struct rspamd_worker *worker,
struct rspamd_srv_reply *rep, int rep_fd,
gpointer ud)
{
struct rspamd_fuzzy_storage_ctx *ctx = ud;
GList *cur;
struct rspamd_worker_listen_socket *ls;
struct rspamd_worker_accept_event *ac_ev;
ctx->peer_fd = rep_fd;
if (rep_fd == -1) {
msg_err("cannot receive peer fd from the main process");
exit(EXIT_FAILURE);
}
else {
rspamd_socket_nonblocking(rep_fd);
}
msg_info("got peer fd reply from the main process");
/* Start listening */
cur = worker->cf->listen_socks;
while (cur) {
ls = cur->data;
if (ls->fd != -1) {
msg_info("start listening on %s",
rspamd_inet_address_to_string_pretty(ls->addr));
if (ls->type == RSPAMD_WORKER_SOCKET_UDP) {
ac_ev = g_malloc0(sizeof(*ac_ev));
ac_ev->accept_ev.data = worker;
ac_ev->event_loop = ctx->event_loop;
ev_io_init(&ac_ev->accept_ev, accept_fuzzy_socket, ls->fd,
EV_READ);
ev_io_start(ctx->event_loop, &ac_ev->accept_ev);
DL_APPEND(worker->accept_events, ac_ev);
}
else {
/* We allow TCP listeners only for a update worker */
g_assert_not_reached();
}
}
cur = g_list_next(cur);
}
if (ctx->peer_fd != -1) {
if (worker->index == 0) {
/* Listen for peer requests */
shutdown(ctx->peer_fd, SHUT_WR);
ctx->peer_ev.data = ctx;
ev_io_init(&ctx->peer_ev, rspamd_fuzzy_peer_io, ctx->peer_fd, EV_READ);
ev_io_start(ctx->event_loop, &ctx->peer_ev);
}
else {
shutdown(ctx->peer_fd, SHUT_RD);
}
}
}
/*
* Start worker process
*/
__attribute__((noreturn)) void
start_fuzzy(struct rspamd_worker *worker)
{
struct rspamd_fuzzy_storage_ctx *ctx = worker->ctx;
GError *err = NULL;
struct rspamd_srv_command srv_cmd;
struct rspamd_config *cfg = worker->srv->cfg;
g_assert(rspamd_worker_check_context(worker->ctx, rspamd_fuzzy_storage_magic));
ctx->event_loop = rspamd_prepare_worker(worker,
"fuzzy",
NULL);
ctx->peer_fd = -1;
ctx->worker = worker;
ctx->cfg = worker->srv->cfg;
ctx->resolver = rspamd_dns_resolver_init(worker->srv->logger,
ctx->event_loop,
worker->srv->cfg);
rspamd_upstreams_library_config(worker->srv->cfg, ctx->cfg->ups_ctx,
ctx->event_loop, ctx->resolver->r);
/* Since this worker uses maps it needs a valid HTTP context */
ctx->http_ctx = rspamd_http_context_create(ctx->cfg, ctx->event_loop,
ctx->cfg->ups_ctx);
if (ctx->keypair_cache_size > 0) {
/* Create keypairs cache */
ctx->keypair_cache = rspamd_keypair_cache_new(ctx->keypair_cache_size);
}
if ((ctx->backend = rspamd_fuzzy_backend_create(ctx->event_loop,
worker->cf->options, cfg, &err)) == NULL) {
msg_err("cannot open backend: %e", err);
if (err) {
g_error_free(err);
}
exit(EXIT_SUCCESS);
}
rspamd_fuzzy_backend_count(ctx->backend, fuzzy_count_callback, ctx);
if (worker->index == 0) {
ctx->updates_pending = g_array_sized_new(FALSE, FALSE,
sizeof(struct fuzzy_peer_cmd), 1024);
rspamd_fuzzy_backend_start_update(ctx->backend, ctx->sync_timeout,
rspamd_fuzzy_storage_periodic_callback, ctx);
if (ctx->dedicated_update_worker && worker->cf->count > 1) {
msg_info_config("stop serving clients request in dedicated update mode");
rspamd_worker_stop_accept(worker);
GList *cur = worker->cf->listen_socks;
while (cur) {
struct rspamd_worker_listen_socket *ls =
(struct rspamd_worker_listen_socket *) cur->data;
if (ls->fd != -1) {
close(ls->fd);
}
cur = g_list_next(cur);
}
}
}
ctx->stat_ev.data = ctx;
ev_timer_init(&ctx->stat_ev, rspamd_fuzzy_stat_callback, ctx->sync_timeout,
ctx->sync_timeout);
ev_timer_start(ctx->event_loop, &ctx->stat_ev);
/* Register custom reload and stat commands for the control socket */
rspamd_control_worker_add_cmd_handler(worker, RSPAMD_CONTROL_RELOAD,
rspamd_fuzzy_storage_reload, ctx);
rspamd_control_worker_add_cmd_handler(worker, RSPAMD_CONTROL_FUZZY_STAT,
rspamd_fuzzy_storage_stat, ctx);
rspamd_control_worker_add_cmd_handler(worker, RSPAMD_CONTROL_FUZZY_SYNC,
rspamd_fuzzy_storage_sync, ctx);
rspamd_control_worker_add_cmd_handler(worker, RSPAMD_CONTROL_FUZZY_BLOCKED,
rspamd_fuzzy_control_blocked, ctx);
if (ctx->update_map != NULL) {
rspamd_config_radix_from_ucl(worker->srv->cfg, ctx->update_map,
"Allow fuzzy updates from specified addresses",
&ctx->update_ips, NULL, worker, "fuzzy update");
}
if (ctx->update_keys_map != NULL) {
struct rspamd_map *m;
if ((m = rspamd_map_add_from_ucl(worker->srv->cfg, ctx->update_keys_map,
"Allow fuzzy updates from specified public keys",
rspamd_kv_list_read,
rspamd_kv_list_fin,
rspamd_kv_list_dtor,
(void **) &ctx->update_keys, worker, RSPAMD_MAP_DEFAULT)) == NULL) {
msg_warn_config("cannot load allow keys map from %s",
ucl_object_tostring(ctx->update_keys_map));
}
else {
m->active_http = TRUE;
}
}
if (ctx->skip_map != NULL) {
struct rspamd_map *m;
if ((m = rspamd_map_add_from_ucl(cfg, ctx->skip_map,
"Skip hashes",
rspamd_kv_list_read,
rspamd_kv_list_fin,
rspamd_kv_list_dtor,
(void **) &ctx->skip_hashes,
worker, RSPAMD_MAP_DEFAULT)) == NULL) {
msg_warn_config("cannot load hashes list from %s",
ucl_object_tostring(ctx->skip_map));
}
else {
m->active_http = TRUE;
}
}
if (ctx->blocked_map != NULL) {
rspamd_config_radix_from_ucl(worker->srv->cfg, ctx->blocked_map,
"Block fuzzy requests from the specific IPs",
&ctx->blocked_ips,
NULL,
worker, "fuzzy blocked");
}
/* Create radix trees */
if (ctx->ratelimit_whitelist_map != NULL) {
rspamd_config_radix_from_ucl(worker->srv->cfg, ctx->ratelimit_whitelist_map,
"Skip ratelimits from specific ip addresses/networks",
&ctx->ratelimit_whitelist,
NULL,
worker, "fuzzy ratelimit whitelist");
}
if (ctx->dynamic_keys_map) {
struct fuzzy_keymap_ucl_buf *jb, **pjb;
ctx->dynamic_keys = kh_init(rspamd_fuzzy_keys_hash);
/* Now try to add map with ucl data */
jb = g_malloc(sizeof(struct fuzzy_keymap_ucl_buf));
pjb = g_malloc(sizeof(struct fuzzy_keymap_ucl_buf *));
jb->buf = NULL;
jb->ctx = ctx;
*pjb = jb;
rspamd_mempool_add_destructor(ctx->cfg->cfg_pool,
(rspamd_mempool_destruct_t) g_free,
pjb);
if (!rspamd_map_add_from_ucl(cfg,
ctx->dynamic_keys_map,
"Dynamic fuzzy keys map",
ucl_keymap_read_cb,
ucl_keymap_fin_cb,
ucl_keymap_dtor_cb,
(void **) pjb, worker, RSPAMD_MAP_DEFAULT)) {
msg_err("cannot add map for dynamic keys");
}
}
if (!isnan(ctx->delay) && ctx->delay_whitelist_map != NULL) {
rspamd_config_radix_from_ucl(worker->srv->cfg, ctx->delay_whitelist_map,
"Skip delay from the following ips",
&ctx->delay_whitelist, NULL, worker,
"fuzzy delayed whitelist");
}
/* Ratelimits */
if (!isnan(ctx->leaky_bucket_rate) && !isnan(ctx->leaky_bucket_burst)) {
ctx->ratelimit_buckets = rspamd_lru_hash_new_full(ctx->max_buckets,
NULL, fuzzy_rl_bucket_free,
rspamd_inet_address_hash, rspamd_inet_address_equal);
rspamd_fuzzy_maybe_load_ratelimits(ctx);
}
/* Maps events */
ctx->resolver = rspamd_dns_resolver_init(worker->srv->logger,
ctx->event_loop,
worker->srv->cfg);
rspamd_map_watch(worker->srv->cfg, ctx->event_loop,
ctx->resolver, worker, RSPAMD_MAP_WATCH_WORKER);
/* Get peer pipe */
memset(&srv_cmd, 0, sizeof(srv_cmd));
srv_cmd.type = RSPAMD_SRV_SOCKETPAIR;
srv_cmd.cmd.spair.af = SOCK_DGRAM;
srv_cmd.cmd.spair.pair_num = worker->index;
memset(srv_cmd.cmd.spair.pair_id, 0, sizeof(srv_cmd.cmd.spair.pair_id));
/* 6 bytes of id (including \0) and bind_conf id */
G_STATIC_ASSERT(sizeof(srv_cmd.cmd.spair.pair_id) >=
sizeof("fuzzy") + sizeof(uint64_t));
memcpy(srv_cmd.cmd.spair.pair_id, "fuzzy", sizeof("fuzzy"));
/* Distinguish workers from each others... */
if (worker->cf->bind_conf && worker->cf->bind_conf->bind_line) {
uint64_t bind_hash = rspamd_cryptobox_fast_hash(worker->cf->bind_conf->bind_line,
strlen(worker->cf->bind_conf->bind_line), 0xdeadbabe);
/* 8 more bytes */
memcpy(srv_cmd.cmd.spair.pair_id + sizeof("fuzzy"), &bind_hash,
sizeof(bind_hash));
}
rspamd_srv_send_command(worker, ctx->event_loop, &srv_cmd, -1,
fuzzy_peer_rep, ctx);
/*
* Extra fields available for this particular worker
*/
luaL_Reg fuzzy_lua_reg = {
.name = "add_fuzzy_pre_handler",
.func = lua_fuzzy_add_pre_handler,
};
rspamd_lua_add_metamethod(ctx->cfg->lua_state, rspamd_worker_classname, &fuzzy_lua_reg);
fuzzy_lua_reg = (luaL_Reg){
.name = "add_fuzzy_post_handler",
.func = lua_fuzzy_add_post_handler,
};
rspamd_lua_add_metamethod(ctx->cfg->lua_state, rspamd_worker_classname, &fuzzy_lua_reg);
fuzzy_lua_reg = (luaL_Reg){
.name = "add_fuzzy_blacklist_handler",
.func = lua_fuzzy_add_blacklist_handler,
};
rspamd_lua_add_metamethod(ctx->cfg->lua_state, rspamd_worker_classname, &fuzzy_lua_reg);
rspamd_lua_run_postloads(ctx->cfg->lua_state, ctx->cfg, ctx->event_loop,
worker);
ev_loop(ctx->event_loop, 0);
rspamd_worker_block_signals();
if (ctx->peer_fd != -1) {
if (worker->index == 0) {
ev_io_stop(ctx->event_loop, &ctx->peer_ev);
}
close(ctx->peer_fd);
}
if (worker->index == 0 && ctx->updates_pending->len > 0) {
msg_info_config("start another event loop to sync fuzzy storage");
if (rspamd_fuzzy_process_updates_queue(ctx, local_db_name, TRUE)) {
ev_loop(ctx->event_loop, 0);
msg_info_config("sync cycle is done");
}
else {
msg_info_config("no need to sync");
}
}
rspamd_fuzzy_backend_close(ctx->backend);
if (worker->index == 0) {
g_array_free(ctx->updates_pending, TRUE);
ctx->updates_pending = NULL;
}
if (ctx->keypair_cache) {
rspamd_keypair_cache_destroy(ctx->keypair_cache);
}
if (ctx->ratelimit_buckets) {
/* Try the best to save ratelimits from the proper worker */
if ((!ctx->dedicated_update_worker && worker->index == 0) ||
(ctx->dedicated_update_worker && worker->index == 1)) {
rspamd_fuzzy_maybe_save_ratelimits(ctx);
}
rspamd_lru_hash_destroy(ctx->ratelimit_buckets);
}
if (ctx->lua_pre_handler_cbref != -1) {
luaL_unref(ctx->cfg->lua_state, LUA_REGISTRYINDEX, ctx->lua_pre_handler_cbref);
}
if (ctx->lua_post_handler_cbref != -1) {
luaL_unref(ctx->cfg->lua_state, LUA_REGISTRYINDEX, ctx->lua_post_handler_cbref);
}
if (ctx->lua_blacklist_cbref != -1) {
luaL_unref(ctx->cfg->lua_state, LUA_REGISTRYINDEX, ctx->lua_blacklist_cbref);
}
if (ctx->default_forbidden_ids) {
kh_destroy(fuzzy_key_ids_set, ctx->default_forbidden_ids);
}
if (ctx->weak_ids) {
kh_destroy(fuzzy_key_ids_set, ctx->weak_ids);
}
REF_RELEASE(ctx->cfg);
rspamd_log_close(worker->srv->logger);
rspamd_unset_crash_handler(worker->srv);
exit(EXIT_SUCCESS);
}
|