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@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,
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
# Will update the shown timer value every second
204
self._update_timer_callback_tag = (gobject.timeout_add
207
elif old and self._update_timer_callback_lock == 0:
208
gobject.source_remove(self._update_timer_callback_tag)
209
self._update_timer_callback_tag = None
211
def checker_completed(self, exitstatus, condition, command):
213
if self.last_checker_failed:
214
self.last_checker_failed = False
215
self.using_timer(False)
216
#self.logger('Checker for client %s (command "%s")'
218
# % (self.properties["Name"], command))
222
if not self.last_checker_failed:
223
self.last_checker_failed = True
224
self.using_timer(True)
225
if os.WIFEXITED(condition):
226
self.logger('Checker for client %s (command "%s")'
227
' failed with exit code %s'
228
% (self.properties["Name"], command,
229
os.WEXITSTATUS(condition)))
230
elif os.WIFSIGNALED(condition):
231
self.logger('Checker for client %s (command "%s")'
232
' was killed by signal %s'
233
% (self.properties["Name"], command,
234
os.WTERMSIG(condition)))
235
elif os.WCOREDUMP(condition):
236
self.logger('Checker for client %s (command "%s")'
238
% (self.properties["Name"], command))
240
self.logger('Checker for client %s completed'
244
def checker_started(self, command):
245
#self.logger('Client %s started checker "%s"'
246
# % (self.properties["Name"], unicode(command)))
249
def got_secret(self):
250
self.last_checker_failed = False
251
self.logger('Client %s received its secret'
252
% self.properties["Name"])
254
def need_approval(self, timeout, default):
256
message = 'Client %s needs approval within %s seconds'
258
message = 'Client %s will get its secret in %s seconds'
260
% (self.properties["Name"], timeout/1000))
261
self.using_timer(True)
263
def rejected(self, reason):
264
self.logger('Client %s was rejected; reason: %s'
265
% (self.properties["Name"], reason))
267
131
def selectable(self):
268
132
"""Make this a "selectable" widget.
269
133
This overrides the method from urwid.FlowWidget."""
272
def rows(self, maxcolrow, focus=False):
136
def rows(self, (maxcol,), focus=False):
273
137
"""How many rows this widget will occupy might depend on
274
138
whether we have focus or not.
275
139
This overrides the method from urwid.FlowWidget"""
276
return self.current_widget(focus).rows(maxcolrow, focus=focus)
140
return self.current_widget(focus).rows((maxcol,), focus=focus)
278
142
def current_widget(self, focus=False):
279
143
if focus or self.opened:
283
147
def update(self):
284
148
"Called when what is visible on the screen should be updated."
285
149
# How to add standout mode to a style
286
with_standout = { "normal": "standout",
287
"bold": "bold-standout",
289
"underline-blink-standout",
290
"bold-underline-blink":
291
"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",
294
158
# Rebuild focus and non-focus widgets using current properties
296
# Base part of a client. Name!
298
% {"name": self.properties["Name"]})
299
if not self.properties["Enabled"]:
301
elif self.properties["ApprovalPending"]:
302
timeout = datetime.timedelta(milliseconds
305
last_approval_request = isoformat_to_datetime(
306
self.properties["LastApprovalRequest"])
307
if last_approval_request is not None:
308
timer = timeout - (datetime.datetime.utcnow()
309
- last_approval_request)
311
timer = datetime.timedelta()
312
if self.properties["ApprovedByDefault"]:
313
message = "Approval in %s. (d)eny?"
315
message = "Denial in %s. (a)pprove?"
316
message = message % unicode(timer).rsplit(".", 1)[0]
317
elif self.last_checker_failed:
318
# When checker has failed, print a timer until client expires
319
expires = self.properties["Expires"]
321
timer = datetime.timedelta(0)
323
expires = datetime.datetime.strptime(expires,
324
'%Y-%m-%dT%H:%M:%S.%f')
325
timer = expires - datetime.datetime.utcnow()
326
message = ('A checker has failed! Time until client'
328
% unicode(timer).rsplit(".", 1)[0])
331
self._text = "%s%s" % (base, message)
159
self._text = (u'name="%(name)s", enabled=%(enabled)s'
333
161
if not urwid.supports_unicode():
334
162
self._text = self._text.encode("ascii", "replace")
335
textlist = [("normal", self._text)]
163
textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
336
164
self._text_widget.set_text(textlist)
337
165
self._focus_text_widget.set_text([(with_standout[text[0]],
346
174
if self.update_hook is not None:
347
175
self.update_hook()
349
def update_timer(self):
350
"""called by gobject. Will indefinitely loop until
351
gobject.source_remove() on tag is called"""
353
return True # Keep calling this
355
def delete(self, *args, **kwargs):
356
if self._update_timer_callback_tag is not None:
357
gobject.source_remove(self._update_timer_callback_tag)
358
self._update_timer_callback_tag = None
359
for match in self.match_objects:
361
self.match_objects = ()
362
178
if self.delete_hook is not None:
363
179
self.delete_hook(self)
364
return super(MandosClientWidget, self).delete(*args, **kwargs)
366
def render(self, maxcolrow, focus=False):
181
def render(self, (maxcol,), focus=False):
367
182
"""Render differently if we have focus.
368
183
This overrides the method from urwid.FlowWidget"""
369
return self.current_widget(focus).render(maxcolrow,
184
return self.current_widget(focus).render((maxcol,),
372
def keypress(self, maxcolrow, key):
187
def keypress(self, (maxcol,), key):
374
189
This overrides the method from urwid.FlowWidget"""
376
self.proxy.Enable(dbus_interface = client_interface,
379
self.proxy.Disable(dbus_interface = client_interface,
382
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
383
dbus_interface = client_interface,
386
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
387
dbus_interface = client_interface,
389
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"_":
390
195
self.server_proxy_object.RemoveClient(self.proxy
394
self.proxy.StartChecker(dbus_interface = client_interface,
397
self.proxy.StopChecker(dbus_interface = client_interface,
400
self.proxy.CheckedOK(dbus_interface = client_interface,
198
self.proxy.StartChecker()
200
self.proxy.StopChecker()
202
self.proxy.CheckedOK()
403
# elif key == "p" or key == "=":
204
# elif key == u"p" or key == "=":
404
205
# self.proxy.pause()
405
# elif key == "u" or key == ":":
206
# elif key == u"u" or key == ":":
406
207
# self.proxy.unpause()
208
# elif key == u"RET":
424
class ConstrainedListBox(urwid.ListBox):
425
"""Like a normal urwid.ListBox, but will consume all "up" or
426
"down" key presses, thus not allowing any containing widgets to
427
use them as an excuse to shift focus away from this widget.
429
def keypress(self, maxcolrow, key):
430
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
431
if ret in ("up", "down"):
436
225
class UserInterface(object):
437
226
"""This is the entire user interface - the whole screen
438
227
with boxes, lists of client widgets, etc.
440
def __init__(self, max_log_length=1000):
441
DBusGMainLoop(set_as_default=True)
230
DBusGMainLoop(set_as_default=True )
443
232
self.screen = urwid.curses_display.Screen()
445
234
self.screen.register_palette((
447
"default", "default", None),
449
"default", "default", "bold"),
451
"default", "default", "underline"),
453
"default", "default", "standout"),
454
("bold-underline-blink",
455
"default", "default", ("bold", "underline")),
457
"default", "default", ("bold", "standout")),
458
("underline-blink-standout",
459
"default", "default", ("underline", "standout")),
460
("bold-underline-blink-standout",
461
"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",
465
if urwid.supports_unicode():
466
self.divider = "─" # \u2500
467
#self.divider = "━" # \u2501
469
#self.divider = "-" # \u002d
470
self.divider = "_" # \u005f
472
254
self.screen.start()
474
256
self.size = self.screen.get_cols_rows()
476
258
self.clients = urwid.SimpleListWalker([])
477
259
self.clients_dict = {}
479
# We will add Text widgets to this list
481
self.max_log_length = max_log_length
483
# We keep a reference to the log widget so we can remove it
484
# from the ListWalker without it getting destroyed
485
self.logbox = ConstrainedListBox(self.log)
487
# This keeps track of whether self.uilist currently has
488
# self.logbox in it or not
489
self.log_visible = True
490
self.log_wrap = "any"
493
self.log_message_raw(("bold",
494
"Mandos Monitor version " + version))
495
self.log_message_raw(("bold",
260
self.topwidget = urwid.LineBox(urwid.ListBox(self.clients))
261
#self.topwidget = urwid.ListBox(clients)
498
263
self.busname = domain + '.Mandos'
499
264
self.main_loop = gobject.MainLoop()
500
265
self.bus = dbus.SystemBus()
501
266
mandos_dbus_objc = self.bus.get_object(
502
self.busname, "/", follow_name_owner_changes=True)
267
self.busname, u"/", follow_name_owner_changes=True)
503
268
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
505
270
= server_interface)
298
=self.remove_client),
543
def client_not_found(self, fingerprint, address):
544
self.log_message(("Client with address %s and fingerprint %s"
545
" could not be found" % (address,
549
"""This rebuilds the User Interface.
550
Call this when the widget layout needs to change"""
552
#self.uilist.append(urwid.ListBox(self.clients))
553
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
555
#header=urwid.Divider(),
558
urwid.Divider(div_char=
561
self.uilist.append(self.logbox)
563
self.topwidget = urwid.Pile(self.uilist)
565
def log_message(self, message):
566
timestamp = datetime.datetime.now().isoformat()
567
self.log_message_raw(timestamp + ": " + message)
569
def log_message_raw(self, markup):
570
"""Add a log message to the log buffer."""
571
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
572
if (self.max_log_length
573
and len(self.log) > self.max_log_length):
574
del self.log[0:len(self.log)-self.max_log_length-1]
575
self.logbox.set_focus(len(self.logbox.body.contents),
579
def toggle_log_display(self):
580
"""Toggle visibility of the log buffer."""
581
self.log_visible = not self.log_visible
583
#self.log_message("Log visibility changed to: "
584
# + unicode(self.log_visible))
586
def change_log_display(self):
587
"""Change type of log display.
588
Currently, this toggles wrapping of text lines."""
589
if self.log_wrap == "clip":
590
self.log_wrap = "any"
592
self.log_wrap = "clip"
593
for textwidget in self.log:
594
textwidget.set_wrap_mode(self.log_wrap)
595
#self.log_message("Wrap mode: " + self.log_wrap)
597
301
def find_and_remove_client(self, path, name):
598
"""Find a client by its object path and remove it.
302
"""Find an client from its object path and remove it.
600
304
This is connected to the ClientRemoved signal from the
601
305
Mandos server object."""
680
369
except KeyError: # :-)
683
if key == "q" or key == "Q":
372
if key == u"q" or key == u"Q":
686
elif key == "window resize":
375
elif key == u"window resize":
687
376
self.size = self.screen.get_cols_rows()
689
elif key == "\f": # Ctrl-L
691
elif key == "l" or key == "D":
692
self.toggle_log_display()
694
elif key == "w" or key == "i":
695
self.change_log_display()
697
elif key == "?" or key == "f1" or key == "esc":
698
if not self.log_visible:
699
self.log_visible = True
701
self.log_message_raw(("bold",
705
"l: Log window toggle",
706
"TAB: Switch window",
708
self.log_message_raw(("bold",
714
"s: Start new checker",
721
if self.topwidget.get_focus() is self.logbox:
722
self.topwidget.set_focus(0)
724
self.topwidget.set_focus(self.logbox)
726
#elif (key == "end" or key == "meta >" or key == "G"
728
# pass # xxx end-of-buffer
729
#elif (key == "home" or key == "meta <" or key == "g"
731
# pass # xxx beginning-of-buffer
732
#elif key == "ctrl e" or key == "$":
733
# pass # xxx move-end-of-line
734
#elif key == "ctrl a" or key == "^":
735
# pass # xxx move-beginning-of-line
736
#elif key == "ctrl b" or key == "meta (" or key == "h":
738
#elif key == "ctrl f" or key == "meta )" or key == "l":
741
# pass # scroll up log
743
# pass # scroll down log
744
380
elif self.topwidget.selectable():
745
381
self.topwidget.keypress(self.size, key)