UPnP support merged and fixed
Fixes Bitmessage#373 Fixes Bitmessage#79 Fixes #4 Needs to be turned on in the config file (keys.dat) by adding "upnp = true" into the main section It needs some cleanup (e.g. if you have multiple routers, it will not correctly handle failure of one of them)
This commit is contained in:
mailchuck
commit
b93308d7ab
GPG Key ID:
0C5F50C0B5F37D87
|
|
@ -149,6 +149,10 @@ class Main:
|
|||
# is the application already running? If yes then exit.
|
||||
thisapp = singleton.singleinstance("", daemon)
|
||||
|
||||
if shared.safeConfigGetBoolean('bitmessagesettings','upnp'):
|
||||
import upnp
|
||||
upnp.createPortMapping()
|
||||
|
||||
# get curses flag
|
||||
curses = False
|
||||
if '-c' in sys.argv:
|
||||
|
|
|
|||
|
|
@ -160,8 +160,10 @@ def assembleVersionMessage(remoteHost, remotePort, myStreamNumber):
|
|||
payload += pack('>q', 1) # bitflags of the services I offer.
|
||||
payload += '\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xFF\xFF' + pack(
|
||||
'>L', 2130706433) # = 127.0.0.1. This will be ignored by the remote host. The actual remote connected IP will be used.
|
||||
payload += pack('>H', shared.config.getint(
|
||||
'bitmessagesettings', 'port'))
|
||||
if safeConfigGetBoolean('bitmessagesettings', 'upnp'):
|
||||
payload += pack('>H', extPort)
|
||||
else:
|
||||
payload += pack('>H', shared.config.getint('bitmessagesettings', 'port'))
|
||||
|
||||
random.seed()
|
||||
payload += eightBytesOfRandomDataUsedToDetectConnectionsToSelf
|
||||
|
|
@ -384,6 +386,9 @@ def doCleanShutdown():
|
|||
'Flushing inventory in memory out to disk. This should normally only take a second...'))
|
||||
flushInventory()
|
||||
|
||||
if safeConfigGetBoolean('bitmessagesettings','upnp'):
|
||||
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:
|
||||
|
|
|
|||
225
src/upnp.py
Normal file
225
src/upnp.py
Normal file
|
|
@ -0,0 +1,225 @@
|
|||
# A simple upnp module to forward port for BitMessage
|
||||
# Reference: http://mattscodecave.com/posts/using-python-and-upnp-to-forward-a-port
|
||||
import httplib
|
||||
from random import randint
|
||||
import socket
|
||||
from struct import unpack, pack
|
||||
import shared
|
||||
|
||||
routers = []
|
||||
recurDepth = 0
|
||||
|
||||
def searchRouter():
|
||||
from debug import logger
|
||||
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"
|
||||
routers = []
|
||||
|
||||
try:
|
||||
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
||||
sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 2)
|
||||
sock.settimeout(2)
|
||||
sock.sendto(ssdpRequest, (SSDP_ADDR, SSDP_PORT))
|
||||
except:
|
||||
logger.exception("UPnP sock failed")
|
||||
try:
|
||||
while True:
|
||||
resp,(ip,port) = sock.recvfrom(1000)
|
||||
if resp is None:
|
||||
continue
|
||||
routers.append(Router(resp, ip))
|
||||
except:
|
||||
logger.error("Failure running UPnP router search.", exc_info=True)
|
||||
|
||||
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
|
||||
import pprint
|
||||
from debug import logger
|
||||
|
||||
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]
|
||||
try:
|
||||
self.routerPath = urlparse(header['location'])
|
||||
if not self.routerPath or not hasattr(self.routerPath, "hostname"):
|
||||
logger.error ("UPnP: no hostname: %s", header['location'])
|
||||
except KeyError:
|
||||
logger.error ("UPnP: missing location header")
|
||||
|
||||
# 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 debug import logger
|
||||
global routers
|
||||
global recurDepth
|
||||
|
||||
if recurDepth > 50:
|
||||
logger.error("Too many failures requesting UPnP port mapping, giving up.")
|
||||
return
|
||||
|
||||
routers = searchRouter()
|
||||
localIPs = socket.gethostbyname_ex(socket.gethostname())[2]
|
||||
logger.debug("Found %i UPnP routers", len(routers))
|
||||
|
||||
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 = shared.config.getint('bitmessagesettings', 'port')
|
||||
if recurDepth == 0:
|
||||
extPort = localPort # try same port first
|
||||
else:
|
||||
extPort = str(randint(32767, 65535))
|
||||
logger.debug("Requesting UPnP mapping on external port %i", extPort)
|
||||
router.AddPortMapping(extPort, localPort, localIP, 'TCP', 'BitMessage')
|
||||
logger.info("Successfully established UPnP mapping on external port %i", extPort)
|
||||
shared.extPort = extPort
|
||||
except UPnPError:
|
||||
recurDepth += 1
|
||||
createPortMapping()
|
||||
recurDepth -= 1
|
||||
|
||||
def deletePortMapping():
|
||||
for router in routers:
|
||||
router.DeletePortMapping(shared.extPort, 'TCP')
|
||||
Loading…
Reference in New Issue
Block a user