resources/libraries/python/NATUtil.py

   1 # Copyright (c) 2019 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """NAT utilities library."""
  15
  16 from pprint import pformat
  17 from socket import AF_INET, inet_pton
  18
  19 from enum import IntEnum
  20
  21 from robot.api import logger
  22
  23 from resources.libraries.python.InterfaceUtil import InterfaceUtil
  24 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
  25
  26
  27 class NATConfigFlags(IntEnum):
  28     """Common NAT plugin APIs"""
  29     NAT_IS_NONE = 0x00
  30     NAT_IS_TWICE_NAT = 0x01
  31     NAT_IS_SELF_TWICE_NAT = 0x02
  32     NAT_IS_OUT2IN_ONLY = 0x04
  33     NAT_IS_ADDR_ONLY = 0x08
  34     NAT_IS_OUTSIDE = 0x10
  35     NAT_IS_INSIDE = 0x20
  36     NAT_IS_STATIC = 0x40
  37     NAT_IS_EXT_HOST_VALID = 0x80
  38
  39
  40 class NATUtil(object):
  41     """This class defines the methods to set NAT."""
  42
  43     def __init__(self):
  44         pass
  45
  46     @staticmethod
  47     def set_nat44_interfaces(node, int_in, int_out):
  48         """Set inside and outside interfaces for NAT44.
  49
  50         :param node: DUT node.
  51         :param int_in: Inside interface.
  52         :param int_out: Outside interface.
  53         :type node: dict
  54         :type int_in: str
  55         :type int_out: str
  56         """
  57
  58         cmd = 'nat44_interface_add_del_feature'
  59
  60         int_in_idx = InterfaceUtil.get_sw_if_index(node, int_in)
  61         err_msg = 'Failed to set inside interface {int} for NAT44 on host ' \
  62                   '{host}'.format(int=int_in, host=node['host'])
  63         args_in = dict(
  64             sw_if_index=int_in_idx,
  65             is_add=1,
  66             flags=getattr(NATConfigFlags, "NAT_IS_INSIDE").value
  67         )
  68         with PapiSocketExecutor(node) as papi_exec:
  69             papi_exec.add(cmd, **args_in).get_reply(err_msg)
  70
  71         int_out_idx = InterfaceUtil.get_sw_if_index(node, int_out)
  72         err_msg = 'Failed to set outside interface {int} for NAT44 on host ' \
  73                   '{host}'.format(int=int_out, host=node['host'])
  74         args_in = dict(
  75             sw_if_index=int_out_idx,
  76             is_add=1,
  77             flags=getattr(NATConfigFlags, "NAT_IS_OUTSIDE").value
  78         )
  79         with PapiSocketExecutor(node) as papi_exec:
  80             papi_exec.add(cmd, **args_in).get_reply(err_msg)
  81
  82     @staticmethod
  83     def set_nat44_deterministic(node, ip_in, subnet_in, ip_out, subnet_out):
  84         """Set deterministic behaviour of NAT44.
  85
  86         :param node: DUT node.
  87         :param ip_in: Inside IP.
  88         :param subnet_in: Inside IP subnet.
  89         :param ip_out: Outside IP.
  90         :param subnet_out: Outside IP subnet.
  91         :type node: dict
  92         :type ip_in: str
  93         :type subnet_in: str or int
  94         :type ip_out: str
  95         :type subnet_out: str or int
  96         """
  97
  98         cmd = 'nat_det_add_del_map'
  99         err_msg = 'Failed to set deterministic behaviour of NAT on host ' \
 100                   '{host}'.format(host=node['host'])
 101         args_in = dict(
 102             is_add=True,
 103             in_addr=inet_pton(AF_INET, str(ip_in)),
 104             in_plen=int(subnet_in),
 105             out_addr=inet_pton(AF_INET, str(ip_out)),
 106             out_plen=int(subnet_out)
 107         )
 108         with PapiSocketExecutor(node) as papi_exec:
 109             papi_exec.add(cmd, **args_in).get_reply(err_msg)
 110
 111     @staticmethod
 112     def show_nat(node):
 113         """Show the NAT configuration and data.
 114
 115         Used data sources:
 116
 117             nat_show_config
 118             nat_worker_dump
 119             nat44_interface_addr_dump
 120             nat44_address_dump
 121             nat44_static_mapping_dump
 122             nat44_user_dump
 123             nat44_interface_dump
 124             nat44_user_session_dump
 125             nat_det_map_dump
 126
 127         :param node: DUT node.
 128         :type node: dict
 129         """
 130
 131         cmd = 'nat_show_config'
 132         err_msg = 'Failed to get NAT configuration on host {host}'.\
 133             format(host=node['host'])
 134         with PapiSocketExecutor(node) as papi_exec:
 135             reply = papi_exec.add(cmd).get_reply(err_msg)
 136         logger.debug("NAT Configuration:\n{reply}".format(reply=pformat(reply)))
 137
 138         cmds = [
 139             "nat_worker_dump",
 140             "nat44_interface_addr_dump",
 141             "nat44_address_dump",
 142             "nat44_static_mapping_dump",
 143             "nat44_user_dump",
 144             "nat44_interface_dump",
 145             "nat44_user_session_dump",
 146             "nat_det_map_dump"
 147         ]
 148         PapiSocketExecutor.dump_and_log(node, cmds)