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
|
/*-
* Copyright 2016 Vsevolod Stakhov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include "libutil/util.h"
#include "libutil/map.h"
#include "libutil/upstream.h"
#include "libutil/http.h"
#include "libutil/http_private.h"
#include "libserver/protocol.h"
#include "libserver/cfg_file.h"
#include "libserver/url.h"
#include "libserver/dns.h"
#include "libmime/message.h"
#include "rspamd.h"
#include "libserver/worker_util.h"
#include "lua/lua_common.h"
#include "keypairs_cache.h"
#include "ottery.h"
#include "unix-std.h"
/* Rotate keys each minute by default */
#define DEFAULT_ROTATION_TIME 60.0
#define msg_err_session(...) rspamd_default_log_function (G_LOG_LEVEL_CRITICAL, \
session->pool->tag.tagname, session->pool->tag.uid, \
G_STRFUNC, \
__VA_ARGS__)
#define msg_warn_session(...) rspamd_default_log_function (G_LOG_LEVEL_WARNING, \
session->pool->tag.tagname, session->pool->tag.uid, \
G_STRFUNC, \
__VA_ARGS__)
#define msg_info_session(...) rspamd_default_log_function (G_LOG_LEVEL_INFO, \
session->pool->tag.tagname, session->pool->tag.uid, \
G_STRFUNC, \
__VA_ARGS__)
#define msg_debug_session(...) rspamd_default_log_function (G_LOG_LEVEL_DEBUG, \
session->pool->tag.tagname, session->pool->tag.uid, \
G_STRFUNC, \
__VA_ARGS__)
gpointer init_rspamd_proxy (struct rspamd_config *cfg);
void start_rspamd_proxy (struct rspamd_worker *worker);
worker_t rspamd_proxy_worker = {
"rspamd_proxy", /* Name */
init_rspamd_proxy, /* Init function */
start_rspamd_proxy, /* Start function */
RSPAMD_WORKER_HAS_SOCKET | RSPAMD_WORKER_KILLABLE,
RSPAMD_WORKER_SOCKET_TCP, /* TCP socket */
RSPAMD_WORKER_VER
};
struct rspamd_http_upstream {
gchar *name;
struct upstream_list *u;
struct rspamd_cryptobox_pubkey *key;
gint parser_from_ref;
gint parser_to_ref;
gboolean local;
};
struct rspamd_http_mirror {
gchar *name;
gchar *settings_id;
struct upstream_list *u;
struct rspamd_cryptobox_pubkey *key;
gdouble prob;
gint parser_from_ref;
gint parser_to_ref;
gboolean local;
};
static const guint64 rspamd_rspamd_proxy_magic = 0xcdeb4fd1fc351980ULL;
struct rspamd_proxy_ctx {
guint64 magic;
gdouble timeout;
struct timeval io_tv;
struct rspamd_config *cfg;
/* DNS resolver */
struct rspamd_dns_resolver *resolver;
/* Events base */
struct event_base *ev_base;
/* Encryption key for clients */
struct rspamd_cryptobox_keypair *key;
/* Keys cache */
struct rspamd_keypair_cache *keys_cache;
/* Upstreams to use */
GHashTable *upstreams;
/* Mirrors to send traffic to */
GPtrArray *mirrors;
/* Default upstream */
struct rspamd_http_upstream *default_upstream;
/* Local rotating keypair for upstreams */
struct rspamd_cryptobox_keypair *local_key;
struct event rotate_ev;
gdouble rotate_tm;
lua_State *lua_state;
/* Array of callback functions called on end of scan to compare results */
GArray *cmp_refs;
};
enum rspamd_backend_flags {
RSPAMD_BACKEND_REPLIED = 1 << 0,
RSPAMD_BACKEND_CLOSED = 1 << 1,
RSPAMD_BACKEND_PARSED = 1 << 2,
};
struct rspamd_proxy_session;
struct rspamd_proxy_backend_connection {
const gchar *name;
struct rspamd_cryptobox_keypair *local_key;
struct rspamd_cryptobox_pubkey *remote_key;
struct upstream *up;
struct rspamd_http_connection *backend_conn;
ucl_object_t *results;
const gchar *err;
struct rspamd_proxy_session *s;
gint backend_sock;
enum rspamd_backend_flags flags;
gint parser_from_ref;
gint parser_to_ref;
};
struct rspamd_proxy_session {
rspamd_mempool_t *pool;
struct rspamd_proxy_ctx *ctx;
rspamd_inet_addr_t *client_addr;
struct rspamd_http_connection *client_conn;
gpointer map;
gpointer shmem_ref;
struct rspamd_proxy_backend_connection *master_conn;
GPtrArray *mirror_conns;
gsize map_len;
gint client_sock;
gboolean is_spamc;
ref_entry_t ref;
};
static GQuark
rspamd_proxy_quark (void)
{
return g_quark_from_static_string ("rspamd-proxy");
}
static gboolean
rspamd_proxy_parse_lua_parser (lua_State *L, const ucl_object_t *obj,
gint *ref_from, gint *ref_to, GError **err)
{
const gchar *lua_script;
gsize slen;
gint err_idx, ref_idx;
GString *tb = NULL;
gboolean has_ref = FALSE;
g_assert (obj != NULL);
g_assert (ref_from != NULL);
g_assert (ref_to != NULL);
*ref_from = -1;
*ref_to = -1;
lua_script = ucl_object_tolstring (obj, &slen);
lua_pushcfunction (L, &rspamd_lua_traceback);
err_idx = lua_gettop (L);
/* Load data */
if (luaL_loadbuffer (L, lua_script, slen, "proxy parser") != 0) {
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot load lua parser script: %s",
lua_tostring (L, -1));
lua_settop (L, 0); /* Error function */
return FALSE;
}
/* Now do it */
if (lua_pcall (L, 0, 1, err_idx) != 0) {
tb = lua_touserdata (L, -1);
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot init lua parser script: %s",
tb->str);
g_string_free (tb, TRUE);
lua_settop (L, 0);
return FALSE;
}
if (lua_istable (L, -1)) {
/*
* We have a table, so we check for two keys:
* 'from' -> function
* 'to' -> function
*
* From converts parent request to a client one
* To converts client request to a parent one
*/
lua_pushstring (L, "from");
lua_gettable (L, -2);
if (lua_isfunction (L, -1)) {
ref_idx = luaL_ref (L, LUA_REGISTRYINDEX);
*ref_from = ref_idx;
has_ref = TRUE;
}
lua_pushstring (L, "to");
lua_gettable (L, -2);
if (lua_isfunction (L, -1)) {
ref_idx = luaL_ref (L, LUA_REGISTRYINDEX);
*ref_to = ref_idx;
has_ref = TRUE;
}
}
else if (!lua_isfunction (L, -1)) {
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot init lua parser script: "
"must return function");
lua_settop (L, 0);
return FALSE;
}
else {
/* Just parser from protocol */
ref_idx = luaL_ref (L, LUA_REGISTRYINDEX);
*ref_from = ref_idx;
lua_settop (L, 0);
has_ref = TRUE;
}
return has_ref;
}
static gboolean
rspamd_proxy_parse_upstream (rspamd_mempool_t *pool,
const ucl_object_t *obj,
gpointer ud,
struct rspamd_rcl_section *section,
GError **err)
{
const ucl_object_t *elt;
struct rspamd_http_upstream *up = NULL;
struct rspamd_proxy_ctx *ctx;
struct rspamd_rcl_struct_parser *pd = ud;
lua_State *L;
ctx = pd->user_struct;
L = ctx->lua_state;
if (ucl_object_type (obj) != UCL_OBJECT) {
g_set_error (err, rspamd_proxy_quark (), 100,
"upstream option must be an object");
return FALSE;
}
elt = ucl_object_lookup (obj, "name");
if (elt == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"upstream option must have some name definition");
return FALSE;
}
up = g_slice_alloc0 (sizeof (*up));
up->parser_from_ref = -1;
up->parser_to_ref = -1;
up->name = g_strdup (ucl_object_tostring (elt));
elt = ucl_object_lookup (obj, "key");
if (elt != NULL) {
up->key = rspamd_pubkey_from_base32 (ucl_object_tostring (elt), 0,
RSPAMD_KEYPAIR_KEX, RSPAMD_CRYPTOBOX_MODE_25519);
if (up->key == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"cannot read upstream key");
goto err;
}
}
elt = ucl_object_lookup (obj, "hosts");
if (elt == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"upstream option must have some hosts definition");
goto err;
}
up->u = rspamd_upstreams_create (ctx->cfg->ups_ctx);
if (!rspamd_upstreams_from_ucl (up->u, elt, 11333, NULL)) {
g_set_error (err, rspamd_proxy_quark (), 100,
"upstream has bad hosts definition");
goto err;
}
elt = ucl_object_lookup (obj, "default");
if (elt && ucl_object_toboolean (elt)) {
ctx->default_upstream = up;
}
elt = ucl_object_lookup (obj, "local");
if (elt && ucl_object_toboolean (elt)) {
up->local = TRUE;
}
/*
* Accept lua function here in form
* fun :: String -> UCL
*/
elt = ucl_object_lookup (obj, "parser");
if (elt) {
if (!rspamd_proxy_parse_lua_parser (L, elt, &up->parser_from_ref,
&up->parser_to_ref, err)) {
goto err;
}
}
g_hash_table_insert (ctx->upstreams, up->name, up);
return TRUE;
err:
if (up) {
g_free (up->name);
rspamd_upstreams_destroy (up->u);
if (up->key) {
rspamd_pubkey_unref (up->key);
}
if (up->parser_from_ref != -1) {
luaL_unref (L, LUA_REGISTRYINDEX, up->parser_from_ref);
}
if (up->parser_to_ref != -1) {
luaL_unref (L, LUA_REGISTRYINDEX, up->parser_to_ref);
}
g_slice_free1 (sizeof (*up), up);
}
return FALSE;
}
static gboolean
rspamd_proxy_parse_mirror (rspamd_mempool_t *pool,
const ucl_object_t *obj,
gpointer ud,
struct rspamd_rcl_section *section,
GError **err)
{
const ucl_object_t *elt;
struct rspamd_http_mirror *up = NULL;
struct rspamd_proxy_ctx *ctx;
struct rspamd_rcl_struct_parser *pd = ud;
lua_State *L;
ctx = pd->user_struct;
L = ctx->lua_state;
if (ucl_object_type (obj) != UCL_OBJECT) {
g_set_error (err, rspamd_proxy_quark (), 100,
"mirror option must be an object");
return FALSE;
}
elt = ucl_object_lookup (obj, "name");
if (elt == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"mirror option must have some name definition");
return FALSE;
}
up = g_slice_alloc0 (sizeof (*up));
up->name = g_strdup (ucl_object_tostring (elt));
up->parser_to_ref = -1;
up->parser_from_ref = -1;
elt = ucl_object_lookup (obj, "key");
if (elt != NULL) {
up->key = rspamd_pubkey_from_base32 (ucl_object_tostring (elt), 0,
RSPAMD_KEYPAIR_KEX, RSPAMD_CRYPTOBOX_MODE_25519);
if (up->key == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"cannot read mirror key");
goto err;
}
}
elt = ucl_object_lookup (obj, "hosts");
if (elt == NULL) {
g_set_error (err, rspamd_proxy_quark (), 100,
"mirror option must have some hosts definition");
goto err;
}
up->u = rspamd_upstreams_create (ctx->cfg->ups_ctx);
if (!rspamd_upstreams_from_ucl (up->u, elt, 11333, NULL)) {
g_set_error (err, rspamd_proxy_quark (), 100,
"mirror has bad hosts definition");
goto err;
}
elt = ucl_object_lookup_any (obj, "probability", "prob", NULL);
if (elt) {
up->prob = ucl_object_todouble (elt);
}
else {
up->prob = 1.0;
}
elt = ucl_object_lookup (obj, "local");
if (elt && ucl_object_toboolean (elt)) {
up->local = TRUE;
}
/*
* Accept lua function here in form
* fun :: String -> UCL
*/
elt = ucl_object_lookup (obj, "parser");
if (elt) {
if (!rspamd_proxy_parse_lua_parser (L, elt, &up->parser_from_ref,
&up->parser_to_ref, err)) {
goto err;
}
}
elt = ucl_object_lookup_any (obj, "settings", "settings_id", NULL);
if (elt && ucl_object_type (elt) == UCL_STRING) {
up->settings_id = g_strdup (ucl_object_tostring (elt));
}
g_ptr_array_add (ctx->mirrors, up);
return TRUE;
err:
if (up) {
g_free (up->name);
rspamd_upstreams_destroy (up->u);
if (up->key) {
rspamd_pubkey_unref (up->key);
}
if (up->parser_from_ref != -1) {
luaL_unref (L, LUA_REGISTRYINDEX, up->parser_from_ref);
}
if (up->parser_to_ref != -1) {
luaL_unref (L, LUA_REGISTRYINDEX, up->parser_to_ref);
}
g_slice_free1 (sizeof (*up), up);
}
return FALSE;
}
static gboolean
rspamd_proxy_parse_script (rspamd_mempool_t *pool,
const ucl_object_t *obj,
gpointer ud,
struct rspamd_rcl_section *section,
GError **err)
{
struct rspamd_proxy_ctx *ctx;
struct rspamd_rcl_struct_parser *pd = ud;
lua_State *L;
const gchar *lua_script;
gsize slen;
gint err_idx, ref_idx;
GString *tb = NULL;
struct stat st;
ctx = pd->user_struct;
L = ctx->lua_state;
if (ucl_object_type (obj) != UCL_STRING) {
g_set_error (err, rspamd_proxy_quark (), 100,
"script option must be a string with file or lua chunk");
return FALSE;
}
lua_script = ucl_object_tolstring (obj, &slen);
lua_pushcfunction (L, &rspamd_lua_traceback);
err_idx = lua_gettop (L);
if (stat (lua_script, &st) != -1) {
/* Load file */
if (luaL_loadfile (L, lua_script) != 0) {
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot load lua parser script: %s",
lua_tostring (L, -1));
lua_settop (L, 0); /* Error function */
goto err;
}
}
else {
/* Load data directly */
if (luaL_loadbuffer (L, lua_script, slen, "proxy parser") != 0) {
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot load lua parser script: %s",
lua_tostring (L, -1));
lua_settop (L, 0); /* Error function */
goto err;
}
}
/* Now do it */
if (lua_pcall (L, 0, 1, err_idx) != 0) {
tb = lua_touserdata (L, -1);
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot init lua parser script: %s",
tb->str);
g_string_free (tb, TRUE);
lua_settop (L, 0);
goto err;
}
if (!lua_isfunction (L, -1)) {
g_set_error (err,
rspamd_proxy_quark (),
EINVAL,
"cannot init lua parser script: "
"must return function, %s returned",
lua_typename (L, lua_type (L, -1)));
lua_settop (L, 0);
goto err;
}
ref_idx = luaL_ref (L, LUA_REGISTRYINDEX);
lua_settop (L, 0);
g_array_append_val (ctx->cmp_refs, ref_idx);
return TRUE;
err:
return FALSE;
}
gpointer
init_rspamd_proxy (struct rspamd_config *cfg)
{
struct rspamd_proxy_ctx *ctx;
GQuark type;
type = g_quark_try_string ("rspamd_proxy");
ctx = g_malloc0 (sizeof (struct rspamd_proxy_ctx));
ctx->magic = rspamd_rspamd_proxy_magic;
ctx->timeout = 5.0;
ctx->upstreams = g_hash_table_new (rspamd_strcase_hash, rspamd_strcase_equal);
ctx->mirrors = g_ptr_array_new ();
ctx->rotate_tm = DEFAULT_ROTATION_TIME;
ctx->cfg = cfg;
ctx->lua_state = cfg->lua_state;
ctx->cmp_refs = g_array_new (FALSE, FALSE, sizeof (gint));
rspamd_rcl_register_worker_option (cfg,
type,
"timeout",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET (struct rspamd_proxy_ctx,
timeout),
RSPAMD_CL_FLAG_TIME_FLOAT,
"IO timeout");
rspamd_rcl_register_worker_option (cfg,
type,
"rotate",
rspamd_rcl_parse_struct_time,
ctx,
G_STRUCT_OFFSET (struct rspamd_proxy_ctx,
rotate_tm),
RSPAMD_CL_FLAG_TIME_FLOAT,
"Rotation keys time, default: "
G_STRINGIFY (DEFAULT_ROTATION_TIME) " seconds");
rspamd_rcl_register_worker_option (cfg,
type,
"keypair",
rspamd_rcl_parse_struct_keypair,
ctx,
G_STRUCT_OFFSET (struct rspamd_proxy_ctx,
key),
0,
"Server's keypair");
rspamd_rcl_register_worker_option (cfg,
type,
"upstream",
rspamd_proxy_parse_upstream,
ctx,
0,
0,
"List of upstreams");
rspamd_rcl_register_worker_option (cfg,
type,
"mirror",
rspamd_proxy_parse_mirror,
ctx,
0,
RSPAMD_CL_FLAG_MULTIPLE,
"List of mirrors");
rspamd_rcl_register_worker_option (cfg,
type,
"script",
rspamd_proxy_parse_script,
ctx,
0,
RSPAMD_CL_FLAG_MULTIPLE,
"Compare script to be executed");
return ctx;
}
static void
proxy_backend_close_connection (struct rspamd_proxy_backend_connection *conn)
{
if (conn && !(conn->flags & RSPAMD_BACKEND_CLOSED)) {
if (conn->backend_conn) {
rspamd_http_connection_reset (conn->backend_conn);
rspamd_http_connection_unref (conn->backend_conn);
}
close (conn->backend_sock);
conn->flags |= RSPAMD_BACKEND_CLOSED;
}
}
static gboolean
proxy_backend_parse_results (struct rspamd_proxy_session *session,
struct rspamd_proxy_backend_connection *conn,
lua_State *L, gint parser_ref,
const gchar *in, gsize inlen)
{
struct ucl_parser *parser;
GString *tb = NULL;
gint err_idx;
if (inlen == 0 || in == NULL) {
return FALSE;
}
if (parser_ref != -1) {
/* Call parser function */
lua_pushcfunction (L, &rspamd_lua_traceback);
err_idx = lua_gettop (L);
lua_rawgeti (L, LUA_REGISTRYINDEX, parser_ref);
/* XXX: copies all data */
lua_pushlstring (L, in, inlen);
if (lua_pcall (L, 1, 1, err_idx) != 0) {
tb = lua_touserdata (L, -1);
msg_err_session (
"cannot run lua parser script: %s",
tb->str);
g_string_free (tb, TRUE);
lua_settop (L, 0);
return FALSE;
}
conn->results = ucl_object_lua_import (L, -1);
lua_settop (L, 0);
}
else {
parser = ucl_parser_new (0);
if (!ucl_parser_add_chunk (parser, in, inlen)) {
msg_err_session ("cannot parse input: %s", ucl_parser_get_error (
parser));
ucl_parser_free (parser);
return FALSE;
}
conn->results = ucl_parser_get_object (parser);
ucl_parser_free (parser);
}
return TRUE;
}
static void
proxy_call_cmp_script (struct rspamd_proxy_session *session, gint cbref)
{
GString *tb = NULL;
gint err_idx;
guint i;
struct rspamd_proxy_backend_connection *conn;
lua_State *L;
L = session->ctx->lua_state;
lua_pushcfunction (L, &rspamd_lua_traceback);
err_idx = lua_gettop (L);
lua_rawgeti (L, LUA_REGISTRYINDEX, cbref);
lua_createtable (L, 0, session->mirror_conns->len + 1);
/* Now push master results */
if (session->master_conn && session->master_conn->results) {
lua_pushstring (L, "master");
ucl_object_push_lua (L, session->master_conn->results, true);
lua_settable (L, -3);
}
else {
lua_pushstring (L, "master");
lua_pushstring (L, "no results");
lua_settable (L, -3);
}
for (i = 0; i < session->mirror_conns->len; i ++) {
conn = g_ptr_array_index (session->mirror_conns, i);
if (conn->results) {
lua_pushstring (L, conn->name);
ucl_object_push_lua (L, conn->results, true);
lua_settable (L, -3);
}
else {
lua_pushstring (L, conn->name);
lua_pushstring (L, conn->err ? conn->err : "unknown error");
lua_settable (L, -3);
}
}
if (lua_pcall (L, 1, 0, err_idx) != 0) {
tb = lua_touserdata (L, -1);
msg_err_session (
"cannot run lua compare script: %s",
tb->str);
g_string_free (tb, TRUE);
}
lua_settop (L, 0);
}
static void
proxy_session_dtor (struct rspamd_proxy_session *session)
{
guint i;
gint cbref;
struct rspamd_proxy_backend_connection *conn;
for (i = 0; i < session->ctx->cmp_refs->len; i ++) {
cbref = g_array_index (session->ctx->cmp_refs, gint, i);
proxy_call_cmp_script (session, cbref);
}
if (session->master_conn) {
proxy_backend_close_connection (session->master_conn);
}
if (session->map && session->map_len) {
munmap (session->map, session->map_len);
}
if (session->client_conn) {
rspamd_http_connection_reset (session->client_conn);
rspamd_http_connection_unref (session->client_conn);
}
for (i = 0; i < session->mirror_conns->len; i ++) {
conn = g_ptr_array_index (session->mirror_conns, i);
if (!(conn->flags & RSPAMD_BACKEND_CLOSED)) {
proxy_backend_close_connection (conn);
}
if (conn->results) {
ucl_object_unref (conn->results);
}
}
if (session->master_conn->results) {
ucl_object_unref (session->master_conn->results);
}
g_ptr_array_free (session->mirror_conns, TRUE);
rspamd_http_message_shmem_unref (session->shmem_ref);
rspamd_inet_address_destroy (session->client_addr);
close (session->client_sock);
rspamd_mempool_delete (session->pool);
g_slice_free1 (sizeof (*session), session);
}
static gboolean
proxy_check_file (struct rspamd_http_message *msg,
struct rspamd_proxy_session *session)
{
const rspamd_ftok_t *tok, *key_tok;
rspamd_ftok_t srch;
const gchar *file_str;
GHashTable *query_args;
GHashTableIter it;
gpointer k, v;
struct http_parser_url u;
rspamd_fstring_t *new_url;
tok = rspamd_http_message_find_header (msg, "File");
if (tok) {
file_str = rspamd_mempool_ftokdup (session->pool, tok);
session->map = rspamd_file_xmap (file_str, PROT_READ,
&session->map_len);
if (session->map == NULL) {
msg_err_session ("cannot map %s: %s", file_str, strerror (errno));
return FALSE;
}
/* Remove header after processing */
rspamd_http_message_remove_header (msg, "File");
}
else {
/* Need to parse query URL */
if (http_parser_parse_url (msg->url->str, msg->url->len, 0, &u) != 0) {
msg_err_session ("bad request url: %V", msg->url);
return FALSE;
}
if (u.field_set & (1 << UF_QUERY)) {
/* In case if we have a query, we need to store it somewhere */
query_args = rspamd_http_message_parse_query (msg);
srch.begin = "File";
srch.len = strlen ("File");
tok = g_hash_table_lookup (query_args, &srch);
if (tok) {
file_str = rspamd_mempool_ftokdup (session->pool, tok);
session->map = rspamd_file_xmap (file_str, PROT_READ,
&session->map_len);
if (session->map == NULL) {
msg_err_session ("cannot map %s: %s", file_str, strerror (errno));
g_hash_table_unref (query_args);
return FALSE;
}
/* We need to create a new URL with file attribute removed */
new_url = rspamd_fstring_new_init (msg->url->str,
u.field_data[UF_QUERY].off);
new_url = rspamd_fstring_append (new_url, "?", 1);
g_hash_table_iter_init (&it, query_args);
while (g_hash_table_iter_next (&it, &k, &v)) {
key_tok = k;
tok = v;
if (!rspamd_ftok_icase_equal (key_tok, &srch)) {
rspamd_printf_fstring (&new_url, "%T=%T&",
key_tok, tok);
}
}
/* Erase last character (might be either & or ?) */
rspamd_fstring_erase (new_url, new_url->len - 1, 1);
rspamd_fstring_free (msg->url);
msg->url = new_url;
}
g_hash_table_unref (query_args);
}
}
return TRUE;
}
static void
proxy_backend_mirror_error_handler (struct rspamd_http_connection *conn, GError *err)
{
struct rspamd_proxy_backend_connection *bk_conn = conn->ud;
struct rspamd_proxy_session *session;
session = bk_conn->s;
msg_info_session ("abnormally closing connection from backend: %s:%s, "
"error: %e",
bk_conn->name,
rspamd_inet_address_to_string (rspamd_upstream_addr (bk_conn->up)),
err);
if (err) {
bk_conn->err = rspamd_mempool_strdup (session->pool, err->message);
}
proxy_backend_close_connection (bk_conn);
REF_RELEASE (bk_conn->s);
}
static gint
proxy_backend_mirror_finish_handler (struct rspamd_http_connection *conn,
struct rspamd_http_message *msg)
{
struct rspamd_proxy_backend_connection *bk_conn = conn->ud;
struct rspamd_proxy_session *session;
session = bk_conn->s;
if (!proxy_backend_parse_results (session, bk_conn, session->ctx->lua_state,
bk_conn->parser_from_ref, msg->body_buf.begin, msg->body_buf.len)) {
msg_warn_session ("cannot parse results from the mirror backend %s:%s",
bk_conn->name,
rspamd_inet_address_to_string (rspamd_upstream_addr (bk_conn->up)));
bk_conn->err = "cannot parse ucl";
}
msg_info_session ("finished mirror connection to %s", bk_conn->name);
proxy_backend_close_connection (bk_conn);
REF_RELEASE (bk_conn->s);
return 0;
}
static void
proxy_open_mirror_connections (struct rspamd_proxy_session *session)
{
gdouble coin;
struct rspamd_http_mirror *m;
guint i;
struct rspamd_proxy_backend_connection *bk_conn;
struct rspamd_http_message *msg;
coin = rspamd_random_double ();
for (i = 0; i < session->ctx->mirrors->len; i ++) {
m = g_ptr_array_index (session->ctx->mirrors, i);
if (m->prob < coin) {
/* No luck */
continue;
}
bk_conn = rspamd_mempool_alloc0 (session->pool,
sizeof (*bk_conn));
bk_conn->s = session;
bk_conn->name = m->name;
bk_conn->up = rspamd_upstream_get (m->u,
RSPAMD_UPSTREAM_ROUND_ROBIN, NULL, 0);
bk_conn->parser_from_ref = m->parser_from_ref;
bk_conn->parser_to_ref = m->parser_to_ref;
if (bk_conn->up == NULL) {
msg_err_session ("cannot select upstream for %s", m->name);
continue;
}
bk_conn->backend_sock = rspamd_inet_address_connect (
rspamd_upstream_addr (bk_conn->up),
SOCK_STREAM, TRUE);
if (bk_conn->backend_sock == -1) {
msg_err_session ("cannot connect upstream for %s", m->name);
rspamd_upstream_fail (bk_conn->up);
continue;
}
msg = rspamd_http_connection_copy_msg (session->client_conn);
rspamd_http_message_remove_header (msg, "Content-Length");
rspamd_http_message_remove_header (msg, "Key");
msg->method = HTTP_GET;
if (msg->url->len == 0) {
msg->url = rspamd_fstring_append (msg->url, "/check", strlen ("/check"));
}
if (m->settings_id != NULL) {
rspamd_http_message_remove_header (msg, "Settings-ID");
rspamd_http_message_add_header (msg, "Settings-ID", m->settings_id);
}
bk_conn->backend_conn = rspamd_http_connection_new (
NULL,
proxy_backend_mirror_error_handler,
proxy_backend_mirror_finish_handler,
RSPAMD_HTTP_CLIENT_SIMPLE,
RSPAMD_HTTP_CLIENT,
session->ctx->keys_cache);
rspamd_http_connection_set_key (bk_conn->backend_conn,
session->ctx->local_key);
msg->peer_key = rspamd_pubkey_ref (m->key);
rspamd_http_connection_write_message_shared (bk_conn->backend_conn,
msg, NULL, NULL, bk_conn,
bk_conn->backend_sock,
&session->ctx->io_tv, session->ctx->ev_base);
g_ptr_array_add (session->mirror_conns, bk_conn);
REF_RETAIN (session);
msg_info_session ("send request to %s", m->name);
}
}
static void
proxy_client_write_error (struct rspamd_proxy_session *session, gint code,
const gchar *status)
{
struct rspamd_http_message *reply;
reply = rspamd_http_new_message (HTTP_RESPONSE);
reply->code = code;
reply->status = rspamd_fstring_new_init (status, strlen (status));
rspamd_http_connection_write_message (session->client_conn,
reply, NULL, NULL, session, session->client_sock,
&session->ctx->io_tv, session->ctx->ev_base);
}
static void
proxy_backend_master_error_handler (struct rspamd_http_connection *conn, GError *err)
{
struct rspamd_proxy_backend_connection *bk_conn = conn->ud;
struct rspamd_proxy_session *session;
session = bk_conn->s;
msg_info_session ("abnormally closing connection from backend: %s, error: %s",
rspamd_inet_address_to_string (rspamd_upstream_addr (session->master_conn->up)),
err->message);
/* Terminate session immediately */
proxy_client_write_error (session, err->code, err->message);
proxy_backend_close_connection (session->master_conn);
}
static gint
proxy_backend_master_finish_handler (struct rspamd_http_connection *conn,
struct rspamd_http_message *msg)
{
struct rspamd_proxy_backend_connection *bk_conn = conn->ud;
struct rspamd_proxy_session *session;
rspamd_fstring_t *reply;
session = bk_conn->s;
rspamd_http_connection_steal_msg (session->master_conn->backend_conn);
rspamd_http_message_remove_header (msg, "Content-Length");
rspamd_http_message_remove_header (msg, "Key");
rspamd_http_connection_reset (session->master_conn->backend_conn);
if (!proxy_backend_parse_results (session, bk_conn, session->ctx->lua_state,
bk_conn->parser_from_ref, msg->body_buf.begin, msg->body_buf.len)) {
msg_warn_session ("cannot parse results from the master backend");
}
if (session->is_spamc) {
/* We need to reformat ucl to fit with legacy spamc protocol */
if (bk_conn->results) {
reply = rspamd_fstring_new ();
rspamd_ucl_torspamc_output (bk_conn->results, &reply);
rspamd_http_message_set_body_from_fstring_steal (msg, reply);
}
else {
msg_warn_session ("cannot parse results from the master backend, "
"return them as is");
}
}
rspamd_http_connection_write_message (session->client_conn,
msg, NULL, NULL, session, session->client_sock,
&session->ctx->io_tv, session->ctx->ev_base);
return 0;
}
static void
proxy_client_error_handler (struct rspamd_http_connection *conn, GError *err)
{
struct rspamd_proxy_session *session = conn->ud;
msg_info_session ("abnormally closing connection from: %s, error: %s",
rspamd_inet_address_to_string (session->client_addr), err->message);
/* Terminate session immediately */
proxy_backend_close_connection (session->master_conn);
REF_RELEASE (session);
}
static gint
proxy_client_finish_handler (struct rspamd_http_connection *conn,
struct rspamd_http_message *msg)
{
struct rspamd_proxy_session *session = conn->ud;
struct rspamd_http_upstream *backend = NULL;
const rspamd_ftok_t *host;
gchar hostbuf[512];
if (!session->master_conn) {
session->master_conn = rspamd_mempool_alloc0 (session->pool,
sizeof (*session->master_conn));
session->master_conn->s = session;
session->master_conn->name = "master";
host = rspamd_http_message_find_header (msg, "Host");
/* Reset spamc legacy */
if (msg->method >= HTTP_SYMBOLS) {
msg->method = HTTP_GET;
session->is_spamc = TRUE;
msg_info_session ("enabling legacy rspamc mode for session");
}
if (msg->url->len == 0) {
msg->url = rspamd_fstring_append (msg->url, "/check", strlen ("/check"));
}
if (host == NULL) {
backend = session->ctx->default_upstream;
}
else {
rspamd_strlcpy (hostbuf, host->begin, MIN(host->len + 1, sizeof (hostbuf)));
backend = g_hash_table_lookup (session->ctx->upstreams, hostbuf);
if (backend == NULL) {
backend = session->ctx->default_upstream;
}
}
if (backend == NULL) {
/* No backend */
msg_err_session ("cannot find upstream for %s", host ? hostbuf : "default");
goto err;
}
else {
session->master_conn->up = rspamd_upstream_get (backend->u,
RSPAMD_UPSTREAM_ROUND_ROBIN, NULL, 0);
if (session->master_conn->up == NULL) {
msg_err_session ("cannot select upstream for %s", host ? hostbuf : "default");
goto err;
}
session->master_conn->backend_sock = rspamd_inet_address_connect (
rspamd_upstream_addr (session->master_conn->up),
SOCK_STREAM, TRUE);
if (session->master_conn->backend_sock == -1) {
msg_err_session ("cannot connect upstream: %s(%s)",
host ? hostbuf : "default",
rspamd_inet_address_to_string (rspamd_upstream_addr (session->master_conn->up)));
rspamd_upstream_fail (session->master_conn->up);
goto err;
}
if (!proxy_check_file (msg, session)) {
goto err;
}
proxy_open_mirror_connections (session);
rspamd_http_connection_steal_msg (session->client_conn);
rspamd_http_message_remove_header (msg, "Content-Length");
rspamd_http_message_remove_header (msg, "Key");
rspamd_http_connection_reset (session->client_conn);
session->shmem_ref = rspamd_http_message_shmem_ref (msg);
session->master_conn->backend_conn = rspamd_http_connection_new (
NULL,
proxy_backend_master_error_handler,
proxy_backend_master_finish_handler,
RSPAMD_HTTP_CLIENT_SIMPLE,
RSPAMD_HTTP_CLIENT,
session->ctx->keys_cache);
session->master_conn->parser_from_ref = backend->parser_from_ref;
session->master_conn->parser_to_ref = backend->parser_to_ref;
rspamd_http_connection_set_key (session->master_conn->backend_conn,
session->ctx->local_key);
msg->peer_key = rspamd_pubkey_ref (backend->key);
rspamd_http_connection_write_message_shared (
session->master_conn->backend_conn,
msg, NULL, NULL, session->master_conn,
session->master_conn->backend_sock,
&session->ctx->io_tv, session->ctx->ev_base);
}
}
else {
msg_info_session ("finished master connection");
proxy_backend_close_connection (session->master_conn);
REF_RELEASE (session);
}
return 0;
err:
rspamd_http_connection_steal_msg (session->client_conn);
rspamd_http_message_remove_header (msg, "Content-Length");
rspamd_http_message_remove_header (msg, "Key");
rspamd_http_connection_reset (session->client_conn);
proxy_client_write_error (session, 404, "Backend not found");
return 0;
}
static void
proxy_accept_socket (gint fd, short what, void *arg)
{
struct rspamd_worker *worker = (struct rspamd_worker *) arg;
struct rspamd_proxy_ctx *ctx;
rspamd_inet_addr_t *addr;
struct rspamd_proxy_session *session;
gint nfd;
ctx = worker->ctx;
if ((nfd =
rspamd_accept_from_socket (fd, &addr, worker->accept_events)) == -1) {
msg_warn ("accept failed: %s", strerror (errno));
return;
}
/* Check for EAGAIN */
if (nfd == 0) {
return;
}
session = g_slice_alloc0 (sizeof (*session));
REF_INIT_RETAIN (session, proxy_session_dtor);
session->client_sock = nfd;
session->client_addr = addr;
session->mirror_conns = g_ptr_array_sized_new (ctx->mirrors->len);
session->pool = rspamd_mempool_new (rspamd_mempool_suggest_size (), "proxy");
session->client_conn = rspamd_http_connection_new (
NULL,
proxy_client_error_handler,
proxy_client_finish_handler,
0,
RSPAMD_HTTP_SERVER,
ctx->keys_cache);
session->ctx = ctx;
if (ctx->key) {
rspamd_http_connection_set_key (session->client_conn, ctx->key);
}
msg_info_session ("accepted connection from %s port %d",
rspamd_inet_address_to_string (addr),
rspamd_inet_address_get_port (addr));
rspamd_http_connection_read_message_shared (session->client_conn,
session,
nfd,
&ctx->io_tv,
ctx->ev_base);
}
static void
proxy_rotate_key (gint fd, short what, void *arg)
{
struct timeval rot_tv;
struct rspamd_proxy_ctx *ctx = arg;
gpointer kp;
double_to_tv (ctx->rotate_tm, &rot_tv);
rot_tv.tv_sec += ottery_rand_range (rot_tv.tv_sec);
event_del (&ctx->rotate_ev);
event_add (&ctx->rotate_ev, &rot_tv);
kp = ctx->local_key;
ctx->local_key = rspamd_keypair_new (RSPAMD_KEYPAIR_KEX,
RSPAMD_CRYPTOBOX_MODE_25519);
rspamd_keypair_unref (kp);
}
void
start_rspamd_proxy (struct rspamd_worker *worker)
{
struct rspamd_proxy_ctx *ctx = worker->ctx;
struct timeval rot_tv;
ctx->ev_base = rspamd_prepare_worker (worker, "rspamd_proxy",
proxy_accept_socket);
ctx->resolver = dns_resolver_init (worker->srv->logger,
ctx->ev_base,
worker->srv->cfg);
double_to_tv (ctx->timeout, &ctx->io_tv);
rspamd_map_watch (worker->srv->cfg, ctx->ev_base, ctx->resolver);
rspamd_upstreams_library_config (worker->srv->cfg, ctx->cfg->ups_ctx,
ctx->ev_base, ctx->resolver->r);
/* XXX: stupid default */
ctx->keys_cache = rspamd_keypair_cache_new (256);
ctx->local_key = rspamd_keypair_new (RSPAMD_KEYPAIR_KEX,
RSPAMD_CRYPTOBOX_MODE_25519);
double_to_tv (ctx->rotate_tm, &rot_tv);
rot_tv.tv_sec += ottery_rand_range (rot_tv.tv_sec);
event_set (&ctx->rotate_ev, -1, EV_TIMEOUT, proxy_rotate_key, ctx);
event_base_set (ctx->ev_base, &ctx->rotate_ev);
event_add (&ctx->rotate_ev, &rot_tv);
event_base_loop (ctx->ev_base, 0);
rspamd_worker_block_signals ();
g_mime_shutdown ();
rspamd_log_close (worker->srv->logger);
if (ctx->key) {
rspamd_keypair_unref (ctx->key);
}
rspamd_keypair_cache_destroy (ctx->keys_cache);
exit (EXIT_SUCCESS);
}
|