4 from scapy.layers.inet import IP, ICMP, TCP
5 from scapy.layers.ipsec import SecurityAssociation
6 from scapy.layers.l2 import Ether, Raw
7 from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest
9 from framework import VppTestCase, VppTestRunner
13 class IPsecIPv4Params(object):
14 addr_type = socket.AF_INET
16 addr_bcast = "255.255.255.255"
19 remote_tun_if_host = '1.1.1.1'
31 auth_algo_vpp_id = 2 # internal VPP enum value for SHA1_96
32 auth_algo = 'HMAC-SHA1-96' # scapy name
33 auth_key = 'C91KUR9GYMm5GfkEvNjX'
35 crypt_algo_vpp_id = 1 # internal VPP enum value for AES_CBC_128
36 crypt_algo = 'AES-CBC' # scapy name
37 crypt_key = 'JPjyOWBeVEQiMe7h'
40 class IPsecIPv6Params(object):
41 addr_type = socket.AF_INET6
43 addr_bcast = "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"
46 remote_tun_if_host = '1111:1111:1111:1111:1111:1111:1111:1111'
58 auth_algo_vpp_id = 4 # internal VPP enum value for SHA_256_128
59 auth_algo = 'SHA2-256-128' # scapy name
60 auth_key = 'C91KUR9GYMm5GfkEvNjX'
62 crypt_algo_vpp_id = 3 # internal VPP enum value for AES_CBC_256
63 crypt_algo = 'AES-CBC' # scapy name
64 crypt_key = 'JPjyOWBeVEQiMe7hJPjyOWBeVEQiMe7h'
67 class TemplateIpsec(VppTestCase):
72 |tra_if| <-------> |VPP|
77 ------ encrypt --- plain ---
78 |tun_if| <------- |VPP| <------ |pg1|
81 ------ decrypt --- plain ---
82 |tun_if| -------> |VPP| ------> |pg1|
85 ipv4_params = IPsecIPv4Params()
86 ipv6_params = IPsecIPv6Params()
87 params = {ipv4_params.addr_type: ipv4_params,
88 ipv6_params.addr_type: ipv6_params}
90 payload = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
99 def ipsec_select_backend(cls):
100 """ empty method to be overloaded when necessary """
105 super(TemplateIpsec, cls).setUpClass()
106 cls.create_pg_interfaces(range(3))
107 cls.interfaces = list(cls.pg_interfaces)
108 for i in cls.interfaces:
114 cls.ipsec_select_backend()
117 super(TemplateIpsec, self).tearDown()
118 if not self.vpp_dead:
119 self.vapi.cli("show hardware")
121 def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1):
122 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
123 sa.encrypt(IP(src=src, dst=dst) / ICMP() / self.payload)
124 for i in range(count)]
126 def gen_encrypt_pkts6(self, sa, sw_intf, src, dst, count=1):
127 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
128 sa.encrypt(IPv6(src=src, dst=dst) /
129 ICMPv6EchoRequest(id=0, seq=1, data=self.payload))
130 for i in range(count)]
132 def gen_pkts(self, sw_intf, src, dst, count=1):
133 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
134 IP(src=src, dst=dst) / ICMP() / self.payload
135 for i in range(count)]
137 def gen_pkts6(self, sw_intf, src, dst, count=1):
138 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
139 IPv6(src=src, dst=dst) /
140 ICMPv6EchoRequest(id=0, seq=1, data=self.payload)
141 for i in range(count)]
143 def configure_sa_tun(self, params):
144 ip_class_by_addr_type = {socket.AF_INET: IP, socket.AF_INET6: IPv6}
145 scapy_tun_sa = SecurityAssociation(
146 self.encryption_type, spi=params.vpp_tun_spi,
147 crypt_algo=params.crypt_algo, crypt_key=params.crypt_key,
148 auth_algo=params.auth_algo, auth_key=params.auth_key,
149 tunnel_header=ip_class_by_addr_type[params.addr_type](
150 src=self.tun_if.remote_addr[params.addr_type],
151 dst=self.tun_if.local_addr[params.addr_type]))
152 vpp_tun_sa = SecurityAssociation(
153 self.encryption_type, spi=params.scapy_tun_spi,
154 crypt_algo=params.crypt_algo, crypt_key=params.crypt_key,
155 auth_algo=params.auth_algo, auth_key=params.auth_key,
156 tunnel_header=ip_class_by_addr_type[params.addr_type](
157 dst=self.tun_if.remote_addr[params.addr_type],
158 src=self.tun_if.local_addr[params.addr_type]))
159 return vpp_tun_sa, scapy_tun_sa
162 def configure_sa_tra(cls, params):
163 params.scapy_tra_sa = SecurityAssociation(cls.encryption_type,
164 spi=params.vpp_tra_spi,
165 crypt_algo=params.crypt_algo,
166 crypt_key=params.crypt_key,
167 auth_algo=params.auth_algo,
168 auth_key=params.auth_key)
169 params.vpp_tra_sa = SecurityAssociation(cls.encryption_type,
170 spi=params.scapy_tra_spi,
171 crypt_algo=params.crypt_algo,
172 crypt_key=params.crypt_key,
173 auth_algo=params.auth_algo,
174 auth_key=params.auth_key)
177 class IpsecTcpTests(object):
178 def test_tcp_checksum(self):
179 """ verify checksum correctness for vpp generated packets """
180 self.vapi.cli("test http server")
181 p = self.params[socket.AF_INET]
182 vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
183 send = (Ether(src=self.tun_if.remote_mac, dst=self.tun_if.local_mac) /
184 scapy_tun_sa.encrypt(IP(src=p.remote_tun_if_host,
185 dst=self.tun_if.local_ip4) /
186 TCP(flags='S', dport=80)))
187 self.logger.debug(ppp("Sending packet:", send))
188 recv = self.send_and_expect(self.tun_if, [send], self.tun_if)
190 decrypted = vpp_tun_sa.decrypt(recv[IP])
191 self.assert_packet_checksums_valid(decrypted)
194 class IpsecTraTests(object):
195 def test_tra_anti_replay(self, count=1):
196 """ ipsec v4 transport anti-reply test """
197 p = self.params[socket.AF_INET]
199 # fire in a packet with seq number 1
200 pkt = (Ether(src=self.tra_if.remote_mac,
201 dst=self.tra_if.local_mac) /
202 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
203 dst=self.tra_if.local_ip4) /
206 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
208 # now move the window over to 235
209 pkt = (Ether(src=self.tra_if.remote_mac,
210 dst=self.tra_if.local_mac) /
211 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
212 dst=self.tra_if.local_ip4) /
215 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
217 # the window size is 64 packets
218 # in window are still accepted
219 pkt = (Ether(src=self.tra_if.remote_mac,
220 dst=self.tra_if.local_mac) /
221 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
222 dst=self.tra_if.local_ip4) /
225 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
227 # out of window are dropped
228 pkt = (Ether(src=self.tra_if.remote_mac,
229 dst=self.tra_if.local_mac) /
230 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
231 dst=self.tra_if.local_ip4) /
234 self.send_and_assert_no_replies(self.tra_if, pkt * 17)
236 err = self.statistics.get_counter(
237 '/err/%s/SA replayed packet' % self.tra4_decrypt_node_name)
238 self.assertEqual(err, 17)
240 # a packet that does not decrypt does not move the window forward
241 bogus_sa = SecurityAssociation(self.encryption_type,
243 pkt = (Ether(src=self.tra_if.remote_mac,
244 dst=self.tra_if.local_mac) /
245 bogus_sa.encrypt(IP(src=self.tra_if.remote_ip4,
246 dst=self.tra_if.local_ip4) /
249 self.send_and_assert_no_replies(self.tra_if, pkt * 17)
251 err = self.statistics.get_counter(
252 '/err/%s/Integrity check failed' % self.tra4_decrypt_node_name)
253 self.assertEqual(err, 17)
255 # which we can determine since this packet is still in the window
256 pkt = (Ether(src=self.tra_if.remote_mac,
257 dst=self.tra_if.local_mac) /
258 p.scapy_tra_sa.encrypt(IP(src=self.tra_if.remote_ip4,
259 dst=self.tra_if.local_ip4) /
262 recv_pkts = self.send_and_expect(self.tra_if, [pkt], self.tra_if)
264 # move the security-associations seq number on to the last we used
265 p.scapy_tra_sa.seq_num = 351
266 p.vpp_tra_sa.seq_num = 351
268 def test_tra_basic(self, count=1):
269 """ ipsec v4 transport basic test """
270 self.vapi.cli("clear errors")
272 p = self.params[socket.AF_INET]
273 send_pkts = self.gen_encrypt_pkts(p.scapy_tra_sa, self.tra_if,
274 src=self.tra_if.remote_ip4,
275 dst=self.tra_if.local_ip4,
277 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
281 decrypted = p.vpp_tra_sa.decrypt(rx[IP])
282 self.assert_packet_checksums_valid(decrypted)
284 self.logger.debug(ppp("Unexpected packet:", rx))
287 self.logger.info(self.vapi.ppcli("show error"))
288 self.logger.info(self.vapi.ppcli("show ipsec"))
290 self.assert_packet_counter_equal(self.tra4_encrypt_node_name, count)
291 self.assert_packet_counter_equal(self.tra4_decrypt_node_name, count)
293 def test_tra_burst(self):
294 """ ipsec v4 transport burst test """
295 self.test_tra_basic(count=257)
297 def test_tra_basic6(self, count=1):
298 """ ipsec v6 transport basic test """
299 self.vapi.cli("clear errors")
301 p = self.params[socket.AF_INET6]
302 send_pkts = self.gen_encrypt_pkts6(p.scapy_tra_sa, self.tra_if,
303 src=self.tra_if.remote_ip6,
304 dst=self.tra_if.local_ip6,
306 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
310 decrypted = p.vpp_tra_sa.decrypt(rx[IPv6])
311 self.assert_packet_checksums_valid(decrypted)
313 self.logger.debug(ppp("Unexpected packet:", rx))
316 self.logger.info(self.vapi.ppcli("show error"))
317 self.logger.info(self.vapi.ppcli("show ipsec"))
319 self.assert_packet_counter_equal(self.tra6_encrypt_node_name, count)
320 self.assert_packet_counter_equal(self.tra6_decrypt_node_name, count)
322 def test_tra_burst6(self):
323 """ ipsec v6 transport burst test """
324 self.test_tra_basic6(count=257)
327 class IpsecTun4Tests(object):
328 def test_tun_basic44(self, count=1):
329 """ ipsec 4o4 tunnel basic test """
330 self.vapi.cli("clear errors")
332 p = self.params[socket.AF_INET]
333 vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
334 send_pkts = self.gen_encrypt_pkts(scapy_tun_sa, self.tun_if,
335 src=p.remote_tun_if_host,
336 dst=self.pg1.remote_ip4,
338 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
339 for recv_pkt in recv_pkts:
340 self.assert_equal(recv_pkt[IP].src, p.remote_tun_if_host)
341 self.assert_equal(recv_pkt[IP].dst, self.pg1.remote_ip4)
342 self.assert_packet_checksums_valid(recv_pkt)
343 send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
344 dst=p.remote_tun_if_host, count=count)
345 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
346 for recv_pkt in recv_pkts:
348 decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IP])
349 if not decrypt_pkt.haslayer(IP):
350 decrypt_pkt = IP(decrypt_pkt[Raw].load)
351 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
352 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
353 self.assert_packet_checksums_valid(decrypt_pkt)
355 self.logger.debug(ppp("Unexpected packet:", recv_pkt))
358 ppp("Decrypted packet:", decrypt_pkt))
363 self.logger.info(self.vapi.ppcli("show error"))
364 self.logger.info(self.vapi.ppcli("show ipsec"))
366 self.assert_packet_counter_equal(self.tun4_encrypt_node_name, count)
367 self.assert_packet_counter_equal(self.tun4_decrypt_node_name, count)
369 def test_tun_burst44(self):
370 """ ipsec 4o4 tunnel burst test """
371 self.test_tun_basic44(count=257)
374 class IpsecTun6Tests(object):
375 def test_tun_basic66(self, count=1):
376 """ ipsec 6o6 tunnel basic test """
377 self.vapi.cli("clear errors")
379 p = self.params[socket.AF_INET6]
380 vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
381 send_pkts = self.gen_encrypt_pkts6(scapy_tun_sa, self.tun_if,
382 src=p.remote_tun_if_host,
383 dst=self.pg1.remote_ip6,
385 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
386 for recv_pkt in recv_pkts:
387 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host)
388 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
389 self.assert_packet_checksums_valid(recv_pkt)
390 send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
391 dst=p.remote_tun_if_host,
393 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
394 for recv_pkt in recv_pkts:
396 decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IPv6])
397 if not decrypt_pkt.haslayer(IPv6):
398 decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
399 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
400 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
401 self.assert_packet_checksums_valid(decrypt_pkt)
403 self.logger.debug(ppp("Unexpected packet:", recv_pkt))
406 ppp("Decrypted packet:", decrypt_pkt))
411 self.logger.info(self.vapi.ppcli("show error"))
412 self.logger.info(self.vapi.ppcli("show ipsec"))
414 self.assert_packet_counter_equal(self.tun6_encrypt_node_name, count)
415 self.assert_packet_counter_equal(self.tun6_decrypt_node_name, count)
417 def test_tun_burst66(self):
418 """ ipsec 6o6 tunnel burst test """
419 self.test_tun_basic66(count=257)
422 class IpsecTunTests(IpsecTun4Tests, IpsecTun6Tests):
426 if __name__ == '__main__':
427 unittest.main(testRunner=VppTestRunner)