/
ssdp.py
323 lines (275 loc) · 11.6 KB
/
ssdp.py
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
# Licensed under the MIT license
# http://opensource.org/licenses/mit-license.php
# Copyright 2005, Tim Potter <tpot@samba.org>
# Copyright 2006 John-Mark Gurney <gurney_j@resnet.uroegon.edu>
# Copyright (C) 2006 Fluendo, S.A. (www.fluendo.com).
# Copyright 2006,2007,2008,2009 Frank Scholz <coherence@beebits.net>
# Copyright 2016 Erwan Martin <public@fzwte.net>
# Copyright 2021 FangYuecheng <github.com/xfangfang>
#
# Implementation of a SSDP server.
#
import sys
import random
import socket
import logging
import threading
import cherrypy
from email.utils import formatdate
from .utils import Setting
SSDP_PORT = 1900
SSDP_ADDR = '239.255.255.250'
SERVER_ID = 'SSDP Server'
logger = logging.getLogger("SSDPServer")
class Sock:
def __init__(self, ip):
self.ip = ip
self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
self.ssdp_addr = socket.inet_aton(SSDP_ADDR)
self.interface = socket.inet_aton(self.ip)
try:
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_IF, self.interface)
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, self.ssdp_addr + self.interface)
except Exception as e:
logger.error(e)
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_LOOP, 0)
# self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 10)
def send_it(self, response, destination):
try:
self.sock.sendto(response.format(self.ip).encode(), destination)
except (AttributeError, socket.error) as msg:
logger.warning("failure sending out data: from {} to {}".format(self.ip, destination))
def close(self):
try:
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_DROP_MEMBERSHIP, self.ssdp_addr + self.interface)
except Exception:
pass
self.sock.close()
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.ip_list = []
self.sock_list = []
self.sock = None
self.running = False
self.ssdp_thread = None
self.sending_byebye = True
# when ip is changed, we need SSDP thread to restart
# But we don't like SSDP sending any byebye data
def start(self):
"""Start ssdp background thread
"""
if not self.running:
self.running = True
self.sending_byebye = True
self.ssdp_thread = threading.Thread(target=self.run, name="SSDP_THREAD")
self.ssdp_thread.start()
def stop(self, byebye=True):
"""Stop ssdp background thread
"""
if self.running:
self.running = False
# Wake up the socket, this will speed up exiting ssdp thread.
try:
socket.socket(socket.AF_INET, socket.SOCK_DGRAM).sendto(b'', (SSDP_ADDR, SSDP_PORT))
except Exception as e:
pass
self.sending_byebye = byebye
if self.ssdp_thread is not None:
self.ssdp_thread.join()
def run(self):
# create UDP server
self.sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
# set IP_MULTICAST_LOOP to false
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_LOOP, 0)
# set SO_REUSEADDR or SO_REUSEPORT
if sys.platform == 'win32':
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
elif sys.platform == 'darwin':
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
elif hasattr(socket, "SO_REUSEPORT"):
try:
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
logger.debug("SSDP set SO_REUSEPORT")
except socket.error as e:
logger.error("SSDP cannot set SO_REUSEPORT")
logger.error(str(e))
elif hasattr(socket, "SO_REUSEADDR"):
try:
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
logger.debug("SSDP set SO_REUSEADDR")
except socket.error as e:
logger.error("SSDP cannot set SO_REUSEADDR")
logger.error(str(e))
# self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 10)
self.ip_list = list(Setting.get_ip())
if sys.platform == 'win32':
self.ip_list.append(('192.168.137.1', '255.255.255.0'))
self.sock_list = []
for ip, mask in self.ip_list:
try:
logger.error('add membership {}'.format(ip))
mreq = socket.inet_aton(SSDP_ADDR) + socket.inet_aton(ip)
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, mreq)
self.sock_list.append(Sock(ip))
except Exception as e:
logger.error(e)
try:
self.sock.bind(('0.0.0.0', SSDP_PORT))
except Exception as e:
logger.error(e)
cherrypy.engine.publish("app_notify", "Macast", "SSDP Can't start")
threading.Thread(target=lambda: Setting.stop_service(), name="SSDP_STOP_THREAD").start()
return
self.sock.settimeout(1)
while self.running:
try:
data, addr = self.sock.recvfrom(1024)
self.datagram_received(data, addr)
except socket.timeout:
continue
self.shutdown()
for ip, mask in self.ip_list:
logger.error("drop membership {}".format(ip))
mreq = socket.inet_aton(SSDP_ADDR) + socket.inet_aton(ip)
try:
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_DROP_MEMBERSHIP, mreq)
except Exception:
continue
self.sock.close()
self.sock = None
def shutdown(self):
for st in self.known:
self.do_byebye(st)
usn = [st for st in self.known]
for st in usn:
self.unregister(st)
def datagram_received(self, data, host_port):
"""Handle a received multicast datagram."""
(host, port) = host_port
try:
header = data.decode().split('\r\n\r\n')[0]
except ValueError as err:
logger.error(err)
return
if len(header) == 0:
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))
if cmd[0] != 'NOTIFY':
logger.info('SSDP command %s %s - from %s:%d' %
(cmd[0], cmd[1], host, port))
if cmd[0] == 'M-SEARCH' and cmd[1] == '*':
# SSDP discovery
logger.debug('M-SEARCH *')
logger.debug(data)
self.discovery_request(headers, (host, port))
elif cmd[0] == 'NOTIFY' and cmd[1] == '*':
# SSDP presence
# logger.debug('NOTIFY *')
pass
else:
logger.warning('Unknown SSDP command %s %s' % (cmd[0], cmd[1]))
def register(self, usn, st, location, server=SERVER_ID,
cache_control='max-age=1800'):
"""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
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):
for sock in self.sock_list:
sock.send_it(response, destination)
def get_subnet_ip(self, ip, mask):
a = [int(n) for n in mask.split('.')]
b = [int(n) for n in ip.split('.')]
return [a[i] & b[i] for i in range(4)]
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']))
# Do we know about this service?
for i in self.known.values():
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
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']))
destination = (host, port)
logger.debug('send discovery response delayed by %ds for %s to %r' % (delay, usn, destination))
# logger.debug(response)
# asyncio.sleep(delay)
for ip, mask in self.ip_list:
if self.get_subnet_ip(ip, mask) == self.get_subnet_ip(host, mask):
self.sock.sendto('\r\n'.join(response).format(ip).encode(), destination)
break
def do_notify(self, usn):
"""Do notification"""
logger.debug('Sending alive notification for %s' % usn)
if usn not in self.known:
return
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']
resp.extend(map(lambda x: ': '.join(x), stcpy.items()))
resp.extend(('', ''))
try:
self.send_it('\r\n'.join(resp), (SSDP_ADDR, SSDP_PORT))
self.send_it('\r\n'.join(resp), (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"""
if not self.sending_byebye:
return
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']
resp.extend(map(lambda x: ': '.join(x), stcpy.items()))
resp.extend(('', ''))
if self.sock:
try:
self.send_it('\r\n'.join(resp), (SSDP_ADDR, SSDP_PORT))
except (AttributeError, socket.error) as msg:
logger.error("error sending byebye notification: %r" % msg)
except KeyError as msg:
logger.error("error building byebye notification: %r" % msg)