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
21
# <http://www.gnu.org/licenses/>.
23
# Contact the authors at <mandos@recompile.se>.
26
from __future__ import (division, absolute_import, print_function,
4
from __future__ import division, absolute_import, with_statement
35
9
import urwid.curses_display
63
30
urwid.curses_display.curses.A_UNDERLINE |= (
64
31
urwid.curses_display.curses.A_BLINK)
66
def isoformat_to_datetime(iso):
67
"Parse an ISO 8601 date string to a datetime.datetime()"
70
d, t = iso.split("T", 1)
71
year, month, day = d.split("-", 2)
72
hour, minute, second = t.split(":", 2)
73
second, fraction = divmod(float(second), 1)
74
return datetime.datetime(int(year),
79
int(second), # Whole seconds
80
int(fraction*1000000)) # Microseconds
82
33
class MandosClientPropertyCache(object):
83
34
"""This wraps a Mandos Client D-Bus proxy object, caches the
84
35
properties and calls a hook function when any of them are
87
def __init__(self, proxy_object=None, *args, **kwargs):
38
def __init__(self, proxy_object=None, properties=None, *args,
88
40
self.proxy = proxy_object # Mandos Client proxy object
90
self.properties = dict()
91
self.property_changed_match = (
92
self.proxy.connect_to_signal("PropertyChanged",
93
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,
97
self.properties.update(
98
self.proxy.GetAll(client_interface,
99
dbus_interface = dbus.PROPERTIES_IFACE))
101
#XXX This breaks good super behaviour
102
# 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)
105
59
def property_changed(self, property=None, value=None):
106
60
"""This is called whenever we get a PropertyChanged signal
122
71
def __init__(self, server_proxy_object=None, update_hook=None,
123
delete_hook=None, logger=None, *args, **kwargs):
72
delete_hook=None, *args, **kwargs):
124
73
# Called on update
125
74
self.update_hook = update_hook
126
75
# Called on delete
127
76
self.delete_hook = delete_hook
128
77
# Mandos Server proxy object
129
78
self.server_proxy_object = server_proxy_object
133
self._update_timer_callback_tag = None
134
self._update_timer_callback_lock = 0
136
80
# The widget shown normally
137
81
self._text_widget = urwid.Text("")
144
88
self.opened = False
146
last_checked_ok = isoformat_to_datetime(self.properties
149
if self.properties ["LastCheckerStatus"] != 0:
150
self.using_timer(True)
152
if self.need_approval:
153
self.using_timer(True)
155
self.match_objects = (
156
self.proxy.connect_to_signal("CheckerCompleted",
157
self.checker_completed,
160
self.proxy.connect_to_signal("CheckerStarted",
161
self.checker_started,
164
self.proxy.connect_to_signal("GotSecret",
168
self.proxy.connect_to_signal("NeedApproval",
172
self.proxy.connect_to_signal("Rejected",
176
#self.logger('Created client {0}'
177
# .format(self.properties["Name"]))
179
def property_changed(self, property=None, value=None):
180
super(self, MandosClientWidget).property_changed(property,
182
if property == "ApprovalPending":
183
using_timer(bool(value))
184
if property == "LastCheckerStatus":
185
using_timer(value != 0)
186
#self.logger('Checker for client {0} (command "{1}") was '
187
# ' successful'.format(self.properties["Name"],
190
def using_timer(self, flag):
191
"""Call this method with True or False when timer should be
192
activated or deactivated.
194
old = self._update_timer_callback_lock
196
self._update_timer_callback_lock += 1
198
self._update_timer_callback_lock -= 1
199
if old == 0 and self._update_timer_callback_lock:
200
# Will update the shown timer value every second
201
self._update_timer_callback_tag = (gobject.timeout_add
204
elif old and self._update_timer_callback_lock == 0:
205
gobject.source_remove(self._update_timer_callback_tag)
206
self._update_timer_callback_tag = None
208
def checker_completed(self, exitstatus, condition, command):
213
if os.WIFEXITED(condition):
214
self.logger('Checker for client {0} (command "{1}")'
215
' failed with exit code {2}'
216
.format(self.properties["Name"], command,
217
os.WEXITSTATUS(condition)))
218
elif os.WIFSIGNALED(condition):
219
self.logger('Checker for client {0} (command "{1}") was'
220
' killed by signal {2}'
221
.format(self.properties["Name"], command,
222
os.WTERMSIG(condition)))
223
elif os.WCOREDUMP(condition):
224
self.logger('Checker for client {0} (command "{1}")'
226
.format(self.properties["Name"], command))
228
self.logger('Checker for client {0} completed'
230
.format(self.properties["Name"]))
233
def checker_started(self, command):
234
"""Server signals that a checker started. This could be useful
235
to log in the future. """
236
#self.logger('Client {0} started checker "{1}"'
237
# .format(self.properties["Name"],
241
def got_secret(self):
242
self.logger('Client {0} received its secret'
243
.format(self.properties["Name"]))
245
def need_approval(self, timeout, default):
247
message = 'Client {0} needs approval within {1} seconds'
249
message = 'Client {0} will get its secret in {1} seconds'
250
self.logger(message.format(self.properties["Name"],
252
self.using_timer(True)
254
def rejected(self, reason):
255
self.logger('Client {0} was rejected; reason: {1}'
256
.format(self.properties["Name"], reason))
258
90
def selectable(self):
259
91
"""Make this a "selectable" widget.
260
92
This overrides the method from urwid.FlowWidget."""
263
def rows(self, maxcolrow, focus=False):
95
def rows(self, (maxcol,), focus=False):
264
96
"""How many rows this widget will occupy might depend on
265
97
whether we have focus or not.
266
98
This overrides the method from urwid.FlowWidget"""
267
return self.current_widget(focus).rows(maxcolrow, focus=focus)
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
269
101
def current_widget(self, focus=False):
270
102
if focus or self.opened:
274
106
def update(self):
275
107
"Called when what is visible on the screen should be updated."
276
108
# How to add standout mode to a style
277
with_standout = { "normal": "standout",
278
"bold": "bold-standout",
280
"underline-blink-standout",
281
"bold-underline-blink":
282
"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",
285
117
# Rebuild focus and non-focus widgets using current properties
287
# Base part of a client. Name!
288
base = '{name}: '.format(name=self.properties["Name"])
289
if not self.properties["Enabled"]:
291
elif self.properties["ApprovalPending"]:
292
timeout = datetime.timedelta(milliseconds
295
last_approval_request = isoformat_to_datetime(
296
self.properties["LastApprovalRequest"])
297
if last_approval_request is not None:
298
timer = timeout - (datetime.datetime.utcnow()
299
- last_approval_request)
301
timer = datetime.timedelta()
302
if self.properties["ApprovedByDefault"]:
303
message = "Approval in {0}. (d)eny?"
305
message = "Denial in {0}. (a)pprove?"
306
message = message.format(unicode(timer).rsplit(".", 1)[0])
307
elif self.properties["LastCheckerStatus"] != 0:
308
# When checker has failed, show timer until client expires
309
expires = self.properties["Expires"]
311
timer = datetime.timedelta(0)
313
expires = (datetime.datetime.strptime
314
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
315
timer = expires - datetime.datetime.utcnow()
316
message = ('A checker has failed! Time until client'
317
' gets disabled: {0}'
318
.format(unicode(timer).rsplit(".", 1)[0]))
321
self._text = "{0}{1}".format(base, message)
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
323
120
if not urwid.supports_unicode():
324
121
self._text = self._text.encode("ascii", "replace")
325
textlist = [("normal", self._text)]
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
326
123
self._text_widget.set_text(textlist)
327
124
self._focus_text_widget.set_text([(with_standout[text[0]],
336
133
if self.update_hook is not None:
337
134
self.update_hook()
339
def update_timer(self):
340
"""called by gobject. Will indefinitely loop until
341
gobject.source_remove() on tag is called"""
343
return True # Keep calling this
345
def delete(self, *args, **kwargs):
346
if self._update_timer_callback_tag is not None:
347
gobject.source_remove(self._update_timer_callback_tag)
348
self._update_timer_callback_tag = None
349
for match in self.match_objects:
351
self.match_objects = ()
352
137
if self.delete_hook is not None:
353
138
self.delete_hook(self)
354
return super(MandosClientWidget, self).delete(*args, **kwargs)
356
def render(self, maxcolrow, focus=False):
140
def render(self, (maxcol,), focus=False):
357
141
"""Render differently if we have focus.
358
142
This overrides the method from urwid.FlowWidget"""
359
return self.current_widget(focus).render(maxcolrow,
143
return self.current_widget(focus).render((maxcol,),
362
def keypress(self, maxcolrow, key):
146
def keypress(self, (maxcol,), key):
364
148
This overrides the method from urwid.FlowWidget"""
366
self.proxy.Enable(dbus_interface = client_interface,
369
self.proxy.Disable(dbus_interface = client_interface,
372
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
373
dbus_interface = client_interface,
376
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
377
dbus_interface = client_interface,
379
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":
380
154
self.server_proxy_object.RemoveClient(self.proxy
384
self.proxy.StartChecker(dbus_interface = client_interface,
387
self.proxy.StopChecker(dbus_interface = client_interface,
390
self.proxy.CheckedOK(dbus_interface = client_interface,
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
393
# elif key == "p" or key == "=":
163
# elif key == u"p" or key == "=":
394
164
# self.proxy.pause()
395
# elif key == "u" or key == ":":
165
# elif key == u"u" or key == ":":
396
166
# self.proxy.unpause()
167
# elif key == u"RET":
416
186
"down" key presses, thus not allowing any containing widgets to
417
187
use them as an excuse to shift focus away from this widget.
419
def keypress(self, maxcolrow, key):
420
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
421
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"):
433
203
self.screen = urwid.curses_display.Screen()
435
205
self.screen.register_palette((
437
"default", "default", None),
439
"default", "default", "bold"),
441
"default", "default", "underline"),
443
"default", "default", "standout"),
444
("bold-underline-blink",
445
"default", "default", ("bold", "underline")),
447
"default", "default", ("bold", "standout")),
448
("underline-blink-standout",
449
"default", "default", ("underline", "standout")),
450
("bold-underline-blink-standout",
451
"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",
455
225
if urwid.supports_unicode():
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
226
self.divider = u"─" # \u2500
227
#self.divider = u"━" # \u2501
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
462
232
self.screen.start()
477
247
# This keeps track of whether self.uilist currently has
478
248
# self.logbox in it or not
479
249
self.log_visible = True
480
self.log_wrap = "any"
250
self.log_wrap = u"any"
483
self.log_message_raw(("bold",
484
"Mandos Monitor version " + version))
485
self.log_message_raw(("bold",
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
488
258
self.busname = domain + '.Mandos'
489
259
self.main_loop = gobject.MainLoop()
491
def client_not_found(self, fingerprint, address):
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
494
.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),
496
296
def rebuild(self):
497
297
"""This rebuilds the User Interface.
498
298
Call this when the widget layout needs to change"""
500
300
#self.uilist.append(urwid.ListBox(self.clients))
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
503
302
#header=urwid.Divider(),
506
urwid.Divider(div_char=
304
footer=urwid.Divider(div_char=self.divider)))
508
305
if self.log_visible:
509
306
self.uilist.append(self.logbox)
510
308
self.topwidget = urwid.Pile(self.uilist)
512
def log_message(self, message):
513
timestamp = datetime.datetime.now().isoformat()
514
self.log_message_raw(timestamp + ": " + message)
516
def log_message_raw(self, markup):
310
def log_message(self, markup):
517
311
"""Add a log message to the log buffer."""
518
312
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
519
313
if (self.max_log_length
520
314
and len(self.log) > self.max_log_length):
521
315
del self.log[0:len(self.log)-self.max_log_length-1]
522
316
self.logbox.set_focus(len(self.logbox.body.contents),
317
coming_from=u"above")
526
319
def toggle_log_display(self):
527
320
"""Toggle visibility of the log buffer."""
528
321
self.log_visible = not self.log_visible
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
323
self.log_message(u"Log visibility changed to: "
324
+ unicode(self.log_visible))
533
326
def change_log_display(self):
534
327
"""Change type of log display.
535
328
Currently, this toggles wrapping of text lines."""
536
if self.log_wrap == "clip":
537
self.log_wrap = "any"
329
if self.log_wrap == u"clip":
330
self.log_wrap = u"any"
539
self.log_wrap = "clip"
332
self.log_wrap = u"clip"
540
333
for textwidget in self.log:
541
334
textwidget.set_wrap_mode(self.log_wrap)
542
#self.log_message("Wrap mode: " + self.log_wrap)
335
self.log_message(u"Wrap mode: " + self.log_wrap)
544
337
def find_and_remove_client(self, path, name):
545
"""Find a client by its object path and remove it.
338
"""Find an client from its object path and remove it.
547
340
This is connected to the ClientRemoved signal from the
548
341
Mandos server object."""
598
388
"""Start the main loop and exit when it's done."""
599
self.bus = dbus.SystemBus()
600
mandos_dbus_objc = self.bus.get_object(
601
self.busname, "/", follow_name_owner_changes=True)
602
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
606
mandos_clients = (self.mandos_serv
607
.GetAllClientsWithProperties())
608
except dbus.exceptions.DBusException:
609
mandos_clients = dbus.Dictionary()
612
.connect_to_signal("ClientRemoved",
613
self.find_and_remove_client,
614
dbus_interface=server_interface,
617
.connect_to_signal("ClientAdded",
619
dbus_interface=server_interface,
622
.connect_to_signal("ClientNotFound",
623
self.client_not_found,
624
dbus_interface=server_interface,
626
for path, client in mandos_clients.iteritems():
627
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
643
390
self._input_callback_tag = (gobject.io_add_watch
644
391
(sys.stdin.fileno(),
655
402
def process_input(self, source, condition):
656
403
keys = self.screen.get_input()
657
translations = { "ctrl n": "down", # Emacs
658
"ctrl p": "up", # Emacs
659
"ctrl v": "page down", # Emacs
660
"meta v": "page up", # Emacs
661
" ": "page down", # less
662
"f": "page down", # less
663
"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
670
417
except KeyError: # :-)
673
if key == "q" or key == "Q":
420
if key == u"q" or key == u"Q":
676
elif key == "window resize":
423
elif key == u"window resize":
677
424
self.size = self.screen.get_cols_rows()
679
elif key == "\f": # Ctrl-L
426
elif key == u"\f": # Ctrl-L
681
elif key == "l" or key == "D":
428
elif key == u"l" or key == u"D":
682
429
self.toggle_log_display()
684
elif key == "w" or key == "i":
431
elif key == u"w" or key == u"i":
685
432
self.change_log_display()
687
elif key == "?" or key == "f1" or key == "esc":
434
elif key == u"?" or key == u"f1" or key == u"esc":
688
435
if not self.log_visible:
689
436
self.log_visible = True
691
self.log_message_raw(("bold",
695
"l: Log window toggle",
696
"TAB: Switch window",
698
self.log_message_raw(("bold",
704
"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",
711
454
if self.topwidget.get_focus() is self.logbox:
712
455
self.topwidget.set_focus(0)
714
457
self.topwidget.set_focus(self.logbox)
716
#elif (key == "end" or key == "meta >" or key == "G"
459
#elif (key == u"end" or key == u"meta >" or key == u"G"
718
461
# pass # xxx end-of-buffer
719
#elif (key == "home" or key == "meta <" or key == "g"
462
#elif (key == u"home" or key == u"meta <" or key == u"g"
721
464
# pass # xxx beginning-of-buffer
722
#elif key == "ctrl e" or key == "$":
465
#elif key == u"ctrl e" or key == u"$":
723
466
# pass # xxx move-end-of-line
724
#elif key == "ctrl a" or key == "^":
467
#elif key == u"ctrl a" or key == u"^":
725
468
# pass # xxx move-beginning-of-line
726
#elif key == "ctrl b" or key == "meta (" or key == "h":
469
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
727
470
# pass # xxx left
728
#elif key == "ctrl f" or key == "meta )" or key == "l":
471
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
729
472
# pass # xxx right
731
474
# pass # scroll up log
733
476
# pass # scroll down log
734
477
elif self.topwidget.selectable():
735
478
self.topwidget.keypress(self.size, key)