Skip to content

Add additional recommended records to PTR responses #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jstasiak merged 2 commits into from
Aug 8, 2019
Merged

Add additional recommended records to PTR responses #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a402ebb
Add additional recommended records to PTR responses
inwotep Aug 6, 2019
a7b2cf1
Add/Update testcases for PTR response optimization
inwotep Aug 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 57 additions & 2 deletions test_zeroconf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,7 @@ def send(out, addr=r._MDNS_ADDR, port=r._MDNS_PORT):
query.add_question(r.DNSQuestion(info.name, r._TYPE_TXT, r._CLASS_IN))
query.add_question(r.DNSQuestion(info.server, r._TYPE_A, r._CLASS_IN))
zc.handle_query(r.DNSIncoming(query.packet()), r._MDNS_ADDR, r._MDNS_PORT)
assert nbr_answers == 4 and nbr_additionals == 1 and nbr_authorities == 0
assert nbr_answers == 4 and nbr_additionals == 4 and nbr_authorities == 0
nbr_answers = nbr_additionals = nbr_authorities = 0

# unregister
Expand All @@ -644,7 +644,7 @@ def send(out, addr=r._MDNS_ADDR, port=r._MDNS_PORT):
query.add_question(r.DNSQuestion(info.name, r._TYPE_TXT, r._CLASS_IN))
query.add_question(r.DNSQuestion(info.server, r._TYPE_A, r._CLASS_IN))
zc.handle_query(r.DNSIncoming(query.packet()), r._MDNS_ADDR, r._MDNS_PORT)
assert nbr_answers == 4 and nbr_additionals == 1 and nbr_authorities == 0
assert nbr_answers == 4 and nbr_additionals == 4 and nbr_authorities == 0
nbr_answers = nbr_additionals = nbr_authorities = 0

# unregister
Expand Down Expand Up @@ -1036,3 +1036,58 @@ def test_multiple_addresses():
)

assert info.addresses == [address, address]


def test_ptr_optimization():

# instantiate a zeroconf instance
zc = Zeroconf(interfaces=['127.0.0.1'])

# service definition
type_ = "_test-srvc-type._tcp.local."
name = "xxxyyy"
registration_name = "%s.%s" % (name, type_)

desc = {'path': '/~paulsm/'}
info = ServiceInfo(type_, registration_name, socket.inet_aton("10.0.1.2"), 80, 0, 0, desc, "ash-2.local.")

# we are going to monkey patch the zeroconf send to check packet sizes
old_send = zc.send

nbr_answers = nbr_additionals = nbr_authorities = 0
has_srv = has_txt = has_a = False

def send(out, addr=r._MDNS_ADDR, port=r._MDNS_PORT):
"""Sends an outgoing packet."""
nonlocal nbr_answers, nbr_additionals, nbr_authorities
nonlocal has_srv, has_txt, has_a

nbr_answers += len(out.answers)
nbr_authorities += len(out.authorities)
for answer in out.additionals:
nbr_additionals += 1
if answer.type == r._TYPE_SRV:
has_srv = True
elif answer.type == r._TYPE_TXT:
has_txt = True
elif answer.type == r._TYPE_A:
has_a = True

old_send(out, addr=addr, port=port)

# monkey patch the zeroconf send
setattr(zc, "send", send)

# register
zc.register_service(info)
nbr_answers = nbr_additionals = nbr_authorities = 0

# query
query = r.DNSOutgoing(r._FLAGS_QR_QUERY | r._FLAGS_AA)
query.add_question(r.DNSQuestion(info.type, r._TYPE_PTR, r._CLASS_IN))
zc.handle_query(r.DNSIncoming(query.packet()), r._MDNS_ADDR, r._MDNS_PORT)
assert nbr_answers == 1 and nbr_additionals == 3 and nbr_authorities == 0
assert has_srv and has_txt and has_a

# unregister
zc.unregister_service(info)
34 changes: 34 additions & 0 deletions zeroconf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2338,6 +2338,40 @@ def handle_query(self, msg: DNSIncoming, addr: Optional[str], port: int) -> None
msg,
DNSPointer(service.type, _TYPE_PTR, _CLASS_IN, service.other_ttl, service.name),
)

# Add recommended additional answers according to
# https://tools.ietf.org/html/rfc6763#section-12.1.
out.add_additional_answer(
DNSService(
service.name,
_TYPE_SRV,
_CLASS_IN | _CLASS_UNIQUE,
service.host_ttl,
service.priority,
service.weight,
service.port,
service.server,
)
)
out.add_additional_answer(
DNSText(
service.name,
_TYPE_TXT,
_CLASS_IN | _CLASS_UNIQUE,
service.other_ttl,
service.text,
)
)
for address in service.addresses:
out.add_additional_answer(
DNSAddress(
service.server,
_TYPE_A,
_CLASS_IN | _CLASS_UNIQUE,
service.host_ttl,
address,
)
)
else:
try:
if out is None:
Expand Down