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 template_ipsec import TemplateIpsec
10 from vpp_ipsec import VppIpsecSA, VppIpsecSpd, VppIpsecSpdEntry,\
12 from vpp_ip_route import VppIpRoute, VppRoutePath
13 from vpp_ip import DpoProto
14 from vpp_papi import VppEnum
17 class IPSecNATTestCase(TemplateIpsec):
22 public network | private network
23 --- encrypt --- plain ---
24 |pg0| <------- |VPP| <------ |pg1|
27 --- decrypt --- plain ---
28 |pg0| -------> |VPP| ------> |pg1|
40 super(IPSecNATTestCase, self).setUp()
41 self.tun_if = self.pg0
43 self.tun_spd = VppIpsecSpd(self, self.tun_spd_id)
44 self.tun_spd.add_vpp_config()
45 VppIpsecSpdItfBinding(self, self.tun_spd,
46 self.tun_if).add_vpp_config()
49 self.config_esp_tun(p)
50 self.logger.info(self.vapi.ppcli("show ipsec"))
52 d = DpoProto.DPO_PROTO_IP6 if p.is_ipv6 else DpoProto.DPO_PROTO_IP4
53 VppIpRoute(self, p.remote_tun_if_host, p.addr_len,
54 [VppRoutePath(self.tun_if.remote_addr[p.addr_type],
57 is_ip6=p.is_ipv6).add_vpp_config()
60 super(IPSecNATTestCase, self).tearDown()
62 def create_stream_plain(self, src_mac, dst_mac, src_ip, dst_ip):
65 Ether(src=src_mac, dst=dst_mac) /
66 IP(src=src_ip, dst=dst_ip) /
67 TCP(sport=self.tcp_port_in, dport=20),
69 Ether(src=src_mac, dst=dst_mac) /
70 IP(src=src_ip, dst=dst_ip) /
71 UDP(sport=self.udp_port_in, dport=20),
73 Ether(src=src_mac, dst=dst_mac) /
74 IP(src=src_ip, dst=dst_ip) /
75 ICMP(id=self.icmp_id_in, type='echo-request')
78 def create_stream_encrypted(self, src_mac, dst_mac, src_ip, dst_ip, sa):
81 Ether(src=src_mac, dst=dst_mac) /
82 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
83 TCP(dport=self.tcp_port_out, sport=20)),
85 Ether(src=src_mac, dst=dst_mac) /
86 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
87 UDP(dport=self.udp_port_out, sport=20)),
89 Ether(src=src_mac, dst=dst_mac) /
90 sa.encrypt(IP(src=src_ip, dst=dst_ip) /
91 ICMP(id=self.icmp_id_out, type='echo-request'))
94 def verify_capture_plain(self, capture):
95 for packet in capture:
97 self.assert_packet_checksums_valid(packet)
98 self.assert_equal(packet[IP].src, self.tun_if.remote_ip4,
99 "decrypted packet source address")
100 self.assert_equal(packet[IP].dst, self.pg1.remote_ip4,
101 "decrypted packet destination address")
102 if packet.haslayer(TCP):
104 packet.haslayer(UDP),
105 "unexpected UDP header in decrypted packet")
106 self.assert_equal(packet[TCP].dport, self.tcp_port_in,
107 "decrypted packet TCP destination port")
108 elif packet.haslayer(UDP):
109 if packet[UDP].payload:
111 packet[UDP][1].haslayer(UDP),
112 "unexpected UDP header in decrypted packet")
113 self.assert_equal(packet[UDP].dport, self.udp_port_in,
114 "decrypted packet UDP destination port")
117 packet.haslayer(UDP),
118 "unexpected UDP header in decrypted packet")
119 self.assert_equal(packet[ICMP].id, self.icmp_id_in,
120 "decrypted packet ICMP ID")
123 ppp("Unexpected or invalid plain packet:", packet))
126 def verify_capture_encrypted(self, capture, sa):
127 for packet in capture:
129 copy = packet.__class__(str(packet))
131 copy = packet.__class__(str(copy))
132 self.assert_equal(packet[UDP].len, copy[UDP].len,
134 self.assert_packet_checksums_valid(packet)
135 self.assertIn(ESP, packet[IP])
136 decrypt_pkt = sa.decrypt(packet[IP])
137 self.assert_packet_checksums_valid(decrypt_pkt)
138 self.assert_equal(decrypt_pkt[IP].src, self.pg1.remote_ip4,
139 "encrypted packet source address")
140 self.assert_equal(decrypt_pkt[IP].dst, self.tun_if.remote_ip4,
141 "encrypted packet destination address")
144 ppp("Unexpected or invalid encrypted packet:", packet))
147 def config_esp_tun(self, params):
148 addr_type = params.addr_type
149 scapy_tun_sa_id = params.scapy_tun_sa_id
150 scapy_tun_spi = params.scapy_tun_spi
151 vpp_tun_sa_id = params.vpp_tun_sa_id
152 vpp_tun_spi = params.vpp_tun_spi
153 auth_algo_vpp_id = params.auth_algo_vpp_id
154 auth_key = params.auth_key
155 crypt_algo_vpp_id = params.crypt_algo_vpp_id
156 crypt_key = params.crypt_key
157 addr_any = params.addr_any
158 addr_bcast = params.addr_bcast
159 flags = (VppEnum.vl_api_ipsec_sad_flags_t.
160 IPSEC_API_SAD_FLAG_UDP_ENCAP)
161 e = VppEnum.vl_api_ipsec_spd_action_t
163 VppIpsecSA(self, scapy_tun_sa_id, scapy_tun_spi,
164 auth_algo_vpp_id, auth_key,
165 crypt_algo_vpp_id, crypt_key,
166 self.vpp_esp_protocol,
167 self.pg1.remote_addr[addr_type],
168 self.tun_if.remote_addr[addr_type],
169 flags=flags).add_vpp_config()
170 VppIpsecSA(self, vpp_tun_sa_id, vpp_tun_spi,
171 auth_algo_vpp_id, auth_key,
172 crypt_algo_vpp_id, crypt_key,
173 self.vpp_esp_protocol,
174 self.tun_if.remote_addr[addr_type],
175 self.pg1.remote_addr[addr_type],
176 flags=flags).add_vpp_config()
178 VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
179 addr_any, addr_bcast,
180 addr_any, addr_bcast,
181 socket.IPPROTO_ESP).add_vpp_config()
182 VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
183 addr_any, addr_bcast,
184 addr_any, addr_bcast,
186 is_outbound=0).add_vpp_config()
187 VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
188 addr_any, addr_bcast,
189 addr_any, addr_bcast,
191 remote_port_start=4500,
192 remote_port_stop=4500).add_vpp_config()
193 VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
194 addr_any, addr_bcast,
195 addr_any, addr_bcast,
197 remote_port_start=4500,
198 remote_port_stop=4500,
199 is_outbound=0).add_vpp_config()
200 VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
201 self.tun_if.remote_addr[addr_type],
202 self.tun_if.remote_addr[addr_type],
203 self.pg1.remote_addr[addr_type],
204 self.pg1.remote_addr[addr_type],
206 policy=e.IPSEC_API_SPD_ACTION_PROTECT,
207 is_outbound=0).add_vpp_config()
208 VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
209 self.pg1.remote_addr[addr_type],
210 self.pg1.remote_addr[addr_type],
211 self.tun_if.remote_addr[addr_type],
212 self.tun_if.remote_addr[addr_type],
213 0, policy=e.IPSEC_API_SPD_ACTION_PROTECT,
214 priority=10).add_vpp_config()
216 def test_ipsec_nat_tun(self):
217 """ IPSec/NAT tunnel test case """
219 scapy_tun_sa = SecurityAssociation(ESP, spi=p.scapy_tun_spi,
220 crypt_algo=p.crypt_algo,
221 crypt_key=p.crypt_key,
222 auth_algo=p.auth_algo,
225 src=self.pg1.remote_ip4,
226 dst=self.tun_if.remote_ip4),
230 # in2out - from private network to public
231 pkts = self.create_stream_plain(
232 self.pg1.remote_mac, self.pg1.local_mac,
233 self.pg1.remote_ip4, self.tun_if.remote_ip4)
234 self.pg1.add_stream(pkts)
235 self.pg_enable_capture(self.pg_interfaces)
237 capture = self.tun_if.get_capture(len(pkts))
238 self.verify_capture_encrypted(capture, scapy_tun_sa)
240 vpp_tun_sa = SecurityAssociation(ESP,
242 crypt_algo=p.crypt_algo,
243 crypt_key=p.crypt_key,
244 auth_algo=p.auth_algo,
247 src=self.tun_if.remote_ip4,
248 dst=self.pg1.remote_ip4),
253 # out2in - from public network to private
254 pkts = self.create_stream_encrypted(
255 self.tun_if.remote_mac, self.tun_if.local_mac,
256 self.tun_if.remote_ip4, self.pg1.remote_ip4, vpp_tun_sa)
257 self.logger.info(ppc("Sending packets:", pkts))
258 self.tun_if.add_stream(pkts)
259 self.pg_enable_capture(self.pg_interfaces)
261 capture = self.pg1.get_capture(len(pkts))
262 self.verify_capture_plain(capture)