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
|
#!/usr/bin/env python3
#
# Copyright (C) 2022-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/>.
#
#
import os
import sys
import typing
from tabulate import tabulate
import vyos.opmode
from vyos.util import bytes_to_human
from vyos.util import commit_in_progress
from vyos.util import call
from vyos.config import Config
ArgMode = typing.Literal['client', 'server', 'site_to_site']
def _get_tunnel_address(peer_host, peer_port, status_file):
peer = peer_host + ':' + peer_port
lst = []
with open(status_file, 'r') as f:
lines = f.readlines()
for line in lines:
if peer in line:
lst.append(line)
# filter out subnet entries if iroute:
# in the case that one sets, say:
# [ ..., 'vtun10', 'server', 'client', 'client1', 'subnet','10.10.2.0/25']
# the status file will have an entry:
# 10.10.2.0/25,client1,...
lst = [l for l in lst[1:] if '/' not in l.split(',')[0]]
tunnel_ip = lst[0].split(',')[0]
return tunnel_ip
def _get_interface_status(mode: str, interface: str) -> dict:
status_file = f'/run/openvpn/{interface}.status'
data: dict = {
'mode': mode,
'intf': interface,
'local_host': '',
'local_port': '',
'date': '',
'clients': [],
}
if not os.path.exists(status_file):
raise vyos.opmode.DataUnavailable('No information for interface {interface}')
with open(status_file, 'r') as f:
lines = f.readlines()
for line_no, line in enumerate(lines):
# remove trailing newline character first
line = line.rstrip('\n')
# check first line header
if line_no == 0:
if mode == 'server':
if not line == 'OpenVPN CLIENT LIST':
raise vyos.opmode.InternalError('Expected "OpenVPN CLIENT LIST"')
else:
if not line == 'OpenVPN STATISTICS':
raise vyos.opmode.InternalError('Expected "OpenVPN STATISTICS"')
continue
# second line informs us when the status file has been last updated
if line_no == 1:
data['date'] = line.lstrip('Updated,').rstrip('\n')
continue
if mode == 'server':
# for line_no > 1, lines appear as follows:
#
# Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since
# client1,172.18.202.10:55904,2880587,2882653,Fri Aug 23 16:25:48 2019
# client3,172.18.204.10:41328,2850832,2869729,Fri Aug 23 16:25:43 2019
# client2,172.18.203.10:48987,2856153,2871022,Fri Aug 23 16:25:45 2019
# ...
# ROUTING TABLE
# ...
if line_no >= 3:
# indicator that there are no more clients
if line == 'ROUTING TABLE':
break
# otherwise, get client data
remote = (line.split(',')[1]).rsplit(':', maxsplit=1)
client = {
'name': line.split(',')[0],
'remote_host': remote[0],
'remote_port': remote[1],
'tunnel': 'N/A',
'rx_bytes': bytes_to_human(int(line.split(',')[2]),
precision=1),
'tx_bytes': bytes_to_human(int(line.split(',')[3]),
precision=1),
'online_since': line.split(',')[4]
}
client['tunnel'] = _get_tunnel_address(client['remote_host'],
client['remote_port'],
status_file)
data['clients'].append(client)
continue
else: # mode == 'client' or mode == 'site-to-site'
if line_no == 2:
client = {
'name': 'N/A',
'remote_host': 'N/A',
'remote_port': 'N/A',
'tunnel': 'N/A',
'rx_bytes': bytes_to_human(int(line.split(',')[1]),
precision=1),
'tx_bytes': '',
'online_since': 'N/A'
}
continue
if line_no == 3:
client['tx_bytes'] = bytes_to_human(int(line.split(',')[1]),
precision=1)
data['clients'].append(client)
break
return data
def _get_raw_data(mode: str) -> list:
data: list = []
conf = Config()
conf_dict = conf.get_config_dict(['interfaces', 'openvpn'],
get_first_key=True)
if not conf_dict:
return data
interfaces = [x for x in list(conf_dict) if
conf_dict[x]['mode'].replace('-', '_') == mode]
for intf in interfaces:
d = _get_interface_status(mode, intf)
d['local_host'] = conf_dict[intf].get('local-host', '')
d['local_port'] = conf_dict[intf].get('local-port', '')
if conf.exists(f'interfaces openvpn {intf} server client'):
d['configured_clients'] = conf.list_nodes(f'interfaces openvpn {intf} server client')
if mode in ['client', 'site_to_site']:
for client in d['clients']:
if 'shared-secret-key-file' in list(conf_dict[intf]):
client['name'] = 'None (PSK)'
client['remote_host'] = conf_dict[intf].get('remote-host', [''])[0]
client['remote_port'] = conf_dict[intf].get('remote-port', '1194')
data.append(d)
return data
def _format_openvpn(data: list) -> str:
if not data:
out = 'No OpenVPN interfaces configured'
return out
headers = ['Client CN', 'Remote Host', 'Tunnel IP', 'Local Host',
'TX bytes', 'RX bytes', 'Connected Since']
out = ''
for d in data:
data_out = []
intf = d['intf']
l_host = d['local_host']
l_port = d['local_port']
for client in d['clients']:
r_host = client['remote_host']
r_port = client['remote_port']
out += f'\nOpenVPN status on {intf}\n\n'
name = client['name']
remote = r_host + ':' + r_port if r_host and r_port else 'N/A'
tunnel = client['tunnel']
local = l_host + ':' + l_port if l_host and l_port else 'N/A'
tx_bytes = client['tx_bytes']
rx_bytes = client['rx_bytes']
online_since = client['online_since']
data_out.append([name, remote, tunnel, local, tx_bytes,
rx_bytes, online_since])
if data_out:
out += tabulate(data_out, headers)
out += "\n"
return out
def show(raw: bool, mode: ArgMode) -> typing.Union[list,str]:
openvpn_data = _get_raw_data(mode)
if raw:
return openvpn_data
return _format_openvpn(openvpn_data)
def reset(interface: str):
if os.path.isfile(f'/run/openvpn/{interface}.conf'):
if commit_in_progress():
raise vyos.opmode.CommitInProgress('Retry OpenVPN reset: commit in progress.')
call(f'systemctl restart openvpn@{interface}.service')
else:
raise vyos.opmode.IncorrectValue(f'OpenVPN interface "{interface}" does not exist!')
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)
|
