Routing guide » History » Version 39
Adrian Georgescu, 10/24/2013 10:08 PM
1 | 5 | Tijmen de Mes | h1. Routing Guide |
---|---|---|---|
2 | |||
3 | 20 | Adrian Georgescu | MSP and SIP Thor platforms are based on a SIP Proxy/Registrar/Presence Agent design. Each SIP server node maintains transaction and dialog state for each 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 authorization, authentication, accounting, NAT traversal and session termination based on the media flow behavior. The design eliminates the need of separate session border controller elements which just add costs, hurt scalability and add no end-user features. |
4 | 1 | Tijmen de Mes | |
5 | 12 | Adrian Georgescu | The platform has rich 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 | 12 | Adrian Georgescu | The platform can be equally used to perform SIP services that include and are not limited to Residential VoIP, Prepaid Cards, Video Calling, Presence and IM, Trunking, Least Cost Routing and ENUM Peering. |
8 | 1 | Tijmen de Mes | |
9 | 4 | Tijmen de Mes | h2. Logical Architecture |
10 | 2 | Tijmen de Mes | |
11 | 6 | Tijmen de Mes | !msp-interconnect.png! |
12 | 2 | Tijmen de Mes | |
13 | 1 | Tijmen de Mes | h2. SIP Entities |
14 | |||
15 | 2 | Tijmen de Mes | This document describes routing logic between several SIP entities defined as follows: |
16 | |||
17 | 4 | Tijmen de Mes | # SIP Proxy: the platform core that performs the logic described in this document |
18 | # End-Point: a SIP end-user device that is configured with the credentials of a SIP account for which the platform is responsable |
||
19 | # PBX: a SIP end-point or intermediary that is configured under a foreign SIP domain not handled by the platform |
||
20 | # PSTN gateway: a SIP end-point or intermediary that is handling the translation between IP (using SIP protocol) and PSTN networks |
||
21 | 1 | Tijmen de Mes | |
22 | 4 | Tijmen de Mes | h2. Supported Signaling |
23 | 3 | Tijmen de Mes | |
24 | 20 | Adrian Georgescu | The platform supports SIP protocol over UDP/TCP/TLS transports. Additional, a gateway to and from XMPP remote domains can be configured. |
25 | 2 | Tijmen de Mes | |
26 | 3 | Tijmen de Mes | h2. Supported Media |
27 | 2 | Tijmen de Mes | |
28 | The platform supports sessions containing the following media types: |
||
29 | 1 | Tijmen de Mes | |
30 | 4 | Tijmen de Mes | * Audio (RTP and sRTP) |
31 | * Video (RTP and sRTP) |
||
32 | * FAX (RTP and T.38) |
||
33 | * Instant messaging (MSRP and its relay extension) |
||
34 | * File transfer (MSRP and its relay extension) |
||
35 | * Page mode messaging (SIP MESSAGE method) |
||
36 | 22 | Adrian Georgescu | * Presence (PIDF XML) |
37 | 2 | Tijmen de Mes | |
38 | 4 | 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. |
39 | 2 | Tijmen de Mes | |
40 | 1 | 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). |
41 | |||
42 | 2 | Tijmen de Mes | h2. Primitives |
43 | |||
44 | 3 | Tijmen de Mes | The routing of SIP sessions is governed by two main protocols: |
45 | 2 | Tijmen de Mes | |
46 | 4 | Tijmen de Mes | # Domain based SIP routing based on RFC3261 and RFC3263 |
47 | # ENUM lookups based on RFC3761 |
||
48 | 2 | Tijmen de Mes | |
49 | The routing logic of the platform can be configured by changing its database tables and configuration files. The primitives used for routing are: |
||
50 | |||
51 | |||
52 | 4 | Tijmen de Mes | |Registrar database|Used to translate a SIP address into a SIP contact address| |
53 | |ENUM|Used to translate an E.164 telephone number into a SIP address| |
||
54 | |SIP alias|Used for adding aliases to existing SIP accounts| |
||
55 | |Emergency numbers|Translation between 911 and 112 into closest emergency access points| |
||
56 | |Call diversion|Translate a SIP address into another based on signaling conditions or end-user preferences| |
||
57 | 1 | Tijmen de Mes | |DNS lookups|Translate a SIP domain/hostname into an protocol:IP:port combination| |
58 | 22 | Adrian Georgescu | |LCR|Used for selection of outgoing PSTN gateway| |
59 | 2 | Tijmen de Mes | |
60 | |||
61 | 4 | Tijmen de Mes | h2. Server Location |
62 | 1 | Tijmen de Mes | |
63 | 4 | 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. |
64 | 1 | Tijmen de Mes | |
65 | 4 | Tijmen de Mes | h2. Configuration Files |
66 | 1 | Tijmen de Mes | |
67 | 4 | Tijmen de Mes | Index of SIP Proxy configuration files located in/etc/opensips/: |
68 | 2 | Tijmen de Mes | |
69 | 4 | Tijmen de Mes | |
70 | |config/settings.m4|Contains the settings that can customize the routing logic| |
||
71 | |config/opensips.m4|Contains the proxy routing logic (should not be modified)| |
||
72 | |config/siteconfig/handle-incoming-pstn.m4|Used to customize routing logic for incoming PSTN calls| |
||
73 | |config/siteconfig/handle-local-extensions.m4|Used to define installation specific custom local extensions| |
||
74 | |config/siteconfig/handle-outgoing-peers.m4|Used to customize routing for outgoing calls to non-local domains| |
||
75 | |config/siteconfig/postprocess-request.m4|Used to customize outgoing requests before they leave the proxy| |
||
76 | |config/siteconfig/preprocess-pstn.m4|Used to customize outgoing PSTN requests before applying LCR routing| |
||
77 | |config/siteconfig/preprocess-request.m4|Used to apply custom pre-processing to a request before anything else| |
||
78 | |config/siteconfig/preprocess-uri.m4|Used to apply custom pre-processing to the request URI before converting to E164| |
||
79 | |||
80 | |||
81 | The settings.m4 file is used to customize the existing routing logic defined in opensips.m4 using the predefined routing options. |
||
82 | 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. 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. |
||
83 | |||
84 | 2 | Tijmen de Mes | h2. NAT Traversal |
85 | 1 | Tijmen de Mes | |
86 | 4 | Tijmen de Mes | NAT traversal methods encountered in the field and their properties: |
87 | 1 | Tijmen de Mes | |
88 | 4 | Tijmen de Mes | * SIP server based (Relay) - reliable server side technology that works with all SIP clients, this method is used by the platform |
89 | * SIP client based (ICE) - client and server technology where client may negotiate media paths, is supported by the platform |
||
90 | * Intermediates based: |
||
91 | ** NAT routers with SIP Application Level Gateway (SIP ALG) - located in customer premises network and the most *unreliable* technique |
||
92 | ** Sessions Border Controllers (SBC) - located in service provider network - reliable with high cost and high complexity |
||
93 | 1 | Tijmen de Mes | |
94 | 4 | 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. |
95 | 2 | Tijmen de Mes | |
96 | Below is a display of all possible NAT traversal techinques used for SIP and related media. |
||
97 | |||
98 | 6 | Tijmen de Mes | !nat-traversal-techniques.png! |
99 | 1 | Tijmen de Mes | |
100 | 4 | 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. |
101 | 2 | Tijmen de Mes | |
102 | 4 | Tijmen de Mes | Optional, "ICE can be deployed":http://mediaproxy-ng.org/wiki/ICE 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. |
103 | 2 | Tijmen de Mes | |
104 | 4 | 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. |
105 | 2 | Tijmen de Mes | |
106 | 1 | Tijmen de Mes | h3. Platform Ports |
107 | |||
108 | 4 | Tijmen de Mes | See the Firewall Setup section for a list of ports used by the platform software. |
109 | 1 | Tijmen de Mes | |
110 | 4 | Tijmen de Mes | bq. Make sure that NAT traversal functions related to SIP known as SIP ALG functionality in the NAT routers are disabled. |
111 | 1 | Tijmen de Mes | |
112 | 4 | Tijmen de Mes | |
113 | |||
114 | 1 | Tijmen de Mes | h2. AAA |
115 | |||
116 | Authentication, Authorization and Accounting are performed depending on particular call flows as follows: |
||
117 | |||
118 | 4 | Tijmen de Mes | h3. Authentication |
119 | 1 | Tijmen de Mes | |
120 | 4 | Tijmen de Mes | The trust relationship between SIP subscribers and SIP Proxy is based on DIGEST algorithm, both have a database with shared credentials. |
121 | 1 | Tijmen de Mes | |
122 | 4 | Tijmen de Mes | h4. Sessions |
123 | |||
124 | 1 | Tijmen de Mes | Authentication for INVITE requests based on two methods: |
125 | 2 | Tijmen de Mes | |
126 | 4 | Tijmen de Mes | # *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. |
127 | # *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. |
||
128 | 1 | Tijmen de Mes | |
129 | 4 | 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. |
130 | 1 | Tijmen de Mes | |
131 | For Instant Messaging and File transfers, MSRP relay reservations are authenticated using the same credentials for each SIP account. |
||
132 | |||
133 | 4 | Tijmen de Mes | h4. Register |
134 | 1 | Tijmen de Mes | |
135 | 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. |
||
136 | 2 | Tijmen de Mes | |
137 | h4. Presence |
||
138 | 1 | Tijmen de Mes | |
139 | The platform provides a Presence Agent that handles PUBLISH, SUBSCRIBE and NOTIFY methods based on SIP SIMPLE standards. The following event packages are supported: |
||
140 | |||
141 | 4 | Tijmen de Mes | * presence |
142 | * presence.winfo |
||
143 | 19 | Adrian Georgescu | * xcap-diff |
144 | 1 | Tijmen de Mes | |
145 | 4 | 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. |
146 | 1 | Tijmen de Mes | |
147 | 4 | 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. |
148 | 1 | Tijmen de Mes | |
149 | SUBSCRIBE for the events message-summary and presence.winfo are allowed only for local users. |
||
150 | |||
151 | 2 | Tijmen de Mes | XCAP requests are authenticated using the same credentials for each SIP account. |
152 | 1 | Tijmen de Mes | |
153 | The following XCAP documents are supported: |
||
154 | |||
155 | 13 | Adrian Georgescu | http://www.openxcap.org/projects/openxcap/wiki/Features |
156 | 2 | Tijmen de Mes | |
157 | 4 | Tijmen de Mes | h3. Authorization |
158 | 1 | Tijmen de Mes | |
159 | 4 | Tijmen de Mes | h4. Sessions |
160 | 2 | Tijmen de Mes | |
161 | Authorization for outgoing SIP sessions can be performed for local SIP accounts based on: |
||
162 | 1 | Tijmen de Mes | |
163 | 4 | Tijmen de Mes | # Access to PSTN |
164 | # Administrative blocking |
||
165 | # Monthly quota usage |
||
166 | # Prepaid balance |
||
167 | 14 | Adrian Georgescu | # Concurrent number of calls |
168 | 4 | Tijmen de Mes | # Call barring (user driven) |
169 | # Custom SIP Proxy logic |
||
170 | 1 | Tijmen de Mes | |
171 | 2 | Tijmen de Mes | Authorization for incoming SIP sessions can be performed for local SIP accounts based on: |
172 | |||
173 | 14 | Adrian Georgescu | # Source IP address |
174 | 4 | Tijmen de Mes | # Administrative blocking |
175 | # Accept based on caller |
||
176 | # Accept based on time of day |
||
177 | # Reject based on caller id |
||
178 | # Custom SIP Proxy logic |
||
179 | 1 | Tijmen de Mes | |
180 | Automatic session cut-off |
||
181 | |||
182 | SIP sessions can be terminated forcefully by the platform based on the following conditions: |
||
183 | |||
184 | 4 | Tijmen de Mes | # Prepaid balance exceeded (in real time) |
185 | # Monthly quota exceeded (on the next call) |
||
186 | # Maximum call duration exceeded |
||
187 | # RTP media timeout |
||
188 | 14 | Adrian Georgescu | # Signaling path lost |
189 | |||
190 | 1 | Tijmen de Mes | |
191 | 4 | Tijmen de Mes | h4. Presence |
192 | 1 | Tijmen de Mes | |
193 | 2 | Tijmen de Mes | Authorization for SUBSCRIBE for the presence event can be performed for local SIP accounts based on: |
194 | |||
195 | 4 | Tijmen de Mes | # XCAP pres-rules document |
196 | # Trusted peers |
||
197 | 2 | Tijmen de Mes | |
198 | |||
199 | |||
200 | 4 | Tijmen de Mes | h3. Accounting |
201 | 2 | Tijmen de Mes | |
202 | 4 | Tijmen de Mes | All SIP and RTP sessions are accounted by using RADIUS requests. See "accounting guide for more information":/wiki/AccountingGuide. |
203 | 1 | Tijmen de Mes | |
204 | 4 | Tijmen de Mes | h2. End-Point to End-Point |
205 | 1 | Tijmen de Mes | |
206 | 7 | Tijmen de Mes | !flow-sip-phone-a-b.png! |
207 | 4 | Tijmen de Mes | |
208 | |||
209 | |Authentication|SIP account A| |
||
210 | |Authorization|SIP account A| |
||
211 | |Billing party|SIP account A| |
||
212 | |Accounting|Postpaid, Prepaid| |
||
213 | |Media types|RTP (audio and video), Presence, MSRP (Instant messaging and file transfers)| |
||
214 | |Address resolution|SIP address, SIP alias, Quickdial, ENUM| |
||
215 | |From header|Must contain a local SIP domain| |
||
216 | 30 | Adrian Georgescu | |Fraud Control | PIKE, ACL, Call control | |
217 | 4 | Tijmen de Mes | |
218 | h3. Quick Dial |
||
219 | |||
220 | 1 | 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: |
221 | |||
222 | 4 | Tijmen de Mes | # The username part of the SIP account must be numeric (example "31208005169@ag-projects.com":mailto:31208005169@ag-projects.com) |
223 | # The *quickdial* attribute of the SIP account must be set to a substring matching the beginning of the username (e.g. 312080051). |
||
224 | # 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":mailto:31208005160@ag-projects.com as destination. |
||
225 | 1 | Tijmen de Mes | |
226 | 4 | Tijmen de Mes | h2. End-Point to PBX |
227 | 1 | Tijmen de Mes | |
228 | 7 | Tijmen de Mes | !flow-sip-phone-a-pbx-b.png! |
229 | 1 | Tijmen de Mes | |
230 | |||
231 | 4 | Tijmen de Mes | |Authentication|SIP account A| |
232 | |Authorization|SIP account A| |
||
233 | |Caller Id|Asserted by the platform| |
||
234 | |Billing party|SIP account A| |
||
235 | |Accounting|Postpaid, Prepaid| |
||
236 | |Media types|RTP (audio)| |
||
237 | |Address resolution|ENUM| |
||
238 | |From header|Must contain a local SIP domain| |
||
239 | 30 | Adrian Georgescu | |Fraud Control | PIKE, ACL, Call control | |
240 | 1 | Tijmen de Mes | |
241 | 4 | Tijmen de Mes | h2. PBX to PBX |
242 | |||
243 | 7 | Tijmen de Mes | !flow-pbx-a-pbx-b.png! |
244 | 4 | Tijmen de Mes | |
245 | 1 | 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. |
246 | |||
247 | |||
248 | 4 | Tijmen de Mes | |Authentication|None| |
249 | |Authorization|Trusted peer A| |
||
250 | |Caller Id|Supplied by trusted peer A| |
||
251 | |Billing party|Trusted peer A| |
||
252 | |Accounting|Postpaid| |
||
253 | 36 | Adrian Georgescu | |Media types|RTP (audio, video), T.38 Fax, SIP MESSAGE| |
254 | 1 | Tijmen de Mes | |Address resolution|ENUM| |
255 | 4 | Tijmen de Mes | |From header|Must contain a non-local SIP domain| |
256 | 30 | Adrian Georgescu | |Fraud Control | None | |
257 | 2 | Tijmen de Mes | |
258 | 4 | 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. |
259 | * 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. |
||
260 | |||
261 | h2. End-Point to PSTN |
||
262 | |||
263 | 1 | 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. |
264 | |||
265 | 4 | Tijmen de Mes | h3. PSTN Gateway Requirements |
266 | 2 | Tijmen de Mes | |
267 | Must have: |
||
268 | |||
269 | 4 | Tijmen de Mes | * SIP signaling based on RFC 3261 |
270 | * DNS lookups based on RFC 3263 |
||
271 | * Support for SIP extensions for caller id and privacy (P headers) |
||
272 | * RTP active mode (send RTP data as soon as call setup is completed) |
||
273 | * Use public routable IP addresses for both signaling and media |
||
274 | 2 | Tijmen de Mes | |
275 | Recommended: |
||
276 | |||
277 | 4 | Tijmen de Mes | * ENUM lookups based on RFC 3761 |
278 | 2 | Tijmen de Mes | |
279 | 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: |
||
280 | |||
281 | 9 | Tijmen de Mes | Route -> Carriers -> Gateways -> Rules |
282 | 2 | Tijmen de Mes | |
283 | |||
284 | 4 | 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 "provisioning guide":/wiki/ProvisioningGuide. |
285 | |||
286 | 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. |
287 | |||
288 | 7 | Tijmen de Mes | !flow-sip-phone-a-pstn.png! |
289 | 2 | Tijmen de Mes | |
290 | |||
291 | 4 | Tijmen de Mes | |Authentication|SIP account A| |
292 | |Authorization|SIP account A| |
||
293 | |Caller Id|Asserted by the platform| |
||
294 | 1 | Tijmen de Mes | |Billing party|SIP account A| |
295 | 4 | Tijmen de Mes | |Accounting|Postpaid, Prepaid| |
296 | 36 | Adrian Georgescu | |Media types|RTP (audio, video), T.38 Fax, SIP MESSAGE| |
297 | 4 | Tijmen de Mes | |Address resolution|ENUM, LCR| |
298 | 2 | Tijmen de Mes | |From header|Must contain a local SIP domain| |
299 | 27 | Tijmen de Mes | |Fraud Control | PIKE, ACL, Call limit | |
300 | 2 | Tijmen de Mes | |
301 | 4 | Tijmen de Mes | h3. Caller id indication |
302 | 2 | Tijmen de Mes | |
303 | 4 | 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. |
304 | 2 | Tijmen de Mes | |
305 | 4 | Tijmen de Mes | h2. PSTN to End-Point |
306 | 2 | Tijmen de Mes | |
307 | 4 | 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. |
308 | 2 | Tijmen de Mes | |
309 | 4 | Tijmen de Mes | h4. ENUM Routing |
310 | |||
311 | 7 | Tijmen de Mes | !msp-enum-lookup.png! |
312 | 4 | Tijmen de Mes | |
313 | 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. |
314 | |||
315 | 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. |
||
316 | |||
317 | 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. |
||
318 | |||
319 | 4 | Tijmen de Mes | h4. Manual Routing |
320 | 2 | Tijmen de Mes | |
321 | 4 | 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. |
322 | 2 | Tijmen de Mes | |
323 | 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. |
||
324 | |||
325 | You must setup the following SIP Proxy configuration file: |
||
326 | |||
327 | 8 | Tijmen de Mes | sipproxy:/etc/opensips/config/siteconfig/handle-incoming-pstn.m4 |
328 | 2 | Tijmen de Mes | |
329 | |||
330 | 4 | Tijmen de Mes | Example: |
331 | 1 | Tijmen de Mes | |
332 | <pre class="wiki"> |
||
333 | 38 | Adrian Georgescu | if (src_ip == 201.176.11.13) { |
334 | DINFO("Call from Carrier 1"); |
||
335 | 2 | Tijmen de Mes | |
336 | 31 | Adrian Georgescu | $rd = "SERVER_DOMAIN"; |
337 | prefix("+"); |
||
338 | set_billing_party(); |
||
339 | DINFO("Performing ENUM lookup"); |
||
340 | route(__ENUM_LOOKUP); |
||
341 | |||
342 | if ($retcode==-1) { |
||
343 | DINFO("User not found"); |
||
344 | sl_send_reply('404', 'User not found'); |
||
345 | LOG_MISSED_CALL('404'); |
||
346 | 30 | Adrian Georgescu | exit; |
347 | 31 | Adrian Georgescu | } else if (!is_uri_host_local()) { |
348 | DINFO("Call to non local user"); |
||
349 | sl_send_reply('403', 'Invalid destination'); |
||
350 | LOG_MISSED_CALL('403'); |
||
351 | 4 | Tijmen de Mes | exit; |
352 | 1 | Tijmen de Mes | } |
353 | 4 | Tijmen de Mes | } |
354 | </pre> |
||
355 | |||
356 | |||
357 | 2 | Tijmen de Mes | |Authentication|None| |
358 | |Authorization|Custom SIP Proxy logic| |
||
359 | 4 | Tijmen de Mes | |Billing party|Trusted peer| |
360 | |Accounting|Postpaid| |
||
361 | 7 | Tijmen de Mes | |Media types|RTP (audio)| |
362 | 4 | Tijmen de Mes | |From header|Must contain a non-local SIP domain| |
363 | 2 | Tijmen de Mes | |Address resolution|ENUM, Custom SIP Proxy logic| |
364 | |||
365 | 29 | Adrian Georgescu | h2. PBX to PSTN |
366 | 1 | Tijmen de Mes | |
367 | 2 | Tijmen de Mes | !flow-pbx-a-pstn.png! |
368 | |||
369 | 1 | Tijmen de Mes | To allow high call per second ratios for call centers or other high density traffic, many checks related to individual accounts are disabled when using trusted peers. Simultaneous call limit, Access Lists, Pike flood detection, quota checks are disabled. Also trusted peers, as their name imply, are allowed to set Caller Id information and Privacy headers, the SIP Proxy will not check nor enforce them fro Trusted peers. |
370 | 34 | Adrian Georgescu | |
371 | |Authentication|Based on source IP address| |
||
372 | 36 | Adrian Georgescu | |Authorization|None required, transit is allowed| |
373 | |Caller Id|Supplied by trusted peer| |
||
374 | |Billing party|IP address| |
||
375 | |Accounting|Postpaid| |
||
376 | |Media types|RTP (audio, video), T.38 Fax, SIP MESSAGE| |
||
377 | 34 | Adrian Georgescu | |Address resolution|ENUM, LCR, Custom SIP Proxy logic| |
378 | |From header|Must contain a non-local SIP domain| |
||
379 | 39 | Adrian Georgescu | |Request URI|Must contain a local SIP domain| |
380 | 34 | Adrian Georgescu | |Fraud control|Source IP only| |
381 | 1 | Tijmen de Mes | |
382 | |||
383 | 34 | Adrian Georgescu | h3. Routing |
384 | 35 | Adrian Georgescu | |
385 | To allow transiting the proxy, *handle-incoming-pstn.m4* configuration file is configured with this logic: |
||
386 | 34 | Adrian Georgescu | |
387 | 32 | Adrian Georgescu | <pre> |
388 | if (FROM_TRUSTED_PARTY) { |
||
389 | DINFO("Call from trusted party"); |
||
390 | |||
391 | $var(need_transit) = 0; |
||
392 | if (uri =~ "^sip:PSTN_REGEXP@.*") { |
||
393 | $rd = "SERVER_DOMAIN"; |
||
394 | strip(2); |
||
395 | prefix("+"); |
||
396 | set_billing_party(); |
||
397 | DINFO("Performing ENUM lookup"); |
||
398 | route(__ENUM_LOOKUP); |
||
399 | |||
400 | if ($retcode==-1) { |
||
401 | DINFO("ENUM number not found. PSTN transit"); |
||
402 | revert_uri(); |
||
403 | $var(need_transit) = 1; |
||
404 | } |
||
405 | } else if (uri =~ "^sip:LOCAL_PSTN_REGEXP@.*") { |
||
406 | $rd = "SERVER_DOMAIN"; |
||
407 | strip(1); |
||
408 | prefix("+COUNTRY_CODE"); |
||
409 | set_billing_party(); |
||
410 | DINFO("Performing ENUM lookup"); |
||
411 | route(__ENUM_LOOKUP); |
||
412 | |||
413 | if ($retcode==-1) { |
||
414 | DINFO("ENUM number not found. PSTN transit"); |
||
415 | revert_uri(); |
||
416 | $var(need_transit) = 1; |
||
417 | } |
||
418 | } else if (uri =~ "^sip:COUNTRY_CODE[1-9][0-9]{4,}@.*") { |
||
419 | $rd = "SERVER_DOMAIN"; |
||
420 | prefix("+"); |
||
421 | set_billing_party(); |
||
422 | DINFO("Performing ENUM lookup"); |
||
423 | route(__ENUM_LOOKUP); |
||
424 | |||
425 | if ($retcode==-1) { |
||
426 | DINFO("ENUM number not found. PSTN transit"); |
||
427 | revert_uri(); |
||
428 | $var(need_transit) = 1; |
||
429 | } |
||
430 | } else if (uri =~ "^sip:\+[0-9]{7,}@.*") { |
||
431 | $rd = "SERVER_DOMAIN"; |
||
432 | set_billing_party(); |
||
433 | DINFO("Performing ENUM lookup"); |
||
434 | route(__ENUM_LOOKUP); |
||
435 | if ($retcode==-1) { |
||
436 | DINFO("ENUM number not found. PSTN transit"); |
||
437 | strip(1); |
||
438 | prefix("00"); |
||
439 | $var(need_transit) = 1; |
||
440 | } |
||
441 | } |
||
442 | if ($var(need_transit) == 1) { |
||
443 | DINFO("Transit call from trusted peer $si"); |
||
444 | route(__PSTN_TRANSIT); |
||
445 | exit; |
||
446 | } |
||
447 | |||
448 | # Check if it's a local user |
||
449 | if (!is_uri_host_local()) { |
||
450 | set_billing_party(); |
||
451 | setflag(ACCOUNTING_FLAG); |
||
452 | $avp(can_uri) = $ru; |
||
453 | t_on_reply("__INVITE_REPLY"); |
||
454 | if (!isflagset(NO_MEDIAPROXY_FLAG)) { |
||
455 | 4 | Tijmen de Mes | DINFO("Engaging mediaproxy for SIP transit call"); |
456 | engage_media_proxy(); |
||
457 | 29 | Adrian Georgescu | } |
458 | $avp(invite_timeout) = OUTGOING_TIMEOUT; |
||
459 | 4 | Tijmen de Mes | DINFO("Set timeout to OUTGOING_TIMEOUT"); |
460 | 29 | Adrian Georgescu | route(__SEND_OUT); |
461 | exit; |
||
462 | } |
||
463 | 2 | Tijmen de Mes | } |
464 | 1 | Tijmen de Mes | </pre> |
465 | |||
466 | 33 | Adrian Georgescu | h3. Provisioning |
467 | |||
468 | 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: |
||
469 | |||
470 | 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. |
471 | 4 | Tijmen de Mes | * The domain name used by the PBX in the Request URI must be different than any domain served by the SIP Proxy otherwise the Proxy will try to lookup a local user. |
472 | 2 | Tijmen de Mes | |
473 | 1 | Tijmen de Mes | h3. Rating |
474 | 2 | Tijmen de Mes | |
475 | 4 | 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. |
476 | 2 | Tijmen de Mes | |
477 | 33 | Adrian Georgescu | h3. Caller Id |
478 | 2 | Tijmen de Mes | |
479 | 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. |
||
480 | 4 | Tijmen de Mes | |
481 | h2. PSTN to PBX |
||
482 | |||
483 | !flow-pbx-a-pstn.png! |
||
484 | |||
485 | |||
486 | |Authentication|None| |
||
487 | |Authorization|Trusted peer PSTN gateway| |
||
488 | 2 | Tijmen de Mes | |Caller Id|Supplied by PSTN gateway| |
489 | 4 | Tijmen de Mes | |Billing party|Trusted peer PSTN gateway| |
490 | |Accounting|Postpaid| |
||
491 | 37 | Adrian Georgescu | |Media types|RTP audio, T.38 Fax, SIP MESSAGE| |
492 | 4 | Tijmen de Mes | |From header|Must contain a non-local SIP domain| |
493 | 2 | Tijmen de Mes | |Address resolution|ENUM, Custom SIP Proxy logic| |
494 | |||
495 | h2. Call Diversion |
||
496 | 4 | Tijmen de Mes | |
497 | !flow-sip-phone-a-b-diverted.png! |
||
498 | |||
499 | 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. |
||
500 | 1 | Tijmen de Mes | |
501 | 28 | Tijmen de Mes | |
502 | 4 | Tijmen de Mes | |Authentication|SIP account A| |
503 | |Authorization|SIP account A| |
||
504 | |Billing party|SIP account B| |
||
505 | 7 | Tijmen de Mes | |Accounting|Postpaid, Prepaid| |
506 | 4 | Tijmen de Mes | |Address resolution|SIP address, SIP alias, Quickdial, ENUM, LCR| |
507 | 2 | Tijmen de Mes | |Fraud control | Forwarding destinations can be limited | |
508 | |||
509 | h2. Presence |
||
510 | 4 | Tijmen de Mes | |
511 | !flow-presence.png! |
||
512 | |||
513 | 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. |
514 | 18 | Adrian Georgescu | |
515 | 4 | Tijmen de Mes | |
516 | 7 | Tijmen de Mes | |Authorization|XCAP pres-rules| |
517 | 4 | Tijmen de Mes | |Address resolution|SIP address, SIP alias, Quickdial, ENUM| |
518 | 2 | Tijmen de Mes | |Accounting|None| |
519 | |||
520 | 1 | Tijmen de Mes | h2. Presence using RLS |
521 | 15 | Adrian Georgescu | |
522 | !flow-rls-services.png! |
||
523 | |||
524 | 4 | 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. |
525 | 1 | Tijmen de Mes | |
526 | |||
527 | 4 | Tijmen de Mes | |Authorization|XCAP org.openmobilealliance.pres-rules| |
528 | |Contacts Storage| XCAP rls-services and resource-lists| |
||
529 | 7 | Tijmen de Mes | |Signaling|RLS SUBSCRIBE RFC4662 and RLMI NOTIFY RFC4662| |
530 | 4 | Tijmen de Mes | |Address resolution|SIP address, SIP alias, Quickdial, ENUM| |
531 | 1 | Tijmen de Mes | |Accounting|None| |
532 | |||
533 | 4 | Tijmen de Mes | h2. IM using MSRP Relay |
534 | 1 | Tijmen de Mes | |
535 | 7 | Tijmen de Mes | !flow-msrp-relay.png! |
536 | 1 | Tijmen de Mes | |
537 | 4 | 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. |
538 | 1 | Tijmen de Mes | |
539 | 4 | Tijmen de Mes | h2. IM using MSRP ACM |
540 | 1 | Tijmen de Mes | |
541 | 7 | Tijmen de Mes | !flow-msrp-acm.png! |
542 | 1 | Tijmen de Mes | |
543 | 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. |
||
544 | |||
545 | 4 | Tijmen de Mes | h2. IM using MSRP ACM and Relay |
546 | |||
547 | 1 | Tijmen de Mes | !flow-msrp-acm-relay.png! |
548 | |||
549 | 4 | Tijmen de Mes | MSRP ACM and Relay methodologies can interoperate. |
550 | 1 | Tijmen de Mes | |
551 | 4 | Tijmen de Mes | h2. File Transfer |
552 | 1 | Tijmen de Mes | |
553 | 21 | 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. |
554 | 1 | Tijmen de Mes | |
555 | 16 | Adrian Georgescu | h2. Emergency Calls |
556 | |||
557 | 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. |
||
558 | |||
559 | See [[Provisioning_guide#Emergency-Numbers|"Provisioning the emergency numbers"]] section for more information. |
||
560 | |||
561 | 17 | Adrian Georgescu | h2. XMMP gateway |
562 | 1 | Tijmen de Mes | |
563 | The platform can be setup to federate with remote XMPP domains using a gateway function. The functionality is described at: |
||
564 | |||
565 | 4 | Tijmen de Mes | http://sylkserver.ag-projects.com/projects/sylkserver/wiki/DesignXMPP |
566 | |||
567 | h2. PBX Media Functions |
||
568 | |||
569 | Functions involving playing media in the middle of a call setup are not possible by the design of a SIP Proxy. Features like: |
||
570 | |||
571 | 1 | Tijmen de Mes | * IVR |
572 | 4 | Tijmen de Mes | * Auto-attendant |
573 | 1 | Tijmen de Mes | * Call queues and ACD |
574 | * Listen-in and barge-in |
||
575 | * Call parking |
||
576 | * Music on hold (MoH) |
||
577 | |||
578 | 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. |