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 verify_capture_plain(self, capture):
88 for packet in capture:
90 self.assert_packet_checksums_valid(packet)
91 self.assert_equal(packet[IP].src, self.pg0.remote_ip4,
92 "decrypted packet source address")
93 self.assert_equal(packet[IP].dst, self.pg1.remote_ip4,
94 "decrypted packet destination address")
95 if packet.haslayer(TCP):
98 "unexpected UDP header in decrypted packet")
99 self.assert_equal(packet[TCP].dport, self.tcp_port_in,
100 "decrypted packet TCP destination port")
101 elif packet.haslayer(UDP):
102 if packet[UDP].payload:
104 packet[UDP][1].haslayer(UDP),
105 "unexpected UDP header in decrypted packet")
106 self.assert_equal(packet[UDP].dport, self.udp_port_in,
107 "decrypted packet UDP destination port")
110 packet.haslayer(UDP),
111 "unexpected UDP header in decrypted packet")
112 self.assert_equal(packet[ICMP].id, self.icmp_id_in,
113 "decrypted packet ICMP ID")
116 ppp("Unexpected or invalid plain packet:", packet))
119 def verify_capture_encrypted(self, capture, sa):
120 for packet in capture:
122 self.assertIn(ESP, packet[IP])
123 decrypt_pkt = sa.decrypt(packet[IP])
124 self.assert_equal(decrypt_pkt[IP].src, self.pg1.remote_ip4,
125 "encrypted packet source address")
126 self.assert_equal(decrypt_pkt[IP].dst, self.pg0.remote_ip4,
127 "encrypted packet destination address")
128 # if decrypt_pkt.haslayer(TCP):
129 # self.tcp_port_out = decrypt_pkt[TCP].sport
130 # elif decrypt_pkt.haslayer(UDP):
131 # self.udp_port_out = decrypt_pkt[UDP].sport
133 # self.icmp_id_out = decrypt_pkt[ICMP].id
136 ppp("Unexpected or invalid encrypted packet:", packet))
140 def config_esp_tun(cls):
144 remote_tun_spi = 1001
146 client = socket.inet_pton(socket.AF_INET, cls.remote_pg0_client_addr)
147 cls.vapi.ip_add_del_route(client, 32, cls.pg0.remote_ip4n)
148 cls.vapi.ipsec_sad_add_del_entry(remote_sa_id, remote_tun_spi,
151 integrity_key_length=20,
152 crypto_key_length=16,
153 protocol=1, udp_encap=1)
154 cls.vapi.ipsec_sad_add_del_entry(local_sa_id, local_tun_spi,
157 integrity_key_length=20,
158 crypto_key_length=16,
159 protocol=1, udp_encap=1)
160 cls.vapi.ipsec_spd_add_del(spd_id)
161 cls.vapi.ipsec_interface_add_del_spd(spd_id, cls.pg0.sw_if_index)
162 l_startaddr = r_startaddr = socket.inet_pton(socket.AF_INET,
164 l_stopaddr = r_stopaddr = socket.inet_pton(socket.AF_INET,
166 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
167 r_startaddr, r_stopaddr,
168 protocol=socket.IPPROTO_ESP)
169 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
170 r_startaddr, r_stopaddr,
171 protocol=socket.IPPROTO_ESP,
173 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
174 r_startaddr, r_stopaddr,
175 remote_port_start=4500,
176 remote_port_stop=4500,
177 protocol=socket.IPPROTO_UDP)
178 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
179 r_startaddr, r_stopaddr,
180 remote_port_start=4500,
181 remote_port_stop=4500,
182 protocol=socket.IPPROTO_UDP,
184 l_startaddr = l_stopaddr = cls.pg0.remote_ip4n
185 r_startaddr = r_stopaddr = cls.pg1.remote_ip4n
186 cls.vapi.ipsec_spd_add_del_entry(spd_id, l_startaddr, l_stopaddr,
187 r_startaddr, r_stopaddr,
188 priority=10, policy=3,
189 is_outbound=0, sa_id=local_sa_id)
190 cls.vapi.ipsec_spd_add_del_entry(spd_id, r_startaddr, r_stopaddr,
191 l_startaddr, l_stopaddr,
192 priority=10, policy=3,
195 def test_ipsec_nat_tun(self):
196 """ IPSec/NAT tunnel test case """
197 local_tun_sa = SecurityAssociation(ESP, spi=0x000003e9,
198 crypt_algo='AES-CBC',
199 crypt_key='JPjyOWBeVEQiMe7h',
200 auth_algo='HMAC-SHA1-96',
201 auth_key='C91KUR9GYMm5GfkEvNjX',
203 src=self.pg1.remote_ip4,
204 dst=self.pg0.remote_ip4),
208 # in2out - from private network to public
209 pkts = self.create_stream_plain(
210 self.pg1.remote_mac, self.pg1.local_mac,
211 self.pg1.remote_ip4, self.pg0.remote_ip4)
212 self.pg1.add_stream(pkts)
213 self.pg_enable_capture(self.pg_interfaces)
215 capture = self.pg0.get_capture(len(pkts))
216 self.verify_capture_encrypted(capture, local_tun_sa)
218 remote_tun_sa = SecurityAssociation(ESP, spi=0x000003e8,
219 crypt_algo='AES-CBC',
220 crypt_key='JPjyOWBeVEQiMe7h',
221 auth_algo='HMAC-SHA1-96',
222 auth_key='C91KUR9GYMm5GfkEvNjX',
224 src=self.pg0.remote_ip4,
225 dst=self.pg1.remote_ip4),
230 # out2in - from public network to private
231 pkts = self.create_stream_encrypted(
232 self.pg0.remote_mac, self.pg0.local_mac,
233 self.pg0.remote_ip4, self.pg1.remote_ip4, remote_tun_sa)
234 self.logger.info(ppc("Sending packets:", pkts))
235 self.pg0.add_stream(pkts)
236 self.pg_enable_capture(self.pg_interfaces)
238 capture = self.pg1.get_capture(len(pkts))
239 self.verify_capture_plain(capture)