2
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>.
4
from __future__ import division, absolute_import, with_statement
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
9
38
import urwid.curses_display
12
41
from dbus.mainloop.glib import DBusGMainLoop
42
from gi.repository import GLib
48
if sys.version_info.major == 2:
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
19
56
# Some useful constants
20
domain = 'se.bsnet.fukt'
57
domain = 'se.recompile'
21
58
server_interface = domain + '.Mandos'
22
59
client_interface = domain + '.Mandos.Client'
25
# Always run in monochrome mode
26
urwid.curses_display.curses.has_colors = lambda : False
28
# Urwid doesn't support blinking, but we want it. Since we have no
29
# use for underline on its own, we make underline also always blink.
30
urwid.curses_display.curses.A_UNDERLINE |= (
31
urwid.curses_display.curses.A_BLINK)
63
dbus.OBJECT_MANAGER_IFACE
64
except AttributeError:
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
def isoformat_to_datetime(iso):
68
"Parse an ISO 8601 date string to a datetime.datetime()"
71
d, t = iso.split("T", 1)
72
year, month, day = d.split("-", 2)
73
hour, minute, second = t.split(":", 2)
74
second, fraction = divmod(float(second), 1)
75
return datetime.datetime(int(year),
80
int(second), # Whole seconds
81
int(fraction*1000000)) # Microseconds
33
83
class MandosClientPropertyCache(object):
34
84
"""This wraps a Mandos Client D-Bus proxy object, caches the
35
85
properties and calls a hook function when any of them are
38
def __init__(self, proxy_object=None, properties=None, *args,
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
40
89
self.proxy = proxy_object # Mandos Client proxy object
42
if properties is None:
43
self.properties = dict()
45
self.properties = properties
46
self.proxy.connect_to_signal("PropertyChanged",
47
self.property_changed,
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)
90
self.properties = dict() if properties is None else properties
91
self.property_changed_match = (
92
self.proxy.connect_to_signal("PropertiesChanged",
93
self.properties_changed,
94
dbus.PROPERTIES_IFACE,
97
if properties is None:
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
59
def property_changed(self, property=None, value=None):
60
"""This is called whenever we get a PropertyChanged signal
61
It updates the changed property in the "properties" dict.
105
def properties_changed(self, interface, properties, invalidated):
106
"""This is called whenever we get a PropertiesChanged signal
107
It updates the changed properties in the "properties" dict.
63
109
# Update properties dict with new value
64
self.properties[property] = value
110
if interface == client_interface:
111
self.properties.update(properties)
114
self.property_changed_match.remove()
67
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
71
121
def __init__(self, server_proxy_object=None, update_hook=None,
72
delete_hook=None, *args, **kwargs):
122
delete_hook=None, logger=None, **kwargs):
73
123
# Called on update
74
124
self.update_hook = update_hook
75
125
# Called on delete
76
126
self.delete_hook = delete_hook
77
127
# Mandos Server proxy object
78
128
self.server_proxy_object = server_proxy_object
132
self._update_timer_callback_tag = None
80
134
# The widget shown normally
81
135
self._text_widget = urwid.Text("")
82
136
# The widget shown when we have focus
83
137
self._focus_text_widget = urwid.Text("")
84
super(MandosClientWidget, self).__init__(
85
update_hook=update_hook, delete_hook=delete_hook,
138
super(MandosClientWidget, self).__init__(**kwargs)
88
140
self.opened = False
142
self.match_objects = (
143
self.proxy.connect_to_signal("CheckerCompleted",
144
self.checker_completed,
147
self.proxy.connect_to_signal("CheckerStarted",
148
self.checker_started,
151
self.proxy.connect_to_signal("GotSecret",
155
self.proxy.connect_to_signal("NeedApproval",
159
self.proxy.connect_to_signal("Rejected",
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
166
def using_timer(self, flag):
167
"""Call this method with True or False when timer should be
168
activated or deactivated.
170
if flag and self._update_timer_callback_tag is None:
171
# Will update the shown timer value every second
172
self._update_timer_callback_tag = (GLib.timeout_add
175
elif not (flag or self._update_timer_callback_tag is None):
176
GLib.source_remove(self._update_timer_callback_tag)
177
self._update_timer_callback_tag = None
179
def checker_completed(self, exitstatus, condition, command):
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
187
if os.WIFEXITED(condition):
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
192
elif os.WIFSIGNALED(condition):
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
199
def checker_started(self, command):
200
"""Server signals that a checker started."""
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
205
def got_secret(self):
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
209
def need_approval(self, timeout, default):
211
message = 'Client {} needs approval within {} seconds'
213
message = 'Client {} will get its secret in {} seconds'
214
self.logger(message.format(self.properties["Name"],
217
def rejected(self, reason):
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
90
221
def selectable(self):
91
222
"""Make this a "selectable" widget.
92
223
This overrides the method from urwid.FlowWidget."""
95
def rows(self, (maxcol,), focus=False):
226
def rows(self, maxcolrow, focus=False):
96
227
"""How many rows this widget will occupy might depend on
97
228
whether we have focus or not.
98
229
This overrides the method from urwid.FlowWidget"""
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
101
232
def current_widget(self, focus=False):
102
233
if focus or self.opened:
106
237
def update(self):
107
238
"Called when what is visible on the screen should be updated."
108
239
# How to add standout mode to a style
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",
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
117
248
# Rebuild focus and non-focus widgets using current properties
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
250
# Base part of a client. Name!
251
base = '{name}: '.format(name=self.properties["Name"])
252
if not self.properties["Enabled"]:
254
self.using_timer(False)
255
elif self.properties["ApprovalPending"]:
256
timeout = datetime.timedelta(milliseconds
259
last_approval_request = isoformat_to_datetime(
260
self.properties["LastApprovalRequest"])
261
if last_approval_request is not None:
262
timer = max(timeout - (datetime.datetime.utcnow()
263
- last_approval_request),
264
datetime.timedelta())
266
timer = datetime.timedelta()
267
if self.properties["ApprovedByDefault"]:
268
message = "Approval in {}. (d)eny?"
270
message = "Denial in {}. (a)pprove?"
271
message = message.format(str(timer).rsplit(".", 1)[0])
272
self.using_timer(True)
273
elif self.properties["LastCheckerStatus"] != 0:
274
# When checker has failed, show timer until client expires
275
expires = self.properties["Expires"]
277
timer = datetime.timedelta(0)
279
expires = (datetime.datetime.strptime
280
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
281
timer = max(expires - datetime.datetime.utcnow(),
282
datetime.timedelta())
283
message = ('A checker has failed! Time until client'
285
.format(str(timer).rsplit(".", 1)[0]))
286
self.using_timer(True)
289
self.using_timer(False)
290
self._text = "{}{}".format(base, message)
120
292
if not urwid.supports_unicode():
121
293
self._text = self._text.encode("ascii", "replace")
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
294
textlist = [("normal", self._text)]
123
295
self._text_widget.set_text(textlist)
124
296
self._focus_text_widget.set_text([(with_standout[text[0]],
133
305
if self.update_hook is not None:
134
306
self.update_hook()
308
def update_timer(self):
309
"""called by GLib. Will indefinitely loop until
310
GLib.source_remove() on tag is called
313
return True # Keep calling this
315
def delete(self, **kwargs):
316
if self._update_timer_callback_tag is not None:
317
GLib.source_remove(self._update_timer_callback_tag)
318
self._update_timer_callback_tag = None
319
for match in self.match_objects:
321
self.match_objects = ()
137
322
if self.delete_hook is not None:
138
323
self.delete_hook(self)
324
return super(MandosClientWidget, self).delete(**kwargs)
140
def render(self, (maxcol,), focus=False):
326
def render(self, maxcolrow, focus=False):
141
327
"""Render differently if we have focus.
142
328
This overrides the method from urwid.FlowWidget"""
143
return self.current_widget(focus).render((maxcol,),
329
return self.current_widget(focus).render(maxcolrow,
146
def keypress(self, (maxcol,), key):
332
def keypress(self, maxcolrow, key):
148
334
This overrides the method from urwid.FlowWidget"""
149
if key == u"e" or key == u"+":
151
elif key == u"d" or key == u"-":
153
elif key == u"r" or key == u"_":
336
self.proxy.Set(client_interface, "Enabled",
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
340
self.proxy.Set(client_interface, "Enabled", False,
342
dbus_interface = dbus.PROPERTIES_IFACE)
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
dbus_interface = client_interface,
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
dbus_interface = client_interface,
351
elif key == "R" or key == "_" or key == "ctrl k":
154
352
self.server_proxy_object.RemoveClient(self.proxy
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
356
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
360
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
364
self.proxy.CheckedOK(dbus_interface = client_interface,
163
# elif key == u"p" or key == "=":
367
# elif key == "p" or key == "=":
164
368
# self.proxy.pause()
165
# elif key == u"u" or key == ":":
369
# elif key == "u" or key == ":":
166
370
# self.proxy.unpause()
167
# elif key == u"RET":
172
def property_changed(self, property=None, value=None,
174
"""Call self.update() if old value is not new value.
376
def properties_changed(self, interface, properties, invalidated):
377
"""Call self.update() if any properties changed.
175
378
This overrides the method from MandosClientPropertyCache"""
176
property_name = unicode(property)
177
old_value = self.properties.get(property_name)
178
super(MandosClientWidget, self).property_changed(
179
property=property, value=value, *args, **kwargs)
180
if self.properties.get(property_name) != old_value:
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
381
super(MandosClientWidget, self).properties_changed(
382
interface, properties, invalidated)
383
if any(old_values[key] != self.properties.get(key)
384
for key in old_values):
197
401
"""This is the entire user interface - the whole screen
198
402
with boxes, lists of client widgets, etc.
200
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
201
405
DBusGMainLoop(set_as_default=True)
203
407
self.screen = urwid.curses_display.Screen()
205
409
self.screen.register_palette((
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",
411
"default", "default", None),
413
"bold", "default", "bold"),
415
"underline,blink", "default", "underline,blink"),
417
"standout", "default", "standout"),
418
("bold-underline-blink",
419
"bold,underline,blink", "default", "bold,underline,blink"),
421
"bold,standout", "default", "bold,standout"),
422
("underline-blink-standout",
423
"underline,blink,standout", "default",
424
"underline,blink,standout"),
425
("bold-underline-blink-standout",
426
"bold,underline,blink,standout", "default",
427
"bold,underline,blink,standout"),
225
430
if urwid.supports_unicode():
226
#self.divider = u"─" # \u2500
227
self.divider = u"━" # \u2501
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
232
437
self.screen.start()
247
454
# This keeps track of whether self.uilist currently has
248
455
# self.logbox in it or not
249
456
self.log_visible = True
250
self.log_wrap = u"any"
457
self.log_wrap = "any"
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
258
465
self.busname = domain + '.Mandos'
259
self.main_loop = gobject.MainLoop()
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),
466
self.main_loop = GLib.MainLoop()
468
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
296
473
def rebuild(self):
297
474
"""This rebuilds the User Interface.
298
475
Call this when the widget layout needs to change"""
300
477
#self.uilist.append(urwid.ListBox(self.clients))
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
302
480
#header=urwid.Divider(),
304
footer=urwid.Divider(div_char=self.divider)))
483
urwid.Divider(div_char=
305
485
if self.log_visible:
306
486
self.uilist.append(self.logbox)
308
487
self.topwidget = urwid.Pile(self.uilist)
310
def log_message(self, markup):
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
311
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
312
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
313
502
if (self.max_log_length
314
503
and len(self.log) > self.max_log_length):
315
504
del self.log[0:len(self.log)-self.max_log_length-1]
505
self.logbox.set_focus(len(self.logbox.body.contents),
317
509
def toggle_log_display(self):
318
510
"""Toggle visibility of the log buffer."""
319
511
self.log_visible = not self.log_visible
321
self.log_message(u"Log visibility changed to: "
322
+ unicode(self.log_visible))
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
324
516
def change_log_display(self):
325
517
"""Change type of log display.
326
518
Currently, this toggles wrapping of text lines."""
327
if self.log_wrap == u"clip":
328
self.log_wrap = u"any"
519
if self.log_wrap == "clip":
520
self.log_wrap = "any"
330
self.log_wrap = u"clip"
522
self.log_wrap = "clip"
331
523
for textwidget in self.log:
332
524
textwidget.set_wrap_mode(self.log_wrap)
333
self.log_message(u"Wrap mode: " + self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
335
def find_and_remove_client(self, path, name):
336
"""Find an client from its object path and remove it.
528
def find_and_remove_client(self, path, interfaces):
529
"""Find a client by its object path and remove it.
338
This is connected to the ClientRemoved signal from the
531
This is connected to the InterfacesRemoved signal from the
339
532
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
341
537
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
345
self.remove_client(client, path)
347
def add_new_client(self, path, properties):
545
def add_new_client(self, path, ifs_and_props):
546
"""Find a client by its object path and remove it.
548
This is connected to the InterfacesAdded signal from the
549
Mandos server object.
551
if client_interface not in ifs_and_props:
552
# Not a Mandos client object; ignore
348
554
client_proxy_object = self.bus.get_object(self.busname, path)
349
555
self.add_client(MandosClientWidget(server_proxy_object
350
556
=self.mandos_serv,
352
558
=client_proxy_object,
353
properties=properties,
357
=self.remove_client),
566
= dict(ifs_and_props[
360
570
def add_client(self, client, path=None):
386
591
"""Start the main loop and exit when it's done."""
592
self.bus = dbus.SystemBus()
593
mandos_dbus_objc = self.bus.get_object(
594
self.busname, "/", follow_name_owner_changes=True)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
599
mandos_clients = (self.mandos_serv
600
.GetAllClientsWithProperties())
601
if not mandos_clients:
602
self.log_message_raw(("bold", "Note: Server has no clients."))
603
except dbus.exceptions.DBusException:
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
605
mandos_clients = dbus.Dictionary()
608
.connect_to_signal("InterfacesRemoved",
609
self.find_and_remove_client,
611
= dbus.OBJECT_MANAGER_IFACE,
614
.connect_to_signal("InterfacesAdded",
617
= dbus.OBJECT_MANAGER_IFACE,
620
.connect_to_signal("ClientNotFound",
621
self.client_not_found,
622
dbus_interface=server_interface,
624
for path, client in mandos_clients.items():
625
client_proxy_object = self.bus.get_object(self.busname,
627
self.add_client(MandosClientWidget(server_proxy_object
630
=client_proxy_object,
388
self._input_callback_tag = (gobject.io_add_watch
641
self._input_callback_tag = (GLib.io_add_watch
389
642
(sys.stdin.fileno(),
391
644
self.process_input))
392
645
self.main_loop.run()
393
646
# Main loop has finished, we should close everything now
394
gobject.source_remove(self._input_callback_tag)
647
GLib.source_remove(self._input_callback_tag)
395
648
self.screen.stop()
415
668
except KeyError: # :-)
418
if key == u"q" or key == u"Q":
671
if key == "q" or key == "Q":
421
elif key == u"window resize":
674
elif key == "window resize":
422
675
self.size = self.screen.get_cols_rows()
424
elif key == u"\f": # Ctrl-L
677
elif key == "ctrl l":
426
elif key == u"l" or key == u"D":
680
elif key == "l" or key == "D":
427
681
self.toggle_log_display()
429
elif key == u"w" or key == u"i":
683
elif key == "w" or key == "i":
430
684
self.change_log_display()
432
elif key == u"?" or key == u"f1":
686
elif key == "?" or key == "f1" or key == "esc":
433
687
if not self.log_visible:
434
688
self.log_visible = True
436
self.log_message((u"bold",
437
u" ".join((u"q: Quit",
439
u"l: Log window toggle",
440
u"TAB: Switch window",
442
self.log_message((u"bold",
443
u" ".join((u"Clients:",
447
u"s: Start new checker",
690
self.log_message_raw(("bold",
694
"l: Log window toggle",
695
"TAB: Switch window",
696
"w: Wrap (log lines)",
697
"v: Toggle verbose log",
699
self.log_message_raw(("bold",
705
"s: Start new checker",
452
712
if self.topwidget.get_focus() is self.logbox:
453
713
self.topwidget.set_focus(0)
455
715
self.topwidget.set_focus(self.logbox)
457
#elif (key == u"end" or key == u"meta >" or key == u"G"
718
if self.log_level == 0:
720
self.log_message("Verbose mode: Off")
723
self.log_message("Verbose mode: On")
724
#elif (key == "end" or key == "meta >" or key == "G"
459
726
# pass # xxx end-of-buffer
460
#elif (key == u"home" or key == u"meta <" or key == u"g"
727
#elif (key == "home" or key == "meta <" or key == "g"
462
729
# pass # xxx beginning-of-buffer
463
#elif key == u"ctrl e" or key == u"$":
730
#elif key == "ctrl e" or key == "$":
464
731
# pass # xxx move-end-of-line
465
#elif key == u"ctrl a" or key == u"^":
732
#elif key == "ctrl a" or key == "^":
466
733
# pass # xxx move-beginning-of-line
467
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
468
735
# pass # xxx left
469
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
470
737
# pass # xxx right
472
739
# pass # scroll up log
474
741
# pass # scroll down log
475
742
elif self.topwidget.selectable():
476
743
self.topwidget.keypress(self.size, key)