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
|
/**
* @file main.h
* Definitions for main rspamd structures
*/
#ifndef RSPAMD_MAIN_H
#define RSPAMD_MAIN_H
#include "config.h"
#include "libutil/fstring.h"
#include "libutil/mem_pool.h"
#include "libutil/util.h"
#include "libutil/logger.h"
#include "libutil/http.h"
#include "libutil/upstream.h"
#include "libserver/url.h"
#include "libserver/protocol.h"
#include "libserver/buffer.h"
#include "libserver/events.h"
#include "libserver/roll_history.h"
#include "libserver/task.h"
#include <magic.h>
/* Default values */
#define FIXED_CONFIG_FILE RSPAMD_CONFDIR "/rspamd.conf"
/* Time in seconds to exit for old worker */
#define SOFT_SHUTDOWN_TIME 10
/* Spam subject */
#define SPAM_SUBJECT "*** SPAM *** "
#ifdef CRLF
#undef CRLF
#undef CR
#undef LF
#endif
#define CRLF "\r\n"
#define CR '\r'
#define LF '\n'
/**
* Worker process structure
*/
struct rspamd_worker {
pid_t pid; /**< pid of worker */
guint index; /**< index number */
guint nconns; /**< current connections count */
gdouble start_time; /**< start time */
struct rspamd_main *srv; /**< pointer to server structure */
GQuark type; /**< process type */
GHashTable *signal_events; /**< signal events */
GList *accept_events; /**< socket events */
struct rspamd_worker_conf *cf; /**< worker config data */
gpointer ctx; /**< worker's specific data */
gint control_pipe[2]; /**< control pipe. [0] is used by main process,
[1] is used by a worker */
gint srv_pipe[2]; /**< used by workers to request something from the
main process. [0] - main, [1] - worker */
struct event srv_ev; /**< used by main for read workers' requests */
gpointer control_data; /**< used by control protocol to handle commands */
};
struct rspamd_worker_signal_handler;
struct rspamd_worker_signal_cb {
void (*handler) (struct rspamd_worker_signal_handler *, void *ud);
void *handler_data;
struct rspamd_worker_signal_cb *next, *prev;
};
struct rspamd_worker_signal_handler {
gint signo;
gboolean enabled;
struct event ev;
struct event_base *base;
struct rspamd_worker *worker;
struct rspamd_worker_signal_cb *cb;
};
struct rspamd_controller_pbkdf {
gint id;
guint rounds;
gsize salt_len;
gsize key_len;
};
/**
* Common structure representing C module context
*/
struct module_s;
struct module_ctx {
gint (*filter)(struct rspamd_task *task); /**< pointer to headers process function */
struct module_s *mod; /**< module pointer */
gboolean enabled; /**< true if module is enabled in configuration */
};
#ifndef WITH_HYPERSCAN
#define RSPAMD_FEATURE_HYPERSCAN "0"
#else
#define RSPAMD_FEATURE_HYPERSCAN "1"
#endif
#ifndef WITH_PCRE2
#define RSPAMD_FEATURE_PCRE2 "0"
#else
#define RSPAMD_FEATURE_PCRE2 "1"
#endif
#ifndef WITH_FANN
#define RSPAMD_FEATURE_FANN "0"
#else
#define RSPAMD_FEATURE_FANN "1"
#endif
#ifndef WITH_SNOWBALL
#define RSPAMD_FEATURE_SNOWBALL "0"
#else
#define RSPAMD_FEATURE_SNOWBALL "1"
#endif
#define RSPAMD_CUR_MODULE_VERSION 0x1
#define RSPAMD_CUR_WORKER_VERSION 0x1
#define RSPAMD_FEATURES \
RSPAMD_FEATURE_HYPERSCAN RSPAMD_FEATURE_PCRE2 \
RSPAMD_FEATURE_FANN RSPAMD_FEATURE_SNOWBALL
#define RSPAMD_MODULE_VER \
RSPAMD_CUR_MODULE_VERSION, /* Module version */ \
RSPAMD_VERSION_NUM, /* Rspamd version */ \
RSPAMD_FEATURES /* Compilation features */ \
#define RSPAMD_WORKER_VER \
RSPAMD_CUR_WORKER_VERSION, /* Worker version */ \
RSPAMD_VERSION_NUM, /* Rspamd version */ \
RSPAMD_FEATURES /* Compilation features */ \
/**
* Module
*/
typedef struct module_s {
const gchar *name;
int (*module_init_func)(struct rspamd_config *cfg, struct module_ctx **ctx);
int (*module_config_func)(struct rspamd_config *cfg);
int (*module_reconfig_func)(struct rspamd_config *cfg);
int (*module_attach_controller_func)(struct module_ctx *ctx,
GHashTable *custom_commands);
guint module_version;
guint64 rspamd_version;
const gchar *rspamd_features;
} module_t;
typedef struct worker_s {
const gchar *name;
gpointer (*worker_init_func)(struct rspamd_config *cfg);
void (*worker_start_func)(struct rspamd_worker *worker);
gboolean has_socket;
gboolean unique;
gboolean threaded;
gboolean killable;
gint listen_type;
guint worker_version;
guint64 rspamd_version;
const gchar *rspamd_features;
} worker_t;
struct rspamd_dynamic_module {
module_t mod;
GModule *lib;
const gchar *path;
GQuark type;
};
struct rspamd_dynamic_worker {
worker_t wrk;
GModule *lib;
GQuark type;
const gchar *path;
};
/**
* Check if loaded worker is compatible with rspamd
* @param cfg
* @param wrk
* @return
*/
gboolean rspamd_check_worker (struct rspamd_config *cfg, worker_t *wrk);
/**
* Check if loaded module is compatible with rspamd
* @param cfg
* @param wrk
* @return
*/
gboolean rspamd_check_module (struct rspamd_config *cfg, module_t *wrk);
struct pidfh;
struct rspamd_config;
struct tokenizer;
struct rspamd_stat_classifier;
struct rspamd_classifier_config;
struct mime_part;
struct rspamd_dns_resolver;
struct rspamd_task;
struct rspamd_cryptobox_library_ctx;
/**
* Server statistics
*/
struct rspamd_stat {
guint messages_scanned; /**< total number of messages scanned */
guint actions_stat[METRIC_ACTION_NOACTION + 1]; /**< statistic for each action */
guint connections_count; /**< total connections count */
guint control_connections_count; /**< connections count to control interface */
guint messages_learned; /**< messages learned */
};
/**
* Struct that determine main server object (for logging purposes)
*/
struct rspamd_main {
struct rspamd_config *cfg; /**< pointer to config structure */
pid_t pid; /**< main pid */
/* Pid file structure */
rspamd_pidfh_t *pfh; /**< struct pidfh for pidfile */
GQuark type; /**< process type */
struct rspamd_stat *stat; /**< pointer to statistics */
rspamd_mempool_t *server_pool; /**< server's memory pool */
GHashTable *workers; /**< workers pool indexed by pid */
GHashTable *spairs; /**< socket pairs requested by workers */
rspamd_logger_t *logger;
uid_t workers_uid; /**< worker's uid running to */
gid_t workers_gid; /**< worker's gid running to */
gboolean is_privilleged; /**< true if run in privilleged mode */
gboolean cores_throttling; /**< turn off cores when limits are exceeded */
struct roll_history *history; /**< rolling history */
struct event_base *ev_base;
};
/**
* Structure to point exception in text from processing
*/
struct process_exception {
gsize pos;
gsize len;
};
/**
* Control session object
*/
struct controller_command;
struct controller_session;
typedef gboolean (*controller_func_t)(gchar **args,
struct controller_session *session);
struct controller_session {
struct rspamd_worker *worker; /**< pointer to worker structure (controller in fact) */
gint sock; /**< socket descriptor */
struct controller_command *cmd; /**< real command */
struct rspamd_config *cfg; /**< pointer to config file */
GList *parts; /**< extracted mime parts */
struct rspamd_async_session * s; /**< async session object */
struct rspamd_dns_resolver *resolver; /**< DNS resolver */
struct event_base *ev_base; /**< Event base */
};
struct rspamd_external_libs_ctx {
magic_t libmagic;
void **local_addrs;
struct rspamd_cryptobox_library_ctx *crypto_ctx;
struct ottery_config *ottery_cfg;
ref_entry_t ref;
};
/**
* Register custom controller function
*/
void register_custom_controller_command (const gchar *name,
controller_func_t handler,
gboolean privilleged,
gboolean require_message);
#define RSPAMD_PBKDF_ID_V1 1
extern const struct rspamd_controller_pbkdf pbkdf_list[];
#endif
/*
* vi:ts=4
*/
|
