2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 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,
29
from future_builtins import *
38
import urwid.curses_display
41
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
51
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
59
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
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
class MandosClientPropertyCache(object):
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
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,
95
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
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.
107
# Update properties dict with new value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
115
"""A Mandos Client which is visible on the screen.
118
def __init__(self, server_proxy_object=None, update_hook=None,
119
delete_hook=None, logger=None, **kwargs):
121
self.update_hook = update_hook
123
self.delete_hook = delete_hook
124
# Mandos Server proxy object
125
self.server_proxy_object = server_proxy_object
129
self._update_timer_callback_tag = None
131
# The widget shown normally
132
self._text_widget = urwid.Text("")
133
# The widget shown when we have focus
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
139
self.match_objects = (
140
self.proxy.connect_to_signal("CheckerCompleted",
141
self.checker_completed,
144
self.proxy.connect_to_signal("CheckerStarted",
145
self.checker_started,
148
self.proxy.connect_to_signal("GotSecret",
152
self.proxy.connect_to_signal("NeedApproval",
156
self.proxy.connect_to_signal("Rejected",
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
163
def using_timer(self, flag):
164
"""Call this method with True or False when timer should be
165
activated or deactivated.
167
if flag and self._update_timer_callback_tag is None:
168
# Will update the shown timer value every second
169
self._update_timer_callback_tag = (gobject.timeout_add
172
elif not (flag or self._update_timer_callback_tag is None):
173
gobject.source_remove(self._update_timer_callback_tag)
174
self._update_timer_callback_tag = None
176
def checker_completed(self, exitstatus, condition, command):
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
184
if os.WIFEXITED(condition):
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
188
os.WEXITSTATUS(condition)))
189
elif os.WIFSIGNALED(condition):
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
os.WTERMSIG(condition)))
196
def checker_started(self, command):
197
"""Server signals that a checker started."""
198
self.logger('Client {} started checker "{}"'
199
.format(self.properties["Name"],
202
def got_secret(self):
203
self.logger('Client {} received its secret'
204
.format(self.properties["Name"]))
206
def need_approval(self, timeout, default):
208
message = 'Client {} needs approval within {} seconds'
210
message = 'Client {} will get its secret in {} seconds'
211
self.logger(message.format(self.properties["Name"],
214
def rejected(self, reason):
215
self.logger('Client {} was rejected; reason: {}'
216
.format(self.properties["Name"], reason))
218
def selectable(self):
219
"""Make this a "selectable" widget.
220
This overrides the method from urwid.FlowWidget."""
223
def rows(self, maxcolrow, focus=False):
224
"""How many rows this widget will occupy might depend on
225
whether we have focus or not.
226
This overrides the method from urwid.FlowWidget"""
227
return self.current_widget(focus).rows(maxcolrow, focus=focus)
229
def current_widget(self, focus=False):
230
if focus or self.opened:
231
return self._focus_widget
235
"Called when what is visible on the screen should be updated."
236
# How to add standout mode to a style
237
with_standout = { "normal": "standout",
238
"bold": "bold-standout",
240
"underline-blink-standout",
241
"bold-underline-blink":
242
"bold-underline-blink-standout",
245
# Rebuild focus and non-focus widgets using current properties
247
# Base part of a client. Name!
248
base = '{name}: '.format(name=self.properties["Name"])
249
if not self.properties["Enabled"]:
251
self.using_timer(False)
252
elif self.properties["ApprovalPending"]:
253
timeout = datetime.timedelta(milliseconds
256
last_approval_request = isoformat_to_datetime(
257
self.properties["LastApprovalRequest"])
258
if last_approval_request is not None:
259
timer = max(timeout - (datetime.datetime.utcnow()
260
- last_approval_request),
261
datetime.timedelta())
263
timer = datetime.timedelta()
264
if self.properties["ApprovedByDefault"]:
265
message = "Approval in {}. (d)eny?"
267
message = "Denial in {}. (a)pprove?"
268
message = message.format(str(timer).rsplit(".", 1)[0])
269
self.using_timer(True)
270
elif self.properties["LastCheckerStatus"] != 0:
271
# When checker has failed, show timer until client expires
272
expires = self.properties["Expires"]
274
timer = datetime.timedelta(0)
276
expires = (datetime.datetime.strptime
277
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
278
timer = max(expires - datetime.datetime.utcnow(),
279
datetime.timedelta())
280
message = ('A checker has failed! Time until client'
282
.format(str(timer).rsplit(".", 1)[0]))
283
self.using_timer(True)
286
self.using_timer(False)
287
self._text = "{}{}".format(base, message)
289
if not urwid.supports_unicode():
290
self._text = self._text.encode("ascii", "replace")
291
textlist = [("normal", self._text)]
292
self._text_widget.set_text(textlist)
293
self._focus_text_widget.set_text([(with_standout[text[0]],
295
if isinstance(text, tuple)
297
for text in textlist])
298
self._widget = self._text_widget
299
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
301
# Run update hook, if any
302
if self.update_hook is not None:
305
def update_timer(self):
306
"""called by gobject. Will indefinitely loop until
307
gobject.source_remove() on tag is called"""
309
return True # Keep calling this
311
def delete(self, **kwargs):
312
if self._update_timer_callback_tag is not None:
313
gobject.source_remove(self._update_timer_callback_tag)
314
self._update_timer_callback_tag = None
315
for match in self.match_objects:
317
self.match_objects = ()
318
if self.delete_hook is not None:
319
self.delete_hook(self)
320
return super(MandosClientWidget, self).delete(**kwargs)
322
def render(self, maxcolrow, focus=False):
323
"""Render differently if we have focus.
324
This overrides the method from urwid.FlowWidget"""
325
return self.current_widget(focus).render(maxcolrow,
328
def keypress(self, maxcolrow, key):
330
This overrides the method from urwid.FlowWidget"""
332
self.proxy.Set(client_interface, "Enabled",
333
dbus.Boolean(True), ignore_reply = True,
334
dbus_interface = dbus.PROPERTIES_IFACE)
336
self.proxy.Set(client_interface, "Enabled", False,
338
dbus_interface = dbus.PROPERTIES_IFACE)
340
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
341
dbus_interface = client_interface,
344
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
345
dbus_interface = client_interface,
347
elif key == "R" or key == "_" or key == "ctrl k":
348
self.server_proxy_object.RemoveClient(self.proxy
352
self.proxy.Set(client_interface, "CheckerRunning",
353
dbus.Boolean(True), ignore_reply = True,
354
dbus_interface = dbus.PROPERTIES_IFACE)
356
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(False), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
360
self.proxy.CheckedOK(dbus_interface = client_interface,
363
# elif key == "p" or key == "=":
365
# elif key == "u" or key == ":":
366
# self.proxy.unpause()
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
374
This overrides the method from MandosClientPropertyCache"""
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):
384
class ConstrainedListBox(urwid.ListBox):
385
"""Like a normal urwid.ListBox, but will consume all "up" or
386
"down" key presses, thus not allowing any containing widgets to
387
use them as an excuse to shift focus away from this widget.
389
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
391
if ret in ("up", "down"):
396
class UserInterface(object):
397
"""This is the entire user interface - the whole screen
398
with boxes, lists of client widgets, etc.
400
def __init__(self, max_log_length=1000, log_level=1):
401
DBusGMainLoop(set_as_default=True)
403
self.screen = urwid.curses_display.Screen()
405
self.screen.register_palette((
407
"default", "default", None),
409
"bold", "default", "bold"),
411
"underline,blink", "default", "underline,blink"),
413
"standout", "default", "standout"),
414
("bold-underline-blink",
415
"bold,underline,blink", "default", "bold,underline,blink"),
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"),
426
if urwid.supports_unicode():
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
435
self.size = self.screen.get_cols_rows()
437
self.clients = urwid.SimpleListWalker([])
438
self.clients_dict = {}
440
# We will add Text widgets to this list
442
self.max_log_length = max_log_length
444
self.log_level = log_level
446
# We keep a reference to the log widget so we can remove it
447
# from the ListWalker without it getting destroyed
448
self.logbox = ConstrainedListBox(self.log)
450
# This keeps track of whether self.uilist currently has
451
# self.logbox in it or not
452
self.log_visible = True
453
self.log_wrap = "any"
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
461
self.busname = domain + '.Mandos'
462
self.main_loop = gobject.MainLoop()
464
def client_not_found(self, fingerprint, address):
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
470
"""This rebuilds the User Interface.
471
Call this when the widget layout needs to change"""
473
#self.uilist.append(urwid.ListBox(self.clients))
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
476
#header=urwid.Divider(),
479
urwid.Divider(div_char=
482
self.uilist.append(self.logbox)
483
self.topwidget = urwid.Pile(self.uilist)
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
489
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
493
def log_message_raw(self, markup, level=1):
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
if (self.max_log_length
499
and len(self.log) > self.max_log_length):
500
del self.log[0:len(self.log)-self.max_log_length-1]
501
self.logbox.set_focus(len(self.logbox.body.contents),
505
def toggle_log_display(self):
506
"""Toggle visibility of the log buffer."""
507
self.log_visible = not self.log_visible
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
512
def change_log_display(self):
513
"""Change type of log display.
514
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
518
self.log_wrap = "clip"
519
for textwidget in self.log:
520
textwidget.set_wrap_mode(self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
524
def find_and_remove_client(self, path, name):
525
"""Find a client by its object path and remove it.
527
This is connected to the ClientRemoved signal from the
528
Mandos server object."""
530
client = self.clients_dict[path]
533
self.log_message("Unknown client {!r} ({!r}) removed"
538
def add_new_client(self, path):
539
client_proxy_object = self.bus.get_object(self.busname, path)
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
552
def add_client(self, client, path=None):
553
self.clients.append(client)
555
path = client.proxy.object_path
556
self.clients_dict[path] = client
557
self.clients.sort(key=lambda c: c.properties["Name"])
560
def remove_client(self, client, path=None):
561
self.clients.remove(client)
563
path = client.proxy.object_path
564
del self.clients_dict[path]
568
"""Redraw the screen"""
569
canvas = self.topwidget.render(self.size, focus=True)
570
self.screen.draw_screen(self.size, canvas)
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,
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()
590
.connect_to_signal("ClientRemoved",
591
self.find_and_remove_client,
592
dbus_interface=server_interface,
595
.connect_to_signal("ClientAdded",
597
dbus_interface=server_interface,
600
.connect_to_signal("ClientNotFound",
601
self.client_not_found,
602
dbus_interface=server_interface,
604
for path, client in mandos_clients.items():
605
client_proxy_object = self.bus.get_object(self.busname,
607
self.add_client(MandosClientWidget(server_proxy_object
610
=client_proxy_object,
621
self._input_callback_tag = (gobject.io_add_watch
626
# Main loop has finished, we should close everything now
627
gobject.source_remove(self._input_callback_tag)
631
self.main_loop.quit()
633
def process_input(self, source, condition):
634
keys = self.screen.get_input()
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
647
key = translations[key]
648
except KeyError: # :-)
651
if key == "q" or key == "Q":
654
elif key == "window resize":
655
self.size = self.screen.get_cols_rows()
657
elif key == "ctrl l":
660
elif key == "l" or key == "D":
661
self.toggle_log_display()
663
elif key == "w" or key == "i":
664
self.change_log_display()
666
elif key == "?" or key == "f1" or key == "esc":
667
if not self.log_visible:
668
self.log_visible = True
670
self.log_message_raw(("bold",
674
"l: Log window toggle",
675
"TAB: Switch window",
676
"w: Wrap (log lines)",
677
"v: Toggle verbose log",
679
self.log_message_raw(("bold",
685
"s: Start new checker",
692
if self.topwidget.get_focus() is self.logbox:
693
self.topwidget.set_focus(0)
695
self.topwidget.set_focus(self.logbox)
698
if self.log_level == 0:
700
self.log_message("Verbose mode: Off")
703
self.log_message("Verbose mode: On")
704
#elif (key == "end" or key == "meta >" or key == "G"
706
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
709
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
711
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
713
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
719
# pass # scroll up log
721
# pass # scroll down log
722
elif self.topwidget.selectable():
723
self.topwidget.keypress(self.size, key)
730
except KeyboardInterrupt:
732
except Exception as e:
733
ui.log_message(str(e))