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
|
#!/usr/bin/env python3
#
# Copyright (C) 2022-2024 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/>.
import os
import sys
import syslog
import xmltodict
from tabulate import tabulate
import vyos.opmode
from vyos.configquery import CliShellApiConfigQuery
from vyos.configquery import ConfigTreeQuery
from vyos.utils.commit import commit_in_progress
from vyos.utils.process import call
from vyos.utils.process import cmd
from vyos.utils.process import run
conntrackd_bin = '/usr/sbin/conntrackd'
conntrackd_config = '/run/conntrackd/conntrackd.conf'
failover_state_file = '/var/run/vyatta-conntrackd-failover-state'
def is_configured():
""" Check if conntrack-sync service is configured """
config = CliShellApiConfigQuery()
if not config.exists(['service', 'conntrack-sync']):
raise vyos.opmode.UnconfiguredSubsystem("conntrack-sync is not configured!")
def send_bulk_update():
""" send bulk update of internal-cache to other systems """
tmp = run(f'{conntrackd_bin} -C {conntrackd_config} -B')
if tmp > 0:
raise vyos.opmode.Error('Failed to send bulk update to other conntrack-sync systems')
def request_sync():
""" request resynchronization with other systems """
tmp = run(f'{conntrackd_bin} -C {conntrackd_config} -n')
if tmp > 0:
raise vyos.opmode.Error('Failed to request resynchronization of external cache')
def flush_cache(direction):
""" flush conntrackd cache (internal or external) """
if direction not in ['internal', 'external']:
raise ValueError()
tmp = run(f'{conntrackd_bin} -C {conntrackd_config} -f {direction}')
if tmp > 0:
raise vyos.opmode.Error('Failed to clear {direction} cache')
def get_formatted_output(data):
data_entries = []
for parsed in data:
for meta in parsed.get('flow', {}).get('meta', []):
direction = meta['@direction']
if direction == 'original':
src = meta['layer3']['src']
dst = meta['layer3']['dst']
sport = meta['layer4'].get('sport')
dport = meta['layer4'].get('dport')
protocol = meta['layer4'].get('@protoname')
orig_src = f'{src}:{sport}' if sport else src
orig_dst = f'{dst}:{dport}' if dport else dst
data_entries.append([orig_src, orig_dst, protocol])
headers = ["Source", "Destination", "Protocol"]
output = tabulate(data_entries, headers, tablefmt="simple")
return output
def from_xml(raw, xml):
out = []
for line in xml.splitlines():
if line == '\n':
continue
parsed = xmltodict.parse(line)
out.append(parsed)
if raw:
return out
else:
return get_formatted_output(out)
def restart():
is_configured()
if commit_in_progress():
raise vyos.opmode.CommitInProgress('Cannot restart conntrackd while a commit is in progress')
syslog.syslog('Restarting conntrack sync service...')
cmd('systemctl restart conntrackd.service')
# request resynchronization with other systems
request_sync()
# send bulk update of internal-cache to other systems
send_bulk_update()
def reset_external_cache():
is_configured()
syslog.syslog('Resetting external cache of conntrack sync service...')
# flush the external cache
flush_cache('external')
# request resynchronization with other systems
request_sync()
def reset_internal_cache():
is_configured()
syslog.syslog('Resetting internal cache of conntrack sync service...')
# flush the internal cache
flush_cache('internal')
# request resynchronization of internal cache with kernel conntrack table
tmp = run(f'{conntrackd_bin} -C {conntrackd_config} -R')
if tmp > 0:
print('ERROR: failed to resynchronize internal cache with kernel conntrack table')
# send bulk update of internal-cache to other systems
send_bulk_update()
def _show_cache(raw, opts):
is_configured()
out = cmd(f'{conntrackd_bin} -C {conntrackd_config} {opts} -x')
return from_xml(raw, out)
def show_external_cache(raw: bool):
opts = '-e ct'
return _show_cache(raw, opts)
def show_external_expect(raw: bool):
opts = '-e expect'
return _show_cache(raw, opts)
def show_internal_cache(raw: bool):
opts = '-i ct'
return _show_cache(raw, opts)
def show_internal_expect(raw: bool):
opts = '-i expect'
return _show_cache(raw, opts)
def show_statistics(raw: bool):
if raw:
raise vyos.opmode.UnsupportedOperation("Machine-readable conntrack-sync statistics are not available yet")
else:
is_configured()
config = ConfigTreeQuery()
print('\nMain Table Statistics:\n')
call(f'{conntrackd_bin} -C {conntrackd_config} -s')
print()
if config.exists(['service', 'conntrack-sync', 'expect-sync']):
print('\nExpect Table Statistics:\n')
call(f'{conntrackd_bin} -C {conntrackd_config} -s exp')
print()
def show_status(raw: bool):
is_configured()
config = ConfigTreeQuery()
ct_sync_intf = config.list_nodes(['service', 'conntrack-sync', 'interface'])
ct_sync_intf = ', '.join(ct_sync_intf)
failover_state = "no transition yet!"
expect_sync_protocols = []
if config.exists(['service', 'conntrack-sync', 'failover-mechanism', 'vrrp']):
failover_mechanism = "vrrp"
vrrp_sync_grp = config.value(['service', 'conntrack-sync', 'failover-mechanism', 'vrrp', 'sync-group'])
if os.path.isfile(failover_state_file):
with open(failover_state_file, "r") as f:
failover_state = f.readline()
if config.exists(['service', 'conntrack-sync', 'expect-sync']):
expect_sync_protocols = config.values(['service', 'conntrack-sync', 'expect-sync'])
if 'all' in expect_sync_protocols:
expect_sync_protocols = ["ftp", "sip", "h323", "nfs", "sqlnet"]
if raw:
status_data = {
"sync_interface": ct_sync_intf,
"failover_mechanism": failover_mechanism,
"sync_group": vrrp_sync_grp,
"last_transition": failover_state,
"sync_protocols": expect_sync_protocols
}
return status_data
else:
if expect_sync_protocols:
expect_sync_protocols = ', '.join(expect_sync_protocols)
else:
expect_sync_protocols = "disabled"
show_status = (f'\nsync-interface : {ct_sync_intf}\n'
f'failover-mechanism : {failover_mechanism} [sync-group {vrrp_sync_grp}]\n'
f'last state transition : {failover_state}\n'
f'ExpectationSync : {expect_sync_protocols}')
return show_status
if __name__ == '__main__':
syslog.openlog(ident='conntrack-tools', logoption=syslog.LOG_PID, facility=syslog.LOG_INFO)
try:
res = vyos.opmode.run(sys.modules[__name__])
if res:
print(res)
except (ValueError, vyos.opmode.Error) as e:
print(e)
sys.exit(1)
|
