Update DHCPv6 DUID code and fix coverity warnings
[vpp.git] / test / test_dhcp6.py
1 from scapy.layers.dhcp6 import DHCP6_Advertise, DHCP6OptClientId, \
2     DHCP6OptStatusCode, DHCP6OptPref, DHCP6OptIA_PD, DHCP6OptIAPrefix, \
3     DHCP6OptServerId, DHCP6_Solicit, DHCP6_Reply, DHCP6_Request, DHCP6_Renew, \
4     DHCP6_Rebind, DUID_LL, DHCP6_Release, DHCP6OptElapsedTime
5 from scapy.layers.inet6 import IPv6, Ether, UDP
6 from scapy.utils6 import in6_mactoifaceid
7 from scapy.utils import inet_ntop, inet_pton
8 from socket import AF_INET6
9 from framework import VppTestCase
10 from time import time
11
12
13 def ip6_normalize(ip6):
14     return inet_ntop(AF_INET6, inet_pton(AF_INET6, ip6))
15
16
17 def mk_ll_addr(mac):
18     euid = in6_mactoifaceid(mac)
19     addr = "fe80::" + euid
20     return addr
21
22
23 class TestDHCPv6PD(VppTestCase):
24     """ DHCPv6 PD Data Plane Test Case """
25
26     @classmethod
27     def setUpClass(cls):
28         super(TestDHCPv6PD, cls).setUpClass()
29
30     def setUp(self):
31         super(TestDHCPv6PD, self).setUp()
32
33         self.create_pg_interfaces(range(1))
34         self.interfaces = list(self.pg_interfaces)
35         for i in self.interfaces:
36             i.admin_up()
37             i.config_ip6()
38
39         self.server_duid = DUID_LL(lladdr=self.pg0.remote_mac)
40
41     def tearDown(self):
42         for i in self.interfaces:
43             i.unconfig_ip6()
44             i.admin_down()
45         super(TestDHCPv6PD, self).tearDown()
46
47     def test_dhcp_send_solicit_receive_advertise(self):
48         """ Verify DHCPv6 PD Solicit packet and received Advertise envent """
49
50         self.vapi.dhcp6_clients_enable_disable()
51
52         self.pg_enable_capture(self.pg_interfaces)
53         self.pg_start()
54         prefix_bin = '\00\01\00\02\00\03' + '\00' * 10
55         prefix = {'prefix': prefix_bin,
56                   'prefix_length': 50,
57                   'preferred_time': 60,
58                   'valid_time': 120}
59         self.vapi.dhcp6_pd_send_client_message(1, self.pg0.sw_if_index,
60                                                T1=20, T2=40, prefixes=[prefix])
61         rx_list = self.pg0.get_capture(1)
62         self.assertEqual(len(rx_list), 1)
63         packet = rx_list[0]
64
65         self.assertTrue(packet.haslayer(IPv6))
66         self.assertTrue(packet[IPv6].haslayer(DHCP6_Solicit))
67
68         client_duid = packet[DHCP6OptClientId].duid
69         trid = packet[DHCP6_Solicit].trid
70
71         dst = ip6_normalize(packet[IPv6].dst)
72         dst2 = ip6_normalize("ff02::1:2")
73         self.assert_equal(dst, dst2)
74         src = ip6_normalize(packet[IPv6].src)
75         src2 = ip6_normalize(self.pg0.local_ip6_ll)
76         self.assert_equal(src, src2)
77         ia_pd = packet[DHCP6OptIA_PD]
78         self.assert_equal(ia_pd.T1, 20)
79         self.assert_equal(ia_pd.T2, 40)
80         self.assert_equal(len(ia_pd.iapdopt), 1)
81         prefix = ia_pd.iapdopt[0]
82         self.assert_equal(prefix.prefix, '1:2:3::')
83         self.assert_equal(prefix.plen, 50)
84         self.assert_equal(prefix.preflft, 60)
85         self.assert_equal(prefix.validlft, 120)
86
87         self.vapi.want_dhcp6_pd_reply_events()
88
89         ia_pd_opts = DHCP6OptIAPrefix(prefix='7:8::', plen=56, preflft=60,
90                                       validlft=120)
91         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
92              IPv6(src=mk_ll_addr(self.pg0.remote_mac),
93                   dst=self.pg0.local_ip6_ll) /
94              UDP(sport=547, dport=546) /
95              DHCP6_Advertise(trid=trid) /
96              DHCP6OptServerId(duid=self.server_duid) /
97              DHCP6OptClientId(duid=client_duid) /
98              DHCP6OptPref(prefval=7) /
99              DHCP6OptStatusCode(statuscode=1) /
100              DHCP6OptIA_PD(iaid=1, T1=20, T2=40, iapdopt=ia_pd_opts)
101              )
102         self.pg0.add_stream([p])
103         self.pg_start()
104
105         ev = self.vapi.wait_for_event(1, "dhcp6_pd_reply_event")
106
107         self.assert_equal(ev.preference, 7)
108         self.assert_equal(ev.status_code, 1)
109         self.assert_equal(ev.T1, 20)
110         self.assert_equal(ev.T2, 40)
111
112         reported_prefix = ev.prefixes[0]
113         prefix = inet_pton(AF_INET6, ia_pd_opts.getfieldval("prefix"))
114         self.assert_equal(reported_prefix.prefix, prefix)
115         self.assert_equal(reported_prefix.prefix_length,
116                           ia_pd_opts.getfieldval("plen"))
117         self.assert_equal(reported_prefix.preferred_time,
118                           ia_pd_opts.getfieldval("preflft"))
119         self.assert_equal(reported_prefix.valid_time,
120                           ia_pd_opts.getfieldval("validlft"))
121
122
123 class TestDHCPv6PDControlPlane(VppTestCase):
124     """ DHCPv6 PD Control Plane Test Case """
125
126     @classmethod
127     def setUpClass(cls):
128         super(TestDHCPv6PDControlPlane, cls).setUpClass()
129
130     def setUp(self):
131         super(TestDHCPv6PDControlPlane, self).setUp()
132
133         self.create_pg_interfaces(range(2))
134         self.interfaces = list(self.pg_interfaces)
135         for i in self.interfaces:
136             i.admin_up()
137
138         self.server_duid = DUID_LL(lladdr=self.pg0.remote_mac)
139         self.client_duid = None
140         self.T1 = 1
141         self.T2 = 2
142
143         fib = self.vapi.ip6_fib_dump()
144         self.initial_addresses = set(self.get_interface_addresses(fib,
145                                                                   self.pg1))
146
147         self.pg_enable_capture(self.pg_interfaces)
148         self.pg_start()
149
150         self.prefix_group = 'my-pd-prefix-group'
151
152         self.vapi.dhcp6_pd_client_enable_disable(
153             self.pg0.sw_if_index,
154             prefix_group=self.prefix_group)
155
156     def tearDown(self):
157         self.vapi.dhcp6_pd_client_enable_disable(self.pg0.sw_if_index,
158                                                  enable=0)
159
160         for i in self.interfaces:
161             i.admin_down()
162
163         super(TestDHCPv6PDControlPlane, self).tearDown()
164
165     @staticmethod
166     def get_interface_addresses(fib, pg):
167         lst = []
168         for entry in fib:
169             if entry.address_length == 128:
170                 path = entry.path[0]
171                 if path.sw_if_index == pg.sw_if_index:
172                     lst.append(entry.address)
173         return lst
174
175     def get_addresses(self):
176         fib = self.vapi.ip6_fib_dump()
177         addresses = set(self.get_interface_addresses(fib, self.pg1))
178         return addresses.difference(self.initial_addresses)
179
180     def validate_duid_ll(self, duid):
181         DUID_LL(duid)
182
183     def validate_packet(self, packet, msg_type, is_resend=False):
184         try:
185             self.assertTrue(packet.haslayer(msg_type))
186             client_duid = packet[DHCP6OptClientId].duid
187             if self.client_duid is None:
188                 self.client_duid = client_duid
189                 self.validate_duid_ll(client_duid)
190             else:
191                 self.assertEqual(self.client_duid, client_duid)
192             if msg_type != DHCP6_Solicit and msg_type != DHCP6_Rebind:
193                 server_duid = packet[DHCP6OptServerId].duid
194                 self.assertEqual(server_duid, self.server_duid)
195             if is_resend:
196                 self.assertEqual(self.trid, packet[msg_type].trid)
197             else:
198                 self.trid = packet[msg_type].trid
199             ip = packet[IPv6]
200             udp = packet[UDP]
201             self.assertEqual(ip.dst, 'ff02::1:2')
202             self.assertEqual(udp.sport, 546)
203             self.assertEqual(udp.dport, 547)
204             dhcpv6 = packet[msg_type]
205             elapsed_time = dhcpv6[DHCP6OptElapsedTime]
206             if (is_resend):
207                 self.assertNotEqual(elapsed_time.elapsedtime, 0)
208             else:
209                 self.assertEqual(elapsed_time.elapsedtime, 0)
210         except:
211             packet.show()
212             raise
213
214     def wait_for_packet(self, msg_type, timeout=None, is_resend=False):
215         if timeout is None:
216             timeout = 3
217         rx_list = self.pg0.get_capture(1, timeout=timeout)
218         packet = rx_list[0]
219         self.validate_packet(packet, msg_type, is_resend=is_resend)
220
221     def wait_for_solicit(self, timeout=None, is_resend=False):
222         self.wait_for_packet(DHCP6_Solicit, timeout, is_resend=is_resend)
223
224     def wait_for_request(self, timeout=None, is_resend=False):
225         self.wait_for_packet(DHCP6_Request, timeout, is_resend=is_resend)
226
227     def wait_for_renew(self, timeout=None, is_resend=False):
228         self.wait_for_packet(DHCP6_Renew, timeout, is_resend=is_resend)
229
230     def wait_for_rebind(self, timeout=None, is_resend=False):
231         self.wait_for_packet(DHCP6_Rebind, timeout, is_resend=is_resend)
232
233     def wait_for_release(self, timeout=None, is_resend=False):
234         self.wait_for_packet(DHCP6_Release, timeout, is_resend=is_resend)
235
236     def send_packet(self, msg_type, t1=None, t2=None, iapdopt=None):
237         if t1 is None:
238             t1 = self.T1
239         if t2 is None:
240             t2 = self.T2
241         if iapdopt is None:
242             opt_ia_pd = DHCP6OptIA_PD(iaid=1, T1=t1, T2=t2)
243         else:
244             opt_ia_pd = DHCP6OptIA_PD(iaid=1, T1=t1, T2=t2, iapdopt=iapdopt)
245         p = (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
246              IPv6(src=mk_ll_addr(self.pg0.remote_mac),
247                   dst=self.pg0.local_ip6_ll) /
248              UDP(sport=547, dport=546) /
249              msg_type(trid=self.trid) /
250              DHCP6OptServerId(duid=self.server_duid) /
251              DHCP6OptClientId(duid=self.client_duid) /
252              opt_ia_pd
253              )
254         self.pg0.add_stream([p])
255         self.pg_enable_capture(self.pg_interfaces)
256         self.pg_start()
257
258     def send_advertise(self, t1=None, t2=None, iapdopt=None):
259         self.send_packet(DHCP6_Advertise, t1, t2, iapdopt)
260
261     def send_reply(self, t1=None, t2=None, iapdopt=None):
262         self.send_packet(DHCP6_Reply, t1, t2, iapdopt)
263
264     def test_T1_and_T2_timeouts(self):
265         """ Test T1 and T2 timeouts """
266
267         self.wait_for_solicit()
268         self.send_advertise()
269         self.wait_for_request()
270         self.send_reply()
271
272         self.sleep(1)
273
274         self.wait_for_renew()
275
276         self.pg_enable_capture(self.pg_interfaces)
277
278         self.sleep(1)
279
280         self.wait_for_rebind()
281
282     def test_prefixes(self):
283         """ Test handling of prefixes """
284         address_bin_1 = None
285         address_bin_2 = None
286         try:
287             address_bin_1 = '\x00' * 6 + '\x00\x02' + '\x00' * 6 + '\x04\x05'
288             address_prefix_length_1 = 60
289             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
290                                                        address_bin_1,
291                                                        address_prefix_length_1,
292                                                        self.prefix_group)
293
294             ia_pd_opts = DHCP6OptIAPrefix(prefix='7:8::', plen=56, preflft=2,
295                                           validlft=3)
296
297             self.wait_for_solicit()
298             self.send_advertise(t1=20, t2=40, iapdopt=ia_pd_opts)
299             self.wait_for_request()
300             self.send_reply(t1=20, t2=40, iapdopt=ia_pd_opts)
301             self.sleep(0.1)
302
303             # check FIB for new address
304             new_addresses = self.get_addresses()
305             self.assertEqual(len(new_addresses), 1)
306             addr = list(new_addresses)[0]
307             self.assertEqual(inet_ntop(AF_INET6, addr), '7:8:0:2::405')
308
309             self.sleep(1)
310
311             address_bin_2 = '\x00' * 6 + '\x00\x76' + '\x00' * 6 + '\x04\x06'
312             address_prefix_length_2 = 62
313             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
314                                                        address_bin_2,
315                                                        address_prefix_length_2,
316                                                        self.prefix_group)
317
318             self.sleep(1)
319
320             # check FIB contains 2 addresses
321             fib = self.vapi.ip6_fib_dump()
322             addresses = set(self.get_interface_addresses(fib, self.pg1))
323             new_addresses = addresses.difference(self.initial_addresses)
324             self.assertEqual(len(new_addresses), 2)
325             addr1 = list(new_addresses)[0]
326             addr2 = list(new_addresses)[1]
327             if inet_ntop(AF_INET6, addr1) == '7:8:0:76::406':
328                 addr1, addr2 = addr2, addr1
329             self.assertEqual(inet_ntop(AF_INET6, addr1), '7:8:0:2::405')
330             self.assertEqual(inet_ntop(AF_INET6, addr2), '7:8:0:76::406')
331
332             self.sleep(1)
333
334             # check that the addresses are deleted
335             fib = self.vapi.ip6_fib_dump()
336             addresses = set(self.get_interface_addresses(fib, self.pg1))
337             new_addresses = addresses.difference(self.initial_addresses)
338             self.assertEqual(len(new_addresses), 0)
339
340         finally:
341             if address_bin_1 is not None:
342                 self.vapi.ip6_add_del_address_using_prefix(
343                     self.pg1.sw_if_index, address_bin_1,
344                     address_prefix_length_1, self.prefix_group, is_add=0)
345             if address_bin_2 is not None:
346                 self.vapi.ip6_add_del_address_using_prefix(
347                     self.pg1.sw_if_index, address_bin_2,
348                     address_prefix_length_2, self.prefix_group, is_add=0)
349
350     def test_sending_client_messages_solicit(self):
351         """ VPP receives messages from DHCPv6 client """
352
353         self.wait_for_solicit()
354         self.send_packet(DHCP6_Solicit)
355         self.send_packet(DHCP6_Request)
356         self.send_packet(DHCP6_Renew)
357         self.send_packet(DHCP6_Rebind)
358         self.sleep(1)
359         self.wait_for_solicit(is_resend=True)
360
361     def test_sending_inapropriate_packets(self):
362         """ Server sends messages with inapropriate message types """
363
364         self.wait_for_solicit()
365         self.send_reply()
366         self.wait_for_solicit(is_resend=True)
367         self.send_advertise()
368         self.wait_for_request()
369         self.send_advertise()
370         self.wait_for_request(is_resend=True)
371         self.send_reply()
372         self.wait_for_renew()
373
374     def test_no_prefix_available_in_advertise(self):
375         """ Advertise message contains NoPrefixAvail status code """
376
377         self.wait_for_solicit()
378         noavail = DHCP6OptStatusCode(statuscode=6)  # NoPrefixAvail
379         self.send_advertise(iapdopt=noavail)
380         self.wait_for_solicit(is_resend=True)
381
382     def test_preferred_greater_than_valit_lifetime(self):
383         """ Preferred lifetime is greater than valid lifetime """
384
385         try:
386             address_bin = '\x00' * 6 + '\x00\x02' + '\x00' * 6 + '\x04\x05'
387             address_prefix_length = 60
388             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
389                                                        address_bin,
390                                                        address_prefix_length,
391                                                        self.prefix_group)
392
393             self.wait_for_solicit()
394             self.send_advertise()
395             self.wait_for_request()
396             ia_pd_opts = DHCP6OptIAPrefix(prefix='7:8::', plen=56, preflft=4,
397                                           validlft=3)
398             self.send_reply(iapdopt=ia_pd_opts)
399
400             self.sleep(0.5)
401
402             # check FIB contains no addresses
403             fib = self.vapi.ip6_fib_dump()
404             addresses = set(self.get_interface_addresses(fib, self.pg1))
405             new_addresses = addresses.difference(self.initial_addresses)
406             self.assertEqual(len(new_addresses), 0)
407
408         finally:
409             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
410                                                        address_bin,
411                                                        address_prefix_length,
412                                                        self.prefix_group,
413                                                        is_add=0)
414
415     def test_T1_greater_than_T2(self):
416         """ T1 is greater than T2 """
417
418         try:
419             address_bin = '\x00' * 6 + '\x00\x02' + '\x00' * 6 + '\x04\x05'
420             address_prefix_length = 60
421             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
422                                                        address_bin,
423                                                        address_prefix_length,
424                                                        self.prefix_group)
425
426             self.wait_for_solicit()
427             self.send_advertise()
428             self.wait_for_request()
429             ia_pd_opts = DHCP6OptIAPrefix(prefix='7:8::', plen=56, preflft=4,
430                                           validlft=8)
431             self.send_reply(t1=80, t2=40, iapdopt=ia_pd_opts)
432
433             self.sleep(0.5)
434
435             # check FIB contains no addresses
436             fib = self.vapi.ip6_fib_dump()
437             addresses = set(self.get_interface_addresses(fib, self.pg1))
438             new_addresses = addresses.difference(self.initial_addresses)
439             self.assertEqual(len(new_addresses), 0)
440
441         finally:
442             self.vapi.ip6_add_del_address_using_prefix(self.pg1.sw_if_index,
443                                                        address_bin,
444                                                        address_prefix_length,
445                                                        self.prefix_group,
446                                                        is_add=0)