NEWS
c21b0b47
 Release notes for SIP Express Router (ser)
 ***********************************************
 
 $Id$
 
627b66ef
 0.8.12 changes
 
11ea58b7
 new modules:
  - answer server options requests [options]
627b66ef
 texops:
  - subst('s/re/repl/flags') support
dda578ba
 core:
  - added switch to check the config file (-c)
faa66933
  - changes: 
        removed len_gt() and replaced with if (msg:len op number|max_len)
        protocol and port can be specified in the alias and listen lines, e.g.:
         alias= tcp:foo.bar:* udp:test.bar:5080 foo.com
         listen= eth0   tcp:eth0:5065 udp:127.0.0.1 [3ffe::1]
dda578ba
  - multiple operator support: ==, != for special operations (e.g myself, ip)
                               ==, !=, ~= for strings
                               ==, !=, >, <, >=, <= for integers
  - new config variables:
      advertised_address= ip | string
        address advertised in via and in the DST_* lumps (e.g RR)
        This is the default value, if empty (default) the socket
        address will be used.
        WARNING: - don't set it unless you know what you are doing
                  (e.g. nat traversal)
                - you can set anything here, no check is made
                 (e.g. foo.bar will be accepted even if 
                  foo.bar doesn't exist)
     advertised_port= no
        port advertised in via and in the DST_*lumps (e.g. RR)
        This is the default value, if empty (default) the socket
        port will be used.
        Same warnings as above.
59653eb8
    tcp_accept_aliases= yes|no
        if a message received over a tcp connection has "alias" in its via
        a new tcp alias port will be created for the connection the message
        came from (the alias port will be set to the via one).
        Based on draft-ietf-sip-connect-reuse-00.txt, but using only the port
        (host aliases are too dangerous IMHO, involve extra DNS
         lookups and the need for them is questionable)
        See force_tcp_alias for more details.
dda578ba
  - new script commands:
     set_advertised_address(ip|string)
        same as advertised_address but it affects only the current message:
        Message host/lump address= the set_advertised one if
        present, else advertised_address else socket address.
     set_advertised_port(no)
        same as advertised_port but it affects only the current
        message; see set_advertised_address & s/address/port/g
59653eb8
    force_tcp_alias()
    force_tcp_alias(port)
        adds a tcp port alias for the current connection (if tcp).
        Usefull if you want to send all the trafic to port_alias through
        the same connection this request came from [it could help 
        for firewall or nat traversal].
        With no parameters adds the port from the message via as the alias.
        When the "aliased" connection is closed (e.g. it's idle for too
        much time), all the port aliases are removed.
        Note: by default ser closes idle connection after 3 minutes (stable)
        or 1 minute (unstable) so to take full advantage of tcp aliases for
        things like firewall and nat traversal, redefine TCP_CON_*TIMEOUT
        in tcp_conn.h and recompile. Also right now there can be maximum
        3 port aliases to a connection (you shouldn't need more than one).
        To change this redefine TCP_CON_MAX_ALIASES in the same file
        (set it to you desired value + 1; 1 is needed for the real port).
 
 
627b66ef
 
 
 
c21b0b47
 ***********************************************
 * Changes introduced in 0.8.11
 ***********************************************
 
06415a6a
 +--------------------------------------------------------+
 | CAUTION: the 0.8.11 release include changes which      |
 | are incompatible with scripts and databases used       |
 | in previous versions. Care is advised when upgrading   |
 | from previous releases to 0.8.11.                      |
 +--------------------------------------------------------+
 
c21b0b47
 New features
 =============
dec54b54
 - RFC3261 support
 	- TCP support and cross-transport forwarding [core]
 	- loose routing support [rr module]
 - New modules
 	- vm -- voicemail interface [vm]
 	- ENUM support [enum]
 	- presence agent [pa]
 	- dynamic domain management -- allows to manipulate 
   	  hosting of multiple domains in run-time [module]
 	- flat-text-file database support [dbtext]
 	- rich access control lists [permissions]
 - Feature Improvements
 	- click-to-dial, which is based on improved tm/FIFO 
 	  that better supports external applications [tm module]
 	- web accounting -- acc module can report to serweb
   	  on placed calls [acc module]
 	- improved exec module (header fields passed now
       as environment variables to scripts) [exec module]
 - Architectural Improvements
 	- powerpc fast locking support
 	- netbsd support
 	- 64 bits arch. support (e.g. netbsd/sparc64).
 - New Experimental Features (not tested at all yet)
 	- nathelper utility for Cisco/ATA NAT traversal [nathelper]
 	- another NAT traversal utility [mangler]
 	- postgress support [postgress]
 	- fcp module [fcp]
 	- pdt module (prefix2domain) [pdt]
c21b0b47
 
 Changes to use of ser scripts
 =============================
 
dec54b54
 About Multiple Transport Support
 --------------------------------
 SER now suports multiple transport protocols: UDP and TCP. As there
 may be UAs which support only either protocol and cannot speak to
 each other directly, we recommend to alway record-route SIP requests,
 to keep the transport-translating SER in path. Also, if a destination
 transport is not known, stateful forwarding is recommended -- use of
 stateless forwarding for TCP2UDP would result in loss of reliability.
 
b2fcef3c
 
c21b0b47
 core
 ----
87405423
 - reply_route has been renamed to failure_route -- the old name caused
   too much confusion
dec54b54
 - forward_tcp and forward_udp can force SER to forward via specific
   transport protocol
c21b0b47
 
 acc module:
 -----------
b2fcef3c
 - radius and sql support integrated in this module; you need to
   recompile to enable it
 - acc_flag is now called log_flag to better reflect it relates
   to the syslog mode (as opposed to sql/radius); for the same
   reasons, the accounting action is now called "acc_log_request"
d1b7f319
   and the option for missed calls "log_missed_calls"
b2fcef3c
 - log_fmt allows now to specify what will be printed to syslog
c21b0b47
 
 auth module:
 ------------
dec54b54
 - auth module has been split in auth, auth_db, auth_radius, group
f4f8f4c3
   group_radius, uri and uri_radius 
 - all the parameters that were part of former auth module are now 
   part of auth_db module
1091e676
 - auth_db module contains all functions needed for database
   authentication
 - auth_radius contains functions needed for radius authentication
 - group module contains group membership checking functions
 - group_radius contains radius group membeship checking functions
07e9f6e9
 - is_in_group has been renamed to is_user_in and places to groups
   module
 - check_to and check_from have been moved to the uri module
1091e676
  
c21b0b47
 
dec54b54
 im module:
 ----------
 - im is no longer used and has been obsoleted by TM
c21b0b47
 
 exec module:
 ------------
 - exec_uri and exec_user have been obsoleted by exec_dset; 
   exec_dset is identical to exec_uri in capabilities; it 
   additionaly passes content of request elements (header 
   fields and URI parts) in environment variables; users of 
   exec_user can use exec_dset now and use the "URI_USER"  
   variable to learn user part of URI
 - exec_dset and exec_msg return false, if return value of 
   script does not euqal zero
 - exec_dset takes an additional parameter, which enables 
   validation of SIP URIs returned by external application
dec54b54
 
cb5742f7
 jabber module:
 --------------
 - presence support for Jabber users is enabled loading the PA
1091e676
   module and using handle_subscribe("jabber") for SUBSCRIBE 
   requests to jabber user 
cb5742f7
 
dec54b54
 msilo module:
 -------------
cb5742f7
 - m_store has now a parameter to set what should be considered
   for storing as destination uri. This enables support for saving
   the messages on negative replies.
dec54b54
 
 radius_acc module:
 ------------------
 - radius_acc module has been removed and radius accounting 
   is now part of acc module
 
 registrar/usrloc modules:
 -------------------------
1091e676
 - multi domain support, the modules user username@domain as AOR
   if enabled
 - descent modification time ordering of contacts
 - case sensitive/insensitive comparison of URI can be enabled
 
c21b0b47
 rr module:
 ----------
dec54b54
 - addRecordRoute has been replaced with record_route
a26d51bd
 - rewriteFromRoute has been replaced with loose_route()
dec54b54
 - a new option, "enable_full_lr" can be set to make life
   with misimplemented UAs easier and put LR in from "lr=on"
1091e676
 - rr module can insert two Record-Route header fields when
   necesarry (disconnected networks, UDP->TCP and so on)
c21b0b47
 
 tm module:
 ----------
eaf10d36
 - t_reply_unsafe, used in former versions within reply_routes,
   is deprecated; now t_reply is used from any places in script
87405423
 - t_on_negative is renamed to t_on_failure -- the old name just
   caused too much confusion
 - FIFO t_uac used by some applications (like serweb) has been
   replaced with t_uac_dlg (which allows easier use by dialog-
   oriented applications, like click-to-dial) 
 - if you wish to do forward to another destination from 
   failure_route (reply_route formerly), you need to call t_relay
   or t_relay_to explicitely now
a7cad316
 - t_relay_to has been replaced with t_relay_to_udp and t_relay_to_tcp
87405423