9f44a40a587b348e74831b15b89e2838d34f932f
[sip-router] / NEWS
1 Release notes for SIP Express Router (ser)
2 ***********************************************
3
4 $Id$
5
6
7
8 2.1.0 changes
9
10 modules:
11  - textops   - functions:
12                         - remove_hf_re("regexp") -- filter message headers out
13                           by matching the header name field against a regular
14                           expression.
15  - avp       - export new selects table to allow dissecting the content of an
16                attribute by interpreting it as a "name-addr" value 
17  - auth      - experimental support for one-time nonces: when enabled a nonce
18                will be accepted only for one response (each new request will
19                be challenged). See one_time_nonce.
20              - experimental support for nc checking when qop=auth
21                (fast, non-locking implementation, see nonce_count, 
22                 nc_array_size, nc_array_order and nid_pool_no) 
23              - switched to base64 nonces
24              - record nonce generation time inside the nonce so that a 
25                received nonce can be checked against ser start time
26                (if older => stale). This allows gracefully handling ser
27                restarts with different auth configs.
28              - added extra authentication checks support, to protect
29                against various reply attacks.
30              - params:
31                        - nonce_auth_max_drift - maximum difference in seconds
32                           from the current time, if a nonce appears to be
33                           created in the future (if exceeded the nonce is 
34                           considered stale).
35                        - one_time_nonce - if enabled each nonce is allowed 
36                           only once => each new request (including 
37                           retransmissions!) will be challenged. It should be
38                           used only in stateful mode (so that tm deals with
39                           the retransmissions). The major disadvantage is that
40                           the UA won't be able to used any cached credentials
41                           (=> extra messages, extra round trips, more work for
42                            the proxy)
43                        - otn_in_flight_no - maximum number of in-flight nonces
44                           for one-time-nonces. It must be a number of the form
45                           2^k (if not it will be automatically rounded down).
46                           The memory used will be otn_in_flight_no/8
47                        - otn_in_flight_order - like otn_in_flight_no, but 
48                           instead of specifying the number as 2^k, it directly
49                           sets k (otn_in_flight_no=2^otn_in_flight_order)
50                        - nonce_count - if enabled and qop=auth or 
51                           qop=auth-int, store and check received nc values
52                           (for details see rfc2617 and auth/doc). It should be
53                           used only in stateful mode (so that tm deals with
54                           the retransmissions which would otherwise be 
55                           challenged). The major advantage is greatly 
56                           enhanced security (extremely small probability of
57                           a succesfull replay attack) combine with support
58                           for cached credentials (if the UAs do support qop 
59                           and auth)
60                        - nc_array_size - size of the array used for storing
61                           nc values, default 1Mb. It will be rounded down to
62                           a 2^k value. It represents the maximum number of
63                           in-flight nonces supported
64                        - nc_array_order - equivalent to nc_array_size, but 
65                           instead of specifying the size in bytes, it can 
66                           be used to directly set the power of 2 used
67                           (nc_array_size=2^nc_array_order)
68                        - nid_pool_no - number of nc and one-time-nonce array 
69                           and index partitions, useful for increasing 
70                           performance on multi-cpu systems (default 1,
71                           recommended 4)
72                        - auth_checks_register, auth_checks_no_dlg, 
73                          auth_checks_in_dlg - flags specifying which extra
74                           message part/parts will be checked for change before
75                           allowing nonce reuse. See the auth module docs for
76                           for more information (modules/auth/README).
77  - blst      - new module containing script blacklist manipulations functions
78                (the source of a message can be blacklisted, removed from the
79                 blacklist or checked for presence in the blacklist).
80  - tm        - added t_reset_fr(), t_reset_retr(), t_reset_max_lifetime()
81              - t_relay_to renamed to t_relay_to_avp (undocumented function)
82              - t_relay() can now also take host and port parameters (e.g.
83                t_relay(host, port)), behaving like a statefull 
84                forwad(host, port) version (forward to host:port using the same
85                protocol on which the message was received)
86              - t_relay_to_udp(), t_relay_to_tcp() and t_relay_to_tls() work
87                now even with no parameters: in this case the message is 
88                forwarded using the request uri, but with the specified protocol
89                (equivalent to a t_relay() with a forced protocol)
90              - method for canceling unreplied branches can now be selected
91                using the new cancel_b_method tm parameter.
92              - support for adding a 503 reply source to the blacklist for
93                the time specified in the Retry-After header (see the new tm
94                parameters blst_503, blst_503_def_timeout, blst_503_min_timeout
95                and blst_503_max_timeout).
96              - different error replies for too many branches (500 but with
97                different text), resolve error (478) or send error
98                (477).
99              - tm can be configured not to automatically send 100 replies
100                for invites either globally (see the auto_inv_100 parameter)
101                or on a per transaction basis (see t_set_auto_inv_100(...))
102              - t_relay* error reply are delayed till the end of the script
103                to allow the script writer to overwrite them
104              - branches are always canceled hop by hop
105              - cancels for silently canceled branches (no replies ever 
106                received) are automatically generated if later a provisional
107                reply arrives on such a branch
108              - noisy_ctimer is now 1 (on) by default
109              - added maximum transaction lifetime - a transaction is not
110                allowed to be active longer then this interval. See
111                t_set_max_lifetime(), max_inv_lifetime and max_noninv_lifetime.
112              - support for changing the retransmission intervals on the fly,
113                on a per transaction basis (it is enabled if tm is compiled
114                with -DTM_DIFF_RT_TIMEOUT -- default): t_set_retr(t1, t2).
115              - transaction are deleted the moment they are not referenced 
116                anymore (removed the need for the delete timer) -- this 
117                should improve memory usage on very busy proxies.
118              - lots of callbacks added
119              - new onsend callbacks support (require defining TMCB_ONSEND prior
120                to compiling tm)
121              - behaviour when receiving a CANCEL which doesn't match any 
122                transaction can be selected using the unmatched_cancel param.
123              - params: 
124                         - cancel_b_method - selects one of the three methods
125                           for dealing with unreplied branches when the 
126                           transaction must be canceled. The possible values
127                           are 0 (old behaviour) for stopping request 
128                           retransmission on the branch and act as if 
129                           the branch was immediately replied with a 487,
130                           1 for continuing to retransmit the request until an
131                           answer is received or the timeout kicks in (default)
132                           and
133                           2 for stopping the request retransmission and sending
134                           CANCEL on the branch (not rfc conforming).
135                           For more information see tm docs.
136                         - blst_503 - if set and if the blacklist is used
137                           (use_dst_blacklist=1), add the source of a 503 reply
138                           to the blacklist
139                         - blst_503_def_timeout - if the Retry-After header from
140                           a 503 reply is missing, use this value for the 
141                           blacklist timeout (in s). Depends on blst_503.
142                           The default value is 0 ( do not blacklist if no
143                           Retry-After is present).
144                         - blst_503_min_timeot (in s) - if the 503 reply 
145                           Retry-After header value is less, use this value
146                           for the blacklist timeout. Depends on blst_503.
147                           The default value is 0.
148                         - blst_503_max_timeout (in s) - if the 503 reply 
149                           Retry-After header value is greater, use this value
150                           instead. Depends on blst_503.
151                           The default value is 3600 s.
152                         - auto_inv_100 - if set (default) tm will automatically
153                           send an 100 reply to INVITEs (see also 
154                          t_set_auto_inv_100())
155                         - noisy_ctimer is now 1 by default
156                         - max_inv_lifetime & max_noninv_lifetime - default
157                           maximum lifetimes for an invite or non-invite 
158                           transaction. After this interval has passed from 
159                           the transaction creation the transaction will be 
160                           either switched into the wait state or in the
161                           final response retransmission state => a transaction
162                           will be kept in memory for maximum: 
163                            max_*inv_lifetime + fr_timer /*ack w.*/ +wait_timer.
164                         - unmatched_cancel - selects between forwarding cancels
165                            that do not match any transaction statefully (0, 
166                            default value), statelessly (1) or dropping them
167                            (2). Note that the statefull forwarding has an 
168                            additional hidden advantage: tm will be able to
169                            recognize INVITEs that arrive after their CANCEL.
170                            Note also that this feature could be used to try
171                            a memory exhaustion DOS attack against a proxy that
172                            authenticates all requests, by continuously flooding
173                            the victim with CANCELs to random destinations 
174                            (since the CANCEL cannot be authenticated, each
175                            received bogus CANCEL will create a new transaction 
176                            that will live by default 30s).
177              - functions:
178                         - t_reset_fr() -- resets the current transaction 
179                           fr_inv_timer and fr_timer to the default values
180                           (set via the tm modparams fr_inv_timer and fr_timer).
181                         - t_reset_retr() -- resets the current transaction
182                           retransmission intervals on the fly, to the default
183                           values (set via the tm modparams retr_timer1 and 
184                           retr_timer2).
185                         - t_reset_max_lifetime() -- resets the current 
186                           transaction maximum lifetime to the default value
187                           (set via the tm  modparam max_inv_lifetime or 
188                            max_noninv_lifetime).
189                         - t_grep_status("code") -- returns true if any branch
190                           received code as the final reply (or if no final 
191                           reply was yet received, but a "code" provisional 
192                           reply).
193                         - t_set_auto_inv_100(on/off) - switch automatically
194                           sending 100 replies to INVITEs on/off on a per
195                           transaction basis. It overrides the tm param.
196                           auto_inv_100.
197                         - t_set_max_lifetime(inv, noninv) - changes the 
198                           maximum transaction lifetime on the fly, for the
199                           current or next to be created transaction.
200                         - t_set_retr(t1, t2) - changes the retransmissions
201                            intervals on the fly, on a per transaction basis.
202 core:
203              - partial cygwin (windows) support revived: core+static modules, 
204                no ipv6, no tcp, no dynamic modules
205              - most of the config variables can now be changed on the fly,
206                without ser restart  (migration work in progress)
207              - tcp improvements (better tcp timers, send fd cache, special
208                 options support)
209              - dns naptr support (see dns_try_naptr and dns_<proto>_pref)
210              - dns srv based load balancing support (see dns_srv_lb)
211              - support for locking ser's pages in memory, pre-mapping
212                all the shared memory on startup (fill it with 0)
213              - real time options
214              - devel: new PROC_INIT rank, init_child(PROC_INIT) called first
215              - futex support on linux (better behaviour when waiting on 
216                long held locks, almost no performance impact otherwise)
217              - when dns search list was used for resolution, store the "link"
218                between the short name and long name in cache as CNAME record
219
220 new config variables:
221   server_id = number - A configurable unique server id that can be used to
222                        discriminate server instances within a cluster of
223                        servers when all other information, such as IP adddresses
224                        are same.
225   loadpath = <modules path> - directory where to load the modules from (-L
226      equivalent); modules can be loaded simply by specifying their name
227      (loadmodule "maxfwd")
228   tcp_fd_cache = yes | no (default yes) - if enabled FDs used for sending
229      will be cached inside the process calling tcp_send (performance increase
230      for sending over tcp at the cost of slightly slower connection closing and
231      extra FDs kept open)
232   tcp_buf_write = yes | no (default no) - if enabled all the tcp  writes that 
233      would block / wait for connect to finish, will be queued and attempted
234      latter (see also tcp_conn_wq_max and tcp_wq_max).
235   tcp_conn_wq_max = bytes (default 32 K) - maximum bytes queued for write 
236      allowed per connection. Attempting to queue more bytes would result
237      in an error and in the connection being closed (too slow). If 
238      tcp_write_buf is not enabled, it has no effect.
239   tcp_wq_max = bytes (default 10 Mb) - maximum bytes queued for write allowed
240      globally. It has no effect if tcp_write_buf is not enabled.
241   tcp_defer_accept =  yes | no (default no) on freebsd  / number of seconds
242         before timeout on linux (default disabled) - tcp accepts will be 
243         delayed until some data is received (improves performance on proxies
244         with lots of opened tcp connections). See linux tcp(7) TCP_DEFER_ACCEPT
245         or freebsd ACCF_DATA(0). For now linux and freebsd only.
246         WARNING: the  linux TCP_DEFER_ACCEPT is buggy (<=2.6.23) and doesn't 
247          work exactly as expected (if no data is received it will retransmit 
248          syn acks for ~ 190 s, irrespective of the set timeout and then it will
249          silently drop the connection without sending a RST or FIN). Try to 
250          use it together with tcp_syncnt (this way the number of retrans.
251           SYNACKs can be limited => the timeout can be controlled in some way).
252   tcp_delayed_ack  = yes | no (default yes when supported) - initial ACK for
253         opened connections will be delayed and sent with the first data
254         segment (see linux tcp(7) TCP_QUICKACK). For now linux only.
255   tcp_syncnt = number of syn retr. (default not set) - number of SYN 
256         retransmissions before aborting a connect attempt (see linux tcp(7)
257         TCP_SYNCNT). Linux only.
258   tcp_linger2 = seconds (not set by default) - lifetime of orphaned sockets
259         in FIN_WAIT2 state (overrides tcp_fin_timeout on, see linux tcp(7) 
260         TCP_LINGER2). Linux only.
261   tcp_keepalive = yes | no (default yes) - enables keepalive for tcp.
262   tcp_keepidle  = seconds (not set by default) - time before starting to send
263          keepalives, if the connection is idle. Linux only.
264   tcp_keepintvl = seconds (not set by default) - time interval between 
265          keepalive probes, when the previous probe failed. Linux only.
266   tcp_keepcnt = number (not set by default) - number of keepalives sent before
267          dropping the connection. Linux only.
268   tcp_crlf_ping = yes | no (set by default) - enable CRLF keepalives aka
269          SIP outbound.
270   pmtu_discovery = 0 | 1 (default 0) - set DF bit in outbound IP if enabled
271   dns_srv_lb = yes | no (default no) - enable dns srv weight based load 
272     balancing (see doc/dns.txt)
273   dns_try_naptr = yes | no (default no) - enable naptr support 
274     (see doc/dns.txt for more info)
275   dns_{udp,tcp,tls}_pref = number - ser preference for each protocol when
276     doing naptr lookups. By default dns_udp_pref=3, dns_tcp_pref=2 and 
277     dns_tls_pref=1. To use the remote site preferences set all dns_*_pref to 
278     the same positive value (e.g. dns_udp_pref=1, dns_tcp_pref=1, 
279     dns_udp_pref=1). To completely ignore NAPTR records for a specific 
280     protocol, set the corresponding protocol preference to -1 (or any other 
281     negative number).  (see doc/dns.txt for more info)
282   dns_search_full_match = yes | no (default yes) - when name was resolved using
283     dns search list, check the domain added in the answer matches with one from
284     the search list (small performance hit, but more safe)
285   mlock_pages = yes |no (default no) - locks all ser pages into memory making 
286     it unswappable (in general one doesn't want his sip proxy swapped out :-))
287   shm_force_alloc = yes | no (default no) - tries to pre-fault all the 
288     shared memory, before starting. When on start time will increase, but
289     combined with mlock_pages will guarantee ser will get all its memory from
290     the beginning (no more kswapd slow downs)
291   real_time = <int> (flags) (default off). - sets real time priority
292      for all the ser processes, or the timers. 
293      Possible values:   0  - off
294                         1  - the "fast" timer
295                         2  - the "slow" timer
296                         4  - all processes, except the timers
297      Example: real_time= 7 => everything switched to real time priority.
298   rt_prio = <int> (default 0) - real time priority used for everything except
299      the timers, if real_time is enabled
300   rt_policy= <0..3> (default 0)- real time scheduling policy, 0 = SCHED_OTHER,
301      1= SCHED_RR and 2=SCHED_FIFO
302   rt_timer1_prio=<int> (default 0) - like rt_prio but for the "fast" timer
303      process (if real_time & 1)
304   rt_timer1_policy=<0..3> (default 0) - like rt_policy but for the "fast" timer
305   rt_timer2_prio=<int> (default 0) - like rt_prio but for the "slow" timer
306   rt_timer2_policy=<0..3> (default 0) - like rt_policy but for the "slow" timer
307   tcp_source_ipv4 = IPv4 address
308   tcp_source_ipv6 = IPv6 address
309     Set the given source IP for all outbound TCP connections.
310     If setting the IP fails the TCP connection will use the default.
311   dns_cache_init = on | off (default on) - if off, the dns cache is not
312     initialized at startup and cannot be enabled runtime, that saves some
313     memory.
314   dst_blacklist_init = on | off (default on) - if off, the blacklist
315     is not initialized at startup and cannot be enabled runtime,
316     that saves some memory.
317
318 build system:
319  - check defines and includes used at compile time and if different 
320    force rebuilding everything in the current dir (creates a new file: 
321    makecfg.lst that stores the compile defines & includes used at compile 
322    time)
323  - make cfg / config support: store the build config in an autogenerated file 
324    (config.mak) and use it for future compiles (e.g.: 
325    make cfg include_modules=mysql skip_modules=print CPU=pentium-m; make all).
326    Main advantages are easier usage and faster builds (e.g. make proper is
327     +16 times faster, make clean ~9 times, make with previously generated
328     config is 2.6 times faster and a make that has nothing to do is ~9 times
329     faster).
330
331
332
333
334 2.0.0 changes
335
336
337 new archs:
338
339
340 modules:
341  - tls        - new module that enables tls support (set enable_tls=yes
342                 in the config file and load the tls module)
343  - ctl        - new  fifo/unixsocket/xmlrpc like module, using a space 
344                 efficient binary encoding for the requests.
345                 It supports multiple clients on tcp, udp, unix stream or
346                 unix datagram modes. By default (no modparams) it opens
347                 one unix stream control socket in /tmp/ser_ctl.
348                 It also includes extended fifo support: multiple fifos,
349                 fifo over tcp, udp and unix sockets (see ctl/ctl.cfg).
350                 Use utils/sercmd/sercmd to send commands to it.
351  - dispatcher - added hashing after request uri and to uri
352               - added a new flag parameter which can be used (for now) to
353                 select only the username or the username, host and port when
354                 hashing after an uri (to, from or request uri)
355               - improved uri hashing (password is ignored, port is used only
356                 if != 5060 or 5061)
357  - tm        - aggregate challenges (WWW/Proxy-Authenticate) from all the
358                401 & 407 if the final reply is a 401/407. To turn this off
359                and fall back to the old behaviour set tm aggregate_challenges
360                parameter to 0.
361              - if a relayed 503 is the final reply, replace it by a 500
362              - if a 503 reply is received try the dns based failover
363                (forward to another ip if the original destination uri 
364                 resolved to several SRV, A or AAAA records)
365              - on 6xx immediately cancel all the branches for which a 
366                provisional response was received and wait for all the 
367                branches to finish (either timeout, the 487 from the CANCEL
368                or a final response still on the wire in the moment the
369                CANCEL was sent)
370              - better final reply selection: 6xx is preferred over other 
371                negative replies; from several 4xx prefer 401, 407, 415, 420,
372                484 (in this order). For all the other cases, return the lowest
373                code (as before)
374              - special functions for checking for timeout, if a reply was
375                received or if the current transaction was canceled
376              - dns failover and dst blacklist support
377              - migrated to the new timers (tm timers completely rewritten)
378              - improved speed and less memory usage
379              - much more precise retransmissions timing
380              - params: - retr_timer1p1, retr_timer1p2, retr_timer1p3 removed
381                          and replaced by retr_timer1 and retr_timer2
382                        - all timer values are now expressed in milliseconds
383                          (they were in seconds before).
384                          Affected params: fr_timer, fr_inv_timer, wt_timer,
385                          delete_timer, retr_timer1, retr_timer2
386                        - retr_timer1 (first retransmission) changed to 500 ms
387                        - delete_timer changed to 200 ms
388                        - unix_tx_timeout expressed now in milliseconds; default
389                          value changed to 500 ms
390              - functions:
391                        - t_branch_timeout() -- returns true if the failure
392                          route is executed for a branch that did timeout
393                          (failure_route only).
394                        - t_branch_replied() -- returns true if the failure 
395                          route is executed for a branch that did receive at
396                          least one reply in the past (the current reply 
397                           is not taken into account). It can be used
398                          together with t_branch_timeout() to distinguish 
399                          between a remote side that doesn't respond (some 
400                          provisional reply received) and one that is completely
401                           dead. (failure_route only)
402                        - t_any_timeout() -- returns true if any of the current
403                          transaction branches did timeout.
404                        - t_any_replied() -- returns true if at least one branch
405                           of the current transaction received one reply in the
406                           past. If called from a failure_route or an
407                           onreply_route, the "current" reply is not taken into
408                           account.
409                        - t_is_canceled() -- returns true if the current 
410                          transaction  has been canceled.
411                        - new t_set_fr(timeout_fr_inv, timeout_fr) -- allows
412                          changing the transaction timer from script, even if
413                          the transaction was already created (see tm docs for
414                          more).
415             - t_relay will not stop script execution anymore in case of
416               send error
417  - textops  - search() can be used in the onsend_route where it will search
418               on the "new" message (after applying all script changes, adding
419               Vias a.s.o) and not on the original message
420  
421 core:
422  - compiled by default with tls hooks support (so that no recompile is
423    needed before loading the tls module and enabling the tls support)
424  -  enable_tls config option added (the reverse of disable_tls)
425  - added STUN keep-alive functionality in accordance with 
426    draft-ietf-behave-rfc3489bis-04.txt
427  - dns cache and dns failover support added (see doc/dns.txt)
428  - destination blacklist added -- destinations to which forwarding fails
429    (send error, tm timeout a.s.o) are temporarily added to a blacklist which 
430     is consulted before each send => faster send error detection
431     in the near future (see doc/dst_blacklist.txt)
432  - default log level switched to 0 (only messages < L_WARN will be printed
433    by default)
434  - separate memdbg log level which controls the memory/malloc related
435    debug messages (to see them ser must be compiled with malloc debuging:
436      -DDBG_QM_MALLOC or -DDBG_FM_MALLOC and memdbg must be <= debug )
437  - added named routes: names can be used instead of numbers in all the
438    route commads or route declarations. route(number) is equivalent to
439    route("number").
440    Example:
441      route("test");
442       route["test"]{
443            ...
444      }
445  - added named flags, declared at the beginning of the config file with:
446      flags  flag1_name[:position],  flag2_name ...
447    Example:
448        flags test, a:1, b:2 ;
449        route{
450               setflag(test);
451               if (isflagset(a)){ # equiv. to isflagset(1)
452                 ....
453               }
454               resetflag(b);  # equiv. to resetflag(2) 
455  - added return [val] which returns from a route. if no value is specified, or
456    a route reaches its end without executing a return statement, it returns 1.
457    If return is used in the top level route is equivalent with exit [val].
458  - drop /exit [n] now will end the script execution
459    exit n will exit with code n (usefull in onreply/onsend routes where
460    if script code !=0 a reply is generated/the message is sent or to force
461    script errors)
462  - added $? which can be used to check the return code of the last executed
463    route{} (e.g. route(1); if ($?==1){ /* ... */}else if ($?==2) ... )
464  - onsend_route added: special route executed before a request is sent.
465                        Only a limited number of commands are allowed (drop, if
466                        + all the checks, msg flag manipulations, send(), log(),
467                        textops::search()). In this route the final destination
468                        of the message is available an can be checked (with
469                        snd_ip, snd_port, to_ip, to_port, snd_proto, snd_af).
470                        This route is executed only when forwarding requests.
471                        It's not executed for replies, retransmissions, or
472                        locally generated messages (e.g. via fifo uac).
473       short example:
474             onsend_route{  if(to_ip==1.2.3.4 && !isflagset(12)){
475                               log(1, "message blocked\n");
476                               drop;
477                            }
478                          }
479  - onsend_route specific checks:
480      - snd_ip, snd_port - behave like src_ip/src_port, but contain the
481        ip/port ser will use to send the message
482      - to_ip, to_port - like above, but contain the ip/port the message will
483        be sent to (not to be confused with dst_ip/dst-port, which are the
484        destination of the original message: ser's ip and port on which the
485        message was received)
486      - snd_proto, snd_af - behave like proto/af but contain the 
487        protocol/address family that ser will use to send the message
488      - msg:len - when used in an onsend_route, msg:len will contain the length
489        of the message on the wire (after all the changes in the script are
490        applied, Vias are added a.s.o) and not the lentgh of the original 
491        message
492  - timer: - improved performance/precision, new api, see doc/timers.txt 
493  - tcp: - improved  performance (io event handling), using OS specific
494            optimizations
495         - 1024 connections limit removed (see tcp_max_connections)
496 -  resolver: - timeouts, retries a.s.o can now be set from ser.cfg
497              (see below dns_* and man resolv.conf(6)).
498              The maximum time a dns request can take (before failing) is:
499               (dns_retr_time*dns_retr_no)*(search_list_domains)
500              If dns_try_ipv6 is yes, mutliply it again by 2.
501              The fastest possible dns config (max 1s):
502                 dns_try_ipv6=no
503                 dns_retr_time=1
504                 dns_retr_no=1
505                 dns_use_search_list=no
506 - default on reply route added: onreply_route {.. } will add a default 
507     onreply route that will be executed for any reply (usefull to catch
508     replies without using tm)
509 - branch_routes added (tm triggered), only a very limited number of commands
510    are available (see tm docs)
511 - avps directly accessible from script with %avp_name (variable style)
512 new config variables:
513    enable_tls/disable_tls = enable/disable tls support, default disable.
514        Note: a tls "engine" is still needed (e.g. the tls module must
515               be loaded, enable_tls by itself is not enough).
516    exit_timeout = seconds - how much time ser will wait for all the shutdown
517        procedures to complete. If this time is exceeded, all the remaining
518        processes are immediately killed and ser exits immediately (it might
519        also generate a core dump if the cleanup part takes too long).
520        Default: 60 s. Use 0 to disable.
521    stun_refresh_interval = number in millisecond (default 0); value for 
522       attribute REFRESH INTERVAL
523    stun_allow_stun = 0 | 1 (off | on - default 1); use STUN or not if compiled
524    stun_allow_fp = 0 | 1 (off | on - default 1); use FINGERPRINT attribute
525    use_dns_cache = on | off  (default on)  
526    use_dns_failover = on | off (default off)
527    dns_cache_flags = number (default 0)
528    dns_cache_negative_ttl = number in seconds (default 60)
529    dns_cache_min_ttl = time in seconds (default 0)
530    dns_cache_max_ttl = time in seconds (default MAXINT)
531    dns_cache_mem = maximum memory used for the dns cache in Kb (default 500 K)
532    dns_cache_gc_interval = interval in seconds after which the dns cache is
533       garbage collected (default: 120 s)
534    use_dst_blacklist = on | off (default off)
535    dst_blacklist_expire = time in s (default 60)
536    dst_blacklist_mem = maximum memory used for the blacklist in Kb (default 250
537       K)
538    dst_blacklist_gc_interval = interval in seconds after which the destination 
539       blacklist is garbage collected (default 60)
540    tos = number  - ip type of service (TOS) value
541    dns_try_ipv6 = yes/no - if yes and a dns lookup fails, it will retry it
542       for ipv6 (AAAA record). Default: yes
543    dns_retr_time = time - time in s before retrying a dns request.
544       Default: system specific, depends also on the/etc/resolv.conf content
545       (usually 5s).
546    dns_retr_no = no. - number of dns retransmissions before giving up.
547       Default: see above (usually 4)
548    dns_servers_no = no. - how many dns servers from the ones defined in 
549       /etc/resolv.conf will be used. Default: all of them.
550    dns_use_search_list= yes/no - if no, the search list in /etc/resolv.conf
551       will be ignored (=> fewer lookups => gives up faster). Default: yes.
552       HINT: even if you don't have a search list defined, setting this option
553       to "no" will still be "faster", because an empty search list is in 
554       fact search "" (so even if the search list is empty/missing there will
555       still be 2 dns queries, eg. foo+'.' and foo+""+'.')
556    tcp_connection_lifetime = value (s) - how long the lifetime of a
557       tcp connection will be exteneded after an IO event (accept, connect, 
558       read, write). Default: 120 s.
559    tcp_poll_method = poll|select|epoll_et|epoll-lt|kqueue|devpoll - poll
560       method used (by default the best one for the current OS is selected)
561    tcp_max_connections = no. - maximum number of tcp connections (if the number
562       is exceeded no new tcp connections will be accepted). Default: 2048.
563
564 tools:
565   utils/sercmd - command line serctl like tool for interrogating ser ctl
566                  module (uses the binrpc encoding). Supports various
567                  connection methods (udp, tcp, unix stream & datagram sockets),
568                  reply formating (see -f, e.g. sercmd -f "pid:%v %v\n" core.ps)
569                  , interactive mode, command line completion (if compiled with 
570                  libreadline) a.s.o.
571
572 WARNING: - older 0.10.99-dev version (< 0.10.99-dev46) returned a 480 reply
573  on invite transaction timeout, if a provisional reply was received. Newer
574  versions reverted to returning 408 on all timeouts (one can use 
575   t_branch_timeout() and t_branch_replied() to distinguish between the two
576   timeout types)
577
578
579
580 0.9.4 fixes/improvements (0.9.4 is a bug fix release for 0.9.3)
581  
582 general:
583  - gcc 4.0 support
584  - mutlicast options are set for all the sockets
585  - mediaproxy: memory leak, unchecked memory allocations
586  - postgress: some bugs and cleanups (compiles cleanly now)
587  - tm: shm cloned lumps (SER-55) 
588  - tm: t_fifo: 64-bit fix
589  - tm: dst_uri clone fix
590  - tm: t_newtran/t_restransmit* races  (!)
591  - usloc: memory leak
592
593 solaris:
594  - serctl, better ISA detection, signals
595 *bsd:
596  - multicast options are properly set
597 openbsd:
598  - tcp 64 bit fix
599
600
601
602 0.9.3 changes
603
604
605 new archs:
606  - alpha experimental support
607  - mips2/cobalt experimental support
608  - x86_64 support
609  - OS X (darwin) support
610  - sparc32 single cpu highly experimental support
611  - ppc64 support
612
613 modules:
614  - enum - support for more than one NAPTR
615  - msilo - explicit multidomain support -- recipient's user ID is stored in
616    the columns username and domain -- r_uri column kept for compatibility
617    reasons (will be removed in future) but not filled by this version of
618    module
619  - mysql - implements a connection pool, all modules will use same connection
620    to access the database
621  - nathelper received port  test (flag 16 for nat_uac_test): compares the
622    source port of the message with sip port in the first Via and returns
623    true if different.
624  - permsions - support for multiple allow/deny files, allow_register function
625  - TM has a new parameter: restart_fr_on_each_reply. If set (default)
626    fr_inv timer will be restarted for each provisional reply, if not set
627    it will be restarted only for the first reply and for replies >=180
628    (but only if increasing, eg.: 180, 181 ...). Usefull when dealing with bad
629    UAs that re-transmit 180s.
630  - TM saves the avp list into transactions, and make it available into
631    callbacks, failure and reply routes.
632  - TM contains new command - t_write_unix("/tmp/sems.sock", "announcement")
633    sends a message using unix socket interface instead of FIFO interface.
634  - TM contains new config variable - unix_tx_timeout -- it specifies the
635    transmit timeout of t_write_sock
636  - VM functionality was transfered into TM module. Instead of fetching the
637    email value from DB (as VM), TM looks for the "email" attribute to get the
638    value.
639    vm() function was replaced with t_write_req()
640    vm_reply() fifo functions was replcated by TM with t_reply() fifo function
641    NOTE!! because current version of SEMS/AA try to send reply via vm_reply,
642    it will not work with the TM version.
643  - xlog - printing the body of any header by specifying the name; new
644    specifiers for user-agent, message buffer, message length, message's flags,
645    message id.
646
647 new modules:
648  - avp / avp_db / avp_radius - load and check avps per caller or callee
649  - avpops - flexible module for operations with avps and database, introducing
650    a pseudo-varible support in SER configuration file
651  - cpl-c - implementation of Call Processing Language
652  - dispatcher - implements a dispatcher for incoming requests using hashes
653    over parts of the request to select the destination
654  - diversion - implements the Diversion extensions as per 
655    draft-levy-sip-diversion-08
656  - flatstore - simple module that implements very fast inserts for accounting
657    purposes
658  - gflags - keeps a bitmap of flags in shared memory and may be used to change
659    behaviour of server based on value of the flags
660  - options - answer server options requests
661  - speeddial - provides on-server speed dial facilities
662  - uri_db - split from uri module, performs various checks related to SIP URI
663    over database fields
664
665 removed modules:
666  - vm - the functionality was transfered to tm module (see t_write_req(...)
667    method)
668
669 core:
670  - new parts:
671        UNIX domain socket server implemented
672  - changes: 
673     - command line: removed -p port and extended -l:
674        -l [proto:]addr[:port] , where proto=udp|tcp and 
675        addr= host|ip_address|interface_name. The format is the same
676        as for listen in the config file. ipv6 addresses must be enclosed in
677        [].
678     - added from_uri & to_uri: behave exactly like uri but use the
679       "From:"/"To:" uris
680        (e.g.: if (from_uri==myself) ..., if (to_uri=~"^sip:test@")... )
681     - config: better escape support in strings (e.g. \", \<cr>, \x0a, \012)
682     - bad network addresses are now automatically fixed
683       (e.g. 192.168.1.80/27 => 192.168.1.64/27)
684     - avp (Attribute-Value Pair) support added
685     - avp alias support added
686     - multicast support added (see mcast_loopback & mcast_ttl)
687     - saving of procces group id enabled, if the -G option is specified
688       (a safe way to quickly kill all ser processes)
689     - core dump-ing is enabled by default, see also disable_core_dump
690     - protocol and port can be specified in the alias and listen lines, e.g.:
691         alias= tcp:foo.bar:* udp:test.bar:5080 foo.com
692         listen= eth0   tcp:eth0:5065 udp:127.0.0.1 [3ffe::1]
693     - multiple operator support: ==, != for special operations (e.g myself, ip)
694                               ==, !=, ~= for strings
695                               ==, !=, >, <, >=, <= for integers
696     - database api changed to support usage of different drivers
697       simultaneously. The database URL must start now with the name of the
698       driver (module). Example: for mysql the DB URL
699       'sql://user:password@dbhost:port/database' must be specified now as
700       'mysql://user:password@dbhost:port/database'
701  - new config variables:
702    mcast_loopback = <yes/no> - loopback sent multicast datagram, default no.
703    mcast_ttl = number - set multicast ttl, default OS specific (usually 1).
704    sock_mode = <permissions> (e.g. sock_mode=0600:  default value = 0660)
705        ser unix sockets and fifo will be created with this permissions
706        (old name fifo_mode is still supported, but deprecated)
707    sock_user = username|"uid"
708    sock_group = groupname|"gid"
709       change the owner and/or group of the ser unix sockets or fifo
710       Short example config snippet:
711            sock_mode=0600        # ser socket/fifo mode
712            sock_user="www-data"  # ser socket/fifo owner
713            sock_group=nogroup  
714            user=nobody       # ser user (ser will suid to it)
715    disable_core_dump= yes|no 
716        by default core dump limits are set to unlimited or a high enough
717        value, set this config variable o yes to disable core dump-ing
718        (will set core limits to 0)
719    open_files_limit= number
720        if set and bigger than the current open file limit, ser will try
721        to increase its open file limit to this number. Note: ser must be
722        started as root to be able to increase a limit past the hard limit
723        (which, for open files, is 1024 on most systems)
724    tcp_connect_timeout= seconds
725        time before an ongoing connect will be aborted
726    tcp_send_timeout= seconds
727        time after a tcp connection will be closed if it is not available 
728        for writing in this interval (and ser wants to send something on it)
729    tcp_accept_aliases= yes|no
730        if a message received over a tcp connection has "alias" in its via
731        a new tcp alias port will be created for the connection the message
732        came from (the alias port will be set to the via one).
733        Based on draft-ietf-sip-connect-reuse-00.txt, but using only the port
734        (host aliases are too dangerous IMHO, involve extra DNS
735         lookups and the need for them is questionable)
736        See force_tcp_alias for more details.
737    log_facility = LOG_LOCAL0
738        if ser logs to syslog, you can control the facility for logging. Very
739        useful when you want to divert all ser logs to a different log file.
740        See man page syslog(3) for more detailes.
741    unix_sock = "/tmp/ser.sock"
742        The name of the socket the unixsock server should listen on.
743    unix_sock_children = 1
744        The number of children that will listen on the unix domain socket.
745    unix_tx_timeout = 2000
746        Timeout (in ms) used when sending replies through unix sockets.
747  - new script commands:
748    force_send_socket([proto:]address[:port])
749        sends the message from the specified socket (it _must_ be one of the
750        sockets ser listens on). If the protocol doesn't match (e.g. udp
751        message "forced" to a tcp socket) the closest socket of the same
752        protocol is used.
753    force_tcp_alias()
754    force_tcp_alias(port)
755        adds a tcp port alias for the current connection (if tcp).
756        Usefull if you want to send all the trafic to port_alias through
757        the same connection this request came from [it could help 
758        for firewall or nat traversal].
759        With no parameters adds the port from the message via as the alias.
760        When the "aliased" connection is closed (e.g. it's idle for too
761        much time), all the port aliases are removed.
762        Note: by default ser closes idle connection after 3 minutes (stable)
763        or 1 minute (unstable) so to take full advantage of tcp aliases for
764        things like firewall and nat traversal, redefine TCP_CON_*TIMEOUT
765        in tcp_conn.h and recompile. Also right now there can be maximum
766        3 port aliases to a connection (you shouldn't need more than one).
767        To change this redefine TCP_CON_MAX_ALIASES in the same file
768        (set it to you desired value + 1; 1 is needed for the real port).
769
770 utilities:
771  - ngrep patch for displaying new lines in captured SIP messages is no longer
772    needed; use ngrep V 1.42 with the option "-W byline"
773
774
775
776 ***********************************************
777 * Changes/fixes introduced in 0.8.12
778 ***********************************************
779 +--------------------------------------------------------+
780 | WARNING: if you want to use a 0.8.11 config script     |
781 | with 0.8.12, replace if ( len_gt(number) ) with:       |
782 |                      if ( msg:len > bumber )           |
783 +--------------------------------------------------------+
784
785 New Features
786 ============
787
788 texops:
789  - subst('s/re/repl/flags') support
790 core:
791  - added switch to check the config file (-c)
792  - changes: removed len_gt() and replaced with if (msg:len op number|max_len)
793  - multiple operator support: ==, != for special operations (e.g myself, ip)
794                               ==, !=, ~= for strings
795                               ==, !=, >, <, >=, <= for integers
796  - new config variables:
797      advertised_address= ip | string
798        address advertised in via and in the DST_* lumps (e.g RR)
799        This is the default value, if empty (default) the socket
800        address will be used.
801        WARNING: - don't set it unless you know what you are doing
802                  (e.g. nat traversal)
803                - you can set anything here, no check is made
804                 (e.g. foo.bar will be accepted even if 
805                  foo.bar doesn't exist)
806     advertised_port= no
807        port advertised in via and in the DST_*lumps (e.g. RR)
808        This is the default value, if empty (default) the socket
809        port will be used.
810        Same warnings as above.
811  - new script commands:
812     set_advertised_address(ip|string)
813        same as advertised_address but it affects only the current message:
814        Message host/lump address= the set_advertised one if
815        present, else advertised_address else socket address.
816     set_advertised_port(no)
817        same as advertised_port but it affects only the current
818        message; see set_advertised_address & s/address/port/g
819
820 usrloc:
821  - usernames are case insensitive
822  
823 registrar:
824  - lookup function succeeds when appending of a branch failed
825
826 auth_db:
827  - support for rpid stored in database (thanks to Jakob Schlyter)
828
829 Bug fixes
830 =========
831 - memory leak in digest credentials parser fixed
832 - authenticathion ha1 didn't include domain if username was of the form
833   user@domain and calculate_ha1 was set to yes (modules/auth_db)
834 - tm reply processing race condition (modules/tm), special thanks go to
835  Dong Liu
836 - Many bugs in pa module fixed, works with registrar again.
837  
838 Security updates
839 ================
840  
841 - fifo processing code will write responses only to other
842  fifos and only if they are not hard-linked, also default
843  ser fifo persmissions were changed to 0600.
844                                                                                 
845 Performance improvements
846 ========================
847 - tuned internal malloc implementation parameters to better reflect the
848 actual workload (malloc is a little bit faster now)
849
850
851
852 ***********************************************
853 * Changes introduced in 0.8.11
854 ***********************************************
855
856 +--------------------------------------------------------+
857 | CAUTION: the 0.8.11 release include changes which      |
858 | are incompatible with scripts and databases used       |
859 | in previous versions. Care is advised when upgrading   |
860 | from previous releases to 0.8.11.                      |
861 +--------------------------------------------------------+
862
863 New features
864 =============
865 - RFC3261 support
866     - TCP support and cross-transport forwarding [core]
867     - loose routing support [rr module]
868 - New modules
869     - vm -- voicemail interface [vm]
870     - ENUM support [enum]
871     - presence agent [pa]
872     - dynamic domain management -- allows to manipulate 
873       hosting of multiple domains in run-time [module]
874     - flat-text-file database support [dbtext]
875     - rich access control lists [permissions]
876 - Feature Improvements
877     - click-to-dial, which is based on improved tm/FIFO 
878       that better supports external applications [tm module]
879     - web accounting -- acc module can report to serweb
880         on placed calls [acc module]
881     - improved exec module (header fields passed now
882       as environment variables to scripts) [exec module]
883 - Architectural Improvements
884     - powerpc fast locking support
885     - netbsd support
886     - 64 bits arch. support (e.g. netbsd/sparc64).
887 - New Experimental Features (not tested at all yet)
888     - nathelper utility for Cisco/ATA NAT traversal [nathelper]
889     - another NAT traversal utility [mangler]
890     - postgress support [postgress]
891     - fcp module [fcp]
892     - pdt module (prefix2domain) [pdt]
893
894 Changes to use of ser scripts
895 =============================
896
897 About Multiple Transport Support
898 --------------------------------
899 SER now suports multiple transport protocols: UDP and TCP. As there
900 may be UAs which support only either protocol and cannot speak to
901 each other directly, we recommend to alway record-route SIP requests,
902 to keep the transport-translating SER in path. Also, if a destination
903 transport is not known, stateful forwarding is recommended -- use of
904 stateless forwarding for TCP2UDP would result in loss of reliability.
905
906
907 core
908 ----
909 - reply_route has been renamed to failure_route -- the old name caused
910   too much confusion
911 - forward_tcp and forward_udp can force SER to forward via specific
912   transport protocol
913
914 acc module:
915 -----------
916 - radius and sql support integrated in this module; you need to
917   recompile to enable it
918 - acc_flag is now called log_flag to better reflect it relates
919   to the syslog mode (as opposed to sql/radius); for the same
920   reasons, the accounting action is now called "acc_log_request"
921   and the option for missed calls "log_missed_calls"
922 - log_fmt allows now to specify what will be printed to syslog
923
924 auth module:
925 ------------
926 - auth module has been split in auth, auth_db, auth_radius, group
927   group_radius, uri and uri_radius 
928 - all the parameters that were part of former auth module are now 
929   part of auth_db module
930 - auth_db module contains all functions needed for database
931   authentication
932 - auth_radius contains functions needed for radius authentication
933 - group module contains group membership checking functions
934 - group_radius contains radius group membeship checking functions
935 - is_in_group has been renamed to is_user_in and places to groups
936   module
937 - check_to and check_from have been moved to the uri module
938  
939
940 im module:
941 ----------
942 - im is no longer used and has been obsoleted by TM
943
944 exec module:
945 ------------
946 - exec_uri and exec_user have been obsoleted by exec_dset; 
947   exec_dset is identical to exec_uri in capabilities; it 
948   additionaly passes content of request elements (header 
949   fields and URI parts) in environment variables; users of 
950   exec_user can use exec_dset now and use the "URI_USER"  
951   variable to learn user part of URI
952 - exec_dset and exec_msg return false, if return value of 
953   script does not euqal zero
954 - exec_dset takes an additional parameter, which enables 
955   validation of SIP URIs returned by external application
956
957 jabber module:
958 --------------
959 - presence support for Jabber users is enabled loading the PA
960   module and using handle_subscribe("jabber") for SUBSCRIBE 
961   requests to jabber user 
962
963 msilo module:
964 -------------
965 - m_store has now a parameter to set what should be considered
966   for storing as destination uri. This enables support for saving
967   the messages on negative replies.
968
969 radius_acc module:
970 ------------------
971 - radius_acc module has been removed and radius accounting 
972   is now part of acc module
973
974 registrar/usrloc modules:
975 -------------------------
976 - multi domain support, the modules user username@domain as AOR
977   if enabled
978 - descent modification time ordering of contacts
979 - case sensitive/insensitive comparison of URI can be enabled
980
981 rr module:
982 ----------
983 - addRecordRoute has been replaced with record_route
984 - rewriteFromRoute has been replaced with loose_route()
985 - a new option, "enable_full_lr" can be set to make life
986   with misimplemented UAs easier and put LR in from "lr=on"
987 - rr module can insert two Record-Route header fields when
988   necesarry (disconnected networks, UDP->TCP and so on)
989
990 tm module:
991 ----------
992 - t_reply_unsafe, used in former versions within reply_routes,
993   is deprecated; now t_reply is used from any places in script
994 - t_on_negative is renamed to t_on_failure -- the old name just
995   caused too much confusion
996 - FIFO t_uac used by some applications (like serweb) has been
997   replaced with t_uac_dlg (which allows easier use by dialog-
998   oriented applications, like click-to-dial) 
999 - if you wish to do forward to another destination from 
1000   failure_route (reply_route formerly), you need to call t_relay
1001   or t_relay_to explicitely now
1002 - t_relay_to has been replaced with t_relay_to_udp and t_relay_to_tcp
1003