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
|
# -*- coding: utf-8 -*-
# management.py
# Copyright (c) 2012 Mike Mattice
# Copyright (C) 2017 LEAP Encryption Access Project
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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/>.
"""
Handles an OpenVPN process through its Management Interface.
"""
import time
from collections import OrderedDict
from twisted.protocols.basic import LineReceiver
from twisted.internet.defer import Deferred
from twisted.logger import Logger
from _human import bytes2human
from ._state import State
class ManagementProtocol(LineReceiver):
log = Logger()
def __init__(self, verbose=False):
self.verbose = verbose
self.state = None
self.remote = None
self.rport = None
self.traffic = TrafficCounter()
self.openvpn_version = ''
self.pid = None
self._defs = []
self._linebuf = []
self._state_listeners = set([])
def addStateListener(self, listener):
"""
A Listener must implement changeState method,
and it will be called with a State object.
"""
self._state_listeners.add(listener)
def lineReceived(self, line):
if self.verbose:
if int(self.verbose) > 1:
print line
elif line.startswith('>LOG'):
print line
if line[0] == '>':
try:
infotype, data = line[1:].split(':', 1)
infotype = infotype.replace('-', '_')
except Exception, msg:
print "failed to parse '%r': %s" % (line, msg)
raise
m = getattr(self, '_handle_%s' % infotype, None)
if m:
try:
m(data)
except Exception, msg:
print "Failure in _handle_%s: %s" % (infotype, msg)
else:
self._handle_unknown(infotype, data)
else:
if line.strip() == 'END':
try:
d = self._defs.pop(0)
d.callback('\n'.join(self._linebuf))
except IndexError:
pass
self._linebuf = []
return
try:
status, data = line.split(': ', 1)
except ValueError:
print "ERROR PARSING:", line
return
if status in ('ERROR', 'SUCCESS'):
try:
d = self._defs.pop(0)
if status == 'SUCCESS':
d.callback(line)
else:
d.errback(line)
except:
pass
else:
self._linebuf.append(line)
def _handle_unknown(self, infotype, data):
self.log.msg(
'Received unhandled infotype %s with data %s' %
(infotype, data))
def _handle_BYTECOUNT(self, data):
down, up = data.split(',')
self.traffic.update(down, up, time.time())
def _handle_ECHO(self, data):
pass
def _handle_FATAL(self, data):
pass
def _handle_HOLD(self, data):
pass
def _handle_INFO(self, data):
pass
def _handle_LOG(self, data):
pass
def _handle_NEED_OK(self, data):
pass
def _handle_NEED_STR(self, data):
pass
def _handle_STATE(self, data):
data = data.strip().split(',')
remote = rport = None
state = ''
ts = None
try:
if len(data) == 9:
(ts, state, verbose, localtun,
remote, rport, laddr, lport, ip6) = data
elif len(data) == 8:
ts, state = data[:2]
elif len(data) == 5:
ts, state, verbose, localtun, remote = data
else:
raise ValueError(
'Cannot parse state data! %s' % data)
except Exception as exc:
self.log.error('Failure parsing data: %s' % exc)
return
if state != self.state:
stateobj = State(state, ts)
for listener in self._state_listeners:
listener.changeState(stateobj)
self.state = stateobj
self.remote = remote
self.rport = rport
def _pushdef(self):
d = Deferred()
self._defs.append(d)
return d
def byteCount(self, interval=0):
d = self._pushdef()
self.sendLine('bytecount %d' % (interval,))
return d
def signal(self, signal='SIGTERM'):
d = self._pushdef()
self.sendLine('signal %s' % (signal,))
return d
def _parseHoldstatus(self, result):
return result.split('=')[0] == '1'
def hold(self, p=''):
d = self._pushdef()
self.sendLine('hold %s' % (p,))
if p == '':
d.addCallback(self._parseHoldstatus)
return d
def _parsePid(self, result):
self.pid = int(result.split('=')[1])
def getPid(self):
d = self._pushdef()
self.sendLine('pid')
d.addCallback(self._parsePid)
return d
def logOn(self):
d = self._pushdef()
self.sendLine('log on')
return d
def stateOn(self):
d = self._pushdef()
self.sendLine('state on')
return d
def _parseVersion(self, data):
version = data.split('\n')[0].split(':')[1]
self.openvpn_version = version.strip()
def getVersion(self):
d = self._pushdef()
self.sendLine('version')
d.addCallback(self._parseVersion)
return d
def getInfo(self):
return {
'remote': self.remote,
'rport': self.rport,
'openvpn_version': self.openvpn_version,
'pid': self.pid,
'traffic_down_total': self.traffic.down,
'traffic_up_total': self.traffic.up}
class TrafficCounter(object):
CAPACITY = 60
def __init__(self):
self.down = None
self.up = None
self._buf = OrderedDict()
def update(self, down, up, ts):
i_down = int(down)
i_up = int(up)
self.down = i_down
self.up = i_up
if len(self._buf) > self.CAPACITY:
self._buf.pop(self._buf.keys()[0])
self._buf[ts] = i_down, i_up
def get_rate(self, human=True):
points = self._buf.items()
if len(points) < 2:
return ['NA', 'NA']
ts1, prev = points[-2]
ts2, last = points[-1]
rate_down = _get_rate(last[0], prev[0], ts2, ts1)
rate_up = _get_rate(last[1], prev[1], ts2, ts1)
rates = rate_down, rate_up
if human:
rates = map(bytes2human, rates)
return rates
def _get_rate(p2, p1, ts2, ts1):
return ((1.0 * (p2 - p1)) / (ts2 - ts1))
|
