3 from scapy.layers.inet import IP, ICMP
4 from scapy.layers.l2 import Ether
5 from scapy.layers.ipsec import *
7 from framework import VppTestCase
8 from vpp_ip_route import VppIpRoute
13 class TestIpsecEsp(VppTestCase):
15 Basic test for ipsec esp sanity - tunnel and transport modes.
17 Below 4 cases are covered as part of this test
18 1) ipsec esp v4 transport basic test - IPv4 Transport mode
19 scenario using HMAC-SHA1-96 intergrity algo
20 2) ipsec esp v4 transport burst test
21 Above test for 257 pkts
22 3) ipsec esp 4o4 tunnel basic test - IPv4 Tunnel mode
23 scenario using HMAC-SHA1-96 intergrity algo
24 4) ipsec esp 4o4 tunnel burst test
25 Above test for 257 pkts
35 --- encrypt --- plain ---
36 |pg0| -------> |VPP| ------> |pg1|
39 --- decrypt --- plain ---
40 |pg0| <------- |VPP| <------ |pg1|
43 Note : IPv6 is not covered
46 remote_pg0_lb_addr = '1.1.1.1'
47 remote_pg1_lb_addr = '2.2.2.2'
51 super(TestIpsecEsp, cls).setUpClass()
53 cls.create_pg_interfaces(range(3))
54 cls.interfaces = list(cls.pg_interfaces)
55 for i in cls.interfaces:
59 cls.logger.info(cls.vapi.ppcli("show int addr"))
61 cls.logger.info(cls.vapi.ppcli("show ipsec"))
63 cls.logger.info(cls.vapi.ppcli("show ipsec"))
65 super(TestIpsecEsp, cls).tearDownClass()
69 def configEspTun(cls):
76 src4 = socket.inet_pton(socket.AF_INET, cls.remote_pg0_lb_addr)
77 cls.vapi.ip_add_del_route(src4, 32, cls.pg0.remote_ip4n)
78 dst4 = socket.inet_pton(socket.AF_INET, cls.remote_pg1_lb_addr)
79 cls.vapi.ip_add_del_route(dst4, 32, cls.pg1.remote_ip4n)
80 cls.vapi.ipsec_sad_add_del_entry(
85 integrity_key_length=20,
88 cls.vapi.ipsec_sad_add_del_entry(
93 integrity_key_length=20,
96 cls.vapi.ipsec_spd_add_del(spd_id)
97 cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg0.sw_if_index)
98 l_startaddr = r_startaddr = socket.inet_pton(
99 socket.AF_INET, "0.0.0.0")
100 l_stopaddr = r_stopaddr = socket.inet_pton(
101 socket.AF_INET, "255.255.255.255")
102 cls.vapi.ipsec_spd_add_del_entry(
109 cls.vapi.ipsec_spd_add_del_entry(
117 l_startaddr = l_stopaddr = socket.inet_pton(
118 socket.AF_INET, cls.remote_pg0_lb_addr)
119 r_startaddr = r_stopaddr = socket.inet_pton(
120 socket.AF_INET, cls.remote_pg1_lb_addr)
121 cls.vapi.ipsec_spd_add_del_entry(
131 cls.vapi.ipsec_spd_add_del_entry(
144 def configEspTra(cls):
149 remote_tra_spi = 2001
151 cls.vapi.ipsec_sad_add_del_entry(
154 integrity_key_length=20,
155 crypto_key_length=16,
158 cls.vapi.ipsec_sad_add_del_entry(
161 integrity_key_length=20,
162 crypto_key_length=16,
165 cls.vapi.ipsec_spd_add_del(spd_id)
166 cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg2.sw_if_index)
167 l_startaddr = r_startaddr = socket.inet_pton(
168 socket.AF_INET, "0.0.0.0")
169 l_stopaddr = r_stopaddr = socket.inet_pton(
170 socket.AF_INET, "255.255.255.255")
171 cls.vapi.ipsec_spd_add_del_entry(
178 cls.vapi.ipsec_spd_add_del_entry(
186 l_startaddr = l_stopaddr = cls.pg2.local_ip4n
187 r_startaddr = r_stopaddr = cls.pg2.remote_ip4n
188 cls.vapi.ipsec_spd_add_del_entry(
198 cls.vapi.ipsec_spd_add_del_entry(
210 def configScapySA(self, is_tun=False):
212 self.remote_tun_sa = SecurityAssociation(
215 crypt_algo='AES-CBC',
216 crypt_key='JPjyOWBeVEQiMe7h',
217 auth_algo='HMAC-SHA1-96',
218 auth_key='C91KUR9GYMm5GfkEvNjX',
220 src=self.pg0.remote_ip4,
221 dst=self.pg0.local_ip4))
222 self.local_tun_sa = SecurityAssociation(
225 crypt_algo='AES-CBC',
226 crypt_key='JPjyOWBeVEQiMe7h',
227 auth_algo='HMAC-SHA1-96',
228 auth_key='C91KUR9GYMm5GfkEvNjX',
230 dst=self.pg0.remote_ip4,
231 src=self.pg0.local_ip4))
233 self.remote_tra_sa = SecurityAssociation(
236 crypt_algo='AES-CBC',
237 crypt_key='JPjyOWBeVEQiMe7h',
238 auth_algo='HMAC-SHA1-96',
239 auth_key='C91KUR9GYMm5GfkEvNjX')
240 self.local_tra_sa = SecurityAssociation(
243 crypt_algo='AES-CBC',
244 crypt_key='JPjyOWBeVEQiMe7h',
245 auth_algo='HMAC-SHA1-96',
246 auth_key='C91KUR9GYMm5GfkEvNjX')
249 super(TestIpsecEsp, self).tearDown()
250 if not self.vpp_dead:
251 self.vapi.cli("show hardware")
253 def send_and_expect(self, input, pkts, output, count=1):
254 input.add_stream(pkts)
255 self.pg_enable_capture(self.pg_interfaces)
257 rx = output.get_capture(count)
260 def gen_encrypt_pkts(self, sa, sw_intf, src, dst, count=1):
261 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
262 sa.encrypt(IP(src=src, dst=dst) / ICMP() /
263 "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
266 def gen_pkts(self, sw_intf, src, dst, count=1):
267 return [Ether(src=sw_intf.remote_mac, dst=sw_intf.local_mac) /
268 IP(src=src, dst=dst) / ICMP() /
269 "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
272 def test_ipsec_esp_tra_basic(self, count=1):
273 """ ipsec esp v4 transport basic test """
276 send_pkts = self.gen_encrypt_pkts(
279 src=self.pg2.remote_ip4,
280 dst=self.pg2.local_ip4,
282 recv_pkts = self.send_and_expect(
283 self.pg2, send_pkts, self.pg2, count=count)
284 # ESP TRA VPP encryption/decryption verification
285 for Pkts in recv_pkts:
286 decrypt_pkt = self.local_tra_sa.decrypt(Pkts[IP])
288 self.logger.info(self.vapi.ppcli("show error"))
289 self.logger.info(self.vapi.ppcli("show ipsec"))
291 def test_ipsec_esp_tra_burst(self):
292 """ ipsec esp v4 transport burst test """
294 self.test_ipsec_esp_tra_basic(count=257)
296 self.logger.info(self.vapi.ppcli("show error"))
297 self.logger.info(self.vapi.ppcli("show ipsec"))
299 def test_ipsec_esp_tun_basic(self, count=1):
300 """ ipsec esp 4o4 tunnel basic test """
302 self.configScapySA(is_tun=True)
303 send_pkts = self.gen_encrypt_pkts(
306 src=self.remote_pg0_lb_addr,
307 dst=self.remote_pg1_lb_addr,
309 recv_pkts = self.send_and_expect(
310 self.pg0, send_pkts, self.pg1, count=count)
311 # ESP TUN VPP decryption verification
312 for recv_pkt in recv_pkts:
313 self.assert_equal(recv_pkt[IP].src, self.remote_pg0_lb_addr)
314 self.assert_equal(recv_pkt[IP].dst, self.remote_pg1_lb_addr)
315 send_pkts = self.gen_pkts(
317 src=self.remote_pg1_lb_addr,
318 dst=self.remote_pg0_lb_addr,
320 recv_pkts = self.send_and_expect(
321 self.pg1, send_pkts, self.pg0, count=count)
322 # ESP TUN VPP encryption verification
323 for recv_pkt in recv_pkts:
324 decrypt_pkt = self.local_tun_sa.decrypt(recv_pkt[IP])
325 self.assert_equal(decrypt_pkt.src, self.remote_pg1_lb_addr)
326 self.assert_equal(decrypt_pkt.dst, self.remote_pg0_lb_addr)
328 self.logger.info(self.vapi.ppcli("show error"))
329 self.logger.info(self.vapi.ppcli("show ipsec"))
331 def test_ipsec_esp_tun_burst(self):
332 """ ipsec esp 4o4 tunnel burst test """
334 self.test_ipsec_esp_tun_basic(count=257)
336 self.logger.info(self.vapi.ppcli("show error"))
337 self.logger.info(self.vapi.ppcli("show ipsec"))
340 if __name__ == '__main__':
341 unittest.main(testRunner=VppTestRunner)