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, '')
24
locale.setlocale(locale.LC_ALL, u'')
57
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
59
29
# Some useful constants
60
domain = 'se.recompile'
30
domain = 'se.bsnet.fukt'
61
31
server_interface = domain + '.Mandos'
62
32
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
35
# Always run in monochrome mode
36
urwid.curses_display.curses.has_colors = lambda : False
38
# Urwid doesn't support blinking, but we want it. Since we have no
39
# use for underline on its own, we make underline also always blink.
40
urwid.curses_display.curses.A_UNDERLINE |= (
41
urwid.curses_display.curses.A_BLINK)
81
43
class MandosClientPropertyCache(object):
82
44
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
45
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
48
def __init__(self, proxy_object=None, *args, **kwargs):
87
49
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)
51
self.properties = dict()
52
self.proxy.connect_to_signal(u"PropertyChanged",
53
self.property_changed,
57
self.properties.update(
58
self.proxy.GetAll(client_interface,
59
dbus_interface = dbus.PROPERTIES_IFACE))
60
super(MandosClientPropertyCache, self).__init__(
61
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.
63
def property_changed(self, property=None, value=None):
64
"""This is called whenever we get a PropertyChanged signal
65
It updates the changed property in the "properties" dict.
107
67
# Update properties dict with new value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
68
self.properties[property] = value
114
71
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
127
84
self.logger = logger
129
self._update_timer_callback_tag = None
131
86
# The widget shown normally
132
self._text_widget = urwid.Text("")
87
self._text_widget = urwid.Text(u"")
133
88
# The widget shown when we have focus
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
89
self._focus_text_widget = urwid.Text(u"")
90
super(MandosClientWidget, self).__init__(
91
update_hook=update_hook, delete_hook=delete_hook,
137
94
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
176
def checker_completed(self, exitstatus, signal, command):
95
self.proxy.connect_to_signal(u"CheckerCompleted",
96
self.checker_completed,
99
self.proxy.connect_to_signal(u"CheckerStarted",
100
self.checker_started,
103
self.proxy.connect_to_signal(u"GotSecret",
107
self.proxy.connect_to_signal(u"Rejected",
112
def checker_completed(self, exitstatus, condition, command):
177
113
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
195
self.logger('Checker for client {} completed'
197
.format(self.properties["Name"]))
114
self.logger(u'Checker for client %s (command "%s")'
116
% (self.properties[u"name"], command))
118
if os.WIFEXITED(condition):
119
self.logger(u'Checker for client %s (command "%s")'
120
u' failed with exit code %s'
121
% (self.properties[u"name"], command,
122
os.WEXITSTATUS(condition)))
124
if os.WIFSIGNALED(condition):
125
self.logger(u'Checker for client %s (command "%s")'
126
u' was killed by signal %s'
127
% (self.properties[u"name"], command,
128
os.WTERMSIG(condition)))
130
if os.WCOREDUMP(condition):
131
self.logger(u'Checker for client %s (command "%s")'
133
% (self.properties[u"name"], command))
134
self.logger(u'Checker for client %s completed mysteriously')
200
136
def checker_started(self, command):
201
"""Server signals that a checker started."""
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
137
self.logger(u'Client %s started checker "%s"'
138
% (self.properties[u"name"], unicode(command)))
206
140
def got_secret(self):
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
210
def need_approval(self, timeout, default):
212
message = 'Client {} needs approval within {} seconds'
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
218
def rejected(self, reason):
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
141
self.logger(u'Client %s received its secret'
142
% self.properties[u"name"])
145
self.logger(u'Client %s was rejected'
146
% self.properties[u"name"])
222
148
def selectable(self):
223
149
"""Make this a "selectable" widget.
224
150
This overrides the method from urwid.FlowWidget."""
227
def rows(self, maxcolrow, focus=False):
153
def rows(self, (maxcol,), focus=False):
228
154
"""How many rows this widget will occupy might depend on
229
155
whether we have focus or not.
230
156
This overrides the method from urwid.FlowWidget"""
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
157
return self.current_widget(focus).rows((maxcol,), focus=focus)
233
159
def current_widget(self, focus=False):
234
160
if focus or self.opened:
238
164
def update(self):
239
165
"Called when what is visible on the screen should be updated."
240
166
# How to add standout mode to a style
241
with_standout = { "normal": "standout",
242
"bold": "bold-standout",
244
"underline-blink-standout",
245
"bold-underline-blink":
246
"bold-underline-blink-standout",
167
with_standout = { u"normal": u"standout",
168
u"bold": u"bold-standout",
170
u"underline-blink-standout",
171
u"bold-underline-blink":
172
u"bold-underline-blink-standout",
249
175
# Rebuild focus and non-focus widgets using current properties
251
# Base part of a client. Name!
252
base = '{name}: '.format(name=self.properties["Name"])
253
if not self.properties["Enabled"]:
255
self.using_timer(False)
256
elif self.properties["ApprovalPending"]:
257
timeout = datetime.timedelta(milliseconds
260
last_approval_request = isoformat_to_datetime(
261
self.properties["LastApprovalRequest"])
262
if last_approval_request is not None:
263
timer = max(timeout - (datetime.datetime.utcnow()
264
- last_approval_request),
265
datetime.timedelta())
267
timer = datetime.timedelta()
268
if self.properties["ApprovedByDefault"]:
269
message = "Approval in {}. (d)eny?"
271
message = "Denial in {}. (a)pprove?"
272
message = message.format(str(timer).rsplit(".", 1)[0])
273
self.using_timer(True)
274
elif self.properties["LastCheckerStatus"] != 0:
275
# When checker has failed, show timer until client expires
276
expires = self.properties["Expires"]
278
timer = datetime.timedelta(0)
280
expires = (datetime.datetime.strptime
281
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
282
timer = max(expires - datetime.datetime.utcnow(),
283
datetime.timedelta())
284
message = ('A checker has failed! Time until client'
286
.format(str(timer).rsplit(".", 1)[0]))
287
self.using_timer(True)
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
176
self._text = (u'%(name)s: %(enabled)s'
177
% { u"name": self.properties[u"name"],
180
if self.properties[u"enabled"]
293
182
if not urwid.supports_unicode():
294
183
self._text = self._text.encode("ascii", "replace")
295
textlist = [("normal", self._text)]
184
textlist = [(u"normal", self._text)]
296
185
self._text_widget.set_text(textlist)
297
186
self._focus_text_widget.set_text([(with_standout[text[0]],
306
195
if self.update_hook is not None:
307
196
self.update_hook()
309
def update_timer(self):
310
"""called by gobject. Will indefinitely loop until
311
gobject.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
gobject.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 = ()
322
199
if self.delete_hook is not None:
323
200
self.delete_hook(self)
324
return super(MandosClientWidget, self).delete(**kwargs)
326
def render(self, maxcolrow, focus=False):
202
def render(self, (maxcol,), focus=False):
327
203
"""Render differently if we have focus.
328
204
This overrides the method from urwid.FlowWidget"""
329
return self.current_widget(focus).render(maxcolrow,
205
return self.current_widget(focus).render((maxcol,),
332
def keypress(self, maxcolrow, key):
208
def keypress(self, (maxcol,), key):
334
210
This overrides the method from urwid.FlowWidget"""
336
self.proxy.Enable(dbus_interface = client_interface,
339
self.proxy.Disable(dbus_interface = client_interface,
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface = client_interface,
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface = client_interface,
349
elif key == "R" or key == "_" or key == "ctrl k":
211
if key == u"e" or key == u"+":
213
elif key == u"d" or key == u"-":
215
elif key == u"r" or key == u"_" or key == u"ctrl k":
350
216
self.server_proxy_object.RemoveClient(self.proxy
354
self.proxy.StartChecker(dbus_interface = client_interface,
357
self.proxy.StopChecker(dbus_interface = client_interface,
360
self.proxy.CheckedOK(dbus_interface = client_interface,
219
self.proxy.StartChecker()
221
self.proxy.StopChecker()
223
self.proxy.CheckedOK()
363
# elif key == "p" or key == "=":
225
# elif key == u"p" or key == "=":
364
226
# self.proxy.pause()
365
# elif key == "u" or key == ":":
227
# elif key == u"u" or key == ":":
366
228
# self.proxy.unpause()
229
# elif key == u"RET":
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
234
def property_changed(self, property=None, value=None,
236
"""Call self.update() if old value is not new value.
374
237
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):
238
property_name = unicode(property)
239
old_value = self.properties.get(property_name)
240
super(MandosClientWidget, self).property_changed(
241
property=property, value=value, *args, **kwargs)
242
if self.properties.get(property_name) != old_value:
397
259
"""This is the entire user interface - the whole screen
398
260
with boxes, lists of client widgets, etc.
400
def __init__(self, max_log_length=1000, log_level=1):
262
def __init__(self, max_log_length=1000):
401
263
DBusGMainLoop(set_as_default=True)
403
265
self.screen = urwid.curses_display.Screen()
405
267
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"),
269
u"default", u"default", None),
271
u"default", u"default", u"bold"),
273
u"default", u"default", u"underline"),
275
u"default", u"default", u"standout"),
276
(u"bold-underline-blink",
277
u"default", u"default", (u"bold", u"underline")),
279
u"default", u"default", (u"bold", u"standout")),
280
(u"underline-blink-standout",
281
u"default", u"default", (u"underline", u"standout")),
282
(u"bold-underline-blink-standout",
283
u"default", u"default", (u"bold", u"underline",
426
287
if urwid.supports_unicode():
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
288
self.divider = u"─" # \u2500
289
#self.divider = u"━" # \u2501
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
291
#self.divider = u"-" # \u002d
292
self.divider = u"_" # \u005f
433
294
self.screen.start()
450
309
# This keeps track of whether self.uilist currently has
451
310
# self.logbox in it or not
452
311
self.log_visible = True
453
self.log_wrap = "any"
312
self.log_wrap = u"any"
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
315
self.log_message_raw((u"bold",
316
u"Mandos Monitor version " + version))
317
self.log_message_raw((u"bold",
461
320
self.busname = domain + '.Mandos'
462
321
self.main_loop = gobject.MainLoop()
322
self.bus = dbus.SystemBus()
323
mandos_dbus_objc = self.bus.get_object(
324
self.busname, u"/", follow_name_owner_changes=True)
325
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
329
mandos_clients = (self.mandos_serv
330
.GetAllClientsWithProperties())
331
except dbus.exceptions.DBusException:
332
mandos_clients = dbus.Dictionary()
335
.connect_to_signal(u"ClientRemoved",
336
self.find_and_remove_client,
337
dbus_interface=server_interface,
340
.connect_to_signal(u"ClientAdded",
342
dbus_interface=server_interface,
345
.connect_to_signal(u"ClientNotFound",
346
self.client_not_found,
347
dbus_interface=server_interface,
349
for path, client in mandos_clients.iteritems():
350
client_proxy_object = self.bus.get_object(self.busname,
352
self.add_client(MandosClientWidget(server_proxy_object
355
=client_proxy_object,
464
365
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))
366
self.log_message((u"Client with address %s and fingerprint %s"
367
u" could not be found" % (address,
469
370
def rebuild(self):
470
371
"""This rebuilds the User Interface.
471
372
Call this when the widget layout needs to change"""
473
374
#self.uilist.append(urwid.ListBox(self.clients))
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
375
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
476
376
#header=urwid.Divider(),
479
urwid.Divider(div_char=
378
footer=urwid.Divider(div_char=self.divider)))
481
379
if self.log_visible:
482
380
self.uilist.append(self.logbox)
483
382
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:
384
def log_message(self, message):
489
385
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
386
self.log_message_raw(timestamp + u": " + message)
493
def log_message_raw(self, markup, level=1):
388
def log_message_raw(self, markup):
494
389
"""Add a log message to the log buffer."""
495
if level < self.log_level:
497
390
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
391
if (self.max_log_length
499
392
and len(self.log) > self.max_log_length):
500
393
del self.log[0:len(self.log)-self.max_log_length-1]
501
394
self.logbox.set_focus(len(self.logbox.body.contents),
395
coming_from=u"above")
505
398
def toggle_log_display(self):
506
399
"""Toggle visibility of the log buffer."""
507
400
self.log_visible = not self.log_visible
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
402
self.log_message(u"Log visibility changed to: "
403
+ unicode(self.log_visible))
512
405
def change_log_display(self):
513
406
"""Change type of log display.
514
407
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
408
if self.log_wrap == u"clip":
409
self.log_wrap = u"any"
518
self.log_wrap = "clip"
411
self.log_wrap = u"clip"
519
412
for textwidget in self.log:
520
413
textwidget.set_wrap_mode(self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
414
self.log_message(u"Wrap mode: " + self.log_wrap)
524
416
def find_and_remove_client(self, path, name):
525
"""Find a client by its object path and remove it.
417
"""Find an client from its object path and remove it.
527
419
This is connected to the ClientRemoved signal from the
528
420
Mandos server object."""
573
468
"""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
470
self._input_callback_tag = (gobject.io_add_watch
622
471
(sys.stdin.fileno(),
648
497
except KeyError: # :-)
651
if key == "q" or key == "Q":
500
if key == u"q" or key == u"Q":
654
elif key == "window resize":
503
elif key == u"window resize":
655
504
self.size = self.screen.get_cols_rows()
657
elif key == "ctrl l":
506
elif key == u"\f": # Ctrl-L
660
elif key == "l" or key == "D":
508
elif key == u"l" or key == u"D":
661
509
self.toggle_log_display()
663
elif key == "w" or key == "i":
511
elif key == u"w" or key == u"i":
664
512
self.change_log_display()
666
elif key == "?" or key == "f1" or key == "esc":
514
elif key == u"?" or key == u"f1" or key == u"esc":
667
515
if not self.log_visible:
668
516
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",
518
self.log_message_raw((u"bold",
522
u"l: Log window toggle",
523
u"TAB: Switch window",
525
self.log_message_raw((u"bold",
531
u"s: Start new checker",
692
536
if self.topwidget.get_focus() is self.logbox:
693
537
self.topwidget.set_focus(0)
695
539
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"
541
#elif (key == u"end" or key == u"meta >" or key == u"G"
706
543
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
544
#elif (key == u"home" or key == u"meta <" or key == u"g"
709
546
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
547
#elif key == u"ctrl e" or key == u"$":
711
548
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
549
#elif key == u"ctrl a" or key == u"^":
713
550
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
551
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
715
552
# pass # xxx left
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
553
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
717
554
# pass # xxx right
719
556
# pass # scroll up log
721
558
# pass # scroll down log
722
559
elif self.topwidget.selectable():
723
560
self.topwidget.keypress(self.size, key)