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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
#!/usr/bin/env python3
#
# Copyright (C) VyOS Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import json
import sys
from tabulate import tabulate
import vyos.opmode
from vyos.configquery import ConfigTreeQuery
from vyos.vpp import VPPControl
protocol_map = {
0: 'all',
1: 'icmp',
6: 'tcp',
17: 'udp',
}
# NAT flags
flags_map = {
'twice-nat': 0x01,
'self-twice-nat': 0x02,
'out2in-only': 0x04,
'out': 0x10,
'in': 0x20,
}
def _verify(func):
"""Decorator checks if config for VPP NAT44 exists"""
from functools import wraps
@wraps(func)
def _wrapper(*args, **kwargs):
config = ConfigTreeQuery()
base = 'vpp nat nat44'
if not config.exists(base):
raise vyos.opmode.UnconfiguredSubsystem(f'{base} is not configured')
return func(*args, **kwargs)
return _wrapper
def decode_bitmask(bitmask: int) -> list:
"""Decode a bitmask into a list of flag names"""
return [name for name, value in flags_map.items() if bitmask & value]
def _get_raw_output(data_dump):
data = [json.loads(json.dumps(d._asdict(), default=str)) for d in data_dump]
return data
def _get_raw_output_sessions(vpp_api):
users: list[dict] = vpp_api.nat44_user_dump()
sessions_list: list[dict] = []
for user in users:
ip_address = str(user._asdict().get('ip_address'))
user_sessions_dump = vpp_api.nat44_user_session_v3_dump(ip_address=ip_address)
user_sessions = [
json.loads(json.dumps(session._asdict(), default=str))
for session in user_sessions_dump
]
sessions_list.extend(user_sessions)
return sorted(sessions_list, key=lambda x: x["inside_ip_address"])
def _get_formatted_output_sessions(sessions_list):
print('NAT44 ED sessions:')
print(f'--------------- {len(sessions_list)} sessions ---------------')
for session in sessions_list:
in_ip_addr = session.get('inside_ip_address')
in_port = session.get('inside_port')
out_ip_addr = session.get('outside_ip_address')
out_port = session.get('outside_port')
protocol = protocol_map[session.get('protocol')].upper()
last_heard = session.get('last_heard')
time_since_last_heard = session.get('time_since_last_heard')
total_bytes = session.get('total_bytes')
total_pkts = session.get('total_pkts')
ext_host_address = session.get('ext_host_address')
ext_host_port = session.get('ext_host_port')
is_timed_out = session.get('is_timed_out')
print(f' i2o {in_ip_addr} proto {protocol} port {in_port}')
print(f' o2i {out_ip_addr} proto {protocol} port {out_port}')
print(f' external host {ext_host_address}:{ext_host_port}')
print(
f' i2o flow: match: saddr {in_ip_addr} sport {in_port} daddr {ext_host_address} dport {ext_host_port} proto {protocol} rewrite: saddr {out_ip_addr}'
+ (
f' sport {out_port}'
if protocol != 'ICMP'
else f' daddr {ext_host_address} icmp-id {ext_host_port}'
)
)
print(
f' o2i flow: match: saddr {ext_host_address} sport {ext_host_port} daddr {out_ip_addr} dport {out_port} proto {protocol} rewrite: '
+ (
f'daddr {in_ip_addr} dport {in_port}'
if protocol != 'ICMP'
else f' saddr {ext_host_address} daddr {in_ip_addr} icmp-id {ext_host_port}'
)
)
print(f' last heard {last_heard}')
print(f' time since last heard {time_since_last_heard}')
print(f' total packets {total_pkts}, total bytes {total_bytes}')
if is_timed_out:
print(' session timed out')
print('\n')
def _get_formatted_output_addresses(addresses):
twice_nat_address = []
translation_address = []
for address_info in addresses:
address = address_info.get('ip_address')
if address_info.get('flags') & flags_map['twice-nat']:
twice_nat_address.append(address)
else:
translation_address.append(address)
print('NAT44 pool addresses:')
for addr in translation_address:
print(f' {addr}')
print('NAT44 twice-nat pool addresses:')
for addr in twice_nat_address:
print(f' {addr}')
def _get_formatted_output_interfaces(vpp, interfaces):
print('NAT44 interfaces:')
for interface in interfaces:
name = vpp.get_interface_name(interface['sw_if_index'])
iface_type = decode_bitmask(interface['flags'])
print(f' {name} {" ".join(iface_type)}')
def _get_formatted_output_rules(rules_list):
data_entries = []
for rule in rules_list:
external_address = rule.get('external_ip_address')
external_port = rule.get('external_port') or ''
local_address = rule.get('local_ip_address')
local_port = rule.get('local_port') or ''
protocol = protocol_map[rule.get('protocol', 0)]
options = ' '.join(decode_bitmask(rule.get('flags')))
values = [
external_address,
external_port,
local_address,
local_port,
protocol,
options,
]
data_entries.append(values)
headers = [
'External address',
'External port',
'Local address',
'Local port',
'Protocol',
'Options',
]
out = sorted(data_entries, key=lambda x: x[2])
return tabulate(out, headers=headers, tablefmt='simple')
@_verify
def show_sessions(raw: bool):
vpp = VPPControl()
sessions_list: list[dict] = _get_raw_output_sessions(vpp.api)
if raw:
return sessions_list
else:
return _get_formatted_output_sessions(sessions_list)
@_verify
def show_summary(raw: bool):
vpp = VPPControl()
return vpp.cli_cmd('show nat44 summary').reply
@_verify
def show_static(raw: bool):
vpp = VPPControl()
nat_static_dump = vpp.api.nat44_static_mapping_dump()
rules_list: list[dict] = _get_raw_output(nat_static_dump)
if raw:
return rules_list
else:
return _get_formatted_output_rules(rules_list)
@_verify
def show_addresses(raw: bool):
vpp = VPPControl()
addresses_dump = vpp.api.nat44_address_dump()
addresses: list[dict] = _get_raw_output(addresses_dump)
if raw:
return addresses
else:
return _get_formatted_output_addresses(addresses)
@_verify
def show_interfaces(raw: bool):
vpp = VPPControl()
interfaces_dump = vpp.api.nat44_interface_dump()
interfaces: list[dict] = _get_raw_output(interfaces_dump)
if raw:
return interfaces
else:
return _get_formatted_output_interfaces(vpp, interfaces)
if __name__ == '__main__':
try:
res = vyos.opmode.run(sys.modules[__name__])
if res:
print(res)
except (ValueError, vyos.opmode.Error) as e:
print(e)
sys.exit(1)
|
