test/test_ipsec_nat.py

   1 #!/usr/bin/env python
   2
   3 import socket
   4
   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,\
  11         VppIpsecSpdItfBinding
  12 from vpp_ip_route import VppIpRoute, VppRoutePath
  13 from vpp_ip import DpoProto
  14
  15
  16 class IPSecNATTestCase(TemplateIpsec):
  17     """ IPSec/NAT
  18     TUNNEL MODE:
  19
  20
  21      public network  |   private network
  22      ---   encrypt  ---   plain   ---
  23     |pg0| <------- |VPP| <------ |pg1|
  24      ---            ---           ---
  25
  26      ---   decrypt  ---   plain   ---
  27     |pg0| -------> |VPP| ------> |pg1|
  28      ---            ---           ---
  29     """
  30
  31     tcp_port_in = 6303
  32     tcp_port_out = 6303
  33     udp_port_in = 6304
  34     udp_port_out = 6304
  35     icmp_id_in = 6305
  36     icmp_id_out = 6305
  37
  38     def setUp(self):
  39         super(IPSecNATTestCase, self).setUp()
  40         self.tun_if = self.pg0
  41
  42         self.tun_spd = VppIpsecSpd(self, self.tun_spd_id)
  43         self.tun_spd.add_vpp_config()
  44         VppIpsecSpdItfBinding(self, self.tun_spd,
  45                               self.tun_if).add_vpp_config()
  46
  47         p = self.ipv4_params
  48         self.config_esp_tun(p)
  49         self.logger.info(self.vapi.ppcli("show ipsec"))
  50
  51         d = DpoProto.DPO_PROTO_IP6 if p.is_ipv6 else DpoProto.DPO_PROTO_IP4
  52         VppIpRoute(self,  p.remote_tun_if_host, p.addr_len,
  53                    [VppRoutePath(self.tun_if.remote_addr[p.addr_type],
  54                                  0xffffffff,
  55                                  proto=d)],
  56                    is_ip6=p.is_ipv6).add_vpp_config()
  57
  58     def tearDown(self):
  59         super(IPSecNATTestCase, self).tearDown()
  60
  61     def create_stream_plain(self, src_mac, dst_mac, src_ip, dst_ip):
  62         return [
  63             # TCP
  64             Ether(src=src_mac, dst=dst_mac) /
  65             IP(src=src_ip, dst=dst_ip) /
  66             TCP(sport=self.tcp_port_in, dport=20),
  67             # UDP
  68             Ether(src=src_mac, dst=dst_mac) /
  69             IP(src=src_ip, dst=dst_ip) /
  70             UDP(sport=self.udp_port_in, dport=20),
  71             # ICMP
  72             Ether(src=src_mac, dst=dst_mac) /
  73             IP(src=src_ip, dst=dst_ip) /
  74             ICMP(id=self.icmp_id_in, type='echo-request')
  75         ]
  76
  77     def create_stream_encrypted(self, src_mac, dst_mac, src_ip, dst_ip, sa):
  78         return [
  79             # TCP
  80             Ether(src=src_mac, dst=dst_mac) /
  81             sa.encrypt(IP(src=src_ip, dst=dst_ip) /
  82                        TCP(dport=self.tcp_port_out, sport=20)),
  83             # UDP
  84             Ether(src=src_mac, dst=dst_mac) /
  85             sa.encrypt(IP(src=src_ip, dst=dst_ip) /
  86                        UDP(dport=self.udp_port_out, sport=20)),
  87             # ICMP
  88             Ether(src=src_mac, dst=dst_mac) /
  89             sa.encrypt(IP(src=src_ip, dst=dst_ip) /
  90                        ICMP(id=self.icmp_id_out, type='echo-request'))
  91         ]
  92
  93     def verify_capture_plain(self, capture):
  94         for packet in capture:
  95             try:
  96                 self.assert_packet_checksums_valid(packet)
  97                 self.assert_equal(packet[IP].src, self.tun_if.remote_ip4,
  98                                   "decrypted packet source address")
  99                 self.assert_equal(packet[IP].dst, self.pg1.remote_ip4,
 100                                   "decrypted packet destination address")
 101                 if packet.haslayer(TCP):
 102                     self.assertFalse(
 103                         packet.haslayer(UDP),
 104                         "unexpected UDP header in decrypted packet")
 105                     self.assert_equal(packet[TCP].dport, self.tcp_port_in,
 106                                       "decrypted packet TCP destination port")
 107                 elif packet.haslayer(UDP):
 108                     if packet[UDP].payload:
 109                         self.assertFalse(
 110                             packet[UDP][1].haslayer(UDP),
 111                             "unexpected UDP header in decrypted packet")
 112                     self.assert_equal(packet[UDP].dport, self.udp_port_in,
 113                                       "decrypted packet UDP destination port")
 114                 else:
 115                     self.assertFalse(
 116                         packet.haslayer(UDP),
 117                         "unexpected UDP header in decrypted packet")
 118                     self.assert_equal(packet[ICMP].id, self.icmp_id_in,
 119                                       "decrypted packet ICMP ID")
 120             except Exception:
 121                 self.logger.error(
 122                     ppp("Unexpected or invalid plain packet:", packet))
 123                 raise
 124
 125     def verify_capture_encrypted(self, capture, sa):
 126         for packet in capture:
 127             try:
 128                 copy = packet.__class__(str(packet))
 129                 del copy[UDP].len
 130                 copy = packet.__class__(str(copy))
 131                 self.assert_equal(packet[UDP].len, copy[UDP].len,
 132                                   "UDP header length")
 133                 self.assert_packet_checksums_valid(packet)
 134                 self.assertIn(ESP, packet[IP])
 135                 decrypt_pkt = sa.decrypt(packet[IP])
 136                 self.assert_packet_checksums_valid(decrypt_pkt)
 137                 self.assert_equal(decrypt_pkt[IP].src, self.pg1.remote_ip4,
 138                                   "encrypted packet source address")
 139                 self.assert_equal(decrypt_pkt[IP].dst, self.tun_if.remote_ip4,
 140                                   "encrypted packet destination address")
 141             except Exception:
 142                 self.logger.error(
 143                     ppp("Unexpected or invalid encrypted packet:", packet))
 144                 raise
 145
 146     def config_esp_tun(self, params):
 147         addr_type = params.addr_type
 148         scapy_tun_sa_id = params.scapy_tun_sa_id
 149         scapy_tun_spi = params.scapy_tun_spi
 150         vpp_tun_sa_id = params.vpp_tun_sa_id
 151         vpp_tun_spi = params.vpp_tun_spi
 152         auth_algo_vpp_id = params.auth_algo_vpp_id
 153         auth_key = params.auth_key
 154         crypt_algo_vpp_id = params.crypt_algo_vpp_id
 155         crypt_key = params.crypt_key
 156         addr_any = params.addr_any
 157         addr_bcast = params.addr_bcast
 158
 159         VppIpsecSA(self, scapy_tun_sa_id, scapy_tun_spi,
 160                    auth_algo_vpp_id, auth_key,
 161                    crypt_algo_vpp_id, crypt_key,
 162                    self.vpp_esp_protocol,
 163                    self.pg1.remote_addr[addr_type],
 164                    self.tun_if.remote_addr[addr_type],
 165                    udp_encap=1).add_vpp_config()
 166         VppIpsecSA(self, vpp_tun_sa_id, vpp_tun_spi,
 167                    auth_algo_vpp_id, auth_key,
 168                    crypt_algo_vpp_id, crypt_key,
 169                    self.vpp_esp_protocol,
 170                    self.tun_if.remote_addr[addr_type],
 171                    self.pg1.remote_addr[addr_type],
 172                    udp_encap=1).add_vpp_config()
 173
 174         VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 175                          addr_any, addr_bcast,
 176                          addr_any, addr_bcast,
 177                          socket.IPPROTO_ESP).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,
 182                          is_outbound=0).add_vpp_config()
 183         VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 184                          addr_any, addr_bcast,
 185                          addr_any, addr_bcast,
 186                          socket.IPPROTO_UDP,
 187                          remote_port_start=4500,
 188                          remote_port_stop=4500).add_vpp_config()
 189         VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 190                          addr_any, addr_bcast,
 191                          addr_any, addr_bcast,
 192                          socket.IPPROTO_UDP,
 193                          remote_port_start=4500,
 194                          remote_port_stop=4500,
 195                          is_outbound=0).add_vpp_config()
 196         VppIpsecSpdEntry(self, self.tun_spd, vpp_tun_sa_id,
 197                          self.tun_if.remote_addr[addr_type],
 198                          self.tun_if.remote_addr[addr_type],
 199                          self.pg1.remote_addr[addr_type],
 200                          self.pg1.remote_addr[addr_type],
 201                          0, priority=10, policy=3,
 202                          is_outbound=0).add_vpp_config()
 203         VppIpsecSpdEntry(self, self.tun_spd, scapy_tun_sa_id,
 204                          self.pg1.remote_addr[addr_type],
 205                          self.pg1.remote_addr[addr_type],
 206                          self.tun_if.remote_addr[addr_type],
 207                          self.tun_if.remote_addr[addr_type],
 208                          0, priority=10, policy=3).add_vpp_config()
 209
 210     def test_ipsec_nat_tun(self):
 211         """ IPSec/NAT tunnel test case """
 212         p = self.ipv4_params
 213         scapy_tun_sa = SecurityAssociation(ESP, spi=p.scapy_tun_spi,
 214                                            crypt_algo=p.crypt_algo,
 215                                            crypt_key=p.crypt_key,
 216                                            auth_algo=p.auth_algo,
 217                                            auth_key=p.auth_key,
 218                                            tunnel_header=IP(
 219                                                src=self.pg1.remote_ip4,
 220                                                dst=self.tun_if.remote_ip4),
 221                                            nat_t_header=UDP(
 222                                                sport=4500,
 223                                                dport=4500))
 224         # in2out - from private network to public
 225         pkts = self.create_stream_plain(
 226             self.pg1.remote_mac, self.pg1.local_mac,
 227             self.pg1.remote_ip4, self.tun_if.remote_ip4)
 228         self.pg1.add_stream(pkts)
 229         self.pg_enable_capture(self.pg_interfaces)
 230         self.pg_start()
 231         capture = self.tun_if.get_capture(len(pkts))
 232         self.verify_capture_encrypted(capture, scapy_tun_sa)
 233
 234         vpp_tun_sa = SecurityAssociation(ESP,
 235                                          spi=p.vpp_tun_spi,
 236                                          crypt_algo=p.crypt_algo,
 237                                          crypt_key=p.crypt_key,
 238                                          auth_algo=p.auth_algo,
 239                                          auth_key=p.auth_key,
 240                                          tunnel_header=IP(
 241                                              src=self.tun_if.remote_ip4,
 242                                              dst=self.pg1.remote_ip4),
 243                                          nat_t_header=UDP(
 244                                              sport=4500,
 245                                              dport=4500))
 246
 247         # out2in - from public network to private
 248         pkts = self.create_stream_encrypted(
 249             self.tun_if.remote_mac, self.tun_if.local_mac,
 250             self.tun_if.remote_ip4, self.pg1.remote_ip4, vpp_tun_sa)
 251         self.logger.info(ppc("Sending packets:", pkts))
 252         self.tun_if.add_stream(pkts)
 253         self.pg_enable_capture(self.pg_interfaces)
 254         self.pg_start()
 255         capture = self.pg1.get_capture(len(pkts))
 256         self.verify_capture_plain(capture)