2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2016 Teddy Hogeborn
7
# Copyright © 2009-2016 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
43
from gi.repository import GObject
45
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'
66
dbus.OBJECT_MANAGER_IFACE
67
except AttributeError:
68
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
def isoformat_to_datetime(iso):
71
"Parse an ISO 8601 date string to a datetime.datetime()"
74
d, t = iso.split("T", 1)
75
year, month, day = d.split("-", 2)
76
hour, minute, second = t.split(":", 2)
77
second, fraction = divmod(float(second), 1)
78
return datetime.datetime(int(year),
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
class MandosClientPropertyCache(object):
87
"""This wraps a Mandos Client D-Bus proxy object, caches the
88
properties and calls a hook function when any of them are
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
93
self.properties = dict() if properties is None else properties
94
self.property_changed_match = (
95
self.proxy.connect_to_signal("PropertiesChanged",
96
self.properties_changed,
97
dbus.PROPERTIES_IFACE,
100
if properties is None:
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
def properties_changed(self, interface, properties, invalidated):
109
"""This is called whenever we get a PropertiesChanged signal
110
It updates the changed properties in the "properties" dict.
112
# Update properties dict with new value
113
if interface == client_interface:
114
self.properties.update(properties)
117
self.property_changed_match.remove()
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
121
"""A Mandos Client which is visible on the screen.
124
def __init__(self, server_proxy_object=None, update_hook=None,
125
delete_hook=None, logger=None, **kwargs):
127
self.update_hook = update_hook
129
self.delete_hook = delete_hook
130
# Mandos Server proxy object
131
self.server_proxy_object = server_proxy_object
135
self._update_timer_callback_tag = None
137
# The widget shown normally
138
self._text_widget = urwid.Text("")
139
# The widget shown when we have focus
140
self._focus_text_widget = urwid.Text("")
141
super(MandosClientWidget, self).__init__(**kwargs)
145
self.match_objects = (
146
self.proxy.connect_to_signal("CheckerCompleted",
147
self.checker_completed,
150
self.proxy.connect_to_signal("CheckerStarted",
151
self.checker_started,
154
self.proxy.connect_to_signal("GotSecret",
158
self.proxy.connect_to_signal("NeedApproval",
162
self.proxy.connect_to_signal("Rejected",
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
169
def using_timer(self, flag):
170
"""Call this method with True or False when timer should be
171
activated or deactivated.
173
if flag and self._update_timer_callback_tag is None:
174
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GObject.timeout_add
178
elif not (flag or self._update_timer_callback_tag is None):
179
GObject.source_remove(self._update_timer_callback_tag)
180
self._update_timer_callback_tag = None
182
def checker_completed(self, exitstatus, condition, command):
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
195
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
202
def checker_started(self, command):
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
208
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
212
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
220
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
224
def selectable(self):
225
"""Make this a "selectable" widget.
226
This overrides the method from urwid.FlowWidget."""
229
def rows(self, maxcolrow, focus=False):
230
"""How many rows this widget will occupy might depend on
231
whether we have focus or not.
232
This overrides the method from urwid.FlowWidget"""
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
def current_widget(self, focus=False):
236
if focus or self.opened:
237
return self._focus_widget
241
"Called when what is visible on the screen should be updated."
242
# How to add standout mode to a style
243
with_standout = { "normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
251
# Rebuild focus and non-focus widgets using current properties
253
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
255
if not self.properties["Enabled"]:
257
self.using_timer(False)
258
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(milliseconds
262
last_approval_request = isoformat_to_datetime(
263
self.properties["LastApprovalRequest"])
264
if last_approval_request is not None:
265
timer = max(timeout - (datetime.datetime.utcnow()
266
- last_approval_request),
267
datetime.timedelta())
269
timer = datetime.timedelta()
270
if self.properties["ApprovedByDefault"]:
271
message = "Approval in {}. (d)eny?"
273
message = "Denial in {}. (a)pprove?"
274
message = message.format(str(timer).rsplit(".", 1)[0])
275
self.using_timer(True)
276
elif self.properties["LastCheckerStatus"] != 0:
277
# When checker has failed, show timer until client expires
278
expires = self.properties["Expires"]
280
timer = datetime.timedelta(0)
282
expires = (datetime.datetime.strptime
283
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
284
timer = max(expires - datetime.datetime.utcnow(),
285
datetime.timedelta())
286
message = ('A checker has failed! Time until client'
288
.format(str(timer).rsplit(".", 1)[0]))
289
self.using_timer(True)
292
self.using_timer(False)
293
self._text = "{}{}".format(base, message)
295
if not urwid.supports_unicode():
296
self._text = self._text.encode("ascii", "replace")
297
textlist = [("normal", self._text)]
298
self._text_widget.set_text(textlist)
299
self._focus_text_widget.set_text([(with_standout[text[0]],
301
if isinstance(text, tuple)
303
for text in textlist])
304
self._widget = self._text_widget
305
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
307
# Run update hook, if any
308
if self.update_hook is not None:
311
def update_timer(self):
312
"""called by GObject. Will indefinitely loop until
313
GObject.source_remove() on tag is called"""
315
return True # Keep calling this
317
def delete(self, **kwargs):
318
if self._update_timer_callback_tag is not None:
319
GObject.source_remove(self._update_timer_callback_tag)
320
self._update_timer_callback_tag = None
321
for match in self.match_objects:
323
self.match_objects = ()
324
if self.delete_hook is not None:
325
self.delete_hook(self)
326
return super(MandosClientWidget, self).delete(**kwargs)
328
def render(self, maxcolrow, focus=False):
329
"""Render differently if we have focus.
330
This overrides the method from urwid.FlowWidget"""
331
return self.current_widget(focus).render(maxcolrow,
334
def keypress(self, maxcolrow, key):
336
This overrides the method from urwid.FlowWidget"""
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface = dbus.PROPERTIES_IFACE)
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
353
elif key == "R" or key == "_" or key == "ctrl k":
354
self.server_proxy_object.RemoveClient(self.proxy
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
362
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface = client_interface,
369
# elif key == "p" or key == "=":
371
# elif key == "u" or key == ":":
372
# self.proxy.unpause()
378
def properties_changed(self, interface, properties, invalidated):
379
"""Call self.update() if any properties changed.
380
This overrides the method from MandosClientPropertyCache"""
381
old_values = { key: self.properties.get(key)
382
for key in properties.keys() }
383
super(MandosClientWidget, self).properties_changed(
384
interface, properties, invalidated)
385
if any(old_values[key] != self.properties.get(key)
386
for key in old_values):
390
class ConstrainedListBox(urwid.ListBox):
391
"""Like a normal urwid.ListBox, but will consume all "up" or
392
"down" key presses, thus not allowing any containing widgets to
393
use them as an excuse to shift focus away from this widget.
395
def keypress(self, *args, **kwargs):
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
397
if ret in ("up", "down"):
402
class UserInterface(object):
403
"""This is the entire user interface - the whole screen
404
with boxes, lists of client widgets, etc.
406
def __init__(self, max_log_length=1000, log_level=1):
407
DBusGMainLoop(set_as_default=True)
409
self.screen = urwid.curses_display.Screen()
411
self.screen.register_palette((
413
"default", "default", None),
415
"bold", "default", "bold"),
417
"underline,blink", "default", "underline,blink"),
419
"standout", "default", "standout"),
420
("bold-underline-blink",
421
"bold,underline,blink", "default", "bold,underline,blink"),
423
"bold,standout", "default", "bold,standout"),
424
("underline-blink-standout",
425
"underline,blink,standout", "default",
426
"underline,blink,standout"),
427
("bold-underline-blink-standout",
428
"bold,underline,blink,standout", "default",
429
"bold,underline,blink,standout"),
432
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
441
self.size = self.screen.get_cols_rows()
443
self.clients = urwid.SimpleListWalker([])
444
self.clients_dict = {}
446
# We will add Text widgets to this list
448
self.max_log_length = max_log_length
450
self.log_level = log_level
452
# We keep a reference to the log widget so we can remove it
453
# from the ListWalker without it getting destroyed
454
self.logbox = ConstrainedListBox(self.log)
456
# This keeps track of whether self.uilist currently has
457
# self.logbox in it or not
458
self.log_visible = True
459
self.log_wrap = "any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
467
self.busname = domain + '.Mandos'
468
self.main_loop = GObject.MainLoop()
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
473
.format(address, fingerprint))
476
"""This rebuilds the User Interface.
477
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
485
urwid.Divider(div_char=
488
self.uilist.append(self.logbox)
489
self.topwidget = urwid.Pile(self.uilist)
491
def log_message(self, message, level=1):
492
"""Log message formatted with timestamp"""
493
if level < self.log_level:
495
timestamp = datetime.datetime.now().isoformat()
496
self.log_message_raw("{}: {}".format(timestamp, message),
499
def log_message_raw(self, markup, level=1):
500
"""Add a log message to the log buffer."""
501
if level < self.log_level:
503
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
504
if (self.max_log_length
505
and len(self.log) > self.max_log_length):
506
del self.log[0:len(self.log)-self.max_log_length-1]
507
self.logbox.set_focus(len(self.logbox.body.contents),
511
def toggle_log_display(self):
512
"""Toggle visibility of the log buffer."""
513
self.log_visible = not self.log_visible
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
518
def change_log_display(self):
519
"""Change type of log display.
520
Currently, this toggles wrapping of text lines."""
521
if self.log_wrap == "clip":
522
self.log_wrap = "any"
524
self.log_wrap = "clip"
525
for textwidget in self.log:
526
textwidget.set_wrap_mode(self.log_wrap)
527
self.log_message("Wrap mode: {}".format(self.log_wrap),
530
def find_and_remove_client(self, path, interfaces):
531
"""Find a client by its object path and remove it.
533
This is connected to the InterfacesRemoved signal from the
534
Mandos server object."""
535
if client_interface not in interfaces:
536
# Not a Mandos client object; ignore
539
client = self.clients_dict[path]
542
self.log_message("Unknown client {!r} removed"
547
def add_new_client(self, path, ifs_and_props):
548
"""Find a client by its object path and remove it.
550
This is connected to the InterfacesAdded signal from the
551
Mandos server object.
553
if client_interface not in ifs_and_props:
554
# Not a Mandos client object; ignore
556
client_proxy_object = self.bus.get_object(self.busname, path)
557
self.add_client(MandosClientWidget(server_proxy_object
560
=client_proxy_object,
568
= dict(ifs_and_props[
572
def add_client(self, client, path=None):
573
self.clients.append(client)
575
path = client.proxy.object_path
576
self.clients_dict[path] = client
577
self.clients.sort(key=lambda c: c.properties["Name"])
580
def remove_client(self, client, path=None):
581
self.clients.remove(client)
583
path = client.proxy.object_path
584
del self.clients_dict[path]
588
"""Redraw the screen"""
589
canvas = self.topwidget.render(self.size, focus=True)
590
self.screen.draw_screen(self.size, canvas)
593
"""Start the main loop and exit when it's done."""
594
self.bus = dbus.SystemBus()
595
mandos_dbus_objc = self.bus.get_object(
596
self.busname, "/", follow_name_owner_changes=True)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
601
mandos_clients = (self.mandos_serv
602
.GetAllClientsWithProperties())
603
if not mandos_clients:
604
self.log_message_raw(("bold", "Note: Server has no clients."))
605
except dbus.exceptions.DBusException:
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
607
mandos_clients = dbus.Dictionary()
610
.connect_to_signal("InterfacesRemoved",
611
self.find_and_remove_client,
613
= dbus.OBJECT_MANAGER_IFACE,
616
.connect_to_signal("InterfacesAdded",
619
= dbus.OBJECT_MANAGER_IFACE,
622
.connect_to_signal("ClientNotFound",
623
self.client_not_found,
624
dbus_interface=server_interface,
626
for path, client in mandos_clients.items():
627
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
643
self._input_callback_tag = (GObject.io_add_watch
648
# Main loop has finished, we should close everything now
649
GObject.source_remove(self._input_callback_tag)
653
self.main_loop.quit()
655
def process_input(self, source, condition):
656
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
669
key = translations[key]
670
except KeyError: # :-)
673
if key == "q" or key == "Q":
676
elif key == "window resize":
677
self.size = self.screen.get_cols_rows()
679
elif key == "ctrl l":
682
elif key == "l" or key == "D":
683
self.toggle_log_display()
685
elif key == "w" or key == "i":
686
self.change_log_display()
688
elif key == "?" or key == "f1" or key == "esc":
689
if not self.log_visible:
690
self.log_visible = True
692
self.log_message_raw(("bold",
696
"l: Log window toggle",
697
"TAB: Switch window",
698
"w: Wrap (log lines)",
699
"v: Toggle verbose log",
701
self.log_message_raw(("bold",
707
"s: Start new checker",
714
if self.topwidget.get_focus() is self.logbox:
715
self.topwidget.set_focus(0)
717
self.topwidget.set_focus(self.logbox)
720
if self.log_level == 0:
722
self.log_message("Verbose mode: Off")
725
self.log_message("Verbose mode: On")
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
elif self.topwidget.selectable():
745
self.topwidget.keypress(self.size, key)
752
except KeyboardInterrupt:
754
except Exception as e:
755
ui.log_message(str(e))