1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
| import uuid import netifaces as ni import logging import threading import random import time import socket import logging from time import sleep from email.utils import formatdate from errno import ENOPROTOOPT from http.server import BaseHTTPRequestHandler, HTTPServer
SSDP_PORT = 1900 SSDP_ADDR = '239.255.255.250' SERVER_ID = 'ZeWaren example SSDP Server' NETWORK_INTERFACE = 'eth1'
logger = logging.getLogger()
class SSDPServer: """A class implementing a SSDP server. The notify_received and searchReceived methods are called when the appropriate type of datagram is received by the server.""" known = {}
def __init__(self): self.sock = None
def run(self): self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) if hasattr(socket, "SO_REUSEPORT"): try: self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) except socket.error as le: # RHEL6 defines SO_REUSEPORT but it doesn't work if le.errno == ENOPROTOOPT: pass else: raise
addr = socket.inet_aton(SSDP_ADDR) interface = socket.inet_aton('0.0.0.0') cmd = socket.IP_ADD_MEMBERSHIP self.sock.setsockopt(socket.IPPROTO_IP, cmd, addr + interface) self.sock.bind(('0.0.0.0', SSDP_PORT)) self.sock.settimeout(1)
while True: try: data, addr = self.sock.recvfrom(1024) self.datagram_received(data, addr) except socket.timeout: continue self.shutdown()
def shutdown(self): for st in self.known: if self.known[st]['MANIFESTATION'] == 'local': self.do_byebye(st)
def datagram_received(self, data, host_port): """Handle a received multicast datagram."""
(host, port) = host_port
try: header, payload = data.decode().split('\r\n\r\n')[:2] except ValueError as err: logger.error(err) return
lines = header.split('\r\n') cmd = lines[0].split(' ') lines = map(lambda x: x.replace(': ', ':', 1), lines[1:]) lines = filter(lambda x: len(x) > 0, lines)
headers = [x.split(':', 1) for x in lines] headers = dict(map(lambda x: (x[0].lower(), x[1]), headers))
logger.info('SSDP command %s %s - from %s:%d' % (cmd[0], cmd[1], host, port)) logger.debug('with headers: {}.'.format(headers)) if cmd[0] == 'M-SEARCH' and cmd[1] == '*': # SSDP discovery self.discovery_request(headers, (host, port)) elif cmd[0] == 'NOTIFY' and cmd[1] == '*': # SSDP presence logger.debug('NOTIFY *') else: logger.warning('Unknown SSDP command %s %s' % (cmd[0], cmd[1]))
def register(self, manifestation, usn, st, location, server=SERVER_ID, cache_control='max-age=1800', silent=False, host=None): """Register a service or device that this SSDP server will respond to."""
logging.info('Registering %s (%s)' % (st, location))
self.known[usn] = {} self.known[usn]['USN'] = usn self.known[usn]['LOCATION'] = location self.known[usn]['ST'] = st self.known[usn]['EXT'] = '' self.known[usn]['SERVER'] = server self.known[usn]['CACHE-CONTROL'] = cache_control
self.known[usn]['MANIFESTATION'] = manifestation self.known[usn]['SILENT'] = silent self.known[usn]['HOST'] = host self.known[usn]['last-seen'] = time.time()
if manifestation == 'local' and self.sock: self.do_notify(usn)
def unregister(self, usn): logger.info("Un-registering %s" % usn) del self.known[usn]
def is_known(self, usn): return usn in self.known
def send_it(self, response, destination, delay, usn): logger.debug('send discovery response delayed by %ds for %s to %r' % (delay, usn, destination)) try: self.sock.sendto(response.encode(), destination) except (AttributeError, socket.error) as msg: logger.warning("failure sending out byebye notification: %r" % msg)
def discovery_request(self, headers, host_port): """Process a discovery request. The response must be sent to the address specified by (host, port)."""
(host, port) = host_port
logger.info('Discovery request from (%s,%d) for %s' % (host, port, headers['st'])) logger.info('Discovery request for %s' % headers['st'])
# Do we know about this service? for i in self.known.values(): if i['MANIFESTATION'] == 'remote': continue if headers['st'] == 'ssdp:all' and i['SILENT']: continue if i['ST'] == headers['st'] or headers['st'] == 'ssdp:all': response = ['HTTP/1.1 200 OK']
usn = None for k, v in i.items(): if k == 'USN': usn = v if k not in ('MANIFESTATION', 'SILENT', 'HOST'): response.append('%s: %s' % (k, v))
if usn: response.append('DATE: %s' % formatdate(timeval=None, localtime=False, usegmt=True))
response.extend(('', '')) delay = random.randint(0, int(headers['mx']))
self.send_it('\r\n'.join(response), (host, port), delay, usn)
def do_notify(self, usn): """Do notification"""
if self.known[usn]['SILENT']: return logger.info('Sending alive notification for %s' % usn)
resp = [ 'NOTIFY * HTTP/1.1', 'HOST: %s:%d' % (SSDP_ADDR, SSDP_PORT), 'NTS: ssdp:alive', ] stcpy = dict(self.known[usn].items()) stcpy['NT'] = stcpy['ST'] del stcpy['ST'] del stcpy['MANIFESTATION'] del stcpy['SILENT'] del stcpy['HOST'] del stcpy['last-seen']
resp.extend(map(lambda x: ': '.join(x), stcpy.items())) resp.extend(('', '')) logger.debug('do_notify content', resp) try: self.sock.sendto('\r\n'.join(resp).encode(), (SSDP_ADDR, SSDP_PORT)) self.sock.sendto('\r\n'.join(resp).encode(), (SSDP_ADDR, SSDP_PORT)) except (AttributeError, socket.error) as msg: logger.warning("failure sending out alive notification: %r" % msg)
def do_byebye(self, usn): """Do byebye"""
logger.info('Sending byebye notification for %s' % usn)
resp = [ 'NOTIFY * HTTP/1.1', 'HOST: %s:%d' % (SSDP_ADDR, SSDP_PORT), 'NTS: ssdp:byebye', ] try: stcpy = dict(self.known[usn].items()) stcpy['NT'] = stcpy['ST'] del stcpy['ST'] del stcpy['MANIFESTATION'] del stcpy['SILENT'] del stcpy['HOST'] del stcpy['last-seen'] resp.extend(map(lambda x: ': '.join(x), stcpy.items())) resp.extend(('', '')) logger.debug('do_byebye content', resp) if self.sock: try: self.sock.sendto('\r\n'.join(resp), (SSDP_ADDR, SSDP_PORT)) except (AttributeError, socket.error) as msg: logger.error("failure sending out byebye notification: %r" % msg) except KeyError as msg: logger.error("error building byebye notification: %r" % msg)
class UPNPHTTPServerHandler(BaseHTTPRequestHandler): """ A HTTP handler that serves the UPnP XML files. """
# Handler for the GET requests def do_GET(self):
if self.path == '/boucherie_wsd.xml': self.send_response(200) self.send_header('Content-type', 'application/xml') self.end_headers() self.wfile.write(self.get_wsd_xml().encode()) return if self.path == '/jambon-3000.xml': self.send_response(200) self.send_header('Content-type', 'application/xml') self.end_headers() self.wfile.write(self.get_device_xml().encode()) return else: self.send_response(404) self.send_header('Content-type', 'text/html') self.end_headers() self.wfile.write(b"Not found.") return
def get_device_xml(self): """ Get the main device descriptor xml file. """ xml = """<root> <specVersion> <major>1</major> <minor>0</minor> </specVersion> <device> <deviceType>urn:schemas-upnp-org:device:Basic:1</deviceType> <friendlyName>{friendly_name}</friendlyName> <UDN>uuid:{uuid}</UDN> <serviceList> <service> <URLBase>http://xxx.yyy.zzz.aaaa:5000</URLBase> <serviceType>urn:boucherie.example.com:service:Jambon:1</serviceType> <serviceId>urn:boucherie.example.com:serviceId:Jambon</serviceId> <controlURL>/jambon</controlURL> <eventSubURL/> <SCPDURL>/boucherie_wsd.xml</SCPDURL> </service> </serviceList> <presentationURL>{presentation_url}</presentationURL> </device> </root>""" return xml.format(friendly_name=self.server.friendly_name, manufacturer=self.server.manufacturer, manufacturer_url=self.server.manufacturer_url, model_description=self.server.model_description, model_name=self.server.model_name, model_number=self.server.model_number, model_url=self.server.model_url, serial_number=self.server.serial_number, uuid=self.server.uuid, presentation_url=self.server.presentation_url)
@staticmethod def get_wsd_xml(): """ Get the device WSD file. """ return """<scpd xmlns="urn:schemas-upnp-org:service-1-0"> <specVersion> <major>1</major> <minor>0</minor> </specVersion> </scpd>"""
class UPNPHTTPServerBase(HTTPServer): """ A simple HTTP server that knows the information about a UPnP device. """ def __init__(self, server_address, request_handler_class): HTTPServer.__init__(self, server_address, request_handler_class) self.port = None self.friendly_name = None self.uuid = None self.presentation_url = None
class UPNPHTTPServer(threading.Thread): """ A thread that runs UPNPHTTPServerBase. """
def __init__(self, port, friendly_name, uuid, presentation_url): threading.Thread.__init__(self, daemon=True) self.server = UPNPHTTPServerBase(('', port), UPNPHTTPServerHandler) self.server.port = port self.server.friendly_name = friendly_name self.server.uuid = uuid self.server.presentation_url = presentation_url
def run(self): self.server.serve_forever()
logger1 = logging.getLogger() logger1.setLevel(logging.DEBUG)
def get_network_interface_ip_address(interface='eth1'): """ Get the first IP address of a network interface. :param interface: The name of the interface. :return: The IP address. """ while True: if NETWORK_INTERFACE not in ni.interfaces(): logger1.error('Could not find interface %s.' % (interface,)) exit(1) interface = ni.ifaddresses(interface) if (2 not in interface) or (len(interface[2]) == 0): logger1.warning('Could not find IP of interface %s. Sleeping.' % (interface,)) sleep(60) continue return interface[2][0]['addr']
device_uuid = uuid.uuid4() local_ip_address = get_network_interface_ip_address(NETWORK_INTERFACE)
http_server = UPNPHTTPServer(8088, friendly_name="Jambon 3000", uuid=device_uuid, presentation_url="http://{}:5000/".format(local_ip_address)) http_server.start()
ssdp = SSDPServer() ssdp.register('local', 'uuid:{}::upnp:rootdevice'.format(device_uuid), 'upnp:rootdevice', 'http://{}:8088/jambon-3000.xml'.format(local_ip_address)) ssdp.run()
|