Configuring the Thomson Gateway SIP Server Configuring the Thomson Gateway SIP Server Date: June 2008 Version: v3.0 Abstract: Applicability: Updates: This application note provides technical information on how to configure the Thomson Gateway SIP Server service. This application note applies to all Thomson Gateway products running a firmware that deploys the SIP Server VoIP service. Thomson continuously develops new solutions, but is also committed to improving its existing products. For more information on Thomson's latest technological innovations, documents and software releases, visit us at http://www.thomson-broadband.com
Chapter 1 1 Definitions Address of Record (AOR) An address-of-record (AOR) is a SIP or SIP Server URI that points to a domain with a location service that can map the URI to another URI where the user might be available. Typically, the location service is populated through registrations. An AOR is frequently thought of as the "public address" of the user. B2BUA A back-to-back user agent (B2BUA) is a logical entity that receives a request and processes it as a user agent server (UAS). In order to determine how the request should be answered, it acts as a user agent client (UAC) and generates requests. Unlike a proxy server, it maintains dialogue state and must participate in all requests sent on the dialogues it has established. External User Agent or Global SIP Account These are the official accounts defined by the VoIP Provider. Internal User Agent or Local SIP Account These are the internal accounts, only known in your local network. 1
2 SIP Server Introduction When your Thomson Gateway incorporates a (local) SIP Server, it encompasses the SIP Proxy functionality, a B2BUA and a registrar. B2BUA According to RFC 3261 a back-to-back user agent (B2BUA) is a logical entity that receives a request and processes it as a user agent server (UAS). In order to determine how the request should be answered, it acts as a user agent client (UAC) and generates requests. Unlike a proxy server, it maintains dialogue state and must participate in all requests sent on the dialogues it has established. The standard defines it as a concatenation of a UAC and UAS and therefore doesn't provide additional definition for this entity. In other words, 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 the final destination. The B2BUA enables service providers to manage and track a call from beginning to end, integrate and offer new value added features, and bring Class-5 type functionality to IP networks. With the B2BUA module, the SIP server becomes an active participant in the call from beginning to end as all signalling messages pass through and are processed by the B2BUA at all times. A B2BUA maintains call state and actively participates in sending requests and responses for dialogues in which it is involved. This B2BUA functionality provides major new applications including: Centralized call management Interworking with alternative networks SIP-based VoIP interworking between LAN and WAN Management and monitoring of the entire call state Cloaking of end point location. Real and virtual User Agent A SIP message received at the WAN side, destined to a global SIP account (as mentioned in the To-header), is terminated by the real UA. Namely, an external UA configured in the SIP Server. An external SIP UA is always a real UA. A SIP message received at the LAN side, destined to an external WAN UA or to an internal UA residing at the (W)LAN or FXS, is terminated by a virtual UA. 2
SIP Server architecture The Thomson Gateway SIP Server has the following functional architecture: Registrar PSTN Phone PSTN Phone F X S UA f_1 UA f_2 Local Location Database UA f_1... UA f_2 UA l_1... UA l_m Local UA Database UA f_1... UA f_2 UA l_1... UA l_m (W) L A N UA l_1... UA l_m UA si_1... UA si_m Global UA Database B2BUA UA se_1. UA se_n UA se_1... UA se_n THOMSON GATEWAY SIP SERVER WAN Internet Outbound Proxy/Registrar 1... n Location Database VoIP UA se_1. UA se_n Element UA f_1 and UA f_2 UA l_1 up to UA l_m UA si_1 up to UA si_m Local UA database Registrar Local location database UA se_1 up to UA se_n Global UA database Outbound proxy/ registrar 1_n Location database Function The (physical) UAs representing an FXS port (two FXS ports are available). The (physical) UAs residing on the (W)LAN. The (logical) UAs residing in the server, only known internally. Database containing the profiles of the local SIP accounts or internal UAs. The registrar for the local SIP accounts or internal UAs. Database containing the location of the local SIP accounts or internal UAs. The (logical) UAs residing in the server, only known externally. Database containing the profiles of the global SIP accounts or external UAs. The proxy/registrars for the global SIP accounts or external UAs. Database containing the location of the global SIP accounts or external UAs. 3
2.1 Scenario Prerequisites Before configuring your Thomson Gateway SIP Server to implement the described scenario, following prerequisites must be fulfilled: Have WAN connectivity with the outbound proxy/registrar (the VoIP Provider). Acquire your telephone number(s) from the VoIP Provider. Acquire the domain name or IP address and port number (typically 5060) of the outbound proxy/registrar (also provided by the VoIP Provider). Determine the internal phone numbers. Description This application note describes how to configure the Thomson Gateway Sip Server service. The configuration is based on the following scenario: Seven local SIP accounts or internal UAs. Two analogue UAs, one for each FXS port, and five internal (= belonging to the local network) IP phones with the following properties: Device Name / Internal user agent ID Internal Phone Number AOR User name Password FXS 1 / intua1 1 11 11@192.168.1. 254 FXS 2 / intua2 2 22 22@192.168.1. 254 IP phone 1 / intua3 3 33 33@192.168.1. 254 IP phone 2 / intua4 4 44 44@192.168.1. 254 IP phone 3 / intua5 5 55 55@192.168.1. 254 IP phone 4 / intua6 6 66 66@192.168.1. 254 IP phone 5 / intua7 7 77 77@192.168.1. 254 user1 1111 user2 2222 user3 3333 user4 4444 user5 5555 user6 6666 user7 7777 User name and password are optional. The local SIP accounts that are terminated in the Thomson Gateway (e.g. representing FXS, DECT phones) are configured as a SIP UA. These UAs must also be configured in the SIP Server part. In this scenario seven internal user agents are created. You can create up to ten internal AORs. 4
Four global SIP accounts or external UAs, with the following properties: External UA I D AOR Outbound registrar Outbound proxy extua1 1 034436111@registrar_VoIP_Provider.co m extua2 2 034436112@registrar_VoIP_Provider.co m extua3 3 034436113@registrar_VoIP_Provider.co m extua4 4 034436114@registrar_VoIP_Provider.co m registrar_voi P_Provider.c om registrar_voi P_Provider.c om registrar_voi P_Provider.c om registrar_voi P_Provider.c om proxy_voip_pro vider.com proxy_voip_pro vider.com proxy_voip_pro vider.com proxy_voip_pro vider.com The AOR of a global SIP account is provided by the VoIP Provider. You can set up up to four external AORs. The internal user agents must be set up as following for the described scenario: Phone 1 and IP phone 1 cannot make external calls. Phone 1 cannot be reached externally, IP phone 1 can be reached via extua1 (so phone 1 can only call internally). Phone 2 can call externally and be reached via extua 2. IP phone 2 can call externally and be reached via extua 1 (so when extua 1 is called, IP phone 1 and IP phone 2 are notified). IP phone 3 and IP phone 4 can call externally and be reached via extua 3. This implies when extua 3 is called, both IP phone 3 and IP phone 4, are notified. IP phone 5 can call externally and be reached via extua 4. This results in following mapping tables: Internal to external user agents Internal device... FXS 1 is mapped to external user agent... none FXS 2 extua 2 IP Phone 1 IP Phone 2 none extua1 IP phone 3 extua 3 IP phone 4 extua 3 IP phone 5 extua 4 5
External to internal user agents External user agent... is mapped to internal device... extua 1 IP phone 1 and IP phone 2 extua 2 FXS 2 extua 3 IP phone 3 and IP phone 4 extua 4 IP phone 5 Limit the number of simultaneous external calls to three (default is four). A summary of this scenario can be found in the following illustration: IP Phone 4 IP Phone 5 FXS 1 FXS 2 IP Phone 1 IP Phone 2 IP Phone 3 Hub FXS (W)LAN intua1... intua7 Internal SIP Server IP address 192.168.1.254 Port 5060 B2BUA External SIP Server extua1...extua4 THOMSON GATEWAY SIP SERVER WAN registrar_voip_provider.com Internet proxy_voip_provider.com 6
2.2 Configuring the SIP Server Overview of the configuration The configuration of your Thomson Gateway SIP Server enhances following steps: 1 Setting up and enabling the SIP Server service. 2 Configuring and enabling the SIP user agents. 3 Mapping of the internal and external UAs. 4 Limiting the number of simultaneous external calls. Each of these steps will be elaborated in detail. 2.2.1 Setting up and enabling the SIP Server service Binding the integrated SIP registrar To bind the integrated SIP Registrar to the interfaces for VoIP traffic, carry out following command: :sipserver registrar bind add intf LocalNetwork sipport 5060 Configuring the outbound proxy To configure the outbound proxy, carry out following command: :sipserver outbproxy add id 1 address proxy_voip_provider.com port 5060 Configuring the outbound registrar To configure the outbound registrar, carry out the following command: :sipserver outbreg add id 1 address registrar_voip_provider.com port 5060 Creating the internal user agents: The internal telephone number are defined by the local network administrator. Those phone numbers occur in the first part of the internal AORs. The second part of the AOR is the IP address of the internal SIP Server, namely 192. 168.1.254. So, the structure of the AOR of the internal user agent is: <internal telephone number>@<ip address of the internal SIP server>. 7
The create and define the internal user agents, carry out following commands; :sipserver intua add id 1 aor 11@192.168.1.254 username 111 password 1111 status enabled :sipserver intua add id 2 aor 22@192.168.1.254 username 222 password 2222 status enabled :sipserver intua add id 3 aor 33@192.168.1.254 username 333 password 3333 status enabled :sipserver intua add id 4 aor 44@192.168.1.254 username 444 password 4444 status enabled :sipserver intua add id 5 aor 55@192.168.1.254 username 555 password 5555 status enabled :sipserver intua add id 6 aor 66@192.168.1.254 username 666 password 6666 status enabled :sipserver intua add id 7 aor 77@192.168.1.254 username 777 password 7777 status enabled To view all of the internal AORs, carry out following command :sipserver intua list id=all ID AOR Username RegStatus Status ------------------------------------------------------------------ 1 11@192.168.1.254 111 Registered Enabled 2 22@192.168.1.254 222 Registered Enabled 3 33@192.168.1.254 333 Registered Enabled 4 44@192.168.1.254 444 Registered Enabled 5 55@192.168.1.254 555 Registered Enabled 6 66@192.168.1.254 666 Registered Enabled 7 77@192.168.1.254 777 Registered Enabled Setting up the external SIP Server AORs The external user agent AORs are provided by the VoIP Provider. To set up the external user agents carry out following commands: :sipserver extua add id 1 aor 034436111 Interface Internet sipport sip outboundregistrar 1 outboundproxy 1 status enabled :sipserver extua add id 2 aor 034436112 Interface Internet sipport sip outboundregistrar 1 outboundproxy 1 status enabled :sipserver extua add id 3 aor 034436113 Interface Internet sipport sip outboundregistrar 1 outboundproxy 1 status enabled 8
:sipserver extua add id 4 aor 034436114 Interface Internet sipport sip outboundregistrar 1 outboundproxy 1 status enabled To view all of the external AORs, carry out following command: :sipserver extua list id=all Enabling the SIP Server service By default, the SIP Server is disabled. To enable the SIP Server service, carry out following command: :service system modify name=sip_server state=enabled To check the state of the SIP Server, carry out following command: :service system list name=sip_server Idx Name Protocol SrcPort DstPort Group State --------------------------------------------------------------------------------- 1 SIP_SERVER enabled 9
2.2.2 Configuring and enabling the SIP user agents Configuring the proxy server for the internal user agents To configure the proxy server for the internal user agents, carry out following command: :voice sip config primproxyaddr 192.168.1.254 proxyport 5060 Configuring the registrar for the internal user agents To configure the registrar for the internal user agents, carry out following command: :voice sip config primregaddr 192.168.1.254 regport 5060 Defining the interface for VoIP traffic To define the interface for VoIP traffic, carry out following command: :voice config static_intf enabled intf LocalNetwork Creating user agents representing an FXS port To create both user agents representing respectively the FXS1 port and the FXS2 port: :voice profile add SIP_URI 11 username 111 password 1111 voiceport FXS1 :voice profile add SIP_URI 22 username 222 password 2222 voiceport FXS2 Configuring the IP phones To configure the IP phones, see the user manual of the IP phone. Enabling the voice service To enable the voice service, carry out following command: :service system modify name VOIP_SIP state enabled Be sure to enable and configure the SIP Server first, otherwise a user agent cannot get registered. To check the state of the SIP Server, carry out following command: :service system list name=voip_sip Idx Name Protocol SrcPort DstPort Group State --------------------------------------------------------------------------------- 1 VOIP_SIP 5065 enabled 10
As the SIP Server is already using port 5060, this port is not available for the SIP user agents. Therefore, another port must be configured to send voice traffic to. The default voice application port for Thomson Gateways equipped with a SIP Server is 5065. To change the default voice port to e.g. 5090, carry out following command: :service system modify name VOIP_SIP port_5090 Checking the status After enabling the voice service check if the user agents are registered. To do so, carry out following command: :voice profile list SIP_URI=all Port Uri DisplayName Username Abbr Nbr RegStatus Msg Waiting -------------------------------------------------------------------------------------------- FXS1 11 111 Registered No FXS2 22 222 Registered No You can also check the status via the Web pages: 1 On the Thomson Gateway home page, click Toolbox. 2 Click Telephony. 3 Click Details. 4 When the user agents are registered is displayed. 11
2.2.3 Mapping the internal and the external user agents The mapping between local and global accounts is only important for incoming calls, in that way that an incoming call on a global account can result in multiple local accounts being alerted. Mapping the internal user agents to the external user agents To map the internal user agents to the external user agents as defined in the scenario, carry out following commands: :sipserver intua map add intua=2 extua=2 :sipserver intua map add intua=4 extua=1 :sipserver intua map add intua=5 extua=3 :sipserver intua map add intua=6 extua=3 :sipserver intua map add intua=7 extua=4 To see the internal to external user agent mappings, carry out following command: :sipserver intua map list intua=all Id internal AOR Id external AOR ------------------------------------------------------------------ 2 22@192.168.1.254 1 034436112 4 44@192.168.1.254 1 034436111 5 55@192.168.1.254 1 034436113 6 66@192.168.1.254 1 034436113 7 77@192.168.1.254 1 034436114 Mapping the external user agents to the internal user agents To map the external user agents to the internal user agents as defined in the scenario, carry out following commands: :sipserver extua map add extua=1 intua=3 :sipserver extua map add extua=1 intua=4 :sipserver extua map add extua=2 intua=2 :sipserver extua map add extua=3 intua=5 :sipserver extua map add extua=3 intua=6 :sipserver extua map add extua=4 intua=7 To see the external to internal user agent mappings, carry out following command: :sipserver extua map list extua=all Id external AOR Id internal AOR ------------------------------------------------------------------ 1 034436111 3 33@192.168.1.254 1 034436111 4 44@192.168.1.254 2 034436112 2 22@192.168.1.254 3 034436113 5 55@192.168.1.254 3 034436113 6 66@192.168.1.254 4 034436114 7 77@192.168.1.254 12
2.2.4 Limiting the number of simultaneous external sessions Why Because of bandwidth issues, and thus of quality issues, you might have to limit the number of simultaneous external sessions. By default this number is set to four. How To limit the number of simultaneous external sessions to three, carry out following command: :sipserver config max_sessions=3 13
Visit us at: www.thomson-broadband.com Coordinates: Thomson Telecom Prins Boudewijnlaan 47 B-2650 Edegem Belgium Copyright 2008 Thomson. All rights reserved. The content of this document is furnished for informational use only, may be subject to change without notice, and should not be construed as a commitment by Thomson. Thomson assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. The information contained in this document represents the current view of Thomson on the issues discussed as of the date of publication. Because Thomson must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Thomson, and Thomson cannot guarantee the accuracy of any information presented after the date of publication. This document is for informational purposes only. Thomson MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE INFORMATION IN THIS DOCUMENT. The names of actual companies and products mentioned herein may be the trademarks of their respective owners.