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
|
#!/usr/bin/env python3
#
# Copyright (C) 2023 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# 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, see <http://www.gnu.org/licenses/>.
# pylint: disable=empty-docstring,missing-module-docstring
import csv
import os
import re
from ipaddress import IPv6Network
from json import dumps as json_write
from vyos import ConfigError
from vyos import airbag
from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.configdict import is_node_changed
from vyos.utils.dict import dict_search
from vyos.utils.file import write_file
from vyos.utils.kernel import check_kmod
from vyos.utils.process import cmd
from vyos.utils.process import run
airbag.enable()
INSTANCE_REGEX = re.compile(r"instance-(\d+)")
JOOL_CONFIG_DIR = "/run/jool"
def get_config(config: Config | None = None) -> None:
if config is None:
config = Config()
base = ["nat64"]
nat64 = config.get_config_dict(base, key_mangling=("-", "_"), get_first_key=True)
base_src = base + ["source", "rule"]
# Load in existing instances so we can destroy any unknown
lines = cmd("jool instance display --csv").splitlines()
for _, instance, _ in csv.reader(lines):
match = INSTANCE_REGEX.fullmatch(instance)
if not match:
# FIXME: Instances that don't match should be ignored but WARN'ed to the user
continue
num = match.group(1)
rules = nat64.setdefault("source", {}).setdefault("rule", {})
# Mark it for deletion
if num not in rules:
rules[num] = {"deleted": True}
continue
# If the user changes the mode, recreate the instance else Jool fails with:
# Jool error: Sorry; you can't change an instance's framework for now.
if is_node_changed(config, base_src + [f"instance-{num}", "mode"]):
rules[num]["recreate"] = True
# If the user changes the pool6, recreate the instance else Jool fails with:
# Jool error: Sorry; you can't change a NAT64 instance's pool6 for now.
if dict_search("source.prefix", rules[num]) and is_node_changed(
config,
base_src + [num, "source", "prefix"],
):
rules[num]["recreate"] = True
return nat64
def verify(nat64) -> None:
if not nat64:
# no need to verify the CLI as nat64 is going to be deactivated
return
if dict_search("source.rule", nat64):
# Ensure only 1 netfilter instance per namespace
nf_rules = filter(
lambda i: "deleted" not in i and i.get('mode') == "netfilter",
nat64["source"]["rule"].values(),
)
next(nf_rules, None) # Discard the first element
if next(nf_rules, None) is not None:
raise ConfigError(
"Jool permits only 1 NAT64 netfilter instance (per network namespace)"
)
for rule, instance in nat64["source"]["rule"].items():
if "deleted" in instance:
continue
# Verify that source.prefix is set and is a /96
if not dict_search("source.prefix", instance):
raise ConfigError(f"Source NAT64 rule {rule} missing source prefix")
if IPv6Network(instance["source"]["prefix"]).prefixlen != 96:
raise ConfigError(f"Source NAT64 rule {rule} source prefix must be /96")
pools = dict_search("translation.pool", instance)
if pools:
for num, pool in pools.items():
if "address" not in pool:
raise ConfigError(
f"Source NAT64 rule {rule} translation pool "
f"{num} missing address/prefix"
)
if "port" not in pool:
raise ConfigError(
f"Source NAT64 rule {rule} translation pool "
f"{num} missing port(-range)"
)
def generate(nat64) -> None:
os.makedirs(JOOL_CONFIG_DIR, exist_ok=True)
if dict_search("source.rule", nat64):
for rule, instance in nat64["source"]["rule"].items():
if "deleted" in instance:
# Delete the unused instance file
os.unlink(os.path.join(JOOL_CONFIG_DIR, f"instance-{rule}.json"))
continue
name = f"instance-{rule}"
config = {
"instance": name,
"framework": "netfilter",
"global": {
"pool6": instance["source"]["prefix"],
"manually-enabled": "disable" not in instance,
},
# "bib": [],
}
if "description" in instance:
config["comment"] = instance["description"]
if dict_search("translation.pool", instance):
pool4 = []
for pool in instance["translation"]["pool"].values():
if "disable" in pool:
continue
protos = pool.get("protocol", {}).keys() or ("tcp", "udp", "icmp")
for proto in protos:
obj = {
"protocol": proto.upper(),
"prefix": pool["address"],
"port range": pool["port"],
}
if "description" in pool:
obj["comment"] = pool["description"]
pool4.append(obj)
if pool4:
config["pool4"] = pool4
write_file(f'{JOOL_CONFIG_DIR}/{name}.json', json_write(config, indent=2))
def apply(nat64) -> None:
if not nat64:
return
if dict_search("source.rule", nat64):
# Deletions first to avoid conflicts
for rule, instance in nat64["source"]["rule"].items():
if not any(k in instance for k in ("deleted", "recreate")):
continue
ret = run(f"jool instance remove instance-{rule}")
if ret != 0:
raise ConfigError(
f"Failed to remove nat64 source rule {rule} (jool instance instance-{rule})"
)
# Now creations
for rule, instance in nat64["source"]["rule"].items():
if "deleted" in instance:
continue
name = f"instance-{rule}"
ret = run(f"jool -i {name} file handle {JOOL_CONFIG_DIR}/{name}.json")
if ret != 0:
raise ConfigError(f"Failed to set jool instance {name}")
if __name__ == "__main__":
try:
check_kmod(["jool"])
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)
|
