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
|
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function, unicode_literals
import socket
from .constants import ipv4_multicast_ip, ipv6_multicast_ip
from .http_helper import parse_headers
from .protocol import create_msearch_payload
from .compat import if_nametoindex, SO_BINDTODEVICE
class SSDPClient(object):
def __init__(
self,
proto="ipv4",
port=1900,
ttl=2,
iface=None,
timeout=5,
address=None,
*args,
**kwargs
):
allowed_protos = ("ipv4", "ipv6")
if proto not in allowed_protos:
raise ValueError(
"Invalid proto - expected one of {}".format(allowed_protos)
)
self.port = port
if proto == "ipv4":
af_type = socket.AF_INET
self.broadcast_ip = ipv4_multicast_ip
self._address = (self.broadcast_ip, port)
elif proto == "ipv6":
af_type = socket.AF_INET6
self.broadcast_ip = ipv6_multicast_ip # TODO: Support other ipv6 multicasts
self._address = (self.broadcast_ip, port, 0, 0)
self.sock = socket.socket(af_type, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl)
self.sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_LOOP, 1)
self.sock.settimeout(timeout)
if address is not None:
self.sock.bind((address, 0))
if iface is not None:
self.sock.setsockopt(socket.SOL_SOCKET, SO_BINDTODEVICE, iface)
if proto == "ipv6":
# Specifically set multicast on interface
iface_index = if_nametoindex(iface)
self.sock.setsockopt(
socket.IPPROTO_IPV6, socket.IPV6_MULTICAST_IF, iface_index
)
def send(self, data):
self.sock.sendto(data, self._address)
def recv(self):
try:
while True:
data = self.sock.recv(1024)
yield data
except socket.timeout:
pass
return
def m_search(self, st="ssdp:all", mx=1):
"""
Send an M-SEARCH request and gather responses.
:param st: The Search Target, used to narrow down the responses that should be received. Defaults to "ssdp:all" which should get responses from any SSDP-enabled device.
:type st: str
:param mx: Maximum wait time (in seconds) that devices are allowed to wait before sending a response. Should be between 1 and 5, though this is not enforced in this implementation. Devices will randomly wait for anywhere between 0 and 'mx' seconds in order to avoid flooding the client that sends the M-SEARCH. Increase the value of 'mx' if you expect a large number of devices to answer, in order to avoid losing responses.
:type mx: int
:return: A list of all discovered SSDP services. Each service is represented by a dict, with the keys being the lowercase equivalents of the response headers.
"""
host = "{}:{}".format(self.broadcast_ip, self.port)
data = create_msearch_payload(host, st, mx)
self.send(data)
responses = [x for x in self.recv()]
parsed_responses = []
for response in responses:
try:
headers = parse_headers(response)
parsed_responses.append(headers)
except ValueError:
# Invalid response, do nothing.
# TODO: Log dropped responses
pass
return parsed_responses
def discover():
"""
An ad-hoc way of discovering all SSDP services without explicitly initializing an :class:`~ssdpy.SSDPClient`.
:return: A list of all discovered SSDP services, each service in a dictionary.
"""
return SSDPClient().m_search()
|
