forked from furlongm/openvpn-monitor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openvpn_interface.py
303 lines (275 loc) · 11.3 KB
/
openvpn_interface.py
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
import re
import socket
from collections import deque
from datetime import datetime
from ipaddress import ip_address
from logging import debug, info, warning
from pprint import pformat
from semantic_version import Version as semver
try:
import GeoIP as geoip1
geoip1_available = True
except ImportError:
geoip1_available = False
try:
from geoip2 import database
from geoip2.errors import AddressNotFoundError
geoip2_available = True
except ImportError:
geoip2_available = False
class OpenvpnMgmtInterface:
def __init__(self, vpns, *, geoip_data=""):
self.vpns = vpns
self.geoip_version = None
self.gi = None
try:
if geoip_data.endswith(".mmdb") and geoip2_available:
self.gi = database.Reader(geoip_data)
self.geoip_version = 2
elif geoip_data.endswith(".dat") and geoip1_available:
self.gi = geoip1.open(geoip_data, geoip1.GEOIP_STANDARD)
self.geoip_version = 1
else:
warning("No compatible geoip1 or geoip2 data/libraries found.")
except IOError:
warning("No compatible geoip1 or geoip2 data/libraries found.")
self.refresh()
def refresh(self):
for key, vpn in list(self.vpns.items()):
self._socket_connect(vpn)
if vpn["socket_connected"]:
self.collect_data(vpn)
self._socket_disconnect()
def collect_data(self, vpn):
ver = self.send_command("version\n")
vpn["release"] = self.parse_version(ver)
vpn["version"] = semver(vpn["release"].split(" ")[1])
state = self.send_command("state\n")
vpn["state"] = self.parse_state(state)
stats = self.send_command("load-stats\n")
vpn["stats"] = self.parse_stats(stats)
status = self.send_command("status 3\n")
vpn["sessions"] = self.parse_status(status, vpn["version"])
def _socket_send(self, command):
self.s.send(command.encode())
def _socket_recv(self, length):
return self.s.recv(length).decode()
def _socket_connect(self, vpn):
timeout = 3
self.s = None
try:
if "socket" in vpn:
self.s = socket.socket(socket.AF_UNIX)
self.s.connect(vpn["socket"])
else:
address = (vpn["host"], int(vpn["port"]))
self.s = socket.create_connection(address, timeout)
vpn["socket_connected"] = True
except socket.timeout as e:
vpn["error"] = "{0!s}".format(e)
warning("socket timeout: {0!s}".format(e))
vpn["socket_connected"] = False
if self.s:
self.s.close()
except socket.error as e:
vpn["error"] = "{0!s}".format(e.strerror)
warning("socket error: {0!s}".format(e))
vpn["socket_connected"] = False
def _socket_disconnect(self):
self._socket_send("quit\n")
self.s.close()
def send_command(self, command):
info(f"Sending command: {command}")
self._socket_send(command)
data = ""
if command.startswith("kill") or command.startswith("client-kill"):
return
while 1:
socket_data = self._socket_recv(1024)
socket_data = re.sub(">INFO(.)*\r\n", "", socket_data)
data += socket_data
if command == "load-stats\n" and data != "":
break
elif data.endswith("\nEND\r\n"):
break
debug(f"=== begin raw data\n{data}\n=== end raw data")
return data
@staticmethod
def parse_state(data):
state = {}
for line in data.splitlines():
parts = line.split(",")
debug(f"=== begin split line\n{parts}\n=== end split line")
if (
parts[0].startswith(">INFO")
or parts[0].startswith("END")
or parts[0].startswith(">CLIENT")
):
continue
else:
state["up_since"] = datetime.fromtimestamp(int(parts[0]))
state["connected"] = parts[1]
state["success"] = parts[2]
if parts[3]:
state["local_ip"] = ip_address(parts[3])
else:
state["local_ip"] = ""
if parts[4]:
state["remote_ip"] = ip_address(parts[4])
state["mode"] = "Client"
else:
state["remote_ip"] = ""
state["mode"] = "Server"
return state
@staticmethod
def parse_stats(data):
stats = {}
line = re.sub("SUCCESS: ", "", data)
parts = line.split(",")
debug("=== begin split line\n{0!s}\n=== end split line".format(parts))
stats["nclients"] = int(re.sub("nclients=", "", parts[0]))
stats["bytesin"] = int(re.sub("bytesin=", "", parts[1]))
stats["bytesout"] = int(re.sub("bytesout=", "", parts[2]).replace("\r\n", ""))
return stats
def parse_status(self, data, version):
gi = self.gi
geoip_version = self.geoip_version
client_section = False
routes_section = False
sessions = {}
client_session = {}
for line in data.splitlines():
parts = deque(line.split("\t"))
debug(f"=== begin split line\n{parts}\n=== end split line")
if parts[0].startswith("END"):
break
if (
parts[0].startswith("TITLE")
or parts[0].startswith("GLOBAL")
or parts[0].startswith("TIME")
):
continue
if parts[0] == "HEADER":
if parts[1] == "CLIENT_LIST":
client_section = True
routes_section = False
if parts[1] == "ROUTING_TABLE":
client_section = False
routes_section = True
continue
if (
parts[0].startswith("TUN")
or parts[0].startswith("TCP")
or parts[0].startswith("Auth")
):
parts = parts[0].split(",")
if parts[0] == "TUN/TAP read bytes":
client_session["tuntap_read"] = int(parts[1])
continue
if parts[0] == "TUN/TAP write bytes":
client_session["tuntap_write"] = int(parts[1])
continue
if parts[0] == "TCP/UDP read bytes":
client_session["tcpudp_read"] = int(parts[1])
continue
if parts[0] == "TCP/UDP write bytes":
client_session["tcpudp_write"] = int(parts[1])
continue
if parts[0] == "Auth read bytes":
client_session["auth_read"] = int(parts[1])
sessions["Client"] = client_session
continue
if client_section:
session = {}
parts.popleft()
common_name = parts.popleft()
remote_str = parts.popleft()
if remote_str.count(":") == 1:
remote, port = remote_str.split(":")
elif "(" in remote_str:
remote, port = remote_str.split("(")
port = port[:-1]
else:
remote = remote_str
port = None
remote_ip = ip_address(remote)
session["remote_ip"] = remote_ip
if port:
session["port"] = int(port)
else:
session["port"] = ""
if session["remote_ip"].is_private:
session["location"] = "RFC1918"
else:
try:
if geoip_version == 1:
gir = gi.record_by_addr(str(session["remote_ip"]))
session["location"] = gir["country_code"]
session["region"] = gir["region"]
session["city"] = gir["city"]
session["country"] = gir["country_name"]
session["longitude"] = gir["longitude"]
session["latitude"] = gir["latitude"]
elif geoip_version == 2:
gir = gi.city(str(session["remote_ip"]))
session["location"] = gir.country.iso_code
session["region"] = gir.subdivisions.most_specific.iso_code
session["city"] = gir.city.name
session["country"] = gir.country.name
session["longitude"] = gir.location.longitude
session["latitude"] = gir.location.latitude
except (AddressNotFoundError, TypeError, SystemError):
pass
local_ipv4 = parts.popleft()
if local_ipv4:
session["local_ip"] = ip_address(local_ipv4)
else:
session["local_ip"] = ""
if version.major >= 2 and version.minor >= 4:
local_ipv6 = parts.popleft()
if local_ipv6:
session["local_ip"] = ip_address(local_ipv6)
session["bytes_recv"] = int(parts.popleft())
session["bytes_sent"] = int(parts.popleft())
parts.popleft()
session["connected_since"] = datetime.fromtimestamp(
int(parts.popleft())
)
username = parts.popleft()
if username != "UNDEF":
session["username"] = username
else:
session["username"] = common_name
if version.major == 2 and version.minor >= 4:
session["client_id"] = parts.popleft()
session["peer_id"] = parts.popleft()
sessions[str(session["local_ip"])] = session
if routes_section:
local_ip = parts[1]
remote_ip = parts[3]
last_seen = datetime.fromtimestamp(int(parts[5]))
if local_ip in sessions:
sessions[local_ip]["last_seen"] = last_seen
if sessions:
pretty_sessions = pformat(sessions)
debug(f"=== begin sessions\n{pretty_sessions}\n=== end sessions")
else:
debug("no sessions")
return sessions
@staticmethod
def parse_version(data):
for line in data.splitlines():
if line.startswith("OpenVPN Version: "):
return line.replace("OpenVPN Version: ", "")
def kill_client(self, vpn_name, ip, port, client_id):
vpn = self.vpns[vpn_name]
self._socket_connect(vpn)
if vpn["socket_connected"]:
release = self.send_command("version\n")
version = semver(self.parse_version(release).split(" ")[1])
if version.major == 2 and version.minor >= 4 and not port:
command = "client-kill {0!s}\n".format(client_id)
else:
command = "kill {0!s}:{1!s}\n".format(ip, port)
self.send_command(command)
self._socket_disconnect()