====================================================================
BOL B2BUA README 
====================================================================
BOL B2BUA
Version v3.1 Release
Apr 2007

========================
Trial Version Agreement
========================
This software is licensed free of charge for evaluation purposes only. 
Some limitations have been introduced to this effect. 
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO 
WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 
IT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 
OR IMPLIED. IN NO EVENT WILL BOL, OR ANY OTHER PARTY, BE REQUIRED TO 
PROVIDE ANY ASSISTANCE OR SERVICE TO YOU. 
By downloading and/or using the software, you thereby agree to these 
above terms.

====================================================================
INTRODUCTION 
====================================================================
The B2BUA is basically two UAs working back-to-back and thus 
controlling the calls going through it. Unlike a sip-proxy, a B2BUA 
will take an incoming call, modify it and present it in other form 
to final destination. The B2BUA is in the call-signaling-path at 
all times. There are numerous applications in which the B2BUA can be 
used either as a media negotiator or a simple supervisor over a call 
between two parties. The software provides a basic framework for a 
B2BUA and we have added a prepaid billing application on top of 
that framework.

Figure 1.
  +-----------------------+
  |   PrePaid Application |
  |_______________________|
  |    B2b Base           |
  |_______________________|

Figure 2.
 +------------+        +-------+        +------------+
 | Endpoint A | <----> | B2BUA | <----> | Endpoint B |
 +------------+        +-------+        +------------+
                          /|\
                           |
                          \|/
                       +--------+
                       | RADIUS | 
                       +--------+

Figure 3.
 +------------+        +-------+        +------------+
 | Proxy (SER)| <----> | B2BUA | <----> |    PSTN    |
 +------------+        +-------+        +------------+
                          /|\
                           |
                          \|/
                       +--------+
                       | RADIUS | 
                       +--------+

Based on the requirement a B2BUA needs to deal with one or more of 
the following:

o AAA (Authentication, Authorization and Accounting) 
o SIP message translation/rewriting
o SDP manipulation
o PDD Timer
o SessionTimer
o Provisioning Response

The Configuration:
------------------
The B2BUA can be configured by using the file b2bConfig.xml, 
using a provisioning system is not supported in this release. 
The details of each field in the configuration file are as 
follows:

<?xml version = "1.0" ?>
<!DOCTYPE B2BUA_Configuration SYSTEM "b2bConfig.dtd">

<B2BUA_Configuration>
  <!-- License part of the B2BUA //-->
  <License>
     <ProductName>BOL B2BUA</ProductName>
     <Version>v3.1 (build 20061123)</Version>
     <Host>192.168.0.40</Host>
     <Port>15060</Port>
     <Key>Trial Version</Key>
     <ExpireDate>Thu, 01 Jan 1970 00:00:00 +0000</ExpireDate>
     <Capacity>20</Capacity>
  </License>
  <!-- The block defines the SIP configuration of the B2BUA //-->
  <SIP>
     <!-- Sip Port and transport, debug ip and port used by the B2BUA //-->
     <Local>
       <IP>192.168.0.40</IP>
       <Port>15060</Port>
       <Transport>UDP</Transport>
       <Transport>UDP</Transport>
       <DebugIP>127.0.0.1</DebugIP>
       <DebugPort>5067</DebugPort>
     </Local>
     <!-- Outbound proxy server address //-->
     <Proxy_Server>
       <Address>192.168.0.78</Address>
       <Port>5067</Port>
     </Proxy_Server>
     <!-- The B2BUA can optinally register itself with a SIP Registrar
      Currently not implemented. //-->
     <Registration>
       <Register>no</Register>
       <Address>0.0.0.0</Address>
       <Port>-1</Port>
       <Expires>60</Expires>
     </Registration>
     <!-- SessionTimer Support, if you don't want the B2BUA 
          to initiate a SessionTimer re-INVITE, set the 
          <PassThrough></PassThrough>
          with the value 'true', currently only the 
          right side is supported
     //-->
     <SessionTimer>
        <PassThrough>false</PassThrough>
        <Left>
          <Enable>false</Enable>
          <Request>UPDATE</Request>
          <Session-Expires>0</Session-Expires>
          <Min-SE>90</Min-SE>
          <Refresher>uas</Refresher>
        </Left>
        <Right>
          <Enable>true</Enable>
          <Request>INVITE</Request>
          <Session-Expires>95</Session-Expires>
          <Min-SE>90</Min-SE>
          <Refresher>uac</Refresher>
        </Right>
     </SessionTimer>
     <!-- InviteTimer //-->
     <InviteTimer>
        <PDDInviteTo100TimeOut>10</PDDInviteTo100TimeOut>
        <PDD100ToRingingTimeOut>20</PDD100ToRingingTimeOut>
        <RingTimeOut>60</RingTimeOut>
     </InviteTimer>
  </SIP>
  <!-- RADIUS Authorization and Accounting configuration part //-->
  <RADIUS>
     <!-- default part of the RADIUS configuration //-->
     <Default>
       <!-- Ports where the RADIUS server is listening for authorization and
            accounting requests from the B2BUA. Password is used by the 
            B2BUA to authenticate itself with the RADIUS Server.
       //-->
       <NAS-Identifier>B2BUA</NAS-Identifier>
       <Authentication_Port>1812</Authentication_Port>
       <Accounting_Port>1813</Accounting_Port>
       <Secret>password20</Secret>
     </Default>
     <BillingServers>
       <!-- if either of the Authentication_Port, Accounting_Port 
            and Secret is not available, the B2BUA will use the above
            default setting 
       //-->
       <Server>
         <Address>192.168.0.20</Address>
       </Server>
       <Server>
         <Address>192.168.0.21</Address>
         <Authentication_Port>1819</Authentication_Port>
         <Accounting_Port>1820</Accounting_Port>
         <Secret>password21</Secret>
       </Server>
     </BillingServers>
     <Attributes>
       <!-- If the RADIUS server did not response after 
            RequestTimeout (in milisecond) time, the B2BUA 
            will use the backup server in the RoundRobinServers 
            setting manner, will retransmit the request for
            RequestRetransmissions times.
       //-->
       <RequestTimeout>2000</RequestTimeout>
       <RequestRetransmissions>3</RequestRetransmissions>
       <RoundRobinServers>yes</RoundRobinServers>
       <!-- When set to yes, this will append a realm value into the 
            UserName part of the RADIUS request, even if the SIP Message doesn't 
            contain a Domain in the realm part of the Proxy-Authorization Header,
            the B2BUA will send the realm with the realm value.
       //-->
       <IncludeDomainInUserName>yes</IncludeDomainInUserName>
       <!-- Append Cisco Vendor Specific attributes such as h323-remote-address,
            h323-setup-time, h323-connect-time, h323-disconnect-time, 
            h323-disconnect-cause for billing purpose
       //-->
       <AppendCiscoAttributes>yes</AppendCiscoAttributes>
     </Attributes>
  </RADIUS>
  <PrePaid>
    <Billing>
       <!-- Limit the user's call duration to 7200 seconds //-->
       <DefaultCallDurationLimit>7200</DefaultCallDurationLimit>
       <!-- this should be set if you want the B2BUA to send RADIUS 
            packet to do prepaid or postpaid billing. The 'free' option 
            currently is not supported.

       The option is either free, mandatory or optional.

       If "free", B2BUA will ignore the user authorization  
       and will set the call duration to be infinite. 
       It will attempt to generate the billing records, 
       but if it cannot talk to the  billing server , it will 
       ignore the records. 

       If "optional", the B2BUA will do the authorization 
       however the billing records will be treated the same as 
       the "free" option. 

       If "mandatory", the B2BUA will do the authorization. 
       If billing records cannot be sent to the billing server, 
       the call will be aborted.

       Note: The free, optional functionality are not fully implemented. 
       //-->
       <Option>mandatory</Option>
       <!-- 
            Frequency in seconds at with the intermittent billing 
            records will be sent from the B2BUA to the RADIUS server 
            during a call.
            The below setting will allow B2BUA to send Accounting-Alive 
            in 60 seconds interval.
       //-->
       <Refresh_Time>60</Refresh_Time>
       <!-- DONNOT change the below values //-->
       <Extract_User_Id_From>Proxy-Authorization</Extract_User_Id_From>
       <User_Id_Decode_Scheme>Basic</User_Id_Decode_Scheme>
    </Billing>
       <!-- Possible values (yes, no). Used in pre-paid billing. 
            If yes, a SIP Info message is used to indicate the user 
            his/her available credit.
            (Currently not working)
       //-->
       <Use_SIP_INFO>no</Use_SIP_INFO>
       <!-- Possible values (yes,no). Used in click-to-dial scenario. 
            If yes, the B2BUA processes the HTTP event. 
            (Currently not implemented)
       //-->
       <Use_HTTP>no</Use_HTTP>
  </PrePaid>
  <Redundancy />
</B2BUA_Configuration>

====================================================================
NEW FEATURES AND FUNCTIONS IN THIS RELEASE 
====================================================================
This release implements these features and functionality:
 
1. The B2BUA implements the 2 A's (Authorization and Accounting)

2. The B2BUA will have three timer to monitor the call setup progress.
   if the timer goes time out, the call will be correctly cleared, and 
   the billing will be correctly calculated.
3. The B2BUA implements the Call monitoring and based on the time a
   user is authorized to make a call, can preempt the call, if 
   duration exceeds the allowed time.

4. Cisco Vendor Specific RADIUS attributes are supported.

5. RADIUS server redundancy supported.

6. Reload configuration at run time using `kill -HUP pid' or 
   `kill -USR1 pid' is supported. Telnet monitoring interface is
   developing in progress.

7. Server status using `kill -USR2 pid' is supported.

8. New features: 
   a) B2BUA is able to send to different trunk gateway and change  
   the RURI using the RADIUS messages, h323-redirect-ip-address,  
   h323-redirect-number 
   b) telnet monitoring interface.
   c) one side Session Timer using INVITE supported.
   d) PDD timer supported.

====================================================================
GETTING STARTED
====================================================================
For more information on using this system, please refer to
the Installation Guide at http://www.bol2000.com/b2bua under 
Documents.

HARDWARE OR SOFTWARE REQUIREMENTS
--------------------------------------------------------------------
The recommended hardware is as follows:
700MHz, Intel Pentium III PC processor, 512MB RAM, 1G Harddisk

The B2bUa runs on Linux operating systems.
On Linux, we have tested with Redhat 9.0, CentOS 3.x 4.x (4.4 now) 
on Intel Pentium III, Pentium 4, Xeon.

The B2BUA can be configured from a flat file (see the sample
config file in the directory b2bConfig.xml)

INSTALLATION INSTRUCTIONS
--------------------------------------------------------------------
1. Download the tar ball.

2. Untar the B2BUA tar using one of these commands:
   - Linux: tar -xvzf BOL B2BUA-n.n.n.tar.gz

Where: n.n.n is the version number.

3. add a directory in the /tools ( root user privilege needed ).
   Extract the tools.tar.gz into the tools directory using the following
command:
   mkdir -vp /tools && tar -C /tools tools.tar.gz

4.
USING THE SOFTWARE
--------------------------------------------------------------------
[BOL B2BUA@ngsw-dev3 /home/BOL B2BUA]$ ./BOL B2BUA -h
program built at: Dec  7 2006 10:34:00
ProductName: BOL B2BUA
ProductVersion: v3.1 (build 20061123)
Usage:
./BOL B2BUA [-V] [-h] [-b] [-d] [-f log-filename] [-v DEBUG_LEVEL] [-c config_file] [-p port]

DESCRIPTION
        -V
                Product Info
        -b
                build information
        -d
                do not fork into background (no daemon mode)
        -f log-filename
                output log to log-filename
        -v DEBUG_LEVEL
                set the debug level
                DEBUG_LEVEL available options
                log output Priorities (from the highest to lowest) :
                LOG_EMERG       /** system is unusable */
                LOG_ALERT       /** action must be taken immediately */
                LOG_CRIT        /** critical conditions */
                LOG_ERR         /** error conditions */
                LOG_WARNING     /** warning conditions */
                LOG_NOTICE      /** normal but significant condition */
                LOG_INFO        /** informational */
                LOG_DEBUG       /** debug-level messages */
                LOG_DEBUG_STACK /** stack debug-level messages */
                LOG_DEBUG_OPER  /** stack operator debug-level messages */
                LOG_DEBUG_HB    /** heartbeat debug-level messages */
                LAST_PRIORITY   /** an alias for the last cpLog priority level,
                                        for use in bounds-checking code */
        -c config_file
                specify a configfile

To execute the B2BUA, reading its configuration from a flat file:
./b2bua -c b2bConfig.xml -v LOG_INFO -f b2b.log

Example scenario using the b2bConfig.xml:

                             +---<-------> RADIUS
                             |             192.168.0.20
                             |
  proxy, RADIUS <-------->  B2bUA    <----->    UA2
192.168.0.20:5060      192.168.0.40:15060     192.168.0.78:5067


====================================================================
CONTACT INFORMATION AND WEBSITE
====================================================================
We welcome your feedback, suggestions and contributions. 
Contact us via email if you have any questions, feedback,
and bug reports.

For general inquiries -
E-Mail:     b2bua_nospam_bol2000.com
MSN:        jiangjinke_nospam_hotmail.com
Skype:      jiangjinke_nospam_163.com
googletalk: jjksam_nospam_gmail.com

please replace the above `_nospam_' with `@'. or contact

====================================================================