2
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 *
4
from __future__ import division, absolute_import, with_statement
41
15
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)
24
locale.setlocale(locale.LC_ALL, u'')
59
26
# Some useful constants
60
domain = 'se.recompile'
27
domain = 'se.bsnet.fukt'
61
28
server_interface = domain + '.Mandos'
62
29
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
32
# Always run in monochrome mode
33
urwid.curses_display.curses.has_colors = lambda : False
35
# Urwid doesn't support blinking, but we want it. Since we have no
36
# use for underline on its own, we make underline also always blink.
37
urwid.curses_display.curses.A_UNDERLINE |= (
38
urwid.curses_display.curses.A_BLINK)
81
40
class MandosClientPropertyCache(object):
82
41
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
42
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
45
def __init__(self, proxy_object=None, *args, **kwargs):
87
46
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)
48
self.properties = dict()
49
self.proxy.connect_to_signal(u"PropertyChanged",
50
self.property_changed,
54
self.properties.update(
55
self.proxy.GetAll(client_interface,
56
dbus_interface = dbus.PROPERTIES_IFACE))
57
super(MandosClientPropertyCache, self).__init__(
58
proxy_object=proxy_object, *args, **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.
60
def property_changed(self, property=None, value=None):
61
"""This is called whenever we get a PropertyChanged signal
62
It updates the changed property in the "properties" dict.
107
64
# Update properties dict with new value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
65
self.properties[property] = value
114
68
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
127
81
self.logger = logger
129
self._update_timer_callback_tag = None
131
83
# The widget shown normally
132
self._text_widget = urwid.Text("")
84
self._text_widget = urwid.Text(u"")
133
85
# The widget shown when we have focus
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
86
self._focus_text_widget = urwid.Text(u"")
87
super(MandosClientWidget, self).__init__(
88
update_hook=update_hook, delete_hook=delete_hook,
137
91
self.opened = False
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
92
self.proxy.connect_to_signal(u"CheckerCompleted",
93
self.checker_completed,
96
self.proxy.connect_to_signal(u"CheckerStarted",
100
self.proxy.connect_to_signal(u"GotSecret",
104
self.proxy.connect_to_signal(u"Rejected",
176
109
def checker_completed(self, exitstatus, condition, command):
177
110
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
111
self.logger(u'Checker for client %s (command "%s")'
113
% (self.properties[u"name"], command))
184
115
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)))
116
self.logger(u'Checker for client %s (command "%s")'
117
u' failed with exit code %s'
118
% (self.properties[u"name"], command,
119
os.WEXITSTATUS(condition)))
121
if os.WIFSIGNALED(condition):
122
self.logger(u'Checker for client %s (command "%s")'
123
u' was killed by signal %s'
124
% (self.properties[u"name"], command,
125
os.WTERMSIG(condition)))
127
if os.WCOREDUMP(condition):
128
self.logger(u'Checker for client %s (command "%s")'
130
% (self.properties[u"name"], command))
131
self.logger(u'Checker for client %s completed mysteriously')
196
133
def checker_started(self, command):
197
"""Server signals that a checker started."""
198
self.logger('Client {} started checker "{}"'
199
.format(self.properties["Name"],
134
self.logger(u'Client %s started checker "%s"'
135
% (self.properties[u"name"], unicode(command)))
202
137
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))
138
self.logger(u'Client %s received its secret'
139
% self.properties[u"name"])
142
self.logger(u'Client %s was rejected'
143
% self.properties[u"name"])
218
145
def selectable(self):
219
146
"""Make this a "selectable" widget.
220
147
This overrides the method from urwid.FlowWidget."""
223
def rows(self, maxcolrow, focus=False):
150
def rows(self, (maxcol,), focus=False):
224
151
"""How many rows this widget will occupy might depend on
225
152
whether we have focus or not.
226
153
This overrides the method from urwid.FlowWidget"""
227
return self.current_widget(focus).rows(maxcolrow, focus=focus)
154
return self.current_widget(focus).rows((maxcol,), focus=focus)
229
156
def current_widget(self, focus=False):
230
157
if focus or self.opened:
234
161
def update(self):
235
162
"Called when what is visible on the screen should be updated."
236
163
# 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",
164
with_standout = { u"normal": u"standout",
165
u"bold": u"bold-standout",
167
u"underline-blink-standout",
168
u"bold-underline-blink":
169
u"bold-underline-blink-standout",
245
172
# 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)
173
self._text = (u'%(name)s: %(enabled)s'
174
% { u"name": self.properties[u"name"],
177
if self.properties[u"enabled"]
289
179
if not urwid.supports_unicode():
290
180
self._text = self._text.encode("ascii", "replace")
291
textlist = [("normal", self._text)]
181
textlist = [(u"normal", self._text)]
292
182
self._text_widget.set_text(textlist)
293
183
self._focus_text_widget.set_text([(with_standout[text[0]],
302
192
if self.update_hook is not None:
303
193
self.update_hook()
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
196
if self.delete_hook is not None:
319
197
self.delete_hook(self)
320
return super(MandosClientWidget, self).delete(**kwargs)
322
def render(self, maxcolrow, focus=False):
199
def render(self, (maxcol,), focus=False):
323
200
"""Render differently if we have focus.
324
201
This overrides the method from urwid.FlowWidget"""
325
return self.current_widget(focus).render(maxcolrow,
202
return self.current_widget(focus).render((maxcol,),
328
def keypress(self, maxcolrow, key):
205
def keypress(self, (maxcol,), key):
330
207
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":
208
if key == u"e" or key == u"+":
210
elif key == u"d" or key == u"-":
212
elif key == u"r" or key == u"_" or key == u"ctrl k":
348
213
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,
216
self.proxy.StartChecker()
218
self.proxy.StopChecker()
220
self.proxy.CheckedOK()
363
# elif key == "p" or key == "=":
222
# elif key == u"p" or key == "=":
364
223
# self.proxy.pause()
365
# elif key == "u" or key == ":":
224
# elif key == u"u" or key == ":":
366
225
# self.proxy.unpause()
226
# elif key == u"RET":
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
231
def property_changed(self, property=None, value=None,
233
"""Call self.update() if old value is not new value.
374
234
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):
235
property_name = unicode(property)
236
old_value = self.properties.get(property_name)
237
super(MandosClientWidget, self).property_changed(
238
property=property, value=value, *args, **kwargs)
239
if self.properties.get(property_name) != old_value:
397
256
"""This is the entire user interface - the whole screen
398
257
with boxes, lists of client widgets, etc.
400
def __init__(self, max_log_length=1000, log_level=1):
259
def __init__(self, max_log_length=1000):
401
260
DBusGMainLoop(set_as_default=True)
403
262
self.screen = urwid.curses_display.Screen()
405
264
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"),
266
u"default", u"default", None),
268
u"default", u"default", u"bold"),
270
u"default", u"default", u"underline"),
272
u"default", u"default", u"standout"),
273
(u"bold-underline-blink",
274
u"default", u"default", (u"bold", u"underline")),
276
u"default", u"default", (u"bold", u"standout")),
277
(u"underline-blink-standout",
278
u"default", u"default", (u"underline", u"standout")),
279
(u"bold-underline-blink-standout",
280
u"default", u"default", (u"bold", u"underline",
426
284
if urwid.supports_unicode():
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
285
self.divider = u"─" # \u2500
286
#self.divider = u"━" # \u2501
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
288
#self.divider = u"-" # \u002d
289
self.divider = u"_" # \u005f
433
291
self.screen.start()
450
306
# This keeps track of whether self.uilist currently has
451
307
# self.logbox in it or not
452
308
self.log_visible = True
453
self.log_wrap = "any"
309
self.log_wrap = u"any"
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
312
self.log_message_raw((u"bold",
313
u"Mandos Monitor version " + version))
314
self.log_message_raw((u"bold",
461
317
self.busname = domain + '.Mandos'
462
318
self.main_loop = gobject.MainLoop()
319
self.bus = dbus.SystemBus()
320
mandos_dbus_objc = self.bus.get_object(
321
self.busname, u"/", follow_name_owner_changes=True)
322
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
326
mandos_clients = (self.mandos_serv
327
.GetAllClientsWithProperties())
328
except dbus.exceptions.DBusException:
329
mandos_clients = dbus.Dictionary()
332
.connect_to_signal(u"ClientRemoved",
333
self.find_and_remove_client,
334
dbus_interface=server_interface,
337
.connect_to_signal(u"ClientAdded",
339
dbus_interface=server_interface,
342
.connect_to_signal(u"ClientNotFound",
343
self.client_not_found,
344
dbus_interface=server_interface,
346
for path, client in mandos_clients.iteritems():
347
client_proxy_object = self.bus.get_object(self.busname,
349
self.add_client(MandosClientWidget(server_proxy_object
352
=client_proxy_object,
464
362
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))
363
self.log_message((u"Client with address %s and fingerprint %s"
364
u" could not be found" % (address,
469
367
def rebuild(self):
470
368
"""This rebuilds the User Interface.
471
369
Call this when the widget layout needs to change"""
473
371
#self.uilist.append(urwid.ListBox(self.clients))
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
372
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
476
373
#header=urwid.Divider(),
479
urwid.Divider(div_char=
375
footer=urwid.Divider(div_char=self.divider)))
481
376
if self.log_visible:
482
377
self.uilist.append(self.logbox)
483
379
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:
381
def log_message(self, message):
489
382
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
383
self.log_message_raw(timestamp + u": " + message)
493
def log_message_raw(self, markup, level=1):
385
def log_message_raw(self, markup):
494
386
"""Add a log message to the log buffer."""
495
if level < self.log_level:
497
387
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
388
if (self.max_log_length
499
389
and len(self.log) > self.max_log_length):
500
390
del self.log[0:len(self.log)-self.max_log_length-1]
501
391
self.logbox.set_focus(len(self.logbox.body.contents),
392
coming_from=u"above")
505
395
def toggle_log_display(self):
506
396
"""Toggle visibility of the log buffer."""
507
397
self.log_visible = not self.log_visible
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
399
self.log_message(u"Log visibility changed to: "
400
+ unicode(self.log_visible))
512
402
def change_log_display(self):
513
403
"""Change type of log display.
514
404
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
405
if self.log_wrap == u"clip":
406
self.log_wrap = u"any"
518
self.log_wrap = "clip"
408
self.log_wrap = u"clip"
519
409
for textwidget in self.log:
520
410
textwidget.set_wrap_mode(self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
411
self.log_message(u"Wrap mode: " + self.log_wrap)
524
413
def find_and_remove_client(self, path, name):
525
"""Find a client by its object path and remove it.
414
"""Find an client from its object path and remove it.
527
416
This is connected to the ClientRemoved signal from the
528
417
Mandos server object."""
573
465
"""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
467
self._input_callback_tag = (gobject.io_add_watch
622
468
(sys.stdin.fileno(),
648
494
except KeyError: # :-)
651
if key == "q" or key == "Q":
497
if key == u"q" or key == u"Q":
654
elif key == "window resize":
500
elif key == u"window resize":
655
501
self.size = self.screen.get_cols_rows()
657
elif key == "ctrl l":
503
elif key == u"\f": # Ctrl-L
660
elif key == "l" or key == "D":
505
elif key == u"l" or key == u"D":
661
506
self.toggle_log_display()
663
elif key == "w" or key == "i":
508
elif key == u"w" or key == u"i":
664
509
self.change_log_display()
666
elif key == "?" or key == "f1" or key == "esc":
511
elif key == u"?" or key == u"f1" or key == u"esc":
667
512
if not self.log_visible:
668
513
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",
515
self.log_message_raw((u"bold",
519
u"l: Log window toggle",
520
u"TAB: Switch window",
522
self.log_message_raw((u"bold",
528
u"s: Start new checker",
692
533
if self.topwidget.get_focus() is self.logbox:
693
534
self.topwidget.set_focus(0)
695
536
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"
538
#elif (key == u"end" or key == u"meta >" or key == u"G"
706
540
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
541
#elif (key == u"home" or key == u"meta <" or key == u"g"
709
543
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
544
#elif key == u"ctrl e" or key == u"$":
711
545
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
546
#elif key == u"ctrl a" or key == u"^":
713
547
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
548
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
715
549
# pass # xxx left
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
550
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
717
551
# pass # xxx right
719
553
# pass # scroll up log
721
555
# pass # scroll down log
722
556
elif self.topwidget.selectable():
723
557
self.topwidget.keypress(self.size, key)