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