Add UPnP support. #810

Closed
lightrabbit wants to merge 1 commits from master into master
3 changed files with 206 additions and 2 deletions

View File

@ -1,4 +1,4 @@
#!/usr/bin/env python2.7
#!/usr/bin/env python2.7
# Copyright (c) 2012 Jonathan Warren
# Copyright (c) 2012 The Bitmessage developers
# Distributed under the MIT/X11 software license. See the accompanying
@ -44,6 +44,7 @@ from debug import logger
# Helper Functions
import helper_bootstrap
import helper_generic
import upnp
def connectToStream(streamNumber):
@ -145,6 +146,9 @@ class Main:
# is the application already running? If yes then exit.
thisapp = singleton.singleinstance()
import upnp
upnp.createPortMapping()
# get curses flag
curses = False
if '-c' in sys.argv:

View File

@ -1,4 +1,4 @@
from __future__ import division
from __future__ import division
softwareVersion = '0.4.4'
verbose = 1
@ -370,6 +370,8 @@ def doCleanShutdown():
'Flushing inventory in memory out to disk. This should normally only take a second...'))
flushInventory()
import upnp
upnp.deletePortMapping()
# Verify that the objectProcessor has finished exiting. It should have incremented the
# shutdown variable from 1 to 2. This must finish before we command the sqlThread to exit.
while shutdown == 1:

198
src/upnp.py Normal file
View File

@ -0,0 +1,198 @@
# A simple upnp module to forward port for BitMessage
# Reference: http://mattscodecave.com/posts/using-python-and-upnp-to-forward-a-port
import socket
import httplib
from shared import config
routers = []
def searchRouter():
SSDP_ADDR = "239.255.255.250"
SSDP_PORT = 1900
SSDP_MX = 2
SSDP_ST = "urn:schemas-upnp-org:device:InternetGatewayDevice:1"
ssdpRequest = "M-SEARCH * HTTP/1.1\r\n" + \
"HOST: %s:%d\r\n" % (SSDP_ADDR, SSDP_PORT) + \
"MAN: \"ssdp:discover\"\r\n" + \
"MX: %d\r\n" % (SSDP_MX, ) + \
"ST: %s\r\n" % (SSDP_ST, ) + "\r\n"
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.sendto(ssdpRequest, (SSDP_ADDR, SSDP_PORT))
routers = []
sock.settimeout(0.5)
try:
resp,(ip,port) = sock.recvfrom(1000)
while resp:
routers.append(Router(resp, ip))
resp,(ip,port) = sock.recvfrom(1000)
except:pass
return routers
def createRequestXML(service, action, arguments=[]):
from xml.dom.minidom import Document
doc = Document()
# create the envelope element and set its attributes
envelope = doc.createElementNS('', 's:Envelope')
envelope.setAttribute('xmlns:s', 'http://schemas.xmlsoap.org/soap/envelope/')
envelope.setAttribute('s:encodingStyle', 'http://schemas.xmlsoap.org/soap/encoding/')
# create the body element
body = doc.createElementNS('', 's:Body')
# create the function element and set its attribute
fn = doc.createElementNS('', 'u:%s' % action)
fn.setAttribute('xmlns:u', 'urn:schemas-upnp-org:service:%s' % service)
# setup the argument element names and values
# using a list of tuples to preserve order
# container for created nodes
argument_list = []
# iterate over arguments, create nodes, create text nodes,
# append text nodes to nodes, and finally add the ready product
# to argument_list
for k, v in arguments:
tmp_node = doc.createElement(k)
tmp_text_node = doc.createTextNode(v)
tmp_node.appendChild(tmp_text_node)
argument_list.append(tmp_node)
# append the prepared argument nodes to the function element
for arg in argument_list:
fn.appendChild(arg)
# append function element to the body element
body.appendChild(fn)
# append body element to envelope element
envelope.appendChild(body)
# append envelope element to document, making it the root element
doc.appendChild(envelope)
# our tree is ready, conver it to a string
return doc.toxml()
class UPnPError(Exception):
def __init__(self, message):
self.message
class Router:
name = ""
path = ""
address = None
routerPath = None
def __init__(self, ssdpResponse, address):
import urllib2
from xml.dom.minidom import parseString
from urlparse import urlparse
self.address = address
row = ssdpResponse.split('\r\n')
header = {}
for i in range(1, len(row)):
part = row[i].split(': ')
if len(part) == 2:
header[part[0].lower()] = part[1]
self.routerPath = urlparse(header['location'])
# get the profile xml file and read it into a variable
directory = urllib2.urlopen(header['location']).read()
# create a DOM object that represents the `directory` document
dom = parseString(directory)
self.name = dom.getElementsByTagName('friendlyName')[0].childNodes[0].data
# find all 'serviceType' elements
service_types = dom.getElementsByTagName('serviceType')
for service in service_types:
if service.childNodes[0].data.find('WANIPConnection') > 0:
self.path = service.parentNode.getElementsByTagName('controlURL')[0].childNodes[0].data
def AddPortMapping(self, externalPort, internalPort, internalClient, protocol, description, leaseDuration = 0, enabled = 1):
resp = self.soapRequest('WANIPConnection:1', 'AddPortMapping', [
('NewExternalPort', str(externalPort)),
('NewProtocol', protocol),
('NewInternalPort', str(internalPort)),
('NewInternalClient', internalClient),
('NewEnabled', str(enabled)),
('NewPortMappingDescription', str(description)),
('NewLeaseDuration', str(leaseDuration))
])
return resp
def DeletePortMapping(self, externalPort, protocol):
resp = self.soapRequest('WANIPConnection:1', 'DeletePortMapping', [
('NewExternalPort', str(externalPort)),
('NewProtocol', protocol),
])
return resp
def GetExternalIPAddress(self):
from xml.dom.minidom import parseString
resp = self.soapRequest('WANIPConnection:1', 'GetExternalIPAddress')
dom = parseString(resp)
return dom.getElementsByTagName('NewExternalIPAddress')[0].childNodes[0].data
def soapRequest(self, service, action, arguments=[]):
from xml.dom.minidom import parseString
conn = httplib.HTTPConnection(self.routerPath.hostname, self.routerPath.port)
conn.request(
'POST',
self.path,
createRequestXML(service, action, arguments),
{
'SOAPAction': '"urn:schemas-upnp-org:service:%s#%s"' % (service, action),
'Content-Type': 'text/xml'
}
)
resp = conn.getresponse().read()
dom = parseString(resp)
errinfo = dom.getElementsByTagName('errorDescription')
if len(errinfo) > 0:
raise UPnPError(errinfo[0].childNodes[0].data)
return resp
def createPortMapping():
from struct import unpack, pack
global routers
routers = searchRouter()
localIPs = socket.gethostbyname_ex(socket.gethostname())[2]
for i in range(len(localIPs)):
localIPs[i], = unpack('>I', socket.inet_aton(localIPs[i]))
try:
#add port mapping for each router
for router in routers:
routerIP, = unpack('>I', socket.inet_aton(router.address))
localIP = None
minDiff = 0xFFFFFFFF
#find nearest localIP as clientIP to specified router
for IP in localIPs:
if IP ^ routerIP < minDiff:
minDiff = IP ^ routerIP
localIP = IP
localIP = socket.inet_ntoa(pack('>I', localIP))
localPort = config.getint('bitmessagesettings', 'port')
router.AddPortMapping(localPort, localPort, localIP, 'TCP', 'BitMessage')
except UPnPError:
from random import randint
newPort = str(randint(32767, 65535))
config.set('bitmessagesettings', 'port', newPort)
createPortMapping()
def deletePortMapping():
localPort = config.getint('bitmessagesettings', 'port')
for router in routers:
router.DeletePortMapping(localPort, 'TCP')