To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-monitor
- browse files at revision 237.24.1
- compare with another revision
- download diff
- download tarball
- view history from revision 237.24.1
- Committer: Teddy Hogeborn
- Date: 2015-05-23 20:18:34 UTC
- mto: (237.7.304 trunk)
- mto: This revision was merged to the branch mainline in revision 325.
- Revision ID: teddy@recompile.se-20150523201834-e89ex4ito93yni8x
mandos: Use multiprocessing module to run checkers.
For a long time, the Mandos server has occasionally logged the message
"ERROR: Child process vanished". This was never a fatal error, but it
has been annoying and slightly worrying, since a definite cause was
not found. One potential cause could be the "multiprocessing" and
"subprocess" modules conflicting w.r.t. SIGCHLD. To avoid this,
change the running of checkers from using subprocess.Popen
asynchronously to instead first create a multiprocessing.Process()
(which is asynchronous) calling a function, and have that function
then call subprocess.call() (which is synchronous). In this way, the
only thing using any asynchronous subprocesses is the multiprocessing
module.
This makes it necessary to change one small thing in the D-Bus API,
since the subprocesses.call() function does not expose the raw wait(2)
status value.
DBUS-API (CheckerCompleted): Change the second value provided by this
D-Bus signal from the raw wait(2) status
to the actual terminating signal number.
mandos (subprocess_call_pipe): New function to be called by
multiprocessing.Process (starting a
separate process).
(Client.last_checker signal): New attribute for signal which
terminated last checker. Like
last_checker_status, only not accessible
via D-Bus.
(Client.checker_callback): Take new "connection" argument and use it
to get returncode; set last_checker_signal.
Return False so gobject does not call this
callback again.
(Client.start_checker): Start checker using a multiprocessing.Process
instead of a subprocess.Popen.
(ClientDBus.checker_callback): Take new "connection" argument. Call
Client.checker_callback early to have
it set last_checker_status and
last_checker_signal; use those. Change
second value provided to D-Bus signal
CheckerCompleted to use
last_checker_signal if checker was
terminated by signal.
mandos-monitor: Update to reflect DBus API change.
(MandosClientWidget.checker_completed): Take "signal" instead of
"condition" argument. Use it
accordingly. Remove dead code
(os.WCOREDUMP case).
For a long time, the Mandos server has occasionally logged the message
"ERROR: Child process vanished". This was never a fatal error, but it
has been annoying and slightly worrying, since a definite cause was
not found. One potential cause could be the "multiprocessing" and
"subprocess" modules conflicting w.r.t. SIGCHLD. To avoid this,
change the running of checkers from using subprocess.Popen
asynchronously to instead first create a multiprocessing.Process()
(which is asynchronous) calling a function, and have that function
then call subprocess.call() (which is synchronous). In this way, the
only thing using any asynchronous subprocesses is the multiprocessing
module.
This makes it necessary to change one small thing in the D-Bus API,
since the subprocesses.call() function does not expose the raw wait(2)
status value.
DBUS-API (CheckerCompleted): Change the second value provided by this
D-Bus signal from the raw wait(2) status
to the actual terminating signal number.
mandos (subprocess_call_pipe): New function to be called by
multiprocessing.Process (starting a
separate process).
(Client.last_checker signal): New attribute for signal which
terminated last checker. Like
last_checker_status, only not accessible
via D-Bus.
(Client.checker_callback): Take new "connection" argument and use it
to get returncode; set last_checker_signal.
Return False so gobject does not call this
callback again.
(Client.start_checker): Start checker using a multiprocessing.Process
instead of a subprocess.Popen.
(ClientDBus.checker_callback): Take new "connection" argument. Call
Client.checker_callback early to have
it set last_checker_status and
last_checker_signal; use those. Change
second value provided to D-Bus signal
CheckerCompleted to use
last_checker_signal if checker was
terminated by signal.
mandos-monitor: Update to reflect DBus API change.
(MandosClientWidget.checker_completed): Take "signal" instead of
"condition" argument. Use it
accordingly. Remove dead code
(os.WCOREDUMP case).
- files added:
- debian/mandos-client.examples
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos-monitor
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
# Copyright © 2009,2010 Teddy Hogeborn
7
# Copyright © 2009,2010 Björn Påhlsson
6
# Copyright © 2009-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 Björn Påhlsson
8
8
#
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
17
17
# GNU General Public License for more details.
18
18
#
19
19
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
21
22
#
22
# Contact the authors at <mandos@fukt.bsnet.se>.
23
# Contact the authors at <mandos@recompile.se>.
23
24
#
24
25
25
from __future__ import division, absolute_import, with_statement
26
from __future__ import (division, absolute_import, print_function,
27
unicode_literals)
28
try:
29
from future_builtins import *
30
except ImportError:
31
pass
26
32
27
33
import sys
28
34
import os
29
import signal
30
35
31
36
import datetime
32
37
34
39
import urwid
35
40
36
41
from dbus.mainloop.glib import DBusGMainLoop
37
import gobject
42
try:
43
import gobject
44
except ImportError:
45
from gi.repository import GObject as gobject
38
46
39
47
import dbus
40
48
41
import UserList
42
43
49
import locale
44
50
45
locale.setlocale(locale.LC_ALL, u'')
51
if sys.version_info.major == 2:
52
str = unicode
53
54
locale.setlocale(locale.LC_ALL, '')
46
55
47
56
import logging
48
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
49
58
50
59
# Some useful constants
51
domain = 'se.bsnet.fukt'
60
domain = 'se.recompile'
52
61
server_interface = domain + '.Mandos'
53
62
client_interface = domain + '.Mandos.Client'
54
version = "1.2.3"
55
56
# Always run in monochrome mode
57
urwid.curses_display.curses.has_colors = lambda : False
58
59
# Urwid doesn't support blinking, but we want it. Since we have no
60
# use for underline on its own, we make underline also always blink.
61
urwid.curses_display.curses.A_UNDERLINE |= (
62
urwid.curses_display.curses.A_BLINK)
63
version = "1.6.9"
63
64
64
65
def isoformat_to_datetime(iso):
65
66
"Parse an ISO 8601 date string to a datetime.datetime()"
66
67
if not iso:
67
68
return None
68
d, t = iso.split(u"T", 1)
69
year, month, day = d.split(u"-", 2)
70
hour, minute, second = t.split(u":", 2)
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
71
72
second, fraction = divmod(float(second), 1)
72
73
return datetime.datetime(int(year),
73
74
int(month),
82
83
properties and calls a hook function when any of them are
83
84
changed.
84
85
"""
85
def __init__(self, proxy_object=None, *args, **kwargs):
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
86
87
self.proxy = proxy_object # Mandos Client proxy object
87
88
self.properties = dict()
89
self.proxy.connect_to_signal(u"PropertyChanged",
90
self.property_changed,
91
client_interface,
92
byte_arrays=True)
93
94
self.properties.update(
95
self.proxy.GetAll(client_interface,
96
dbus_interface = dbus.PROPERTIES_IFACE))
97
98
#XXX This break good super behaviour!
99
# super(MandosClientPropertyCache, self).__init__(
100
# *args, **kwargs)
88
self.properties = dict() if properties is None else properties
89
self.property_changed_match = (
90
self.proxy.connect_to_signal("PropertiesChanged",
91
self.properties_changed,
92
dbus.PROPERTIES_IFACE,
93
byte_arrays=True))
94
95
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface
99
= dbus.PROPERTIES_IFACE))
100
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
101
102
102
def property_changed(self, property=None, value=None):
103
"""This is called whenever we get a PropertyChanged signal
104
It updates the changed property in the "properties" dict.
103
def properties_changed(self, interface, properties, invalidated):
104
"""This is called whenever we get a PropertiesChanged signal
105
It updates the changed properties in the "properties" dict.
105
106
"""
106
107
# Update properties dict with new value
107
self.properties[property] = value
108
self.properties.update(properties)
109
110
def delete(self):
111
self.property_changed_match.remove()
108
112
109
113
110
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
112
116
"""
113
117
114
118
def __init__(self, server_proxy_object=None, update_hook=None,
115
delete_hook=None, logger=None, *args, **kwargs):
119
delete_hook=None, logger=None, **kwargs):
116
120
# Called on update
117
121
self.update_hook = update_hook
118
122
# Called on delete
123
127
self.logger = logger
124
128
125
129
self._update_timer_callback_tag = None
126
self._update_timer_callback_lock = 0
127
self.last_checker_failed = False
128
130
129
131
# The widget shown normally
130
self._text_widget = urwid.Text(u"")
132
self._text_widget = urwid.Text("")
131
133
# The widget shown when we have focus
132
self._focus_text_widget = urwid.Text(u"")
133
super(MandosClientWidget, self).__init__(
134
update_hook=update_hook, delete_hook=delete_hook,
135
*args, **kwargs)
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
136
136
self.update()
137
137
self.opened = False
138
138
139
last_checked_ok = isoformat_to_datetime(self.properties
140
[u"LastCheckedOK"])
141
if last_checked_ok is None:
142
self.last_checker_failed = True
143
else:
144
self.last_checker_failed = ((datetime.datetime.utcnow()
145
- last_checked_ok)
146
> datetime.timedelta
147
(milliseconds=
148
self.properties
149
[u"Interval"]))
150
151
if self.last_checker_failed:
152
self.using_timer(True)
153
154
if self.need_approval:
155
self.using_timer(True)
156
157
self.proxy.connect_to_signal(u"CheckerCompleted",
158
self.checker_completed,
159
client_interface,
160
byte_arrays=True)
161
self.proxy.connect_to_signal(u"CheckerStarted",
162
self.checker_started,
163
client_interface,
164
byte_arrays=True)
165
self.proxy.connect_to_signal(u"GotSecret",
166
self.got_secret,
167
client_interface,
168
byte_arrays=True)
169
self.proxy.connect_to_signal(u"NeedApproval",
170
self.need_approval,
171
client_interface,
172
byte_arrays=True)
173
self.proxy.connect_to_signal(u"Rejected",
174
self.rejected,
175
client_interface,
176
byte_arrays=True)
139
self.match_objects = (
140
self.proxy.connect_to_signal("CheckerCompleted",
141
self.checker_completed,
142
client_interface,
143
byte_arrays=True),
144
self.proxy.connect_to_signal("CheckerStarted",
145
self.checker_started,
146
client_interface,
147
byte_arrays=True),
148
self.proxy.connect_to_signal("GotSecret",
149
self.got_secret,
150
client_interface,
151
byte_arrays=True),
152
self.proxy.connect_to_signal("NeedApproval",
153
self.need_approval,
154
client_interface,
155
byte_arrays=True),
156
self.proxy.connect_to_signal("Rejected",
157
self.rejected,
158
client_interface,
159
byte_arrays=True))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
177
162
178
def property_changed(self, property=None, value=None):
179
super(self, MandosClientWidget).property_changed(property,
180
value)
181
if property == u"ApprovalPending":
182
using_timer(bool(value))
183
184
163
def using_timer(self, flag):
185
164
"""Call this method with True or False when timer should be
186
165
activated or deactivated.
187
166
"""
188
old = self._update_timer_callback_lock
189
if flag:
190
self._update_timer_callback_lock += 1
191
else:
192
self._update_timer_callback_lock -= 1
193
if old == 0 and self._update_timer_callback_lock:
167
if flag and self._update_timer_callback_tag is None:
168
# Will update the shown timer value every second
194
169
self._update_timer_callback_tag = (gobject.timeout_add
195
170
(1000,
196
171
self.update_timer))
197
elif old and self._update_timer_callback_lock == 0:
172
elif not (flag or self._update_timer_callback_tag is None):
198
173
gobject.source_remove(self._update_timer_callback_tag)
199
174
self._update_timer_callback_tag = None
200
175
201
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, command):
202
177
if exitstatus == 0:
203
if self.last_checker_failed:
204
self.last_checker_failed = False
205
self.using_timer(False)
206
#self.logger(u'Checker for client %s (command "%s")'
207
# u' was successful'
208
# % (self.properties[u"Name"], command))
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
180
command), level=0)
209
181
self.update()
210
182
return
211
183
# Checker failed
212
if not self.last_checker_failed:
213
self.last_checker_failed = True
214
self.using_timer(True)
215
if os.WIFEXITED(condition):
216
self.logger(u'Checker for client %s (command "%s")'
217
u' failed with exit code %s'
218
% (self.properties[u"Name"], command,
219
os.WEXITSTATUS(condition)))
220
elif os.WIFSIGNALED(condition):
221
self.logger(u'Checker for client %s (command "%s")'
222
u' was killed by signal %s'
223
% (self.properties[u"Name"], command,
224
os.WTERMSIG(condition)))
225
elif os.WCOREDUMP(condition):
226
self.logger(u'Checker for client %s (command "%s")'
227
u' dumped core'
228
% (self.properties[u"Name"], command))
184
if exitstatus >= 0:
185
self.logger('Checker for client {} (command "{}") failed'
186
' with exit code {}'
187
.format(self.properties["Name"], command,
188
exitstatus))
189
elif signal != 0:
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
signal))
229
194
else:
230
self.logger(u'Checker for client %s completed'
231
u' mysteriously')
195
self.logger('Checker for client {} completed'
196
' mysteriously'
197
.format(self.properties["Name"]))
232
198
self.update()
233
199
234
200
def checker_started(self, command):
235
#self.logger(u'Client %s started checker "%s"'
236
# % (self.properties[u"Name"], unicode(command)))
237
pass
201
"""Server signals that a checker started."""
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
204
command), level=0)
238
205
239
206
def got_secret(self):
240
self.last_checker_failed = False
241
self.logger(u'Client %s received its secret'
242
% self.properties[u"Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
243
209
244
210
def need_approval(self, timeout, default):
245
211
if not default:
246
message = u'Client %s needs approval within %s seconds'
212
message = 'Client {} needs approval within {} seconds'
247
213
else:
248
message = u'Client %s will get its secret in %s seconds'
249
self.logger(message
250
% (self.properties[u"Name"], timeout/1000))
251
self.using_timer(True)
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
216
timeout/1000))
252
217
253
218
def rejected(self, reason):
254
self.logger(u'Client %s was rejected; reason: %s'
255
% (self.properties[u"Name"], reason))
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
256
221
257
222
def selectable(self):
258
223
"""Make this a "selectable" widget.
259
224
This overrides the method from urwid.FlowWidget."""
260
225
return True
261
226
262
def rows(self, (maxcol,), focus=False):
227
def rows(self, maxcolrow, focus=False):
263
228
"""How many rows this widget will occupy might depend on
264
229
whether we have focus or not.
265
230
This overrides the method from urwid.FlowWidget"""
266
return self.current_widget(focus).rows((maxcol,), focus=focus)
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
267
232
268
233
def current_widget(self, focus=False):
269
234
if focus or self.opened:
273
238
def update(self):
274
239
"Called when what is visible on the screen should be updated."
275
240
# How to add standout mode to a style
276
with_standout = { u"normal": u"standout",
277
u"bold": u"bold-standout",
278
u"underline-blink":
279
u"underline-blink-standout",
280
u"bold-underline-blink":
281
u"bold-underline-blink-standout",
241
with_standout = { "normal": "standout",
242
"bold": "bold-standout",
243
"underline-blink":
244
"underline-blink-standout",
245
"bold-underline-blink":
246
"bold-underline-blink-standout",
282
247
}
283
248
284
249
# Rebuild focus and non-focus widgets using current properties
285
250
286
251
# Base part of a client. Name!
287
base = (u'%(name)s: '
288
% {u"name": self.properties[u"Name"]})
289
if not self.properties[u"Enabled"]:
290
message = u"DISABLED"
291
elif self.properties[u"ApprovalPending"]:
252
base = '{name}: '.format(name=self.properties["Name"])
253
if not self.properties["Enabled"]:
254
message = "DISABLED"
255
self.using_timer(False)
256
elif self.properties["ApprovalPending"]:
292
257
timeout = datetime.timedelta(milliseconds
293
258
= self.properties
294
[u"ApprovalDelay"])
259
["ApprovalDelay"])
295
260
last_approval_request = isoformat_to_datetime(
296
self.properties[u"LastApprovalRequest"])
261
self.properties["LastApprovalRequest"])
297
262
if last_approval_request is not None:
298
timer = timeout - (datetime.datetime.utcnow()
299
- last_approval_request)
263
timer = max(timeout - (datetime.datetime.utcnow()
264
- last_approval_request),
265
datetime.timedelta())
300
266
else:
301
267
timer = datetime.timedelta()
302
if self.properties[u"ApprovedByDefault"]:
303
message = u"Approval in %s. (d)eny?"
304
else:
305
message = u"Denial in %s. (a)pprove?"
306
message = message % unicode(timer).rsplit(".", 1)[0]
307
elif self.last_checker_failed:
308
timeout = datetime.timedelta(milliseconds
309
= self.properties
310
[u"Timeout"])
311
last_ok = isoformat_to_datetime(
312
max((self.properties[u"LastCheckedOK"]
313
or self.properties[u"Created"]),
314
self.properties[u"LastEnabled"]))
315
timer = timeout - (datetime.datetime.utcnow() - last_ok)
316
message = (u'A checker has failed! Time until client'
317
u' gets disabled: %s'
318
% unicode(timer).rsplit(".", 1)[0])
268
if self.properties["ApprovedByDefault"]:
269
message = "Approval in {}. (d)eny?"
270
else:
271
message = "Denial in {}. (a)pprove?"
272
message = message.format(str(timer).rsplit(".", 1)[0])
273
self.using_timer(True)
274
elif self.properties["LastCheckerStatus"] != 0:
275
# When checker has failed, show timer until client expires
276
expires = self.properties["Expires"]
277
if expires == "":
278
timer = datetime.timedelta(0)
279
else:
280
expires = (datetime.datetime.strptime
281
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
282
timer = max(expires - datetime.datetime.utcnow(),
283
datetime.timedelta())
284
message = ('A checker has failed! Time until client'
285
' gets disabled: {}'
286
.format(str(timer).rsplit(".", 1)[0]))
287
self.using_timer(True)
319
288
else:
320
message = u"enabled"
321
self._text = "%s%s" % (base, message)
322
289
message = "enabled"
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
292
323
293
if not urwid.supports_unicode():
324
294
self._text = self._text.encode("ascii", "replace")
325
textlist = [(u"normal", self._text)]
295
textlist = [("normal", self._text)]
326
296
self._text_widget.set_text(textlist)
327
297
self._focus_text_widget.set_text([(with_standout[text[0]],
328
298
text[1])
337
307
self.update_hook()
338
308
339
309
def update_timer(self):
340
"called by gobject"
310
"""called by gobject. Will indefinitely loop until
311
gobject.source_remove() on tag is called"""
341
312
self.update()
342
313
return True # Keep calling this
343
314
344
def delete(self):
315
def delete(self, **kwargs):
345
316
if self._update_timer_callback_tag is not None:
346
317
gobject.source_remove(self._update_timer_callback_tag)
347
318
self._update_timer_callback_tag = None
319
for match in self.match_objects:
320
match.remove()
321
self.match_objects = ()
348
322
if self.delete_hook is not None:
349
323
self.delete_hook(self)
324
return super(MandosClientWidget, self).delete(**kwargs)
350
325
351
def render(self, (maxcol,), focus=False):
326
def render(self, maxcolrow, focus=False):
352
327
"""Render differently if we have focus.
353
328
This overrides the method from urwid.FlowWidget"""
354
return self.current_widget(focus).render((maxcol,),
329
return self.current_widget(focus).render(maxcolrow,
355
330
focus=focus)
356
331
357
def keypress(self, (maxcol,), key):
332
def keypress(self, maxcolrow, key):
358
333
"""Handle keys.
359
334
This overrides the method from urwid.FlowWidget"""
360
if key == u"+":
361
self.proxy.Enable(dbus_interface = client_interface)
362
elif key == u"-":
363
self.proxy.Disable(dbus_interface = client_interface)
364
elif key == u"a":
335
if key == "+":
336
self.proxy.Enable(dbus_interface = client_interface,
337
ignore_reply=True)
338
elif key == "-":
339
self.proxy.Disable(dbus_interface = client_interface,
340
ignore_reply=True)
341
elif key == "a":
365
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
366
dbus_interface = client_interface)
367
elif key == u"d":
343
dbus_interface = client_interface,
344
ignore_reply=True)
345
elif key == "d":
368
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
369
dbus_interface = client_interface)
370
elif key == u"R" or key == u"_" or key == u"ctrl k":
347
dbus_interface = client_interface,
348
ignore_reply=True)
349
elif key == "R" or key == "_" or key == "ctrl k":
371
350
self.server_proxy_object.RemoveClient(self.proxy
372
.object_path)
373
elif key == u"s":
374
self.proxy.StartChecker(dbus_interface = client_interface)
375
elif key == u"S":
376
self.proxy.StopChecker(dbus_interface = client_interface)
377
elif key == u"C":
378
self.proxy.CheckedOK(dbus_interface = client_interface)
351
.object_path,
352
ignore_reply=True)
353
elif key == "s":
354
self.proxy.StartChecker(dbus_interface = client_interface,
355
ignore_reply=True)
356
elif key == "S":
357
self.proxy.StopChecker(dbus_interface = client_interface,
358
ignore_reply=True)
359
elif key == "C":
360
self.proxy.CheckedOK(dbus_interface = client_interface,
361
ignore_reply=True)
379
362
# xxx
380
# elif key == u"p" or key == "=":
363
# elif key == "p" or key == "=":
381
364
# self.proxy.pause()
382
# elif key == u"u" or key == ":":
365
# elif key == "u" or key == ":":
383
366
# self.proxy.unpause()
384
# elif key == u"RET":
367
# elif key == "RET":
385
368
# self.open()
386
369
else:
387
370
return key
388
371
389
def property_changed(self, property=None, value=None,
390
*args, **kwargs):
391
"""Call self.update() if old value is not new value.
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
392
374
This overrides the method from MandosClientPropertyCache"""
393
property_name = unicode(property)
394
old_value = self.properties.get(property_name)
395
super(MandosClientWidget, self).property_changed(
396
property=property, value=value, *args, **kwargs)
397
if self.properties.get(property_name) != old_value:
375
old_values = { key: self.properties.get(key)
376
for key in properties.keys() }
377
super(MandosClientWidget, self).properties_changed(
378
interface, properties, invalidated)
379
if any(old_values[key] != self.properties.get(key)
380
for key in old_values):
398
381
self.update()
399
382
400
383
403
386
"down" key presses, thus not allowing any containing widgets to
404
387
use them as an excuse to shift focus away from this widget.
405
388
"""
406
def keypress(self, (maxcol, maxrow), key):
407
ret = super(ConstrainedListBox, self).keypress((maxcol,
408
maxrow), key)
409
if ret in (u"up", u"down"):
389
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
391
if ret in ("up", "down"):
410
392
return
411
393
return ret
412
394
415
397
"""This is the entire user interface - the whole screen
416
398
with boxes, lists of client widgets, etc.
417
399
"""
418
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
419
401
DBusGMainLoop(set_as_default=True)
420
402
421
403
self.screen = urwid.curses_display.Screen()
422
404
423
405
self.screen.register_palette((
424
(u"normal",
425
u"default", u"default", None),
426
(u"bold",
427
u"default", u"default", u"bold"),
428
(u"underline-blink",
429
u"default", u"default", u"underline"),
430
(u"standout",
431
u"default", u"default", u"standout"),
432
(u"bold-underline-blink",
433
u"default", u"default", (u"bold", u"underline")),
434
(u"bold-standout",
435
u"default", u"default", (u"bold", u"standout")),
436
(u"underline-blink-standout",
437
u"default", u"default", (u"underline", u"standout")),
438
(u"bold-underline-blink-standout",
439
u"default", u"default", (u"bold", u"underline",
440
u"standout")),
406
("normal",
407
"default", "default", None),
408
("bold",
409
"bold", "default", "bold"),
410
("underline-blink",
411
"underline,blink", "default", "underline,blink"),
412
("standout",
413
"standout", "default", "standout"),
414
("bold-underline-blink",
415
"bold,underline,blink", "default", "bold,underline,blink"),
416
("bold-standout",
417
"bold,standout", "default", "bold,standout"),
418
("underline-blink-standout",
419
"underline,blink,standout", "default",
420
"underline,blink,standout"),
421
("bold-underline-blink-standout",
422
"bold,underline,blink,standout", "default",
423
"bold,underline,blink,standout"),
441
424
))
442
425
443
426
if urwid.supports_unicode():
444
self.divider = u"─" # \u2500
445
#self.divider = u"━" # \u2501
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
446
429
else:
447
#self.divider = u"-" # \u002d
448
self.divider = u"_" # \u005f
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
449
432
450
433
self.screen.start()
451
434
458
441
self.log = []
459
442
self.max_log_length = max_log_length
460
443
444
self.log_level = log_level
445
461
446
# We keep a reference to the log widget so we can remove it
462
447
# from the ListWalker without it getting destroyed
463
448
self.logbox = ConstrainedListBox(self.log)
465
450
# This keeps track of whether self.uilist currently has
466
451
# self.logbox in it or not
467
452
self.log_visible = True
468
self.log_wrap = u"any"
453
self.log_wrap = "any"
469
454
470
455
self.rebuild()
471
self.log_message_raw((u"bold",
472
u"Mandos Monitor version " + version))
473
self.log_message_raw((u"bold",
474
u"q: Quit ?: Help"))
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
459
"q: Quit ?: Help"))
475
460
476
461
self.busname = domain + '.Mandos'
477
462
self.main_loop = gobject.MainLoop()
478
self.bus = dbus.SystemBus()
479
mandos_dbus_objc = self.bus.get_object(
480
self.busname, u"/", follow_name_owner_changes=True)
481
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
482
dbus_interface
483
= server_interface)
484
try:
485
mandos_clients = (self.mandos_serv
486
.GetAllClientsWithProperties())
487
except dbus.exceptions.DBusException:
488
mandos_clients = dbus.Dictionary()
489
490
(self.mandos_serv
491
.connect_to_signal(u"ClientRemoved",
492
self.find_and_remove_client,
493
dbus_interface=server_interface,
494
byte_arrays=True))
495
(self.mandos_serv
496
.connect_to_signal(u"ClientAdded",
497
self.add_new_client,
498
dbus_interface=server_interface,
499
byte_arrays=True))
500
(self.mandos_serv
501
.connect_to_signal(u"ClientNotFound",
502
self.client_not_found,
503
dbus_interface=server_interface,
504
byte_arrays=True))
505
for path, client in mandos_clients.iteritems():
506
client_proxy_object = self.bus.get_object(self.busname,
507
path)
508
self.add_client(MandosClientWidget(server_proxy_object
509
=self.mandos_serv,
510
proxy_object
511
=client_proxy_object,
512
properties=client,
513
update_hook
514
=self.refresh,
515
delete_hook
516
=self.remove_client,
517
logger
518
=self.log_message),
519
path=path)
520
463
521
464
def client_not_found(self, fingerprint, address):
522
self.log_message((u"Client with address %s and fingerprint %s"
523
u" could not be found" % (address,
524
fingerprint)))
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
525
468
526
469
def rebuild(self):
527
470
"""This rebuilds the User Interface.
537
480
self.divider)))
538
481
if self.log_visible:
539
482
self.uilist.append(self.logbox)
540
pass
541
483
self.topwidget = urwid.Pile(self.uilist)
542
484
543
def log_message(self, message):
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
488
return
544
489
timestamp = datetime.datetime.now().isoformat()
545
self.log_message_raw(timestamp + u": " + message)
490
self.log_message_raw("{}: {}".format(timestamp, message),
491
level=level)
546
492
547
def log_message_raw(self, markup):
493
def log_message_raw(self, markup, level=1):
548
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
496
return
549
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
550
498
if (self.max_log_length
551
499
and len(self.log) > self.max_log_length):
552
500
del self.log[0:len(self.log)-self.max_log_length-1]
553
501
self.logbox.set_focus(len(self.logbox.body.contents),
554
coming_from=u"above")
502
coming_from="above")
555
503
self.refresh()
556
504
557
505
def toggle_log_display(self):
558
506
"""Toggle visibility of the log buffer."""
559
507
self.log_visible = not self.log_visible
560
508
self.rebuild()
561
#self.log_message(u"Log visibility changed to: "
562
# + unicode(self.log_visible))
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
563
511
564
512
def change_log_display(self):
565
513
"""Change type of log display.
566
514
Currently, this toggles wrapping of text lines."""
567
if self.log_wrap == u"clip":
568
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
569
517
else:
570
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
571
519
for textwidget in self.log:
572
520
textwidget.set_wrap_mode(self.log_wrap)
573
#self.log_message(u"Wrap mode: " + self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
522
level=0)
574
523
575
524
def find_and_remove_client(self, path, name):
576
"""Find an client from its object path and remove it.
525
"""Find a client by its object path and remove it.
577
526
578
527
This is connected to the ClientRemoved signal from the
579
528
Mandos server object."""
581
530
client = self.clients_dict[path]
582
531
except KeyError:
583
532
# not found?
533
self.log_message("Unknown client {!r} ({!r}) removed"
534
.format(name, path))
584
535
return
585
self.remove_client(client, path)
536
client.delete()
586
537
587
538
def add_new_client(self, path):
588
539
client_proxy_object = self.bus.get_object(self.busname, path)
603
554
if path is None:
604
555
path = client.proxy.object_path
605
556
self.clients_dict[path] = client
606
self.clients.sort(None, lambda c: c.properties[u"Name"])
557
self.clients.sort(key=lambda c: c.properties["Name"])
607
558
self.refresh()
608
559
609
560
def remove_client(self, client, path=None):
611
562
if path is None:
612
563
path = client.proxy.object_path
613
564
del self.clients_dict[path]
614
if not self.clients_dict:
615
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
616
# is completely emptied, we need to recreate it.
617
self.clients = urwid.SimpleListWalker([])
618
self.rebuild()
619
565
self.refresh()
620
566
621
567
def refresh(self):
625
571
626
572
def run(self):
627
573
"""Start the main loop and exit when it's done."""
574
self.bus = dbus.SystemBus()
575
mandos_dbus_objc = self.bus.get_object(
576
self.busname, "/", follow_name_owner_changes=True)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
578
dbus_interface
579
= server_interface)
580
try:
581
mandos_clients = (self.mandos_serv
582
.GetAllClientsWithProperties())
583
if not mandos_clients:
584
self.log_message_raw(("bold", "Note: Server has no clients."))
585
except dbus.exceptions.DBusException:
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
587
mandos_clients = dbus.Dictionary()
588
589
(self.mandos_serv
590
.connect_to_signal("ClientRemoved",
591
self.find_and_remove_client,
592
dbus_interface=server_interface,
593
byte_arrays=True))
594
(self.mandos_serv
595
.connect_to_signal("ClientAdded",
596
self.add_new_client,
597
dbus_interface=server_interface,
598
byte_arrays=True))
599
(self.mandos_serv
600
.connect_to_signal("ClientNotFound",
601
self.client_not_found,
602
dbus_interface=server_interface,
603
byte_arrays=True))
604
for path, client in mandos_clients.items():
605
client_proxy_object = self.bus.get_object(self.busname,
606
path)
607
self.add_client(MandosClientWidget(server_proxy_object
608
=self.mandos_serv,
609
proxy_object
610
=client_proxy_object,
611
properties=client,
612
update_hook
613
=self.refresh,
614
delete_hook
615
=self.remove_client,
616
logger
617
=self.log_message),
618
path=path)
619
628
620
self.refresh()
629
621
self._input_callback_tag = (gobject.io_add_watch
630
622
(sys.stdin.fileno(),
640
632
641
633
def process_input(self, source, condition):
642
634
keys = self.screen.get_input()
643
translations = { u"ctrl n": u"down", # Emacs
644
u"ctrl p": u"up", # Emacs
645
u"ctrl v": u"page down", # Emacs
646
u"meta v": u"page up", # Emacs
647
u" ": u"page down", # less
648
u"f": u"page down", # less
649
u"b": u"page up", # less
650
u"j": u"down", # vi
651
u"k": u"up", # vi
635
translations = { "ctrl n": "down", # Emacs
636
"ctrl p": "up", # Emacs
637
"ctrl v": "page down", # Emacs
638
"meta v": "page up", # Emacs
639
" ": "page down", # less
640
"f": "page down", # less
641
"b": "page up", # less
642
"j": "down", # vi
643
"k": "up", # vi
652
644
}
653
645
for key in keys:
654
646
try:
656
648
except KeyError: # :-)
657
649
pass
658
650
659
if key == u"q" or key == u"Q":
651
if key == "q" or key == "Q":
660
652
self.stop()
661
653
break
662
elif key == u"window resize":
654
elif key == "window resize":
663
655
self.size = self.screen.get_cols_rows()
664
656
self.refresh()
665
elif key == u"\f": # Ctrl-L
657
elif key == "ctrl l":
658
self.screen.clear()
666
659
self.refresh()
667
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
668
661
self.toggle_log_display()
669
662
self.refresh()
670
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
671
664
self.change_log_display()
672
665
self.refresh()
673
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
674
667
if not self.log_visible:
675
668
self.log_visible = True
676
669
self.rebuild()
677
self.log_message_raw((u"bold",
678
u" ".
679
join((u"q: Quit",
680
u"?: Help",
681
u"l: Log window toggle",
682
u"TAB: Switch window",
683
u"w: Wrap (log)"))))
684
self.log_message_raw((u"bold",
685
u" "
686
.join((u"Clients:",
687
u"+: Enable",
688
u"-: Disable",
689
u"R: Remove",
690
u"s: Start new checker",
691
u"S: Stop checker",
692
u"C: Checker OK",
693
u"a: Approve",
694
u"d: Deny"))))
670
self.log_message_raw(("bold",
671
" ".
672
join(("q: Quit",
673
"?: Help",
674
"l: Log window toggle",
675
"TAB: Switch window",
676
"w: Wrap (log lines)",
677
"v: Toggle verbose log",
678
))))
679
self.log_message_raw(("bold",
680
" "
681
.join(("Clients:",
682
"+: Enable",
683
"-: Disable",
684
"R: Remove",
685
"s: Start new checker",
686
"S: Stop checker",
687
"C: Checker OK",
688
"a: Approve",
689
"d: Deny"))))
695
690
self.refresh()
696
elif key == u"tab":
691
elif key == "tab":
697
692
if self.topwidget.get_focus() is self.logbox:
698
693
self.topwidget.set_focus(0)
699
694
else:
700
695
self.topwidget.set_focus(self.logbox)
701
696
self.refresh()
702
#elif (key == u"end" or key == u"meta >" or key == u"G"
703
# or key == u">"):
697
elif key == "v":
698
if self.log_level == 0:
699
self.log_level = 1
700
self.log_message("Verbose mode: Off")
701
else:
702
self.log_level = 0
703
self.log_message("Verbose mode: On")
704
#elif (key == "end" or key == "meta >" or key == "G"
705
# or key == ">"):
704
706
# pass # xxx end-of-buffer
705
#elif (key == u"home" or key == u"meta <" or key == u"g"
706
# or key == u"<"):
707
#elif (key == "home" or key == "meta <" or key == "g"
708
# or key == "<"):
707
709
# pass # xxx beginning-of-buffer
708
#elif key == u"ctrl e" or key == u"$":
710
#elif key == "ctrl e" or key == "$":
709
711
# pass # xxx move-end-of-line
710
#elif key == u"ctrl a" or key == u"^":
712
#elif key == "ctrl a" or key == "^":
711
713
# pass # xxx move-beginning-of-line
712
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
713
715
# pass # xxx left
714
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
715
717
# pass # xxx right
716
#elif key == u"a":
718
#elif key == "a":
717
719
# pass # scroll up log
718
#elif key == u"z":
720
#elif key == "z":
719
721
# pass # scroll down log
720
722
elif self.topwidget.selectable():
721
723
self.topwidget.keypress(self.size, key)
727
729
ui.run()
728
730
except KeyboardInterrupt:
729
731
ui.screen.stop()
730
except Exception, e:
731
ui.log_message(unicode(e))
732
except Exception as e:
733
ui.log_message(str(e))
732
734
ui.screen.stop()
733
735
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0