1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# Copyright (c) 2020 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""NAT utilities library."""
from pprint import pformat
from enum import IntEnum
from ipaddress import IPv4Address
from robot.api import logger
from resources.libraries.python.Constants import Constants
from resources.libraries.python.InterfaceUtil import InterfaceUtil
from resources.libraries.python.PapiExecutor import PapiSocketExecutor
class NatConfigFlags(IntEnum):
"""Common NAT plugin APIs"""
NAT_IS_NONE = 0x00
NAT_IS_TWICE_NAT = 0x01
NAT_IS_SELF_TWICE_NAT = 0x02
NAT_IS_OUT2IN_ONLY = 0x04
NAT_IS_ADDR_ONLY = 0x08
NAT_IS_OUTSIDE = 0x10
NAT_IS_INSIDE = 0x20
NAT_IS_STATIC = 0x40
NAT_IS_EXT_HOST_VALID = 0x80
class NatAddrPortAllocAlg(IntEnum):
"""NAT Address and port assignment algorithms."""
NAT_ALLOC_ALG_DEFAULT = 0
NAT_ALLOC_ALG_MAP_E = 1
NAT_ALLOC_ALG_PORT_RANGE = 2
class NATUtil:
"""This class defines the methods to set NAT."""
def __init__(self):
pass
@staticmethod
def set_nat44_interface(node, interface, flag):
"""Set inside and outside interfaces for NAT44.
:param node: DUT node.
:param interface: Inside interface.
:param flag: Interface NAT configuration flag name.
:type node: dict
:type interface: str
:type flag: str
"""
cmd = u"nat44_interface_add_del_feature"
err_msg = f"Failed to set {flag} interface {interface} for NAT44 " \
f"on host {node[u'host']}"
args_in = dict(
sw_if_index=InterfaceUtil.get_sw_if_index(node, interface),
is_add=1,
flags=getattr(NatConfigFlags, flag).value
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args_in).get_reply(err_msg)
@staticmethod
def set_nat44_interfaces(node, int_in, int_out):
"""Set inside and outside interfaces for NAT44.
:param node: DUT node.
:param int_in: Inside interface.
:param int_out: Outside interface.
:type node: dict
:type int_in: str
:type int_out: str
"""
NATUtil.set_nat44_interface(node, int_in, u"NAT_IS_INSIDE")
NATUtil.set_nat44_interface(node, int_out, u"NAT_IS_OUTSIDE")
@staticmethod
def set_nat44_deterministic(node, ip_in, subnet_in, ip_out, subnet_out):
"""Set deterministic behaviour of NAT44.
:param node: DUT node.
:param ip_in: Inside IP.
:param subnet_in: Inside IP subnet.
:param ip_out: Outside IP.
:param subnet_out: Outside IP subnet.
:type node: dict
:type ip_in: str
:type subnet_in: str or int
:type ip_out: str
:type subnet_out: str or int
"""
cmd = u"nat_det_add_del_map"
err_msg = f"Failed to set deterministic behaviour of NAT " \
f"on host {node[u'host']}"
args_in = dict(
is_add=True,
in_addr=IPv4Address(str(ip_in)).packed,
in_plen=int(subnet_in),
out_addr=IPv4Address(str(ip_out)).packed,
out_plen=int(subnet_out)
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args_in).get_reply(err_msg)
@staticmethod
def set_nat44_address_range(
node, start_ip, end_ip, vrf_id=Constants.BITWISE_NON_ZERO,
flag=u"NAT_IS_NONE"):
"""Set NAT44 address range.
:param node: DUT node.
:param start_ip: IP range start.
:param end_ip: IP range end.
:param vrf_id: VRF index (Optional).
:param flag: NAT flag name.
:type node: dict
:type start_ip: str
:type end_ip: str
:type vrf_id: int
:type flag: str
"""
cmd = u"nat44_add_del_address_range"
err_msg = f"Failed to set NAT44 address range on host {node[u'host']}"
args_in = dict(
is_add=True,
first_ip_address=IPv4Address(str(start_ip)).packed,
last_ip_address=IPv4Address(str(end_ip)).packed,
vrf_id=vrf_id,
flags=getattr(NatConfigFlags, flag).value
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args_in).get_reply(err_msg)
@staticmethod
def show_nat_config(node):
"""Show the NAT configuration.
:param node: DUT node.
:type node: dict
"""
cmd = u"nat_show_config"
err_msg = f"Failed to get NAT configuration on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
reply = papi_exec.add(cmd).get_reply(err_msg)
logger.debug(f"NAT Configuration:\n{pformat(reply)}")
@staticmethod
def show_nat44_summary(node):
"""Show NAT44 summary on the specified topology node.
:param node: Topology node.
:type node: dict
"""
PapiSocketExecutor.run_cli_cmd(node, u"show nat44 summary")
@staticmethod
def show_nat_base_data(node):
"""Show the NAT base data.
Used data sources:
nat_worker_dump
nat44_interface_addr_dump
nat44_address_dump
nat44_static_mapping_dump
nat44_interface_dump
:param node: DUT node.
:type node: dict
"""
cmd = u"nat_show_config"
err_msg = f"Failed to get NAT base data on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
reply = papi_exec.add(cmd).get_reply(err_msg)
logger.debug(f"NAT Configuration:\n{pformat(reply)}")
cmds = [
u"nat_worker_dump",
u"nat44_interface_addr_dump",
u"nat44_address_dump",
u"nat44_static_mapping_dump",
u"nat44_interface_dump",
]
PapiSocketExecutor.dump_and_log(node, cmds)
@staticmethod
def show_nat_user_data(node):
"""Show the NAT user data.
Used data sources:
nat44_user_dump
nat44_user_session_dump
:param node: DUT node.
:type node: dict
"""
cmd = u"nat_show_config"
err_msg = f"Failed to get NAT user data on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
reply = papi_exec.add(cmd).get_reply(err_msg)
logger.debug(f"NAT Configuration:\n{pformat(reply)}")
cmds = [
u"nat44_user_dump",
u"nat44_user_session_dump",
]
PapiSocketExecutor.dump_and_log(node, cmds)
|
