Version 55 (Adrian Georgescu, 04/15/2010 01:48 pm)

1 32 Adrian Georgescu
= MediaProxy ICE Support =
2 1 Redmine Admin
3 1 Redmine Admin
== Background ==
4 1 Redmine Admin
5 39 Adrian Georgescu
[ ICE methodology] has been defined to help end-points traverse NAT routers for  RTP media by finding the shortest available path between the end-points. Where the network topology does not allow for direct media path between the end-points, a TURN server has been standardized to provide the end-points with a visible public candidate that can be used to relay traffic  to the end-points behind an unfriendly NAT type (e.g. symmetric). TURN servers are not widely deployed today whereas solutions like SIP Proxies in tandem with RTP relays are. 
6 1 Redmine Admin
7 31 Adrian Georgescu
RTP relays that work in tandem with SIP Proxies perform similar function to the TURN protocol except that the reservation is done by the SIP Proxy rather than by the user agent. The SIP User Agent does not need to support TURN protocol in order to use the relay, which makes it compatible with any SIP User Agent available today. Such solution used widely today is the tandem '''OpenSIPS/MediaProxy'''. 
8 11 Redmine Admin
9 33 Adrian Georgescu
Until the addition of this functionality, MediaProxy module used to rewrite the SDP in order to present to the destination SIP User Agent a reachable IP:port number for sending RTP/RTCP. This had the dis-advantage that the session was always using a relay and it was mutually exclusive with the use of ICE. The rewriting of the SDP and the missing candiate correspondent to the c= line of the SDP caused the target SIP end-point to reply with ICE missmatch and the ICE negotiation always failed in its tracks.
10 3 Redmine Admin
11 37 Adrian Georgescu
== Features ==
12 37 Adrian Georgescu
13 36 Adrian Georgescu
By using the current solution, the SIP Proxy administrator can decide whether ICE is allowed and which priority the MediaProxy candidate has on a per call basis. There is no need for deploying a TURN server anymore in order to support ICE negotiation between end-points.
14 53 Adrian Georgescu
15 53 Adrian Georgescu
The client needs to implement STUN and the latest ICE specification. [ Blink] is a SIP client that is fully compliant with these requirements.
16 36 Adrian Georgescu
17 30 Adrian Georgescu
== Implementation ==
18 1 Redmine Admin
19 31 Adrian Georgescu
To circumvent the failure of ICE negotiation, MediaProxy module in OpenSIPS is now:
20 3 Redmine Admin
21 55 Adrian Georgescu
 1. Creating a proper candidate based on the media relay IP:port allocation
22 55 Adrian Georgescu
 1. Appending the candidate to the offer/answer of the SDP
23 55 Adrian Georgescu
 1. Allowing an administrator to set a policy about how to use the relay candidate
24 1 Redmine Admin
25 42 Redmine Admin
OpenSIPS mediaproxy module has new settings:
26 1 Redmine Admin
27 1 Redmine Admin
28 42 Redmine Admin
29 42 Redmine Admin
30 1 Redmine Admin
31 1 Redmine Admin
32 42 Redmine Admin
"ice-candidate" defines a global setting whereas "ice_candidate_avp" allows the user to override that value by setting the specified AVP. It can take 3 different values: "none", "low-priority" or "high-priority". None means no candidate will be added at all, and low-priority or high-priority affect on the priority field of the ICE candidate being inserted. Example:
33 1 Redmine Admin
34 1 Redmine Admin
35 1 Redmine Admin
route {
36 27 Redmine Admin
37 42 Redmine Admin
$avp(s:ice_candidate) := "low-priority";
38 27 Redmine Admin
39 1 Redmine Admin
40 25 Redmine Admin
41 30 Adrian Georgescu
42 1 Redmine Admin
For the initial INVITE and its reply, mediaproxy module now appends an ICE candidate to the SDP as follows:
43 1 Redmine Admin
44 28 Adrian Georgescu
45 43 Adrian Georgescu
if ((ice_candidate != none and ice_candidate_avp != none) 
46 43 Adrian Georgescu
        and SDP offer contains a=ice-pwd 
47 43 Adrian Georgescu
        and a=ice-ufrag and a=candidate line(s) then: 
48 1 Redmine Admin
	append to the SDP the following line:
49 42 Redmine Admin
	a=candidate:R(random string) 1 UDP PRIORITY MP_IP MP_PORT typ relay
50 42 Redmine Admin
        a=candidate:R(random string) 2 UDP PRIORITY MP_IP MP_RTCP_PORT typ relay
51 25 Redmine Admin
52 1 Redmine Admin
53 12 Redmine Admin
54 1 Redmine Admin
55 42 Redmine Admin
 * R(random string) = we'll use 'R' plus a random string as the foundation. The random string is the hex representation of the chosen relay IP address. Having the 'R' as the first letter is just a convention to represent a relayed candidate.
56 1 Redmine Admin
 * PRIORITY = 2!^24 * POLICY + 2!^8  * 65535 + 2!^0  * 256 - Candidate ID (1 for RTP, 2 for RTCP)
57 42 Redmine Admin
    * POLICY = 0  if $avp(s:ice_candidate) == low-priority and POLICY = 130  if $avp(s:ice_candidate) == high-priority. A value of 130 is being used as the high priority candidate type preference, as it will be even higher than host candidates priority.
58 23 Adrian Georgescu
59 42 Redmine Admin
NOTE: The AVP has precedence over the module parameter, that is, if module parameter is set to low-priority and the AVP is set to none, no candidate will be added.
60 30 Adrian Georgescu
61 30 Adrian Georgescu
If ICE negotiation succeeds and the MediaProxy relay candidate has not been selected by the end-points, MediaProxy deallocates its ports after the built-in timeout and does not terminate the dialog in case of missing BYEs. MediaProxy decides this, if both SDP offer and answer have ICE support and if STUN binding requests (which correspond to ICE probing) have been detected while no RTP has been subsequently sent through the relay. 
62 34 Adrian Georgescu
63 52 Adrian Georgescu
== Software versions  ==
64 1 Redmine Admin
65 44 Adrian Georgescu
You need the following software versions to support ICE:
66 38 Adrian Georgescu
67 48 Adrian Georgescu
 * MediaProxy version >=2.4.2
68 49 Adrian Georgescu
 * OpenSIPS version >= 1.6.0
69 50 Adrian Georgescu
70 50 Adrian Georgescu
CDRTool version >=7.1.0 can be used to display the media traces.
71 50 Adrian Georgescu
72 38 Adrian Georgescu