Routing guide

Version 2 (Tijmen de Mes, 10/11/2012 11:58 am)

1 1 Tijmen de Mes
h1. Routing guide
2 1 Tijmen de Mes
3 1 Tijmen de Mes
The platform is based on a SIP Proxy/Registrar design, it maintains both transaction and dialog state for each SIP session and is able to terminate each of them based on various criteria. The platform handles and controls the RTP and MSRP media planes and is able to take decisions related to accounting, NAT traversal and session termination based on the media flow.
4 1 Tijmen de Mes
5 1 Tijmen de Mes
The platform has telephony functions equivalent with traditional Class 4 switches (routing inter-carrier calls) and Class 5 switches (routing last-mile calls to end-users).
6 1 Tijmen de Mes
7 1 Tijmen de Mes
The platform can perform SIP services that include but are not limited to Residential VoIP, Prepaid Cards, Video Calling, Presence and IM, Trunking, Least Cost Routing and ENUM Peering.
8 2 Tijmen de Mes
9 2 Tijmen de Mes
h2. Logical Architecture 
10 2 Tijmen de Mes
11 2 Tijmen de Mes
[[Image(msp-interconnect.png)]]
12 2 Tijmen de Mes
13 2 Tijmen de Mes
== SIP Entities ==
14 2 Tijmen de Mes
15 2 Tijmen de Mes
This document describes routing logic between several SIP entities defined as follows:
16 2 Tijmen de Mes
17 2 Tijmen de Mes
 1. SIP Proxy: the platform core that performs the logic described in this document
18 2 Tijmen de Mes
 1. End-Point: a SIP end-user device that is configured with the credentials of a SIP account for which the platform is responsable
19 2 Tijmen de Mes
 1. PBX: a SIP end-point or intermediary that is configured under a foreign SIP domain not handled by the platform 
20 2 Tijmen de Mes
 1. PSTN gateway: a SIP end-point or intermediary that is handling the translation between IP (using SIP protocol) and PSTN networks
21 2 Tijmen de Mes
22 2 Tijmen de Mes
== Supported Signaling ==
23 2 Tijmen de Mes
24 2 Tijmen de Mes
The platform supports only UDP transport at a unique IP:port combination configured in the server. By default the port is 5060.
25 2 Tijmen de Mes
26 2 Tijmen de Mes
== Supported Media ==
27 2 Tijmen de Mes
28 2 Tijmen de Mes
The platform supports sessions containing the following media types:
29 2 Tijmen de Mes
30 2 Tijmen de Mes
 * Audio (RTP and sRTP)
31 2 Tijmen de Mes
 * Video (RTP and sRTP)
32 2 Tijmen de Mes
 * FAX (RTP and T.38)
33 2 Tijmen de Mes
 * Instant messaging (MSRP and its relay extension)
34 2 Tijmen de Mes
 * File transfer (MSRP and its relay extension)
35 2 Tijmen de Mes
 * Page mode messaging (SIP MESSAGE method)
36 2 Tijmen de Mes
37 2 Tijmen de Mes
The platform is codec agnostic, the negotiation of the codecs depends entirely on the end-points. The MediaProxy component that relays the RTP media between the end-points, for NAT traversal and accounting purposes, relays all packets at IP layer 3 (UDP protocol that encapsulates the RTP/RTCP streams). The actual payload with the particular codecs used inside the RTP streams is transparently passed between end-points without interference from MediaProxy. 
38 2 Tijmen de Mes
39 2 Tijmen de Mes
Other payloads are supported as long as they are embedded into a supported stream, for example any payload that is embedded within the RTP streams (zRTP, DTMF tones) or MSRP streams (file transfer, multy-party chat service, desktop sharing).
40 2 Tijmen de Mes
41 2 Tijmen de Mes
== Primitives ==
42 2 Tijmen de Mes
43 2 Tijmen de Mes
The routing of SIP sessions is governed by two main protocols:
44 2 Tijmen de Mes
45 2 Tijmen de Mes
 1. Domain based SIP routing based on RFC3261 and RFC3263
46 2 Tijmen de Mes
 1. ENUM lookups based on RFC3761
47 2 Tijmen de Mes
48 2 Tijmen de Mes
The routing logic of the platform can be configured by changing its database tables and configuration files. The primitives used for routing are:
49 2 Tijmen de Mes
50 2 Tijmen de Mes
|| Registrar database || Used to translate  a SIP address into a SIP contact address ||
51 2 Tijmen de Mes
|| ENUM|| Used to translate an E.164 telephone number into a SIP address ||
52 2 Tijmen de Mes
|| SIP alias || Used for adding aliases to existing SIP accounts||
53 2 Tijmen de Mes
|| Emergency numbers || Translation between 911 and 112 into closest emergency access points||
54 2 Tijmen de Mes
|| Call diversion|| Translate  a SIP address into another based on signaling conditions or end-user preferences||
55 2 Tijmen de Mes
|| DNS lookups || Translate a SIP domain/hostname into an protocol:IP:port combination ||
56 2 Tijmen de Mes
|| LCR|| Used for selection of PSTN gateway ||
57 2 Tijmen de Mes
58 2 Tijmen de Mes
== Server Location ==
59 2 Tijmen de Mes
60 2 Tijmen de Mes
To locate the SIP Proxy/Registrar for a domain, SIP endpoints must perform DNS lookups based on RFC3263 that return the IP:port combination for which the server is configured.  
61 2 Tijmen de Mes
62 2 Tijmen de Mes
== Configuration Files ==
63 2 Tijmen de Mes
64 2 Tijmen de Mes
Index of SIP Proxy configuration files located  in/etc/opensips/:
65 2 Tijmen de Mes
66 2 Tijmen de Mes
|| config/settings.m4 || Contains the settings that can customize the routing logic ||
67 2 Tijmen de Mes
|| config/opensips.m4 || Contains the proxy routing logic (should not be modified) ||
68 2 Tijmen de Mes
|| config/siteconfig/handle-incoming-pstn.m4 || Used to customize routing logic for incoming PSTN calls ||
69 2 Tijmen de Mes
|| config/siteconfig/handle-local-extensions.m4 || Used to define installation specific custom local extensions ||
70 2 Tijmen de Mes
|| config/siteconfig/handle-outgoing-peers.m4 || Used to customize routing for outgoing calls to non-local domains ||
71 2 Tijmen de Mes
|| config/siteconfig/postprocess-request.m4 || Used to customize outgoing requests before they leave the proxy ||
72 2 Tijmen de Mes
|| config/siteconfig/preprocess-pstn.m4 || Used to customize outgoing PSTN requests before applying LCR routing ||
73 2 Tijmen de Mes
|| config/siteconfig/preprocess-request.m4 || Used to apply custom pre-processing to a request before anything else ||
74 2 Tijmen de Mes
|| config/siteconfig/preprocess-uri.m4 || Used to apply custom pre-processing to the request URI before converting to E164 ||
75 2 Tijmen de Mes
76 2 Tijmen de Mes
The settings.m4 file is used to customize the existing routing logic defined in opensips.m4 using the predefined routing options.
77 2 Tijmen de Mes
[[BR]]
78 2 Tijmen de Mes
The files under the siteconfig/ directory can contain installation specific routing logic, which will be included by opensips.m4 and will allow for the routing logic to be adapted to the specific requirements of a given installation.
79 2 Tijmen de Mes
The opensips.m4 file will always be overwritten on upgrades, so it should never be modified, while the files under the siteconfig/ directory will never be overwritten and can be modified without restrictions.
80 2 Tijmen de Mes
81 2 Tijmen de Mes
== NAT Traversal ==
82 2 Tijmen de Mes
83 2 Tijmen de Mes
NAT traversal methods encountered in the field and their properties: 
84 2 Tijmen de Mes
85 2 Tijmen de Mes
 * SIP server based (Relay) - reliable server side technology that works with all SIP clients, this method is used by the platform 
86 2 Tijmen de Mes
 * SIP client based (ICE) - client and server technology where client may negotiate media paths, is supported by the platform
87 2 Tijmen de Mes
 * Intermediates based:
88 2 Tijmen de Mes
  * NAT routers with SIP Application Level Gateway (SIP ALG) - located in customer premises network and the most '''unreliable''' technique 
89 2 Tijmen de Mes
  * Sessions Border Controllers (SBC) - located in service provider network - reliable with high cost and high complexity 
90 2 Tijmen de Mes
91 2 Tijmen de Mes
The most reliable way to solve NAT issues with SIP is server based, by relaying packets using servers visible by both end-points. A new methodology under development is ICE, which relies partially on the SIP clients. NAT traversal applied in intermediates only introduce problems and SBCs add costs without adding value to the SIP service. 
92 2 Tijmen de Mes
93 2 Tijmen de Mes
Below is a display of all possible NAT traversal techinques used for SIP and related media.
94 2 Tijmen de Mes
95 2 Tijmen de Mes
[[Image(nat-traversal-techniques.png)]]
96 2 Tijmen de Mes
97 2 Tijmen de Mes
The platform handles the NAT traversal for all its end-points by relaying all traffic, signaling and media through its servers that have public IP address and are visible for both end-points involved in a call flow. 
98 2 Tijmen de Mes
99 2 Tijmen de Mes
Optional, [http://mediaproxy-ng.org/wiki/ICE ICE can be deployed] when supported by the end-points. The media relay acts like a TURN candidate and the operator may choose on a per call basis when and how this relay is to be used. When using ICE, SIP sessions that do not have a BYE cannot be accounted for. 
100 2 Tijmen de Mes
101 2 Tijmen de Mes
NAT traversal is not the same thing as Firewall traversal. A firewall has an administrative policy, which must be set to support SIP and associated media traffic. 
102 2 Tijmen de Mes
103 2 Tijmen de Mes
=== Platform Ports ===
104 2 Tijmen de Mes
105 2 Tijmen de Mes
See the [wiki:MSPInstallation#Firewallsetup Firewall Setup] section for a list of ports used by the platform software.
106 2 Tijmen de Mes
107 2 Tijmen de Mes
> Make sure that NAT traversal functions related to SIP known as [wiki:FAQ_3849 SIP ALG functionality] in the NAT routers are disabled. 
108 2 Tijmen de Mes
109 2 Tijmen de Mes
== AAA ==
110 2 Tijmen de Mes
111 2 Tijmen de Mes
Authentication, Authorization and Accounting are performed depending on particular call flows as follows:
112 2 Tijmen de Mes
113 2 Tijmen de Mes
=== Authentication ===
114 2 Tijmen de Mes
115 2 Tijmen de Mes
The trust relationship between SIP subscribers and SIP Proxy is based on DIGEST algorithm, both have a database with shared credentials. 
116 2 Tijmen de Mes
117 2 Tijmen de Mes
==== Sessions ====
118 2 Tijmen de Mes
 
119 2 Tijmen de Mes
Authentication for INVITE requests based on two methods:
120 2 Tijmen de Mes
121 2 Tijmen de Mes
 1. '''SIP credentials''', when the From header contains a domain served by the platform. The From header presented by the device must match the credentials used for authentication.
122 2 Tijmen de Mes
 1. '''Trusted peer''' identified by IP address, used when the From header contains a remote domain and the request URI is not a local SIP address.
123 2 Tijmen de Mes
124 2 Tijmen de Mes
By default, incoming SIP sessions from remote domains to local SIP accounts served by the platform are not authenticated and always authorized. 
125 2 Tijmen de Mes
126 2 Tijmen de Mes
For Instant Messaging and File transfers, MSRP relay reservations are authenticated using the same credentials for each SIP account.
127 2 Tijmen de Mes
128 2 Tijmen de Mes
==== Register ====
129 2 Tijmen de Mes
130 2 Tijmen de Mes
Authentication for REGISTER methods is based on SIP credentials, this method can be used only by local SIP accounts and will not be relayed outside the platform. The From header presented by the SIP device must match the credentials used for authentication.
131 2 Tijmen de Mes
132 2 Tijmen de Mes
==== Presence ====
133 2 Tijmen de Mes
134 2 Tijmen de Mes
The platform provides a Presence Agent that handles PUBLISH, SUBSCRIBE and NOTIFY methods based on SIP SIMPLE standards. The following event packages are supported:
135 2 Tijmen de Mes
136 2 Tijmen de Mes
 * presence
137 2 Tijmen de Mes
 * presence.winfo
138 2 Tijmen de Mes
139 2 Tijmen de Mes
Authentication for PUBLISH is based on SIP credentials, this methods can be used only by local SIP accounts  and will not be relayed outside the platform. The From header presented by the SIP device must match the credentials used for authentication. Authentication for SUBSCRIBE  requests are based on SIP credentials, when the From header contains a domain served by the SIP Proxy. 
140 2 Tijmen de Mes
141 2 Tijmen de Mes
SUBSCRIBE requests from remote domains are allowed without authentication when the request URI is a local SIP address served by the platform. 
142 2 Tijmen de Mes
143 2 Tijmen de Mes
SUBSCRIBE for the events message-summary and presence.winfo are allowed only for local users.
144 2 Tijmen de Mes
145 2 Tijmen de Mes
XCAP requests are authenticated using the same credentials for each SIP account.
146 2 Tijmen de Mes
147 2 Tijmen de Mes
The following XCAP documents are supported:
148 2 Tijmen de Mes
149 2 Tijmen de Mes
 * pres-rules
150 2 Tijmen de Mes
 * resource-lists
151 2 Tijmen de Mes
 * rls-services
152 2 Tijmen de Mes
 * xcap-caps
153 2 Tijmen de Mes
154 2 Tijmen de Mes
=== Authorization ===
155 2 Tijmen de Mes
156 2 Tijmen de Mes
==== Sessions ====
157 2 Tijmen de Mes
158 2 Tijmen de Mes
Authorization for outgoing SIP sessions can be performed for local SIP accounts based on:
159 2 Tijmen de Mes
160 2 Tijmen de Mes
 1. Access to PSTN
161 2 Tijmen de Mes
 1. Administrative blocking
162 2 Tijmen de Mes
 1. Monthly quota usage
163 2 Tijmen de Mes
 1. Prepaid balance
164 2 Tijmen de Mes
 1. Call barring (user driven)
165 2 Tijmen de Mes
 1. Custom SIP Proxy logic
166 2 Tijmen de Mes
167 2 Tijmen de Mes
Authorization for incoming SIP sessions can be performed for local SIP accounts based on:
168 2 Tijmen de Mes
169 2 Tijmen de Mes
 1. Administrative blocking
170 2 Tijmen de Mes
 1. Accept based on caller
171 2 Tijmen de Mes
 1. Accept based on time of day
172 2 Tijmen de Mes
 1. Reject  based on caller id
173 2 Tijmen de Mes
 1. Custom SIP Proxy logic
174 2 Tijmen de Mes
175 2 Tijmen de Mes
Automatic session cut-off
176 2 Tijmen de Mes
177 2 Tijmen de Mes
SIP sessions can be terminated forcefully by the platform based on the following conditions:
178 2 Tijmen de Mes
179 2 Tijmen de Mes
 1. Prepaid balance exceeded (in real time)
180 2 Tijmen de Mes
 1. Monthly quota exceeded (on the next call)
181 2 Tijmen de Mes
 1. Maximum call duration exceeded
182 2 Tijmen de Mes
 1. RTP media timeout
183 2 Tijmen de Mes
184 2 Tijmen de Mes
==== Presence ====
185 2 Tijmen de Mes
186 2 Tijmen de Mes
Authorization for SUBSCRIBE for the presence event can be performed for local SIP accounts based on:
187 2 Tijmen de Mes
188 2 Tijmen de Mes
 1. XCAP pres-rules document
189 2 Tijmen de Mes
 1. Trusted peers
190 2 Tijmen de Mes
  
191 2 Tijmen de Mes
=== Accounting ===
192 2 Tijmen de Mes
193 2 Tijmen de Mes
All SIP and RTP sessions are accounted by using RADIUS requests. See [wiki:AccountingGuide accounting guide for more information].
194 2 Tijmen de Mes
195 2 Tijmen de Mes
== End-Point to End-Point ==
196 2 Tijmen de Mes
197 2 Tijmen de Mes
[[Image(flow-sip-phone-a-b.png, width=600)]]
198 2 Tijmen de Mes
199 2 Tijmen de Mes
|| Authentication || SIP account A ||
200 2 Tijmen de Mes
|| Authorization || SIP account A ||
201 2 Tijmen de Mes
|| Billing party || SIP account A ||
202 2 Tijmen de Mes
|| Accounting || Postpaid, Prepaid ||
203 2 Tijmen de Mes
|| Media types || RTP (audio and video), Presence, MSRP (Instant messaging and file transfers) ||
204 2 Tijmen de Mes
|| Address resolution || SIP address, SIP alias, Quickdial, ENUM ||
205 2 Tijmen de Mes
|| From header || Must contain a local SIP domain||
206 2 Tijmen de Mes
207 2 Tijmen de Mes
=== Quick Dial ===
208 2 Tijmen de Mes
209 2 Tijmen de Mes
Quick dial is a per SIP account feature that allows to dial short numbers to match other SIP accounts in the same number range. The SIP Proxy will try to autocomplete the number to form a full address. To use this feature:
210 2 Tijmen de Mes
211 2 Tijmen de Mes
 1. The username part of the SIP account must be numeric (example 31208005169@ag-projects.com)
212 2 Tijmen de Mes
 2. The '''quickdial''' attribute of the SIP account must be set to a substring matching the beginning of the username (e.g. 312080051).     
213 2 Tijmen de Mes
 3. When user dials 60 the example above, the SIP Proxy will concatenate the quickdial set to 312080051 with the dialed number 60 and try 31208005160@ag-projects.com as destination. 
214 2 Tijmen de Mes
215 2 Tijmen de Mes
== End-Point to PBX ==
216 2 Tijmen de Mes
217 2 Tijmen de Mes
[[Image(flow-sip-phone-a-pbx-b.png, width=600)]]
218 2 Tijmen de Mes
219 2 Tijmen de Mes
|| Authentication || SIP account A ||
220 2 Tijmen de Mes
|| Authorization || SIP account A ||
221 2 Tijmen de Mes
|| Caller Id || Asserted by the platform ||
222 2 Tijmen de Mes
|| Billing party || SIP account A ||
223 2 Tijmen de Mes
|| Accounting || Postpaid, Prepaid ||
224 2 Tijmen de Mes
|| Media types || RTP (audio) ||
225 2 Tijmen de Mes
|| Address resolution || ENUM ||
226 2 Tijmen de Mes
|| From header || Must contain a local SIP domain||
227 2 Tijmen de Mes
228 2 Tijmen de Mes
== PBX to PBX ==
229 2 Tijmen de Mes
230 2 Tijmen de Mes
[[Image(flow-pbx-a-pbx-b.png, width=600)]]
231 2 Tijmen de Mes
232 2 Tijmen de Mes
The PBX has its own accounts and connected devices. Requests originating from a PBX cannot be therefore authorized based on username/password combinations as they are not provisioned in the platform subscriber database, they are locally managed by the PBX owner. The traffic generated by the PBX can be only identified by its source IP address(es). To allow traffic from a PBX, the platform uses the concept of trusted peers. A trusted peer is an IP address that is allowed to route SIP calls through the platform without digest authorization. Beware that, no checks are done by the proxy related to the incoming caller identity, as long as the SIP sessions originate from the trusted IP address. Once you trust an IP address, you trust all traffic generated by it.
233 2 Tijmen de Mes
234 2 Tijmen de Mes
|| Authentication || None ||
235 2 Tijmen de Mes
|| Authorization || Trusted peer A ||
236 2 Tijmen de Mes
|| Caller Id || Supplied by trusted peer A ||
237 2 Tijmen de Mes
|| Billing party || Trusted peer A ||
238 2 Tijmen de Mes
|| Accounting || Postpaid ||
239 2 Tijmen de Mes
|| Media types || RTP (audio) ||
240 2 Tijmen de Mes
|| Address resolution || ENUM ||
241 2 Tijmen de Mes
|| From header || Must contain a non-local SIP domain||
242 2 Tijmen de Mes
243 2 Tijmen de Mes
 * The domain name used by the PBX in the From field must be different than any domain served by the SIP Proxy otherwise the Proxy will challenge the session for credentials as it does for any other locally registered SIP account.
244 2 Tijmen de Mes
 * To route incoming traffic for a number block assigned to the PBX, create ENUM entries that point to the hostname (or IP address) of the PBX. 
245 2 Tijmen de Mes
246 2 Tijmen de Mes
== End-Point to PSTN ==
247 2 Tijmen de Mes
248 2 Tijmen de Mes
For interconnection with PSTN, a SIP trunking service must be setup between the SIP Proxy and the PSTN gateway provider. The authorization of SIP requests is based on transitive trust. The SIP Proxy has a trust relationship with each SIP subscriber and the PSTN gateway has a trust relation with the SIP Proxy. The trust relation between the SIP Proxy and the PSTN gateway is based on the IP addresses. The PSTN gateway cannot use DIGEST authentication in the relation with the SIP Proxy because it does not have access to the SIP accounts database of the SIP Proxy.
249 2 Tijmen de Mes
250 2 Tijmen de Mes
=== PSTN Gateway Requirements ===
251 2 Tijmen de Mes
252 2 Tijmen de Mes
Must have:
253 2 Tijmen de Mes
254 2 Tijmen de Mes
 * SIP signaling based on RFC 3261
255 2 Tijmen de Mes
 * DNS lookups based on RFC 3263
256 2 Tijmen de Mes
 * Support for SIP extensions for caller id and privacy (P headers)
257 2 Tijmen de Mes
 * RTP active mode (send RTP data as soon as call setup is completed)
258 2 Tijmen de Mes
 * Use public routable IP addresses for both signaling and media
259 2 Tijmen de Mes
260 2 Tijmen de Mes
Recommended:
261 2 Tijmen de Mes
262 2 Tijmen de Mes
 * ENUM lookups based on RFC 3761
263 2 Tijmen de Mes
264 2 Tijmen de Mes
Routing to PSTN destinations is realized by provisioning the PSTN carriers, gateways and routes (also known as Least Cost Routing engine or LCR). The structure of the PSTN provisioning is as follows:
265 2 Tijmen de Mes
266 2 Tijmen de Mes
{{{
267 2 Tijmen de Mes
Route ->  Carriers -> Gateways -> Rules
268 2 Tijmen de Mes
}}}
269 2 Tijmen de Mes
270 2 Tijmen de Mes
For each PSTN prefix (called a PSTN route) a set of carriers can be assigned with an optional priority. Each carrier can have one or more gateways and each gateway can have optional rules for converting the number. For more information see the [wiki:ProvisioningGuide provisioning guide].
271 2 Tijmen de Mes
272 2 Tijmen de Mes
Once the SIP request is authenticated, the SIP Proxy authorizes the request based on the rights associated with the subscriber account and decides whether a SIP session to the PSTN gateway is allowed or not. If the session is allowed, the SIP Proxy asserts an identity associated to the SIP account, which can be the telephone number presented as caller ID to the destination, locates a PSTN gateway for the dialed number (by using least cost routing or other configured logic) and forwards the request to the PSTN gateways inserting itself in the path of subsequent messages.
273 2 Tijmen de Mes
274 2 Tijmen de Mes
[[Image(flow-sip-phone-a-pstn.png, width=600)]]
275 2 Tijmen de Mes
276 2 Tijmen de Mes
|| Authentication || SIP account A ||
277 2 Tijmen de Mes
|| Authorization || SIP account A ||
278 2 Tijmen de Mes
|| Caller Id || Asserted by the platform ||
279 2 Tijmen de Mes
|| Billing party || SIP account A ||
280 2 Tijmen de Mes
|| Accounting || Postpaid, Prepaid ||
281 2 Tijmen de Mes
|| Media types || RTP (audio) ||
282 2 Tijmen de Mes
|| Address resolution || ENUM, LCR ||
283 2 Tijmen de Mes
|| From header || Must contain a local SIP domain||
284 2 Tijmen de Mes
285 2 Tijmen de Mes
=== Caller id indication ===
286 2 Tijmen de Mes
287 2 Tijmen de Mes
The platform generates a Caller ID indication by appending Remote-Party-Id or P-Asserted identity headers, depending on its configuration.  The content of the headers is generated with the SipAccount->rpid attribute associated with the SIP account.
288 2 Tijmen de Mes
289 2 Tijmen de Mes
== PSTN to End-Point ==
290 2 Tijmen de Mes
291 2 Tijmen de Mes
The platform is designed to accept traffic from outside SIP end-points (this includes remote PSTN gateways) to any local user. This means that a PSTN gateway that initiates a session to a correct SIP address user@domain belonging to the platform will be accepted and routed to the SIP devices belonging to the user with no extra configurations. When a SIP session originates from the PSTN, only the dialed telephone (a.k.a. E.164) number is known. For routing sessions from the PSTN to the SIP Proxy of the platform the gateway must translate the telephone number into a valid SIP address. 
292 2 Tijmen de Mes
293 2 Tijmen de Mes
==== ENUM Routing ====
294 2 Tijmen de Mes
295 2 Tijmen de Mes
[[Image(msp-enum-lookup.png)]]
296 2 Tijmen de Mes
297 2 Tijmen de Mes
The ideal way to achieve this number translation with minimum configuration is for the PSTN gateway to perform an ENUM lookup (RFC 3761). All popular open source software gateways like Asterisk and OpenSIPS are able to perform ENUM lookups and commercial gateways have started adding this support into their commercial products.
298 2 Tijmen de Mes
299 2 Tijmen de Mes
The ENUM look-up queries the DNS server provisioned with E.164 numbers by the operator, which is always kept up to date by the operator. The result of a successful ENUM lookup is a SIP address. Once the ENUM lookup is complete, the PSTN gateway can initiate the SIP session to the SIP address returned by the ENUM lookups.
300 2 Tijmen de Mes
301 2 Tijmen de Mes
The only setting required in the PSTN gateway for this setup is the top level domain used to perform ENUM lookups. The ENUM top level domain must be the same used by the SIP Proxy lookup and NGNPro provisioning.
302 2 Tijmen de Mes
303 2 Tijmen de Mes
==== Manual Routing ====
304 2 Tijmen de Mes
305 2 Tijmen de Mes
For PSTN gateways that are not able to perform ENUM lookups and from which we need to accept incoming sessions, the SIP Proxy can be configured to accept any traffic, manipulate the number format based on custom rules and help performing the ENUM lookup in the behalf of the gateway. 
306 2 Tijmen de Mes
307 2 Tijmen de Mes
The PSTN gateway must be configured for the E.164 number ranges to be routed to the MSP platform and the hostname of the SIP Proxy machine (e.g. sip.example.com). Do not use static IP addresses in the PSTN configuration, use the DNS name configured by the operator so that when the IP addresses of the SIP Proxy change or when multiple SIP Proxies are used by default (like in SIP Thor) the gateway does not need to be re-configured.
308 2 Tijmen de Mes
309 2 Tijmen de Mes
You must setup the following SIP Proxy configuration file:
310 2 Tijmen de Mes
311 2 Tijmen de Mes
{{{
312 2 Tijmen de Mes
sipproxy:/etc/opensips/config/siteconfig/handle-incoming-pstn.m4
313 2 Tijmen de Mes
}}}
314 2 Tijmen de Mes
315 2 Tijmen de Mes
Example: 
316 2 Tijmen de Mes
317 2 Tijmen de Mes
{{{
318 2 Tijmen de Mes
if (allow_trusted()) {
319 2 Tijmen de Mes
    DINFO("Incoming PSTN call");
320 2 Tijmen de Mes
    if (uri=~"^sip:0[1-9][0-9]{4,}@.*") {
321 2 Tijmen de Mes
        strip(1);
322 2 Tijmen de Mes
        prefix("+31");
323 2 Tijmen de Mes
        DINFO("Converted to ENUM number $ru");
324 2 Tijmen de Mes
    } else if (uri=~"^sip:0031[1-9][0-9]{4,}@.*") {
325 2 Tijmen de Mes
        strip(2);
326 2 Tijmen de Mes
        prefix("+");
327 2 Tijmen de Mes
        DINFO("Converted to ENUM number $ru");
328 2 Tijmen de Mes
    } else {
329 2 Tijmen de Mes
        ERROR("Invalid destination");
330 2 Tijmen de Mes
        sl_send_reply("403", "Invalid destination");
331 2 Tijmen de Mes
        LOG_MISSED_CALL("403");
332 2 Tijmen de Mes
        exit;
333 2 Tijmen de Mes
    }
334 2 Tijmen de Mes
335 2 Tijmen de Mes
    rewritehostport("example.com");
336 2 Tijmen de Mes
337 2 Tijmen de Mes
    route(__ENUM_LOOKUP);
338 2 Tijmen de Mes
339 2 Tijmen de Mes
    if (retcode==-1) {
340 2 Tijmen de Mes
        DINFO("User not found");
341 2 Tijmen de Mes
        sl_send_reply("404", "User not found");
342 2 Tijmen de Mes
        LOG_MISSED_CALL("404");
343 2 Tijmen de Mes
        exit;
344 2 Tijmen de Mes
    } else if (!is_uri_host_local()) {
345 2 Tijmen de Mes
        DINFO("Call to non local user");
346 2 Tijmen de Mes
        sl_send_reply("403", "Invalid destination");
347 2 Tijmen de Mes
        LOG_MISSED_CALL("403");
348 2 Tijmen de Mes
        exit;
349 2 Tijmen de Mes
    }
350 2 Tijmen de Mes
}
351 2 Tijmen de Mes
}}}
352 2 Tijmen de Mes
353 2 Tijmen de Mes
|| Authentication || None ||
354 2 Tijmen de Mes
|| Authorization || Custom SIP Proxy logic ||
355 2 Tijmen de Mes
|| Billing party || Trusted peer  ||
356 2 Tijmen de Mes
|| Accounting || Postpaid||
357 2 Tijmen de Mes
|| Media types || RTP (audio) ||
358 2 Tijmen de Mes
|| From header || Must contain a non-local SIP domain||
359 2 Tijmen de Mes
|| Address resolution || ENUM, Custom SIP Proxy logic ||
360 2 Tijmen de Mes
361 2 Tijmen de Mes
== PBX to PSTN ==
362 2 Tijmen de Mes
363 2 Tijmen de Mes
[[Image(flow-pbx-a-pstn.png, width=600)]]
364 2 Tijmen de Mes
365 2 Tijmen de Mes
The IP address(es) of the PBX must be added in the trusted table using the SOAP/XML provisioning API. To allow trusted parties to transit your SIP Proxy edit sip:/etc/opensips/config/siteconfig/handle-incoming-pstn.m4 and add to it:
366 2 Tijmen de Mes
367 2 Tijmen de Mes
{{{
368 2 Tijmen de Mes
if (allow_trusted()) {
369 2 Tijmen de Mes
    if (uri=~"^sip:0[1-9]*@.*") {
370 2 Tijmen de Mes
        # National calls must be formated as 00XX
371 2 Tijmen de Mes
        strip(1);
372 2 Tijmen de Mes
        prefix("0031");
373 2 Tijmen de Mes
        route(__PSTN_TRANSIT);
374 2 Tijmen de Mes
        exit;
375 2 Tijmen de Mes
    } else if (uri=~"^sip:00[1-9]*@.*") {
376 2 Tijmen de Mes
        # International calls
377 2 Tijmen de Mes
        route(__PSTN_TRANSIT);
378 2 Tijmen de Mes
        exit;
379 2 Tijmen de Mes
    } else {
380 2 Tijmen de Mes
        ERROR("Invalid destination");
381 2 Tijmen de Mes
        sl_send_reply("403", "Invalid destination");
382 2 Tijmen de Mes
        LOG_MISSED_CALL("403");
383 2 Tijmen de Mes
        exit;
384 2 Tijmen de Mes
    }
385 2 Tijmen de Mes
}
386 2 Tijmen de Mes
}}}
387 2 Tijmen de Mes
388 2 Tijmen de Mes
|| Authentication || None ||
389 2 Tijmen de Mes
|| Authorization || Trusted peer A ||
390 2 Tijmen de Mes
|| Caller Id || Supplied by trusted peer A ||
391 2 Tijmen de Mes
|| Billing party || Trusted peer A ||
392 2 Tijmen de Mes
|| Accounting || Postpaid||
393 2 Tijmen de Mes
|| Media types || RTP (audio) ||
394 2 Tijmen de Mes
|| Address resolution || ENUM, LCR, Custom SIP Proxy logic ||
395 2 Tijmen de Mes
|| From header || Must contain a non-local SIP domain||
396 2 Tijmen de Mes
397 2 Tijmen de Mes
The domain name used by the PBX in the From field must be different than any domain served by the SIP Proxy otherwise the Proxy will challenge the session for credentials as it does for any other locally registered SIP account.
398 2 Tijmen de Mes
399 2 Tijmen de Mes
=== Rating ===
400 2 Tijmen de Mes
401 2 Tijmen de Mes
To rate the traffic generated by trusted peers you must add a rating plan in CDRTool rating engine based on the source IP address (the gateway field in rating customers table). Beware that no quota can be imposed on the traffic of a trusted peer.
402 2 Tijmen de Mes
403 2 Tijmen de Mes
=== Caller Id Indication ===
404 2 Tijmen de Mes
405 2 Tijmen de Mes
Traffic generated by the trusted peers and any header thereof containing caller id indication is also trusted. When allowing traffic to transit from PBXs to PSTN gateways connected to the, make sure that the way caller ID indication is provided by the trusted party is compatible with what the PSTN gateway expects. 
406 2 Tijmen de Mes
407 2 Tijmen de Mes
== PSTN to PBX ==
408 2 Tijmen de Mes
409 2 Tijmen de Mes
[[Image(flow-pbx-a-pstn.png, width=600)]]
410 2 Tijmen de Mes
411 2 Tijmen de Mes
|| Authentication || None ||
412 2 Tijmen de Mes
|| Authorization || Trusted peer PSTN gateway ||
413 2 Tijmen de Mes
|| Caller Id || Supplied by PSTN gateway ||
414 2 Tijmen de Mes
|| Billing party || Trusted peer PSTN gateway ||
415 2 Tijmen de Mes
|| Accounting || Postpaid||
416 2 Tijmen de Mes
|| Media types || RTP (audio) ||
417 2 Tijmen de Mes
|| From header || Must contain a non-local SIP domain||
418 2 Tijmen de Mes
|| Address resolution || ENUM, Custom SIP Proxy logic ||
419 2 Tijmen de Mes
420 2 Tijmen de Mes
== Call Diversion ==
421 2 Tijmen de Mes
422 2 Tijmen de Mes
[[Image(flow-sip-phone-a-b-diverted.png, width=600)]]
423 2 Tijmen de Mes
424 2 Tijmen de Mes
A user may chose to divert his/her calls based on various conditions (like unconditional, busy or not online) to another SIP address including PSTN destinations. Diverted calls are always charged to the user who enabled them. For every call diversion, a new Diversion header is appended to the original SIP request.
425 2 Tijmen de Mes
 
426 2 Tijmen de Mes
|| Authentication || SIP account A ||
427 2 Tijmen de Mes
|| Authorization || SIP account A ||
428 2 Tijmen de Mes
|| Billing party || SIP account B ||
429 2 Tijmen de Mes
|| Accounting || Postpaid, Prepaid ||
430 2 Tijmen de Mes
|| Address resolution || SIP address, SIP alias, Quickdial, ENUM, LCR ||
431 2 Tijmen de Mes
432 2 Tijmen de Mes
== Presence ==
433 2 Tijmen de Mes
434 2 Tijmen de Mes
[[Image(flow-presence.png, width=600)]]
435 2 Tijmen de Mes
436 2 Tijmen de Mes
Multiple watchers are subscribed to a publisher. The Publisher authorizes the watchers to subscriber to presence notifications by updating pres-rules XCAP document. The Publisher must subscribe to event presence.winfo to receive notifications from the Presence Agent about the watcher list.
437 2 Tijmen de Mes
438 2 Tijmen de Mes
|| Authorization || XCAP pres-rules ||
439 2 Tijmen de Mes
|| Address resolution || SIP address, SIP alias, Quickdial, ENUM ||
440 2 Tijmen de Mes
|| Accounting || None ||
441 2 Tijmen de Mes
442 2 Tijmen de Mes
== RLS Services ==
443 2 Tijmen de Mes
444 2 Tijmen de Mes
[[Image(flow-rls-services.png, width=600)]]
445 2 Tijmen de Mes
446 2 Tijmen de Mes
A subscriber uploads to the XCAP server a resource list. Then it subscribes to the list by sending a SUBSCRIBE for event presence with extra header Supported: eventlist, the Presence agent then subscribes to all recipients from the resource lists and returns consolidated NOTIFY with the state of all lists.
447 2 Tijmen de Mes
448 2 Tijmen de Mes
|| Authorization || XCAP pres-rules ||
449 2 Tijmen de Mes
|| Address resolution || SIP address, SIP alias, Quickdial, ENUM ||
450 2 Tijmen de Mes
|| Accounting || None ||
451 2 Tijmen de Mes
452 2 Tijmen de Mes
== IM using MSRP Relay ==
453 2 Tijmen de Mes
454 2 Tijmen de Mes
[[Image(flow-msrp-relay.png, width=600)]]
455 2 Tijmen de Mes
456 2 Tijmen de Mes
Instant Messaging based on MSRP protocol is similar to a regular SIP audio session. Instead of RTP media , MSRP is used for establishing a media channel. Instead of MediaProxy, A MSRP relay is used to traverse the NAT. The called party reserves a session in the MSRP relay and offeres it in the response to the SIP INVITE. The calling party the initiates a TCP/TLS connection to the relay reserved address and the called party does the same. By using the relay both parties can establish a TCP flow from behind their NAT routers.
457 2 Tijmen de Mes
458 2 Tijmen de Mes
== IM using MSRP ACM  ==
459 2 Tijmen de Mes
460 2 Tijmen de Mes
[[Image(flow-msrp-acm.png, width=600)]]
461 2 Tijmen de Mes
462 2 Tijmen de Mes
MSRP ACM is an alternative method for traversing NAT that is standardized by 3GPP that is interoperable with the IETF MSRP relay specification. The SBC mangles the SDP and stays in the SIP signaling and MSRP media path and forces the end-points to be both active (that is starting the outbound MSRP connection) when behind NAT. 
463 2 Tijmen de Mes
464 2 Tijmen de Mes
== IM using MSRP ACM  and Relay ==
465 2 Tijmen de Mes
466 2 Tijmen de Mes
[[Image(flow-msrp-acm-relay.png, width=600)]]
467 2 Tijmen de Mes
468 2 Tijmen de Mes
MSRP ACM and Relay methodologies can interoperate.
469 2 Tijmen de Mes
  
470 2 Tijmen de Mes
== File Transfer ==
471 2 Tijmen de Mes
472 2 Tijmen de Mes
File transfer based on MSRP protocol is similar to a regular SIP audio session. Instead of RTP media , MSRP is used for establishing a media channel. A MSRP relay is used to traverse the NAT.
473 2 Tijmen de Mes
474 2 Tijmen de Mes
== Emergency Calls ==
475 2 Tijmen de Mes
476 2 Tijmen de Mes
Emergency calls refer to dialing short numbers usually associated with emergency services like police or fire-brigade (e.g. 112 or 911). When a session is setup to a short number designated as an emergency number (in the SIP Proxy configuration), a database lookup is performed by the proxy in the emergency_mapping table. Based on the '''region''' attribute provisioned with the SIP account, the final destination corresponding with the emergency number is looked up. Only local users can dial an emergency number.
477 2 Tijmen de Mes
478 2 Tijmen de Mes
See [wiki:ProvisioningGuide#Emergencynumbers Provisioning the emergency numbers] section for more information.
479 2 Tijmen de Mes
480 2 Tijmen de Mes
=== PBX Functions ===
481 2 Tijmen de Mes
482 2 Tijmen de Mes
Functions involving playing media in the middle of a call setup are not possible by the design of a SIP Proxy. Features like:
483 2 Tijmen de Mes
484 2 Tijmen de Mes
    * IVR
485 2 Tijmen de Mes
    * Auto-attendant
486 2 Tijmen de Mes
    * Call queues and ACD
487 2 Tijmen de Mes
    * Listen-in and barge-in
488 2 Tijmen de Mes
    * Call parking
489 2 Tijmen de Mes
    * Music on hold (MoH)
490 2 Tijmen de Mes
491 2 Tijmen de Mes
are not performed by a SIP Proxy. Such functions can be implemented only by dedicated IP-PBX added to the platform. The platform is used to route calls between such PBXs, from the MSP perspective these PBX are seen as SIP trunks connected to the platform.