5 from scapy.layers.l2 import Ether
6 from scapy.layers.inet import ICMP, IP, TCP, UDP
7 from scapy.layers.ipsec import SecurityAssociation, ESP
8 from util import ppp, ppc
9 from framework import VppTestCase
12 class IPSecNATTestCase(VppTestCase):
24 public network | private network
25 --- encrypt --- plain ---
26 |pg0| <------- |VPP| <------ |pg1|
29 --- decrypt --- plain ---
30 |pg0| -------> |VPP| ------> |pg1|
34 remote_pg0_client_addr = '1.1.1.1'
38 super(IPSecNATTestCase, cls).setUpClass()
39 cls.create_pg_interfaces(range(2))
40 for i in cls.pg_interfaces:
41 i.configure_ipv4_neighbors()
46 cls.tcp_port_in = 6303
47 cls.tcp_port_out = 6303
48 cls.udp_port_in = 6304
49 cls.udp_port_out = 6304
51 cls.icmp_id_out = 6305
53 cls.logger.info(cls.vapi.ppcli("show ipsec"))
55 def create_stream_plain(self, src_mac, dst_mac, src_ip, dst_ip):
58 Ether(src=src_mac, dst=dst_mac) /
59 IP(src=src_ip, dst=dst_ip) /
60 TCP(sport=self.tcp_port_in, dport=20),
62 Ether(src=src_mac, dst=dst_mac) /
63 IP(src=src_ip, dst=dst_ip) /
64 UDP(sport=self.udp_port_in, dport=20),
66 Ether(src=src_mac, dst=dst_mac) /
67 IP(src=src_ip, dst=dst_ip) /
68 ICMP(id=self.icmp_id_in, type='echo-request')
71 def create_stream_encrypted(self, src_mac, dst_mac, src_ip, dst_ip, sa):
74 Ether(src=src_mac, dst=dst_mac) /
75 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
76 TCP(dport=self.tcp_port_out, sport=20)),
78 Ether(src=src_mac, dst=dst_mac) /
79 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
80 UDP(dport=self.udp_port_out, sport=20)),
82 Ether(src=src_mac, dst=dst_mac) /
83 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
84 ICMP(id=self.icmp_id_out, type='echo-request'))
87 def check_checksum(self, pkt, layer):
88 """ Check checksum of the packet on given layer """
89 new = pkt.__class__(str(pkt))
91 new = new.__class__(str(new))
92 self.assertEqual(new[layer].chksum, pkt[layer].chksum)
94 def check_ip_checksum(self, pkt):
95 return self.check_checksum(pkt, 'IP')
97 def check_tcp_checksum(self, pkt):
98 return self.check_checksum(pkt, 'TCP')
100 def check_udp_checksum(self, pkt):
101 return self.check_checksum(pkt, 'UDP')
103 def check_icmp_checksum(self, pkt):
104 return self.check_checksum(pkt, 'ICMP')
106 def verify_capture_plain(self, capture):
107 for packet in capture:
109 self.check_ip_checksum(packet)
110 self.assert_equal(packet[IP].src, self.pg0.remote_ip4,
111 "decrypted packet source address")
112 self.assert_equal(packet[IP].dst, self.pg1.remote_ip4,
113 "decrypted packet destination address")
114 if packet.haslayer(TCP):
116 packet.haslayer(UDP),
117 "unexpected UDP header in decrypted packet")
118 self.assert_equal(packet[TCP].dport, self.tcp_port_in,
119 "decrypted packet TCP destination port")
120 self.check_tcp_checksum(packet)
121 elif packet.haslayer(UDP):
122 if packet[UDP].payload:
124 packet[UDP][1].haslayer(UDP),
125 "unexpected UDP header in decrypted packet")
126 self.assert_equal(packet[UDP].dport, self.udp_port_in,
127 "decrypted packet UDP destination port")
130 packet.haslayer(UDP),
131 "unexpected UDP header in decrypted packet")
132 self.assert_equal(packet[ICMP].id, self.icmp_id_in,
133 "decrypted packet ICMP ID")
134 self.check_icmp_checksum(packet)
137 ppp("Unexpected or invalid plain packet:", packet))
140 def verify_capture_encrypted(self, capture, sa):
141 for packet in capture:
143 self.assertIn(ESP, packet[IP])
144 decrypt_pkt = sa.decrypt(packet[IP])
145 self.assert_equal(decrypt_pkt[IP].src, self.pg1.remote_ip4,
146 "encrypted packet source address")
147 self.assert_equal(decrypt_pkt[IP].dst, self.pg0.remote_ip4,
148 "encrypted packet destination address")
149 # if decrypt_pkt.haslayer(TCP):
150 # self.tcp_port_out = decrypt_pkt[TCP].sport
151 # elif decrypt_pkt.haslayer(UDP):
152 # self.udp_port_out = decrypt_pkt[UDP].sport
154 # self.icmp_id_out = decrypt_pkt[ICMP].id
157 ppp("Unexpected or invalid encrypted packet:", packet))
161 def config_esp_tun(cls):
165 remote_tun_spi = 1001
167 client = socket.inet_pton(socket.AF_INET, cls.remote_pg0_client_addr)
168 cls.vapi.ip_add_del_route(client, 32, cls.pg0.remote_ip4n)
169 cls.vapi.ipsec_sad_add_del_entry(remote_sa_id, remote_tun_spi,
172 integrity_key_length=20,
173 crypto_key_length=16,
174 protocol=1, udp_encap=1)
175 cls.vapi.ipsec_sad_add_del_entry(local_sa_id, local_tun_spi,
178 integrity_key_length=20,
179 crypto_key_length=16,
180 protocol=1, udp_encap=1)
181 cls.vapi.ipsec_spd_add_del(spd_id)
182 cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg0.sw_if_index)
183 l_startaddr = r_startaddr = socket.inet_pton(socket.AF_INET,
185 l_stopaddr = r_stopaddr = socket.inet_pton(socket.AF_INET,
187 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
188 r_startaddr, r_stopaddr,
189 protocol=socket.IPPROTO_ESP)
190 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
191 r_startaddr, r_stopaddr,
192 protocol=socket.IPPROTO_ESP,
194 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
195 r_startaddr, r_stopaddr,
196 remote_port_start=4500,
197 remote_port_stop=4500,
198 protocol=socket.IPPROTO_UDP)
199 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
200 r_startaddr, r_stopaddr,
201 remote_port_start=4500,
202 remote_port_stop=4500,
203 protocol=socket.IPPROTO_UDP,
205 l_startaddr = l_stopaddr = cls.pg0.remote_ip4n
206 r_startaddr = r_stopaddr = cls.pg1.remote_ip4n
207 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
208 r_startaddr, r_stopaddr,
209 priority=10, policy=3,
210 is_outbound=0, sa_id=local_sa_id)
211 cls.vapi.ipsec_spd_add_del_entry(spd_id, r_startaddr, r_stopaddr,
212 l_startaddr, l_stopaddr,
213 priority=10, policy=3,
216 def test_ipsec_nat_tun(self):
217 """ IPSec/NAT tunnel test case """
218 local_tun_sa = SecurityAssociation(ESP, spi=0x000003e9,
219 crypt_algo='AES-CBC',
220 crypt_key='JPjyOWBeVEQiMe7h',
221 auth_algo='HMAC-SHA1-96',
222 auth_key='C91KUR9GYMm5GfkEvNjX',
224 src=self.pg1.remote_ip4,
225 dst=self.pg0.remote_ip4),
229 # in2out - from private network to public
230 pkts = self.create_stream_plain(
231 self.pg1.remote_mac, self.pg1.local_mac,
232 self.pg1.remote_ip4, self.pg0.remote_ip4)
233 self.pg1.add_stream(pkts)
234 self.pg_enable_capture(self.pg_interfaces)
236 capture = self.pg0.get_capture(len(pkts))
237 self.verify_capture_encrypted(capture, local_tun_sa)
239 remote_tun_sa = SecurityAssociation(ESP, spi=0x000003e8,
240 crypt_algo='AES-CBC',
241 crypt_key='JPjyOWBeVEQiMe7h',
242 auth_algo='HMAC-SHA1-96',
243 auth_key='C91KUR9GYMm5GfkEvNjX',
245 src=self.pg0.remote_ip4,
246 dst=self.pg1.remote_ip4),
251 # out2in - from public network to private
252 pkts = self.create_stream_encrypted(
253 self.pg0.remote_mac, self.pg0.local_mac,
254 self.pg0.remote_ip4, self.pg1.remote_ip4, remote_tun_sa)
255 self.logger.info(ppc("Sending packets:", pkts))
256 self.pg0.add_stream(pkts)
257 self.pg_enable_capture(self.pg_interfaces)
259 capture = self.pg1.get_capture(len(pkts))
260 self.verify_capture_plain(capture)