2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 Björn Påhlsson
9
# This program is free software: you can redistribute it and/or modify
10
# it under the terms of the GNU General Public License as published by
11
# the Free Software Foundation, either version 3 of the License, or
12
# (at your option) any later version.
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
# GNU General Public License for more details.
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/>.
22
# Contact the authors at <mandos@recompile.se>.
25
from __future__ import (division, absolute_import, print_function,
4
from __future__ import division, absolute_import, with_statement
34
9
import urwid.curses_display
62
30
urwid.curses_display.curses.A_UNDERLINE |= (
63
31
urwid.curses_display.curses.A_BLINK)
65
def isoformat_to_datetime(iso):
66
"Parse an ISO 8601 date string to a datetime.datetime()"
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
72
second, fraction = divmod(float(second), 1)
73
return datetime.datetime(int(year),
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
81
33
class MandosClientPropertyCache(object):
82
34
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
35
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, *args, **kwargs):
38
def __init__(self, proxy_object=None, properties=None, *args,
87
40
self.proxy = proxy_object # Mandos Client proxy object
89
self.properties = dict()
90
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
42
if properties is None:
43
self.properties = dict()
45
self.properties = properties
46
self.proxy.connect_to_signal("PropertyChanged",
47
self.property_changed,
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
51
if properties is None:
52
self.properties.update(self.proxy.GetAll(client_interface,
54
dbus.PROPERTIES_IFACE))
55
super(MandosClientPropertyCache, self).__init__(
56
proxy_object=proxy_object,
57
properties=properties, *args, **kwargs)
104
59
def property_changed(self, property=None, value=None):
105
60
"""This is called whenever we get a PropertyChanged signal
121
71
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, *args, **kwargs):
72
delete_hook=None, *args, **kwargs):
123
73
# Called on update
124
74
self.update_hook = update_hook
125
75
# Called on delete
126
76
self.delete_hook = delete_hook
127
77
# Mandos Server proxy object
128
78
self.server_proxy_object = server_proxy_object
132
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
135
80
# The widget shown normally
136
81
self._text_widget = urwid.Text("")
143
88
self.opened = False
145
last_checked_ok = isoformat_to_datetime(self.properties
148
if self.properties ["LastCheckerStatus"] != 0:
149
self.using_timer(True)
151
if self.need_approval:
152
self.using_timer(True)
154
self.match_objects = (
155
self.proxy.connect_to_signal("CheckerCompleted",
156
self.checker_completed,
159
self.proxy.connect_to_signal("CheckerStarted",
160
self.checker_started,
163
self.proxy.connect_to_signal("GotSecret",
167
self.proxy.connect_to_signal("NeedApproval",
171
self.proxy.connect_to_signal("Rejected",
175
#self.logger('Created client {0}'
176
# .format(self.properties["Name"]))
178
def property_changed(self, property=None, value=None):
179
super(self, MandosClientWidget).property_changed(property,
181
if property == "ApprovalPending":
182
using_timer(bool(value))
183
if property == "LastCheckerStatus":
184
using_timer(value != 0)
185
#self.logger('Checker for client {0} (command "{1}") was '
186
# ' successful'.format(self.properties["Name"],
189
def using_timer(self, flag):
190
"""Call this method with True or False when timer should be
191
activated or deactivated.
193
old = self._update_timer_callback_lock
195
self._update_timer_callback_lock += 1
197
self._update_timer_callback_lock -= 1
198
if old == 0 and self._update_timer_callback_lock:
199
# Will update the shown timer value every second
200
self._update_timer_callback_tag = (gobject.timeout_add
203
elif old and self._update_timer_callback_lock == 0:
204
gobject.source_remove(self._update_timer_callback_tag)
205
self._update_timer_callback_tag = None
207
def checker_completed(self, exitstatus, condition, command):
212
if os.WIFEXITED(condition):
213
self.logger('Checker for client {0} (command "{1}")'
214
' failed with exit code {2}'
215
.format(self.properties["Name"], command,
216
os.WEXITSTATUS(condition)))
217
elif os.WIFSIGNALED(condition):
218
self.logger('Checker for client {0} (command "{1}") was'
219
' killed by signal {2}'
220
.format(self.properties["Name"], command,
221
os.WTERMSIG(condition)))
222
elif os.WCOREDUMP(condition):
223
self.logger('Checker for client {0} (command "{1}")'
225
.format(self.properties["Name"], command))
227
self.logger('Checker for client {0} completed'
229
.format(self.properties["Name"]))
232
def checker_started(self, command):
233
"""Server signals that a checker started. This could be useful
234
to log in the future. """
235
#self.logger('Client {0} started checker "{1}"'
236
# .format(self.properties["Name"],
240
def got_secret(self):
241
self.logger('Client {0} received its secret'
242
.format(self.properties["Name"]))
244
def need_approval(self, timeout, default):
246
message = 'Client {0} needs approval within {1} seconds'
248
message = 'Client {0} will get its secret in {1} seconds'
249
self.logger(message.format(self.properties["Name"],
251
self.using_timer(True)
253
def rejected(self, reason):
254
self.logger('Client {0} was rejected; reason: {1}'
255
.format(self.properties["Name"], reason))
257
90
def selectable(self):
258
91
"""Make this a "selectable" widget.
259
92
This overrides the method from urwid.FlowWidget."""
262
def rows(self, maxcolrow, focus=False):
95
def rows(self, (maxcol,), focus=False):
263
96
"""How many rows this widget will occupy might depend on
264
97
whether we have focus or not.
265
98
This overrides the method from urwid.FlowWidget"""
266
return self.current_widget(focus).rows(maxcolrow, focus=focus)
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
268
101
def current_widget(self, focus=False):
269
102
if focus or self.opened:
273
106
def update(self):
274
107
"Called when what is visible on the screen should be updated."
275
108
# How to add standout mode to a style
276
with_standout = { "normal": "standout",
277
"bold": "bold-standout",
279
"underline-blink-standout",
280
"bold-underline-blink":
281
"bold-underline-blink-standout",
109
with_standout = { u"normal": u"standout",
110
u"bold": u"bold-standout",
112
u"underline-blink-standout",
113
u"bold-underline-blink":
114
u"bold-underline-blink-standout",
284
117
# Rebuild focus and non-focus widgets using current properties
286
# Base part of a client. Name!
287
base = '{name}: '.format(name=self.properties["Name"])
288
if not self.properties["Enabled"]:
290
elif self.properties["ApprovalPending"]:
291
timeout = datetime.timedelta(milliseconds
294
last_approval_request = isoformat_to_datetime(
295
self.properties["LastApprovalRequest"])
296
if last_approval_request is not None:
297
timer = timeout - (datetime.datetime.utcnow()
298
- last_approval_request)
300
timer = datetime.timedelta()
301
if self.properties["ApprovedByDefault"]:
302
message = "Approval in {0}. (d)eny?"
304
message = "Denial in {0}. (a)pprove?"
305
message = message.format(unicode(timer).rsplit(".", 1)[0])
306
elif self.properties["LastCheckerStatus"] != 0:
307
# When checker has failed, print a timer until client expires
308
expires = self.properties["Expires"]
310
timer = datetime.timedelta(0)
312
expires = datetime.datetime.strptime(expires,
313
'%Y-%m-%dT%H:%M:%S.%f')
314
timer = expires - datetime.datetime.utcnow()
315
message = ('A checker has failed! Time until client'
316
' gets disabled: {0}'
317
.format(unicode(timer).rsplit(".", 1)[0]))
320
self._text = "{0}{1}".format(base, message)
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
322
120
if not urwid.supports_unicode():
323
121
self._text = self._text.encode("ascii", "replace")
324
textlist = [("normal", self._text)]
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
325
123
self._text_widget.set_text(textlist)
326
124
self._focus_text_widget.set_text([(with_standout[text[0]],
335
133
if self.update_hook is not None:
336
134
self.update_hook()
338
def update_timer(self):
339
"""called by gobject. Will indefinitely loop until
340
gobject.source_remove() on tag is called"""
342
return True # Keep calling this
344
def delete(self, *args, **kwargs):
345
if self._update_timer_callback_tag is not None:
346
gobject.source_remove(self._update_timer_callback_tag)
347
self._update_timer_callback_tag = None
348
for match in self.match_objects:
350
self.match_objects = ()
351
137
if self.delete_hook is not None:
352
138
self.delete_hook(self)
353
return super(MandosClientWidget, self).delete(*args, **kwargs)
355
def render(self, maxcolrow, focus=False):
140
def render(self, (maxcol,), focus=False):
356
141
"""Render differently if we have focus.
357
142
This overrides the method from urwid.FlowWidget"""
358
return self.current_widget(focus).render(maxcolrow,
143
return self.current_widget(focus).render((maxcol,),
361
def keypress(self, maxcolrow, key):
146
def keypress(self, (maxcol,), key):
363
148
This overrides the method from urwid.FlowWidget"""
365
self.proxy.Enable(dbus_interface = client_interface,
368
self.proxy.Disable(dbus_interface = client_interface,
371
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
372
dbus_interface = client_interface,
375
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
376
dbus_interface = client_interface,
378
elif key == "R" or key == "_" or key == "ctrl k":
149
if key == u"e" or key == u"+":
151
elif key == u"d" or key == u"-":
153
elif key == u"r" or key == u"_" or key == u"ctrl k":
379
154
self.server_proxy_object.RemoveClient(self.proxy
383
self.proxy.StartChecker(dbus_interface = client_interface,
386
self.proxy.StopChecker(dbus_interface = client_interface,
389
self.proxy.CheckedOK(dbus_interface = client_interface,
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
392
# elif key == "p" or key == "=":
163
# elif key == u"p" or key == "=":
393
164
# self.proxy.pause()
394
# elif key == "u" or key == ":":
165
# elif key == u"u" or key == ":":
395
166
# self.proxy.unpause()
167
# elif key == u"RET":
415
186
"down" key presses, thus not allowing any containing widgets to
416
187
use them as an excuse to shift focus away from this widget.
418
def keypress(self, maxcolrow, key):
419
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
420
if ret in ("up", "down"):
189
def keypress(self, (maxcol, maxrow), key):
190
ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
191
if ret in (u"up", u"down"):
432
203
self.screen = urwid.curses_display.Screen()
434
205
self.screen.register_palette((
436
"default", "default", None),
438
"default", "default", "bold"),
440
"default", "default", "underline"),
442
"default", "default", "standout"),
443
("bold-underline-blink",
444
"default", "default", ("bold", "underline")),
446
"default", "default", ("bold", "standout")),
447
("underline-blink-standout",
448
"default", "default", ("underline", "standout")),
449
("bold-underline-blink-standout",
450
"default", "default", ("bold", "underline",
207
u"default", u"default", None),
209
u"default", u"default", u"bold"),
211
u"default", u"default", u"underline"),
213
u"default", u"default", u"standout"),
214
(u"bold-underline-blink",
215
u"default", u"default", (u"bold", u"underline")),
217
u"default", u"default", (u"bold", u"standout")),
218
(u"underline-blink-standout",
219
u"default", u"default", (u"underline", u"standout")),
220
(u"bold-underline-blink-standout",
221
u"default", u"default", (u"bold", u"underline",
454
225
if urwid.supports_unicode():
455
self.divider = "─" # \u2500
456
#self.divider = "━" # \u2501
226
self.divider = u"─" # \u2500
227
#self.divider = u"━" # \u2501
458
#self.divider = "-" # \u002d
459
self.divider = "_" # \u005f
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
461
232
self.screen.start()
476
247
# This keeps track of whether self.uilist currently has
477
248
# self.logbox in it or not
478
249
self.log_visible = True
479
self.log_wrap = "any"
250
self.log_wrap = u"any"
482
self.log_message_raw(("bold",
483
"Mandos Monitor version " + version))
484
self.log_message_raw(("bold",
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
487
258
self.busname = domain + '.Mandos'
488
259
self.main_loop = gobject.MainLoop()
490
def client_not_found(self, fingerprint, address):
491
self.log_message("Client with address {0} and fingerprint"
492
" {1} could not be found"
493
.format(address, fingerprint))
260
self.bus = dbus.SystemBus()
261
mandos_dbus_objc = self.bus.get_object(
262
self.busname, u"/", follow_name_owner_changes=True)
263
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
267
mandos_clients = (self.mandos_serv
268
.GetAllClientsWithProperties())
269
except dbus.exceptions.DBusException:
270
mandos_clients = dbus.Dictionary()
273
.connect_to_signal("ClientRemoved",
274
self.find_and_remove_client,
275
dbus_interface=server_interface,
278
.connect_to_signal("ClientAdded",
280
dbus_interface=server_interface,
282
for path, client in mandos_clients.iteritems():
283
client_proxy_object = self.bus.get_object(self.busname,
285
self.add_client(MandosClientWidget(server_proxy_object
288
=client_proxy_object,
293
=self.remove_client),
495
296
def rebuild(self):
496
297
"""This rebuilds the User Interface.
497
298
Call this when the widget layout needs to change"""
499
300
#self.uilist.append(urwid.ListBox(self.clients))
500
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
502
302
#header=urwid.Divider(),
505
urwid.Divider(div_char=
304
footer=urwid.Divider(div_char=self.divider)))
507
305
if self.log_visible:
508
306
self.uilist.append(self.logbox)
509
308
self.topwidget = urwid.Pile(self.uilist)
511
def log_message(self, message):
512
timestamp = datetime.datetime.now().isoformat()
513
self.log_message_raw(timestamp + ": " + message)
515
def log_message_raw(self, markup):
310
def log_message(self, markup):
516
311
"""Add a log message to the log buffer."""
517
312
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
518
313
if (self.max_log_length
519
314
and len(self.log) > self.max_log_length):
520
315
del self.log[0:len(self.log)-self.max_log_length-1]
521
316
self.logbox.set_focus(len(self.logbox.body.contents),
317
coming_from=u"above")
525
319
def toggle_log_display(self):
526
320
"""Toggle visibility of the log buffer."""
527
321
self.log_visible = not self.log_visible
529
#self.log_message("Log visibility changed to: "
530
# + unicode(self.log_visible))
323
self.log_message(u"Log visibility changed to: "
324
+ unicode(self.log_visible))
532
326
def change_log_display(self):
533
327
"""Change type of log display.
534
328
Currently, this toggles wrapping of text lines."""
535
if self.log_wrap == "clip":
536
self.log_wrap = "any"
329
if self.log_wrap == u"clip":
330
self.log_wrap = u"any"
538
self.log_wrap = "clip"
332
self.log_wrap = u"clip"
539
333
for textwidget in self.log:
540
334
textwidget.set_wrap_mode(self.log_wrap)
541
#self.log_message("Wrap mode: " + self.log_wrap)
335
self.log_message(u"Wrap mode: " + self.log_wrap)
543
337
def find_and_remove_client(self, path, name):
544
"""Find a client by its object path and remove it.
338
"""Find an client from its object path and remove it.
546
340
This is connected to the ClientRemoved signal from the
547
341
Mandos server object."""
597
388
"""Start the main loop and exit when it's done."""
598
self.bus = dbus.SystemBus()
599
mandos_dbus_objc = self.bus.get_object(
600
self.busname, "/", follow_name_owner_changes=True)
601
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
605
mandos_clients = (self.mandos_serv
606
.GetAllClientsWithProperties())
607
except dbus.exceptions.DBusException:
608
mandos_clients = dbus.Dictionary()
611
.connect_to_signal("ClientRemoved",
612
self.find_and_remove_client,
613
dbus_interface=server_interface,
616
.connect_to_signal("ClientAdded",
618
dbus_interface=server_interface,
621
.connect_to_signal("ClientNotFound",
622
self.client_not_found,
623
dbus_interface=server_interface,
625
for path, client in mandos_clients.iteritems():
626
client_proxy_object = self.bus.get_object(self.busname,
628
self.add_client(MandosClientWidget(server_proxy_object
631
=client_proxy_object,
642
390
self._input_callback_tag = (gobject.io_add_watch
643
391
(sys.stdin.fileno(),
654
402
def process_input(self, source, condition):
655
403
keys = self.screen.get_input()
656
translations = { "ctrl n": "down", # Emacs
657
"ctrl p": "up", # Emacs
658
"ctrl v": "page down", # Emacs
659
"meta v": "page up", # Emacs
660
" ": "page down", # less
661
"f": "page down", # less
662
"b": "page up", # less
404
translations = { u"ctrl n": u"down", # Emacs
405
u"ctrl p": u"up", # Emacs
406
u"ctrl v": u"page down", # Emacs
407
u"meta v": u"page up", # Emacs
408
u" ": u"page down", # less
409
u"f": u"page down", # less
410
u"b": u"page up", # less
669
417
except KeyError: # :-)
672
if key == "q" or key == "Q":
420
if key == u"q" or key == u"Q":
675
elif key == "window resize":
423
elif key == u"window resize":
676
424
self.size = self.screen.get_cols_rows()
678
elif key == "\f": # Ctrl-L
426
elif key == u"\f": # Ctrl-L
680
elif key == "l" or key == "D":
428
elif key == u"l" or key == u"D":
681
429
self.toggle_log_display()
683
elif key == "w" or key == "i":
431
elif key == u"w" or key == u"i":
684
432
self.change_log_display()
686
elif key == "?" or key == "f1" or key == "esc":
434
elif key == u"?" or key == u"f1" or key == u"esc":
687
435
if not self.log_visible:
688
436
self.log_visible = True
690
self.log_message_raw(("bold",
694
"l: Log window toggle",
695
"TAB: Switch window",
697
self.log_message_raw(("bold",
703
"s: Start new checker",
438
self.log_message((u"bold",
439
u" ".join((u"q: Quit",
441
u"l: Log window toggle",
442
u"TAB: Switch window",
444
self.log_message((u"bold",
445
u" ".join((u"Clients:",
449
u"s: Start new checker",
710
454
if self.topwidget.get_focus() is self.logbox:
711
455
self.topwidget.set_focus(0)
713
457
self.topwidget.set_focus(self.logbox)
715
#elif (key == "end" or key == "meta >" or key == "G"
459
#elif (key == u"end" or key == u"meta >" or key == u"G"
717
461
# pass # xxx end-of-buffer
718
#elif (key == "home" or key == "meta <" or key == "g"
462
#elif (key == u"home" or key == u"meta <" or key == u"g"
720
464
# pass # xxx beginning-of-buffer
721
#elif key == "ctrl e" or key == "$":
465
#elif key == u"ctrl e" or key == u"$":
722
466
# pass # xxx move-end-of-line
723
#elif key == "ctrl a" or key == "^":
467
#elif key == u"ctrl a" or key == u"^":
724
468
# pass # xxx move-beginning-of-line
725
#elif key == "ctrl b" or key == "meta (" or key == "h":
469
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
726
470
# pass # xxx left
727
#elif key == "ctrl f" or key == "meta )" or key == "l":
471
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
728
472
# pass # xxx right
730
474
# pass # scroll up log
732
476
# pass # scroll down log
733
477
elif self.topwidget.selectable():
734
478
self.topwidget.keypress(self.size, key)