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
|
/*-
* 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.
*/
#ifndef RSPAMD_RE_CACHE_H
#define RSPAMD_RE_CACHE_H
#include "config.h"
#include "libutil/regexp.h"
#ifdef __cplusplus
extern "C" {
#endif
struct rspamd_re_cache;
struct rspamd_re_runtime;
struct rspamd_task;
struct rspamd_config;
enum rspamd_re_type {
RSPAMD_RE_HEADER,
RSPAMD_RE_RAWHEADER,
RSPAMD_RE_ALLHEADER,
RSPAMD_RE_MIMEHEADER,
RSPAMD_RE_MIME,
RSPAMD_RE_RAWMIME,
RSPAMD_RE_URL,
RSPAMD_RE_EMAIL,
RSPAMD_RE_BODY, /* full in SA */
RSPAMD_RE_SABODY, /* body in SA */
RSPAMD_RE_SARAWBODY, /* rawbody in SA */
RSPAMD_RE_WORDS, /* normalized words */
RSPAMD_RE_RAWWORDS, /* raw words */
RSPAMD_RE_STEMWORDS, /* stemmed words */
RSPAMD_RE_SELECTOR, /* use lua selector to process regexp */
RSPAMD_RE_MAX
};
struct rspamd_re_cache_stat {
uint64_t bytes_scanned;
uint64_t bytes_scanned_pcre;
unsigned int regexp_checked;
unsigned int regexp_matched;
unsigned int regexp_total;
unsigned int regexp_fast_cached;
};
/**
* Initialize re_cache persistent structure
*/
struct rspamd_re_cache *rspamd_re_cache_new(void);
/**
* Add the existing regexp to the cache
* @param cache cache object
* @param re regexp object
* @param type type of object
* @param type_data associated data with the type (e.g. header name)
* @param datalen associated data length
* @param lua_cbref optional lua callback reference for matching purposes
*/
rspamd_regexp_t *
rspamd_re_cache_add(struct rspamd_re_cache *cache, rspamd_regexp_t *re,
enum rspamd_re_type type,
gconstpointer type_data, gsize datalen,
int lua_cbref);
/**
* Replace regexp in the cache with another regexp
* @param cache cache object
* @param what re to replace
* @param with regexp object to replace the origin
*/
void rspamd_re_cache_replace(struct rspamd_re_cache *cache,
rspamd_regexp_t *what,
rspamd_regexp_t *with);
/**
* Initialize and optimize re cache structure
*/
void rspamd_re_cache_init(struct rspamd_re_cache *cache,
struct rspamd_config *cfg);
enum rspamd_hyperscan_status {
RSPAMD_HYPERSCAN_UNKNOWN = 0,
RSPAMD_HYPERSCAN_UNSUPPORTED,
RSPAMD_HYPERSCAN_LOADED_PARTIAL,
RSPAMD_HYPERSCAN_LOADED_FULL,
RSPAMD_HYPERSCAN_LOAD_ERROR,
};
/**
* Returns true when hyperscan is loaded
* @param cache
* @return
*/
enum rspamd_hyperscan_status rspamd_re_cache_is_hs_loaded(struct rspamd_re_cache *cache);
/**
* Get runtime data for a cache
*/
struct rspamd_re_runtime *rspamd_re_cache_runtime_new(struct rspamd_re_cache *cache);
/**
* Get runtime statistics
*/
const struct rspamd_re_cache_stat *
rspamd_re_cache_get_stat(struct rspamd_re_runtime *rt);
/**
* Process regexp runtime and return the result for a specific regexp
* @param task task object
* @param rt cache runtime object
* @param re regexp object
* @param type type of object
* @param type_data associated data with the type (e.g. header name)
* @param datalen associated data length
* @param is_strong use case sensitive match when looking for headers
*/
int rspamd_re_cache_process(struct rspamd_task *task,
rspamd_regexp_t *re,
enum rspamd_re_type type,
gconstpointer type_data,
gsize datalen,
gboolean is_strong);
int rspamd_re_cache_process_ffi(void *ptask,
void *pre,
int type,
void *type_data,
int is_strong);
/**
* Destroy runtime data
*/
void rspamd_re_cache_runtime_destroy(struct rspamd_re_runtime *rt);
/**
* Unref re cache
*/
void rspamd_re_cache_unref(struct rspamd_re_cache *cache);
/**
* Retain reference to re cache
*/
struct rspamd_re_cache *rspamd_re_cache_ref(struct rspamd_re_cache *cache);
/**
* Set limit for all regular expressions in the cache, returns previous limit
*/
unsigned int rspamd_re_cache_set_limit(struct rspamd_re_cache *cache, unsigned int limit);
/**
* Convert re type to a human readable string (constant one)
*/
const char *rspamd_re_cache_type_to_string(enum rspamd_re_type type);
/**
* Convert re type string to the type enum
*/
enum rspamd_re_type rspamd_re_cache_type_from_string(const char *str);
struct ev_loop;
/**
* Compile expressions to the hyperscan tree and store in the `cache_dir`
*/
int rspamd_re_cache_compile_hyperscan(struct rspamd_re_cache *cache,
const char *cache_dir,
double max_time,
gboolean silent,
struct ev_loop *event_loop,
void (*cb)(unsigned int ncompiled, GError *err, void *cbd),
void *cbd);
/**
* Returns TRUE if the specified file is valid hyperscan cache
*/
gboolean rspamd_re_cache_is_valid_hyperscan_file(struct rspamd_re_cache *cache,
const char *path,
gboolean silent,
gboolean try_load,
GError **err);
/**
* Loads all hyperscan regexps precompiled
*/
enum rspamd_hyperscan_status rspamd_re_cache_load_hyperscan(
struct rspamd_re_cache *cache,
const char *cache_dir, bool try_load);
/**
* Registers lua selector in the cache
*/
void rspamd_re_cache_add_selector(struct rspamd_re_cache *cache,
const char *sname, int ref);
#ifdef __cplusplus
}
#endif
#endif
|
