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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
# Copyright 2021-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library. If not, see <http://www.gnu.org/licenses/>.
# T2199: Remove unavailable nodes due to XML/Python implementation using nftables
# monthdays: nftables does not have a monthdays equivalent
# utc: nftables userspace uses localtime and calculates the UTC offset automatically
# icmp/v6: migrate previously available `type-name` to valid type/code
# T4178: Update tcp flags to use multi value node
# T6071: CLI description limit of 256 characters
import re
from vyos.configtree import ConfigTree
max_len_description = 255
base = ['firewall']
icmp_remove = ['any']
icmp_translations = {
'ping': 'echo-request',
'pong': 'echo-reply',
'ttl-exceeded': 'time-exceeded',
# Network Unreachable
'network-unreachable': [3, 0],
'host-unreachable': [3, 1],
'protocol-unreachable': [3, 2],
'port-unreachable': [3, 3],
'fragmentation-needed': [3, 4],
'source-route-failed': [3, 5],
'network-unknown': [3, 6],
'host-unknown': [3, 7],
'network-prohibited': [3, 9],
'host-prohibited': [3, 10],
'TOS-network-unreachable': [3, 11],
'TOS-host-unreachable': [3, 12],
'communication-prohibited': [3, 13],
'host-precedence-violation': [3, 14],
'precedence-cutoff': [3, 15],
# Redirect
'network-redirect': [5, 0],
'host-redirect': [5, 1],
'TOS-network-redirect': [5, 2],
'TOS host-redirect': [5, 3],
# Time Exceeded
'ttl-zero-during-transit': [11, 0],
'ttl-zero-during-reassembly': [11, 1],
'ttl-exceeded': 'time-exceeded',
# Parameter Problem
'ip-header-bad': [12, 0],
'required-option-missing': [12, 1]
}
icmpv6_remove = []
icmpv6_translations = {
'ping': 'echo-request',
'pong': 'echo-reply',
# Destination Unreachable
'no-route': [1, 0],
'communication-prohibited': [1, 1],
'address-unreachble': [1, 3],
'port-unreachable': [1, 4],
# nd
'redirect': 'nd-redirect',
'router-solicitation': 'nd-router-solicit',
'router-advertisement': 'nd-router-advert',
'neighbour-solicitation': 'nd-neighbor-solicit',
'neighbor-solicitation': 'nd-neighbor-solicit',
'neighbour-advertisement': 'nd-neighbor-advert',
'neighbor-advertisement': 'nd-neighbor-advert',
# Time Exceeded
'ttl-zero-during-transit': [3, 0],
'ttl-zero-during-reassembly': [3, 1],
# Parameter Problem
'bad-header': [4, 0],
'unknown-header-type': [4, 1],
'unknown-option': [4, 2]
}
v4_groups = ["address-group", "network-group", "port-group"]
v6_groups = ["ipv6-address-group", "ipv6-network-group", "port-group"]
def migrate(config: ConfigTree) -> None:
if not config.exists(base):
# Nothing to do
return
v4_found = False
v6_found = False
translated_dict = {}
if config.exists(base + ['group']):
for group_type in config.list_nodes(base + ['group']):
for group_name in config.list_nodes(base + ['group', group_type]):
name_description = base + ['group', group_type, group_name, 'description']
if config.exists(name_description):
tmp = config.return_value(name_description)
config.set(name_description, value=tmp[:max_len_description])
if '+' in group_name:
replacement_string = "_"
if group_type in v4_groups and not v4_found:
v4_found = True
if group_type in v6_groups and not v6_found:
v6_found = True
new_group_name = group_name.replace('+', replacement_string)
while config.exists(base + ['group', group_type, new_group_name]):
replacement_string = replacement_string + "_"
new_group_name = group_name.replace('+', replacement_string)
translated_dict[group_name] = new_group_name
config.copy(base + ['group', group_type, group_name], base + ['group', group_type, new_group_name])
config.delete(base + ['group', group_type, group_name])
if config.exists(base + ['name']):
for name in config.list_nodes(base + ['name']):
name_description = base + ['name', name, 'description']
if config.exists(name_description):
tmp = config.return_value(name_description)
config.set(name_description, value=tmp[:max_len_description])
if not config.exists(base + ['name', name, 'rule']):
continue
for rule in config.list_nodes(base + ['name', name, 'rule']):
rule_description = base + ['name', name, 'rule', rule, 'description']
if config.exists(rule_description):
tmp = config.return_value(rule_description)
config.set(rule_description, value=tmp[:max_len_description])
rule_recent = base + ['name', name, 'rule', rule, 'recent']
rule_time = base + ['name', name, 'rule', rule, 'time']
rule_tcp_flags = base + ['name', name, 'rule', rule, 'tcp', 'flags']
rule_icmp = base + ['name', name, 'rule', rule, 'icmp']
if config.exists(rule_time + ['monthdays']):
config.delete(rule_time + ['monthdays'])
if config.exists(rule_time + ['utc']):
config.delete(rule_time + ['utc'])
if config.exists(rule_recent + ['time']):
tmp = int(config.return_value(rule_recent + ['time']))
unit = 'minute'
if tmp > 600:
unit = 'hour'
elif tmp < 10:
unit = 'second'
config.set(rule_recent + ['time'], value=unit)
if config.exists(rule_tcp_flags):
tmp = config.return_value(rule_tcp_flags)
config.delete(rule_tcp_flags)
for flag in tmp.split(","):
if flag[0] == '!':
config.set(rule_tcp_flags + ['not', flag[1:].lower()])
else:
config.set(rule_tcp_flags + [flag.lower()])
if config.exists(rule_icmp + ['type-name']):
tmp = config.return_value(rule_icmp + ['type-name'])
if tmp in icmp_remove:
config.delete(rule_icmp + ['type-name'])
elif tmp in icmp_translations:
translate = icmp_translations[tmp]
if isinstance(translate, str):
config.set(rule_icmp + ['type-name'], value=translate)
elif isinstance(translate, list):
config.delete(rule_icmp + ['type-name'])
config.set(rule_icmp + ['type'], value=translate[0])
config.set(rule_icmp + ['code'], value=translate[1])
for direction in ['destination', 'source']:
if config.exists(base + ['name', name, 'rule', rule, direction]):
if config.exists(base + ['name', name, 'rule', rule, direction, 'group']) and v4_found:
for group_type in config.list_nodes(base + ['name', name, 'rule', rule, direction, 'group']):
group_name = config.return_value(base + ['name', name, 'rule', rule, direction, 'group', group_type])
if '+' in group_name:
if group_name[0] == "!":
new_group_name = "!" + translated_dict[group_name[1:]]
else:
new_group_name = translated_dict[group_name]
config.set(base + ['name', name, 'rule', rule, direction, 'group', group_type], value=new_group_name)
pg_base = base + ['name', name, 'rule', rule, direction, 'group', 'port-group']
proto_base = base + ['name', name, 'rule', rule, 'protocol']
if config.exists(pg_base) and not config.exists(proto_base):
config.set(proto_base, value='tcp_udp')
if '+' in name:
replacement_string = "_"
new_name = name.replace('+', replacement_string)
while config.exists(base + ['name', new_name]):
replacement_string = replacement_string + "_"
new_name = name.replace('+', replacement_string)
config.copy(base + ['name', name], base + ['name', new_name])
config.delete(base + ['name', name])
if config.exists(base + ['ipv6-name']):
for name in config.list_nodes(base + ['ipv6-name']):
name_description = base + ['ipv6-name', name, 'description']
if config.exists(name_description):
tmp = config.return_value(name_description)
config.set(name_description, value=tmp[:max_len_description])
if not config.exists(base + ['ipv6-name', name, 'rule']):
continue
for rule in config.list_nodes(base + ['ipv6-name', name, 'rule']):
rule_description = base + ['ipv6-name', name, 'rule', rule, 'description']
if config.exists(rule_description):
tmp = config.return_value(rule_description)
config.set(rule_description, value=tmp[:max_len_description])
rule_recent = base + ['ipv6-name', name, 'rule', rule, 'recent']
rule_time = base + ['ipv6-name', name, 'rule', rule, 'time']
rule_tcp_flags = base + ['ipv6-name', name, 'rule', rule, 'tcp', 'flags']
rule_icmp = base + ['ipv6-name', name, 'rule', rule, 'icmpv6']
if config.exists(rule_time + ['monthdays']):
config.delete(rule_time + ['monthdays'])
if config.exists(rule_time + ['utc']):
config.delete(rule_time + ['utc'])
if config.exists(rule_recent + ['time']):
tmp = int(config.return_value(rule_recent + ['time']))
unit = 'minute'
if tmp > 600:
unit = 'hour'
elif tmp < 10:
unit = 'second'
config.set(rule_recent + ['time'], value=unit)
if config.exists(rule_tcp_flags):
tmp = config.return_value(rule_tcp_flags)
config.delete(rule_tcp_flags)
for flag in tmp.split(","):
if flag[0] == '!':
config.set(rule_tcp_flags + ['not', flag[1:].lower()])
else:
config.set(rule_tcp_flags + [flag.lower()])
if config.exists(base + ['ipv6-name', name, 'rule', rule, 'protocol']):
tmp = config.return_value(base + ['ipv6-name', name, 'rule', rule, 'protocol'])
if tmp == 'icmpv6':
config.set(base + ['ipv6-name', name, 'rule', rule, 'protocol'], value='ipv6-icmp')
if config.exists(rule_icmp + ['type']):
tmp = config.return_value(rule_icmp + ['type'])
type_code_match = re.match(r'^(\d+)(?:/(\d+))?$', tmp)
if type_code_match:
config.set(rule_icmp + ['type'], value=type_code_match[1])
if type_code_match[2]:
config.set(rule_icmp + ['code'], value=type_code_match[2])
elif tmp in icmpv6_remove:
config.delete(rule_icmp + ['type'])
elif tmp in icmpv6_translations:
translate = icmpv6_translations[tmp]
if isinstance(translate, str):
config.delete(rule_icmp + ['type'])
config.set(rule_icmp + ['type-name'], value=translate)
elif isinstance(translate, list):
config.set(rule_icmp + ['type'], value=translate[0])
config.set(rule_icmp + ['code'], value=translate[1])
else:
config.rename(rule_icmp + ['type'], 'type-name')
for direction in ['destination', 'source']:
if config.exists(base + ['ipv6-name', name, 'rule', rule, direction]):
if config.exists(base + ['ipv6-name', name, 'rule', rule, direction, 'group']) and v6_found:
for group_type in config.list_nodes(base + ['ipv6-name', name, 'rule', rule, direction, 'group']):
group_name = config.return_value(base + ['ipv6-name', name, 'rule', rule, direction, 'group', group_type])
if '+' in group_name:
if group_name[0] == "!":
new_group_name = "!" + translated_dict[group_name[1:]]
else:
new_group_name = translated_dict[group_name]
config.set(base + ['ipv6-name', name, 'rule', rule, direction, 'group', group_type], value=new_group_name)
pg_base = base + ['ipv6-name', name, 'rule', rule, direction, 'group', 'port-group']
proto_base = base + ['ipv6-name', name, 'rule', rule, 'protocol']
if config.exists(pg_base) and not config.exists(proto_base):
config.set(proto_base, value='tcp_udp')
if '+' in name:
replacement_string = "_"
new_name = name.replace('+', replacement_string)
while config.exists(base + ['ipv6-name', new_name]):
replacement_string = replacement_string + "_"
new_name = name.replace('+', replacement_string)
config.copy(base + ['ipv6-name', name], base + ['ipv6-name', new_name])
config.delete(base + ['ipv6-name', name])
|
