Debugging the reason why your router cannot be found

Version 5 (Alan McGovern, 11/09/2009 01:04 AM)

1 1
h1. Debugging the reason why your router cannot be found
2 1
3 2 Alan McGovern
The uPnP specification is (generally speaking) badly implemented by a lot of router vendors. There are so many different quirks that I've come across that it's very hard to say whether or not a specific router will work with Mono.Nat. For the cases where your router does not work, here's how to debug the issue.
4 1
5 2 Alan McGovern
h2. Step 0: Enabling debug output
6 1
7 2 Alan McGovern
If you're running in a console application you can print debug information straight to the screen:
8 2 Alan McGovern
9 2 Alan McGovern
<pre>NatUtility.Logger = Console.Out;</pre>
10 2 Alan McGovern
11 2 Alan McGovern
If you want to log to a file, it's just as easy:
12 2 Alan McGovern
13 2 Alan McGovern
<pre>NatUtility.Logger = new StreamWriter (File.OpenWrite ("logfile.txt"));</pre>
14 2 Alan McGovern
15 2 Alan McGovern
If you fail to get past step 1 below, or just want all the debug output, you should enable verbose mode:
16 2 Alan McGovern
17 2 Alan McGovern
<pre>NatUtility.Verbose = true</pre>
18 1
19 1
h2. Step 1: Detecting available services
20 1
21 1
In order to detect what services are available on the local network, a udp broadcast message is sent. There are two kinds of message:
22 1
# The 'tell me everything you support' message
23 1
# The 'respond if you support service X' message
24 1
25 1
Mono.Nat uses the 'tell me everything you support' style message. I haven't come across a router which has failed to respond to this, though there are some which fail to respond to the second type of message. If your router fails at this step, then this is probably why. Typical output from this step is a dozen or so copies of the following:
26 1
27 1
<pre>
28 1
UPnP Response: HTTP/1.1 200 OK
29 1
SERVER: Ambit OS/1.0 UPnP/1.0 AMBIT-UPNP/1.0
30 1
EXT:
31 1
LOCATION: http://192.168.0.10:80/Public_UPNP_gatedesc.xml
32 1
CACHE-CONTROL: max-age=3600
33 1
ST: upnp:rootdevice
34 1
USN: uuid:e346a71d-99ef-86a6-3222-e9ba2bb3dfa0::upnp:rootdevice
35 1
36 1
37 1
UPnP Response: HTTP/1.1 200 OK
38 1
SERVER: Ambit OS/1.0 UPnP/1.0 AMBIT-UPNP/1.0
39 1
EXT:
40 1
LOCATION: http://192.168.0.10:80/Public_UPNP_gatedesc.xml
41 1
CACHE-CONTROL: max-age=3600
42 1
ST: urn:schemas-upnp-org:device:InternetGatewayDevice:1
43 1
USN: uuid:e346a71d-99ef-86a6-3222-e9ba2bb3dfa0::urn:schemas-upnp-org:device:InternetGatewayDevice:1
44 1
</pre>
45 1
46 1
h2. Step 2: Getting the service listing
47 1
48 1
If your router advertises one of the three services that Mono.Nat assumes will allow port forwarding, you will see output similar to this:
49 1
50 1
<pre>
51 1
UPnP Response: Router advertised a 'urn:schemas-upnp-org:service:WANIPConnection:' service
52 1
Found device at: http://192.168.0.10:80/Public_UPNP_gatedesc.xml
53 1
Parsed device as: 192.168.0.10:80
54 1
Fetching service list: 192.168.0.10:80
55 1
</pre>
56 1
57 5 Alan McGovern
h2. Step 3: Parsing a service listing
58 1
59 1
The service listing contains the details required to connect to the upnp service on the router. If the listing can be retrieved and parsed, you'll see output similar to this:
60 1
61 1
<pre>
62 1
192.168.0.10:80: Parsed services list
63 1
192.168.0.10:80: Found service: urn:schemas-upnp-org:service:Layer3Forwarding:1
64 1
192.168.0.10:80: Found service: urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1
65 1
192.168.0.10:80: Found service: urn:schemas-upnp-org:service:WANIPConnection:1
66 1
192.168.0.10:80: Found upnp service at: /Public_UPNP_C3
67 1
192.168.0.10:80: Assuming control Uri is relative: /Public_UPNP_C3
68 1
192.168.0.10:80: Handshake Complete
69 1
</pre>
70 1
71 3 Alan McGovern
h2. Step 4: Using the device
72 1
73 1
Once the control Uri has been discovered, the DeviceFound event will be raised and you will be passed the INatDevice to use. From here you just need to make calls to the various methods like INatDevice.MapPort or INatDevice.GetExternalIP. It's worth noting that some devices will accept port maps which have a different internal IP address and external IP address, for example mapping external port 10000 to internal port 5000, while others will throw an exception. A few devices will silently ignore the internal port value and just map the external port 5000 to the internal port 5000.
74 1
75 4 Alan McGovern
h2. Submitting patches so your router works without modifications
76 1
77 1
If your router requires a fix to be detected with Mono.Nat, please let me know and supply a patch with the required changes. I'll gladly incorporate any changes which increase compatibility with different router models.