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