def handle_confirm(self, bundle: TransactionBundle):
"""
Handle a client requesting confirmation
:param bundle: The request bundle
"""
# Make sure we are responsible for this link
link_address = bundle.get_link_address()
if not address_in_prefixes(link_address, self.responsible_for_links):
logger.debug("Not confirming to link {}: "
"doesn't match {}".format(link_address, ', '.join(map(str, self.responsible_for_links))))
return
# Get the assignment
assignment = self.get_assignment(bundle)
# Collect unanswered options
unanswered_iana_options = bundle.get_unanswered_iana_options()
# See if there are any addresses on a link that I am responsible for
for option in unanswered_iana_options:
for suboption in option.get_options_of_type(IAAddressOption):
if suboption.address == assignment.address:
# This is the address from the assignment: it's ok
bundle.mark_handled(option)
continue
if address_in_prefixes(suboption.address, self.responsible_for_links):
# Oops, an address on a link that I am responsible for, but it's the wrong one...
force_status(bundle.response.options,
StatusCodeOption(STATUS_NOTONLINK,
"{} is not assigned to you".format(suboption.address)))
bundle.mark_handled(option)
return
def handle_renew_rebind(self, bundle: TransactionBundle):
"""
Handle a client renewing/rebinding addresses
:param bundle: The request bundle
"""
# Get the assignment
assignment = self.get_assignment(bundle)
# Client ID for logging
client_id_option = bundle.request.get_option_of_type(ClientIdOption)
# Collect unanswered options
unanswered_iana_options = bundle.get_unanswered_iana_options()
unanswered_iapd_options = bundle.get_unanswered_iapd_options()
for option in unanswered_iapd_options:
if assignment.prefix and prefix_overlaps_prefixes(assignment.prefix, option.get_prefixes()):
# Overlap with our assigned prefix: take responsibility
response_suboptions = []
for suboption in option.get_options_of_type(IAPrefixOption):
if suboption.prefix == assignment.prefix:
# This is the correct option, renew it
logger.info("Renewing {} for {!r}".format(assignment.prefix, client_id_option.duid))
response_suboptions.append(IAPrefixOption(prefix=assignment.prefix,
preferred_lifetime=self.prefix_preferred_lifetime,
valid_lifetime=self.prefix_valid_lifetime))
else:
# This isn't right
logger.info("Withdrawing {} from {!r}".format(suboption.prefix, client_id_option.duid))
response_suboptions.append(IAPrefixOption(prefix=suboption.prefix,
preferred_lifetime=0, valid_lifetime=0))
response_option = IAPDOption(option.iaid, options=response_suboptions)
bundle.response.options.append(response_option)
bundle.mark_handled(option)
for option in unanswered_iana_options:
if any([address_in_prefixes(address, self.responsible_for_links) for address in option.get_addresses()]):
# Overlap with our addresses: take responsibility
response_suboptions = []
for suboption in option.get_options_of_type(IAAddressOption):
if suboption.address == assignment.address:
# This is the correct option, renew it
logger.info("Renewing {} for {!r}".format(assignment.address, client_id_option.duid))
response_suboptions.append(IAAddressOption(address=assignment.address,
preferred_lifetime=self.address_preferred_lifetime,
valid_lifetime=self.address_valid_lifetime))
else:
# This isn't right
logger.info("Withdrawing {} from {!r}".format(suboption.address, client_id_option.duid))
response_suboptions.append(IAAddressOption(address=suboption.address,
preferred_lifetime=0, valid_lifetime=0))
response_option = IANAOption(option.iaid, options=response_suboptions)
bundle.response.options.append(response_option)
bundle.mark_handled(option)
def handle_request(self, bundle: TransactionBundle):
"""
Handle a client requesting addresses (also handles SolicitMessage)
:param bundle: The request bundle
"""
# Get the assignment
assignment = self.get_assignment(bundle)
# Collect unanswered options
unanswered_iana_options = bundle.get_unanswered_iana_options()
unanswered_iapd_options = bundle.get_unanswered_iapd_options()
# Try to assign the prefix first: it's not dependent on the link
if assignment.prefix:
found_option = self.find_iapd_option_for_prefix(unanswered_iapd_options, assignment.prefix)
if found_option:
# Answer to this option
logger.info("Assigning {} to {!r}".format(assignment.prefix,
bundle.request.get_option_of_type(ClientIdOption).duid))
response_option = IAPDOption(found_option.iaid, options=[
IAPrefixOption(prefix=assignment.prefix,
preferred_lifetime=self.prefix_preferred_lifetime,
valid_lifetime=self.prefix_valid_lifetime)
])
bundle.response.options.append(response_option)
bundle.mark_handled(found_option)
# Make sure we are responsible for this link
link_address = bundle.get_link_address()
if not address_in_prefixes(link_address, self.responsible_for_links):
logger.debug("Not assigning to link {}: "
"doesn't match {}".format(link_address, ', '.join(map(str, self.responsible_for_links))))
return
if assignment.address:
found_option = self.find_iana_option_for_address(unanswered_iana_options, assignment.address)
if found_option:
# Answer to this option
logger.info("Assigning {} to {!r}".format(assignment.address,
bundle.request.get_option_of_type(ClientIdOption).duid))
response_option = IANAOption(found_option.iaid, options=[
IAAddressOption(address=assignment.address,
preferred_lifetime=self.address_preferred_lifetime,
valid_lifetime=self.address_valid_lifetime)
])
bundle.response.options.append(response_option)
bundle.mark_handled(found_option)
def handle_release_decline(self, bundle: TransactionBundle):
"""
Handle a client releasing or declining resources. Doesn't really need to do anything because assignments are
fixed. Just mark the right options as handled.
:param bundle: The request bundle
"""
# Get the assignment
assignment = self.get_assignment(bundle)
# Collect unanswered options
unanswered_iana_options = bundle.get_unanswered_iana_options()
unanswered_iapd_options = bundle.get_unanswered_iapd_options()
for option in unanswered_iapd_options:
if assignment.prefix and prefix_overlaps_prefixes(assignment.prefix, option.get_prefixes()):
# Overlap with our assigned prefix: take responsibility
bundle.mark_handled(option)
for option in unanswered_iana_options:
if any([address_in_prefixes(address, self.responsible_for_links) for address in option.get_addresses()]):
# Overlap with our addresses: take responsibility
bundle.mark_handled(option)
class TransactionBundleTestCase(unittest.TestCase):
def setUp(self):
self.bundle = TransactionBundle(relayed_solicit_message, True)
self.ia_bundle = TransactionBundle(SolicitMessage(options=[
IANAOption(b'0001'),
IANAOption(b'0002'),
IATAOption(b'0003'),
IATAOption(b'0004'),
IAPDOption(b'0005'),
IAPDOption(b'0006'),
]), False)
self.option_handlers = [
InterfaceIdOptionHandler(),
]
def test_request(self):
self.assertEqual(self.bundle.request, solicit_message)
def test_incoming_relay_messages(self):
self.assertEqual(len(self.bundle.incoming_relay_messages), 2)
self.assertEqual(self.bundle.incoming_relay_messages[0].hop_count, 0)
self.assertEqual(self.bundle.incoming_relay_messages[1].hop_count, 1)
def test_no_response(self):
self.assertRaisesRegex(ValueError, 'Cannot create outgoing',
self.bundle.create_outgoing_relay_messages)
def test_bad_response(self):
self.bundle.response = SolicitMessage()
with self.assertLogs() as cm:
self.assertIsNone(self.bundle.outgoing_message)
self.assertEqual(len(cm.output), 1)
self.assertRegex(cm.output[0], 'server should not send')
def test_outgoing_message(self):
# Set the response and let the option handlers do their work
# Which in this case is copy the InterfaceId to the response
self.bundle.response = advertise_message
self.bundle.create_outgoing_relay_messages()
for option_handler in self.option_handlers:
option_handler.handle(self.bundle)
self.assertEqual(self.bundle.outgoing_message, relayed_advertise_message)
def test_direct_outgoing_message(self):
self.ia_bundle.response = advertise_message
self.assertEqual(self.ia_bundle.outgoing_message, advertise_message)
def test_auto_create_outgoing_relay_messages(self):
self.bundle.response = advertise_message
self.assertIsInstance(self.bundle.outgoing_message, RelayReplyMessage)
def test_no_outgoing_message(self):
self.assertIsNone(self.bundle.outgoing_message)
def test_unanswered_ia_options(self):
unanswered_options = self.ia_bundle.get_unanswered_ia_options()
self.assertEqual(len(unanswered_options), 4)
self.assertIn(IANAOption(b'0001'), unanswered_options)
self.assertIn(IANAOption(b'0002'), unanswered_options)
self.assertIn(IATAOption(b'0003'), unanswered_options)
self.assertIn(IATAOption(b'0004'), unanswered_options)
def test_mark_handled(self):
self.ia_bundle.mark_handled(IANAOption(b'0001'))
self.ia_bundle.mark_handled(IATAOption(b'0004'))
unanswered_options = self.ia_bundle.get_unanswered_ia_options()
self.assertEqual(len(unanswered_options), 2)
self.assertIn(IANAOption(b'0002'), unanswered_options)
self.assertIn(IATAOption(b'0003'), unanswered_options)
def test_unanswered_iana_options(self):
unanswered_options = self.ia_bundle.get_unanswered_iana_options()
self.assertEqual(len(unanswered_options), 2)
self.assertIn(IANAOption(b'0001'), unanswered_options)
self.assertIn(IANAOption(b'0002'), unanswered_options)
def test_unanswered_iata_options(self):
unanswered_options = self.ia_bundle.get_unanswered_iata_options()
self.assertEqual(len(unanswered_options), 2)
self.assertIn(IATAOption(b'0003'), unanswered_options)
self.assertIn(IATAOption(b'0004'), unanswered_options)
def test_unanswered_iapd_options(self):
unanswered_options = self.ia_bundle.get_unanswered_iapd_options()
self.assertEqual(len(unanswered_options), 2)
self.assertIn(IAPDOption(b'0005'), unanswered_options)
self.assertIn(IAPDOption(b'0006'), unanswered_options)
def test_unknown_message(self):
with self.assertLogs() as cm:
TransactionBundle(UnknownMessage(1608, b'Unknown'), False)
self.assertEqual(len(cm.output), 1)
self.assertRegex(cm.output[0], 'unrecognised message')
def test_wrong_way(self):
with self.assertLogs() as cm:
TransactionBundle(ReplyMessage(), False)
self.assertEqual(len(cm.output), 1)
self.assertRegex(cm.output[0], 'server should not receive')
def test_link_address(self):
self.assertEqual(self.bundle.get_link_address(), IPv6Address('2001:db8:ffff:1::1'))
self.assertEqual(self.ia_bundle.get_link_address(), IPv6Address('::'))
