2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2011 Teddy Hogeborn
7
# Copyright © 2009-2011 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@fukt.bsnet.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,
40
# Type conversion mapping
42
dbus.ObjectPath: unicode,
44
dbus.Signature: unicode,
52
dbus.Dictionary: dict,
87
59
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,
61
if properties is None:
62
self.properties = dict()
64
self.properties = dict(self.convert_property(prop, val)
66
properties.iteritems())
67
self.proxy.connect_to_signal("PropertyChanged",
68
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__(
72
if properties is None:
73
self.properties.update(
74
self.convert_property(prop, val)
76
self.proxy.GetAll(client_interface,
78
dbus.PROPERTIES_IFACE).iteritems())
79
super(MandosClientPropertyCache, self).__init__(
80
proxy_object=proxy_object,
81
properties=properties, *args, **kwargs)
83
def convert_property(self, property, value):
84
"""This converts the arguments from a D-Bus signal, which are
85
D-Bus types, into normal Python types, using a conversion
86
function from "self.type_map".
88
property_name = unicode(property) # Always a dbus.String
89
if isinstance(value, dbus.UTF8String):
90
# Should not happen, but prepare for it anyway
91
value = dbus.String(str(value).decode("utf-8"))
93
convfunc = self.type_map[type(value)]
95
# Unknown type, return unmodified
96
return property_name, value
97
return property_name, convfunc(value)
104
98
def property_changed(self, property=None, value=None):
105
99
"""This is called whenever we get a PropertyChanged signal
106
100
It updates the changed property in the "properties" dict.
102
# Convert name and value
103
property_name, cvalue = self.convert_property(property, value)
108
104
# Update properties dict with new value
109
self.properties[property] = value
111
def delete(self, *args, **kwargs):
112
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
105
self.properties[property_name] = cvalue
117
108
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
144
129
self.opened = False
146
last_checked_ok = isoformat_to_datetime(self.properties
148
if last_checked_ok is None:
149
self.last_checker_failed = True
151
self.last_checker_failed = ((datetime.datetime.utcnow()
158
if self.last_checker_failed:
159
self.using_timer(True)
161
if self.need_approval:
162
self.using_timer(True)
164
self.match_objects = (
165
self.proxy.connect_to_signal("CheckerCompleted",
166
self.checker_completed,
169
self.proxy.connect_to_signal("CheckerStarted",
170
self.checker_started,
173
self.proxy.connect_to_signal("GotSecret",
177
self.proxy.connect_to_signal("NeedApproval",
181
self.proxy.connect_to_signal("Rejected",
185
#self.logger('Created client %s' % (self.properties["Name"]))
187
def property_changed(self, property=None, value=None):
188
super(self, MandosClientWidget).property_changed(property,
190
if property == "ApprovalPending":
191
using_timer(bool(value))
193
def using_timer(self, flag):
194
"""Call this method with True or False when timer should be
195
activated or deactivated.
197
old = self._update_timer_callback_lock
199
self._update_timer_callback_lock += 1
201
self._update_timer_callback_lock -= 1
202
if old == 0 and self._update_timer_callback_lock:
203
self._update_timer_callback_tag = (gobject.timeout_add
206
elif old and self._update_timer_callback_lock == 0:
207
gobject.source_remove(self._update_timer_callback_tag)
208
self._update_timer_callback_tag = None
210
def checker_completed(self, exitstatus, condition, command):
212
if self.last_checker_failed:
213
self.last_checker_failed = False
214
self.using_timer(False)
215
#self.logger('Checker for client %s (command "%s")'
217
# % (self.properties["Name"], command))
221
if not self.last_checker_failed:
222
self.last_checker_failed = True
223
self.using_timer(True)
224
if os.WIFEXITED(condition):
225
self.logger('Checker for client %s (command "%s")'
226
' failed with exit code %s'
227
% (self.properties["Name"], command,
228
os.WEXITSTATUS(condition)))
229
elif os.WIFSIGNALED(condition):
230
self.logger('Checker for client %s (command "%s")'
231
' was killed by signal %s'
232
% (self.properties["Name"], command,
233
os.WTERMSIG(condition)))
234
elif os.WCOREDUMP(condition):
235
self.logger('Checker for client %s (command "%s")'
237
% (self.properties["Name"], command))
239
self.logger('Checker for client %s completed'
243
def checker_started(self, command):
244
#self.logger('Client %s started checker "%s"'
245
# % (self.properties["Name"], unicode(command)))
248
def got_secret(self):
249
self.last_checker_failed = False
250
self.logger('Client %s received its secret'
251
% self.properties["Name"])
253
def need_approval(self, timeout, default):
255
message = 'Client %s needs approval within %s seconds'
257
message = 'Client %s will get its secret in %s seconds'
259
% (self.properties["Name"], timeout/1000))
260
self.using_timer(True)
262
def rejected(self, reason):
263
self.logger('Client %s was rejected; reason: %s'
264
% (self.properties["Name"], reason))
266
131
def selectable(self):
267
132
"""Make this a "selectable" widget.
268
133
This overrides the method from urwid.FlowWidget."""
271
def rows(self, maxcolrow, focus=False):
136
def rows(self, (maxcol,), focus=False):
272
137
"""How many rows this widget will occupy might depend on
273
138
whether we have focus or not.
274
139
This overrides the method from urwid.FlowWidget"""
275
return self.current_widget(focus).rows(maxcolrow, focus=focus)
140
return self.current_widget(focus).rows((maxcol,), focus=focus)
277
142
def current_widget(self, focus=False):
278
143
if focus or self.opened:
282
147
def update(self):
283
148
"Called when what is visible on the screen should be updated."
284
149
# How to add standout mode to a style
285
with_standout = { "normal": "standout",
286
"bold": "bold-standout",
288
"underline-blink-standout",
289
"bold-underline-blink":
290
"bold-underline-blink-standout",
150
with_standout = { u"normal": u"standout",
151
u"bold": u"bold-standout",
153
u"underline-blink-standout",
154
u"bold-underline-blink":
155
u"bold-underline-blink-standout",
293
158
# Rebuild focus and non-focus widgets using current properties
295
# Base part of a client. Name!
297
% {"name": self.properties["Name"]})
298
if not self.properties["Enabled"]:
300
elif self.properties["ApprovalPending"]:
301
timeout = datetime.timedelta(milliseconds
304
last_approval_request = isoformat_to_datetime(
305
self.properties["LastApprovalRequest"])
306
if last_approval_request is not None:
307
timer = timeout - (datetime.datetime.utcnow()
308
- last_approval_request)
310
timer = datetime.timedelta()
311
if self.properties["ApprovedByDefault"]:
312
message = "Approval in %s. (d)eny?"
314
message = "Denial in %s. (a)pprove?"
315
message = message % unicode(timer).rsplit(".", 1)[0]
316
elif self.last_checker_failed:
317
timeout = datetime.timedelta(milliseconds
320
last_ok = isoformat_to_datetime(
321
max((self.properties["LastCheckedOK"]
322
or self.properties["Created"]),
323
self.properties["LastEnabled"]))
324
timer = timeout - (datetime.datetime.utcnow() - last_ok)
325
message = ('A checker has failed! Time until client'
327
% unicode(timer).rsplit(".", 1)[0])
330
self._text = "%s%s" % (base, message)
159
self._text = (u'name="%(name)s", enabled=%(enabled)s'
332
161
if not urwid.supports_unicode():
333
162
self._text = self._text.encode("ascii", "replace")
334
textlist = [("normal", self._text)]
163
textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
335
164
self._text_widget.set_text(textlist)
336
165
self._focus_text_widget.set_text([(with_standout[text[0]],
345
174
if self.update_hook is not None:
346
175
self.update_hook()
348
def update_timer(self):
351
return True # Keep calling this
353
def delete(self, *args, **kwargs):
354
if self._update_timer_callback_tag is not None:
355
gobject.source_remove(self._update_timer_callback_tag)
356
self._update_timer_callback_tag = None
357
for match in self.match_objects:
359
self.match_objects = ()
360
178
if self.delete_hook is not None:
361
179
self.delete_hook(self)
362
return super(MandosClientWidget, self).delete(*args, **kwargs)
364
def render(self, maxcolrow, focus=False):
181
def render(self, (maxcol,), focus=False):
365
182
"""Render differently if we have focus.
366
183
This overrides the method from urwid.FlowWidget"""
367
return self.current_widget(focus).render(maxcolrow,
184
return self.current_widget(focus).render((maxcol,),
370
def keypress(self, maxcolrow, key):
187
def keypress(self, (maxcol,), key):
372
189
This overrides the method from urwid.FlowWidget"""
374
self.proxy.Enable(dbus_interface = client_interface,
377
self.proxy.Disable(dbus_interface = client_interface,
380
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
381
dbus_interface = client_interface,
384
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
385
dbus_interface = client_interface,
387
elif key == "R" or key == "_" or key == "ctrl k":
190
if key == u"e" or key == u"+":
192
elif key == u"d" or key == u"-":
194
elif key == u"r" or key == u"_":
388
195
self.server_proxy_object.RemoveClient(self.proxy
392
self.proxy.StartChecker(dbus_interface = client_interface,
395
self.proxy.StopChecker(dbus_interface = client_interface,
398
self.proxy.CheckedOK(dbus_interface = client_interface,
198
self.proxy.StartChecker()
200
self.proxy.StopChecker()
202
self.proxy.CheckedOK()
401
# elif key == "p" or key == "=":
204
# elif key == u"p" or key == "=":
402
205
# self.proxy.pause()
403
# elif key == "u" or key == ":":
206
# elif key == u"u" or key == ":":
404
207
# self.proxy.unpause()
208
# elif key == u"RET":
422
class ConstrainedListBox(urwid.ListBox):
423
"""Like a normal urwid.ListBox, but will consume all "up" or
424
"down" key presses, thus not allowing any containing widgets to
425
use them as an excuse to shift focus away from this widget.
427
def keypress(self, maxcolrow, key):
428
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
429
if ret in ("up", "down"):
434
225
class UserInterface(object):
435
226
"""This is the entire user interface - the whole screen
436
227
with boxes, lists of client widgets, etc.
438
def __init__(self, max_log_length=1000):
439
DBusGMainLoop(set_as_default=True)
230
DBusGMainLoop(set_as_default=True )
441
232
self.screen = urwid.curses_display.Screen()
443
234
self.screen.register_palette((
445
"default", "default", None),
447
"default", "default", "bold"),
449
"default", "default", "underline"),
451
"default", "default", "standout"),
452
("bold-underline-blink",
453
"default", "default", ("bold", "underline")),
455
"default", "default", ("bold", "standout")),
456
("underline-blink-standout",
457
"default", "default", ("underline", "standout")),
458
("bold-underline-blink-standout",
459
"default", "default", ("bold", "underline",
236
u"default", u"default", None),
238
u"default", u"default", u"bold"),
240
u"default", u"default", u"underline"),
242
u"default", u"default", u"standout"),
243
(u"bold-underline-blink",
244
u"default", u"default", (u"bold", u"underline")),
246
u"default", u"default", (u"bold", u"standout")),
247
(u"underline-blink-standout",
248
u"default", u"default", (u"underline", u"standout")),
249
(u"bold-underline-blink-standout",
250
u"default", u"default", (u"bold", u"underline",
463
if urwid.supports_unicode():
464
self.divider = "─" # \u2500
465
#self.divider = "━" # \u2501
467
#self.divider = "-" # \u002d
468
self.divider = "_" # \u005f
470
254
self.screen.start()
472
256
self.size = self.screen.get_cols_rows()
474
258
self.clients = urwid.SimpleListWalker([])
475
259
self.clients_dict = {}
477
# We will add Text widgets to this list
479
self.max_log_length = max_log_length
481
# We keep a reference to the log widget so we can remove it
482
# from the ListWalker without it getting destroyed
483
self.logbox = ConstrainedListBox(self.log)
485
# This keeps track of whether self.uilist currently has
486
# self.logbox in it or not
487
self.log_visible = True
488
self.log_wrap = "any"
491
self.log_message_raw(("bold",
492
"Mandos Monitor version " + version))
493
self.log_message_raw(("bold",
260
self.topwidget = urwid.LineBox(urwid.ListBox(self.clients))
261
#self.topwidget = urwid.ListBox(clients)
496
263
self.busname = domain + '.Mandos'
497
264
self.main_loop = gobject.MainLoop()
498
265
self.bus = dbus.SystemBus()
499
266
mandos_dbus_objc = self.bus.get_object(
500
self.busname, "/", follow_name_owner_changes=True)
267
self.busname, u"/", follow_name_owner_changes=True)
501
268
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
503
270
= server_interface)
298
=self.remove_client),
541
def client_not_found(self, fingerprint, address):
542
self.log_message(("Client with address %s and fingerprint %s"
543
" could not be found" % (address,
547
"""This rebuilds the User Interface.
548
Call this when the widget layout needs to change"""
550
#self.uilist.append(urwid.ListBox(self.clients))
551
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
553
#header=urwid.Divider(),
556
urwid.Divider(div_char=
559
self.uilist.append(self.logbox)
561
self.topwidget = urwid.Pile(self.uilist)
563
def log_message(self, message):
564
timestamp = datetime.datetime.now().isoformat()
565
self.log_message_raw(timestamp + ": " + message)
567
def log_message_raw(self, markup):
568
"""Add a log message to the log buffer."""
569
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
570
if (self.max_log_length
571
and len(self.log) > self.max_log_length):
572
del self.log[0:len(self.log)-self.max_log_length-1]
573
self.logbox.set_focus(len(self.logbox.body.contents),
577
def toggle_log_display(self):
578
"""Toggle visibility of the log buffer."""
579
self.log_visible = not self.log_visible
581
#self.log_message("Log visibility changed to: "
582
# + unicode(self.log_visible))
584
def change_log_display(self):
585
"""Change type of log display.
586
Currently, this toggles wrapping of text lines."""
587
if self.log_wrap == "clip":
588
self.log_wrap = "any"
590
self.log_wrap = "clip"
591
for textwidget in self.log:
592
textwidget.set_wrap_mode(self.log_wrap)
593
#self.log_message("Wrap mode: " + self.log_wrap)
595
301
def find_and_remove_client(self, path, name):
596
"""Find a client by its object path and remove it.
302
"""Find an client from its object path and remove it.
598
304
This is connected to the ClientRemoved signal from the
599
305
Mandos server object."""
678
369
except KeyError: # :-)
681
if key == "q" or key == "Q":
372
if key == u"q" or key == u"Q":
684
elif key == "window resize":
375
elif key == u"window resize":
685
376
self.size = self.screen.get_cols_rows()
687
elif key == "\f": # Ctrl-L
689
elif key == "l" or key == "D":
690
self.toggle_log_display()
692
elif key == "w" or key == "i":
693
self.change_log_display()
695
elif key == "?" or key == "f1" or key == "esc":
696
if not self.log_visible:
697
self.log_visible = True
699
self.log_message_raw(("bold",
703
"l: Log window toggle",
704
"TAB: Switch window",
706
self.log_message_raw(("bold",
712
"s: Start new checker",
719
if self.topwidget.get_focus() is self.logbox:
720
self.topwidget.set_focus(0)
722
self.topwidget.set_focus(self.logbox)
724
#elif (key == "end" or key == "meta >" or key == "G"
726
# pass # xxx end-of-buffer
727
#elif (key == "home" or key == "meta <" or key == "g"
729
# pass # xxx beginning-of-buffer
730
#elif key == "ctrl e" or key == "$":
731
# pass # xxx move-end-of-line
732
#elif key == "ctrl a" or key == "^":
733
# pass # xxx move-beginning-of-line
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
739
# pass # scroll up log
741
# pass # scroll down log
742
380
elif self.topwidget.selectable():
743
381
self.topwidget.keypress(self.size, key)