db_sqlite: rename database scheme files, to allow automatic updates
[sip-router] / dst_blacklist.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2006 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * ser is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 /** SIP-router core :: Destination blacklists.
24  * @file
25  * @ingroup core
26  * Module: @ref core
27  */
28
29 /* History:
30  * --------
31  *  2006-07-29  created by andrei
32  *  2007-07-30  dst blacklist measurements added (Gergo)
33  *  2009-12-22  blacklist ignore mask support and dst_blacklist_{add,su}
34  *               switched to macros (andrei)
35  */
36
37 #ifndef dst_black_list_h
38 #define dst_black_list_h
39
40 #include "ip_addr.h"
41 #include "parser/msg_parser.h"
42 #include "timer_ticks.h"
43 #include "cfg_core.h"
44
45 #define DEFAULT_BLST_TIMEOUT            60  /**< 1 min. */
46 #define DEFAULT_BLST_MAX_MEM            250 /**< 250 KB */
47
48 /** @name flags: */
49 /*@{ */
50
51 #define BLST_IS_IPV6            1               /**< set if the address is ipv6 */
52 #define BLST_ERR_SEND           (1<<1)  /**< set if  send is denied/failed */
53 #define BLST_ERR_CONNECT        (1<<2)  /**< set if connect failed (tcp/tls) */
54 #define BLST_ICMP_RCVD          (1<<3)  /**< set if icmp error */
55 #define BLST_ERR_TIMEOUT        (1<<4)  /**< set if sip timeout */
56 #define BLST_503                        (1<<5)  /**< set for 503 replies */
57 #define BLST_ADM_PROHIBITED     (1<<6)  /**< administratively prohibited */
58 #define BLST_PERMANENT          (1<<7)  /**< never deleted, never expires */
59 /*@} */
60
61 /* uncomment the define above to enable blacklist callbacks support */
62 /*#define DST_BLACKLIST_HOOKS*/
63
64 #define DST_BLACKLIST_CONTINUE 0 /**< add: do nothing/ignore, search: ignore */
65 #define DST_BLACKLIST_ACCEPT 1   /**< add: force accept, search: force match */
66 #define DST_BLACKLIST_DENY  -1   /**< add: deny, search: force no match */
67
68 #define DST_BLACKLIST_ADD_CB 1
69 #define DST_BLACKLIST_SEARCH_CB 2
70
71
72 extern unsigned blst_proto_imask[PROTO_LAST+1];
73
74 #ifdef DST_BLACKLIST_HOOKS
75 struct blacklist_hook{
76         /* WARNING: msg might be NULL, and it might point to shared memory
77          * without locking, do not modify it! msg can be used typically for checking
78          * the message flags with isflagset() */
79         int (*on_blst_action)(struct dest_info* si, unsigned char* err_flags,
80                                                         struct sip_msg* msg);
81         /* called before ser shutdown */
82         void (*destroy)(void);
83 };
84
85 int register_blacklist_hook(struct blacklist_hook *h, int type);
86 #endif /* DST_BLACKLIST_HOOKS */
87
88 int init_dst_blacklist();
89 #ifdef USE_DST_BLACKLIST_STATS
90 int init_dst_blacklist_stats(int iproc_num);
91 #define DST_BLACKLIST_ALL_STATS "bkl_all_stats"
92 #endif
93 void destroy_dst_blacklist();
94
95
96 /** force add to the blacklist.
97  * like @function dst_blacklist_add_to, but no ignore mask or
98  * blacklist enabled checks are made.
99  * @see dst_blacklist_add_to for the parameters and return value.
100  */
101 int dst_blacklist_force_add_to(unsigned char err_flags, struct dest_info* si,
102                                                                 struct sip_msg* msg, ticks_t timeout);
103
104 /** force add to the blacklist, long version.
105  * like @function dst_blacklist_su_to, but no ignore mask or
106  * blacklist enabled checks are made.
107  * @see dst_blacklist_su_to for the parameters and return value.
108  */
109 int dst_blacklist_force_su_to(  unsigned char err_flags,
110                                                                 unsigned char proto,
111                                                                 union sockaddr_union* dst,
112                                                                 struct sip_msg* msg,
113                                                                 ticks_t timeout);
114
115
116 /** checks if blacklist should be used.
117   * @param  err_flags - blacklist reason
118   * @param si - filled dest_info structure pointer.
119   * @return 1 if blacklist is enabled (core_cfg) and the event/error
120   *           is not in the ignore list.
121   *         0 otherwise
122   */
123 #define should_blacklist(err_flags, si) \
124         (cfg_get(core, core_cfg, use_dst_blacklist) && \
125                 ((err_flags) & ~blst_proto_imask[(unsigned)((si)->proto)] & \
126                                            ~(si)->send_flags.blst_imask ))
127
128
129 /** checks if blacklist should be used, long version.
130   * @param  err_flags - blacklist reason
131   * @param snd_flags - snd_flags pointer, can be 0.
132   * @param proto - protocol, can be 0 (PROTO_NONE).
133   * @param si  - sockaddr_union pointer, can be 0.
134   * @return 1 if blacklist is enabled (core_cfg) and the event/error
135   *           is not in the ignore list.
136   *         0 otherwise
137   */
138 #define should_blacklist_su(err_flags, snd_flags, proto, su) \
139         (cfg_get(core, core_cfg, use_dst_blacklist) && \
140                 ((err_flags) & ~blst_proto_imask[(unsigned)(proto)] & \
141                                         ~((snd_flags)?((snd_flags_t*)(snd_flags))->blst_imask:0)))
142
143
144 /** adds a dst to the blacklist.
145  *
146  * @param  err_flags - blacklist reason
147  * @param si  - dest_info structure (dst).
148  * @param msg - sip msg struct. pointer if known, 0 otherwise.
149  * @param timeout - timeout in ticks.
150  * @return >=0 on success, -1 on error.
151  */
152 #define dst_blacklist_add_to(err_flags, si, msg, timeout) \
153         (should_blacklist(err_flags, si)? \
154                 dst_blacklist_force_add_to((err_flags), (si), (msg), (timeout))\
155                 : 0)
156
157
158 /** adds a dst to the blacklist, long version.
159  * Similar to dst_blacklist_add_to, but uses "unpacked" parameters.
160  * @param  err_flags - blacklist reason
161  * @param proto - protocol.
162  * @param dst  - sockaddr_union pointer.
163  * @param snd_flags - snd_flags pointer, can be 0.
164  * @param msg - sip msg struct. pointer if known, 0 otherwise.
165  * @param timeout - timeout in ticks.
166  * @return >=0 on success, -1 on error.
167  */
168 #define dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, timeout) \
169         (should_blacklist_su(err_flags, snd_flags, proto, dst) ? \
170                 dst_blacklist_force_su_to((err_flags), (proto), (dst), (msg), \
171                                                                         (timeout))\
172                 : 0)
173
174
175 /** adds a dst to the blacklist with default timeout.
176  *
177  * @param  err_flags - blacklist reason
178  * @param si  - dest_info structure (dst).
179  * @param msg - sip msg struct. pointer if known, 0 otherwise.
180  * @return >=0 on success, -1 on error.
181  * @see dst_blacklist_add_to.
182  */
183 #define dst_blacklist_add(err_flags, si, msg) \
184         dst_blacklist_add_to(err_flags, si, msg, \
185                                                         S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))
186
187
188 /** adds a dst to the blacklist with default timeout, long version.
189  * Similar to dst_blacklist_add_to, but uses "unpacked" parameters.
190  * @param  err_flags - blacklist reason
191  * @param proto - protocol.
192  * @param dst  - sockaddr_union pointer.
193  * @param snd_flags - snd_flags pointer, can be 0.
194  * @param msg - sip msg struct. pointer if known, 0 otherwise.
195  * @return >=0 on success, -1 on error.
196  * @see dst_blacklist_su_to.
197  */
198 #define dst_blacklist_su(err_flags, proto, dst, snd_flags, msg) \
199         dst_blacklist_su_to(err_flags, proto, dst, snd_flags, msg, \
200                                                         S_TO_TICKS(cfg_get(core, core_cfg, blst_timeout)))
201
202 int dst_is_blacklisted(struct dest_info* si, struct sip_msg* msg);
203
204 /** delete an entry from the blacklist. */
205 int dst_blacklist_del(struct dest_info* si, struct sip_msg* msg);
206
207 /** deletes all the entries from the blacklist except the permanent ones.
208  * (which are marked with BLST_PERMANENT)
209  */
210 void dst_blst_flush(void);
211
212 int use_dst_blacklist_fixup(void *handle, str *gname, str *name, void **val);
213
214 /** KByte to Byte conversion. */
215 int blst_max_mem_fixup(void *handle, str *gname, str *name, void **val);
216
217 void blst_reinit_ign_masks(str* gname, str* name);
218
219 #endif