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
161 def configure_sa_tra(self, params):
162 scapy_tra_sa = SecurityAssociation(self.encryption_type,
163 spi=params.vpp_tra_spi,
164 crypt_algo=params.crypt_algo,
165 crypt_key=params.crypt_key,
166 auth_algo=params.auth_algo,
167 auth_key=params.auth_key)
168 vpp_tra_sa = SecurityAssociation(self.encryption_type,
169 spi=params.scapy_tra_spi,
170 crypt_algo=params.crypt_algo,
171 crypt_key=params.crypt_key,
172 auth_algo=params.auth_algo,
173 auth_key=params.auth_key)
174 return vpp_tra_sa, scapy_tra_sa
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_basic(self, count=1):
196 """ ipsec v4 transport basic test """
198 p = self.params[socket.AF_INET]
199 vpp_tra_sa, scapy_tra_sa = self.configure_sa_tra(p)
200 send_pkts = self.gen_encrypt_pkts(scapy_tra_sa, self.tra_if,
201 src=self.tra_if.remote_ip4,
202 dst=self.tra_if.local_ip4,
204 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
208 decrypted = vpp_tra_sa.decrypt(p[IP])
209 self.assert_packet_checksums_valid(decrypted)
211 self.logger.debug(ppp("Unexpected packet:", p))
214 self.logger.info(self.vapi.ppcli("show error"))
215 self.logger.info(self.vapi.ppcli("show ipsec"))
217 def test_tra_burst(self):
218 """ ipsec v4 transport burst test """
219 self.test_tra_basic(count=257)
221 def test_tra_basic6(self, count=1):
222 """ ipsec v6 transport basic test """
224 p = self.params[socket.AF_INET6]
225 vpp_tra_sa, scapy_tra_sa = self.configure_sa_tra(p)
226 send_pkts = self.gen_encrypt_pkts6(scapy_tra_sa, self.tra_if,
227 src=self.tra_if.remote_ip6,
228 dst=self.tra_if.local_ip6,
230 recv_pkts = self.send_and_expect(self.tra_if, send_pkts,
234 decrypted = vpp_tra_sa.decrypt(p[IPv6])
235 self.assert_packet_checksums_valid(decrypted)
237 self.logger.debug(ppp("Unexpected packet:", p))
240 self.logger.info(self.vapi.ppcli("show error"))
241 self.logger.info(self.vapi.ppcli("show ipsec"))
243 def test_tra_burst6(self):
244 """ ipsec v6 transport burst test """
245 self.test_tra_basic6(count=257)
248 class IpsecTun4Tests(object):
249 def test_tun_basic44(self, count=1):
250 """ ipsec 4o4 tunnel basic test """
252 p = self.params[socket.AF_INET]
253 vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
254 send_pkts = self.gen_encrypt_pkts(scapy_tun_sa, self.tun_if,
255 src=p.remote_tun_if_host,
256 dst=self.pg1.remote_ip4,
258 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
259 for recv_pkt in recv_pkts:
260 self.assert_equal(recv_pkt[IP].src, p.remote_tun_if_host)
261 self.assert_equal(recv_pkt[IP].dst, self.pg1.remote_ip4)
262 self.assert_packet_checksums_valid(recv_pkt)
263 send_pkts = self.gen_pkts(self.pg1, src=self.pg1.remote_ip4,
264 dst=p.remote_tun_if_host, count=count)
265 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
266 for recv_pkt in recv_pkts:
268 decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IP])
269 if not decrypt_pkt.haslayer(IP):
270 decrypt_pkt = IP(decrypt_pkt[Raw].load)
271 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip4)
272 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
273 self.assert_packet_checksums_valid(decrypt_pkt)
275 self.logger.debug(ppp("Unexpected packet:", recv_pkt))
278 ppp("Decrypted packet:", decrypt_pkt))
283 self.logger.info(self.vapi.ppcli("show error"))
284 self.logger.info(self.vapi.ppcli("show ipsec"))
286 def test_tun_burst44(self):
287 """ ipsec 4o4 tunnel burst test """
288 self.test_tun_basic44(count=257)
291 class IpsecTun6Tests(object):
292 def test_tun_basic66(self, count=1):
293 """ ipsec 6o6 tunnel basic test """
295 p = self.params[socket.AF_INET6]
296 vpp_tun_sa, scapy_tun_sa = self.configure_sa_tun(p)
297 send_pkts = self.gen_encrypt_pkts6(scapy_tun_sa, self.tun_if,
298 src=p.remote_tun_if_host,
299 dst=self.pg1.remote_ip6,
301 recv_pkts = self.send_and_expect(self.tun_if, send_pkts, self.pg1)
302 for recv_pkt in recv_pkts:
303 self.assert_equal(recv_pkt[IPv6].src, p.remote_tun_if_host)
304 self.assert_equal(recv_pkt[IPv6].dst, self.pg1.remote_ip6)
305 self.assert_packet_checksums_valid(recv_pkt)
306 send_pkts = self.gen_pkts6(self.pg1, src=self.pg1.remote_ip6,
307 dst=p.remote_tun_if_host,
309 recv_pkts = self.send_and_expect(self.pg1, send_pkts, self.tun_if)
310 for recv_pkt in recv_pkts:
312 decrypt_pkt = vpp_tun_sa.decrypt(recv_pkt[IPv6])
313 if not decrypt_pkt.haslayer(IPv6):
314 decrypt_pkt = IPv6(decrypt_pkt[Raw].load)
315 self.assert_equal(decrypt_pkt.src, self.pg1.remote_ip6)
316 self.assert_equal(decrypt_pkt.dst, p.remote_tun_if_host)
317 self.assert_packet_checksums_valid(decrypt_pkt)
319 self.logger.debug(ppp("Unexpected packet:", recv_pkt))
322 ppp("Decrypted packet:", decrypt_pkt))
327 self.logger.info(self.vapi.ppcli("show error"))
328 self.logger.info(self.vapi.ppcli("show ipsec"))
330 def test_tun_burst66(self):
331 """ ipsec 6o6 tunnel burst test """
332 self.test_tun_basic66(count=257)
335 class IpsecTunTests(IpsecTun4Tests, IpsecTun6Tests):
339 if __name__ == '__main__':
340 unittest.main(testRunner=VppTestRunner)