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>.
4
from __future__ import division, absolute_import, with_statement
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
15
41
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
24
locale.setlocale(locale.LC_ALL, u'')
51
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
27
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
29
59
# Some useful constants
30
domain = 'se.bsnet.fukt'
60
domain = 'se.recompile'
31
61
server_interface = domain + '.Mandos'
32
62
client_interface = domain + '.Mandos.Client'
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)
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
43
81
class MandosClientPropertyCache(object):
44
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
45
83
properties and calls a hook function when any of them are
48
def __init__(self, proxy_object=None, *args, **kwargs):
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
49
87
self.proxy = proxy_object # Mandos Client proxy object
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))
61
#XXX This break good super behaviour!
62
# super(MandosClientPropertyCache, self).__init__(
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)
65
def property_changed(self, property=None, value=None):
66
"""This is called whenever we get a PropertyChanged signal
67
It updates the changed property in the "properties" dict.
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.
69
107
# Update properties dict with new value
70
self.properties[property] = value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
73
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
86
127
self.logger = logger
129
self._update_timer_callback_tag = None
88
131
# The widget shown normally
89
self._text_widget = urwid.Text(u"")
132
self._text_widget = urwid.Text("")
90
133
# The widget shown when we have focus
91
self._focus_text_widget = urwid.Text(u"")
92
super(MandosClientWidget, self).__init__(
93
update_hook=update_hook, delete_hook=delete_hook,
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
96
137
self.opened = False
97
self.proxy.connect_to_signal(u"CheckerCompleted",
98
self.checker_completed,
101
self.proxy.connect_to_signal(u"CheckerStarted",
102
self.checker_started,
105
self.proxy.connect_to_signal(u"GotSecret",
109
self.proxy.connect_to_signal(u"NeedApproval",
113
self.proxy.connect_to_signal(u"Rejected",
118
def checker_completed(self, exitstatus, condition, command):
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):
119
177
if exitstatus == 0:
120
#self.logger(u'Checker for client %s (command "%s")'
122
# % (self.properties[u"name"], command))
124
if os.WIFEXITED(condition):
125
self.logger(u'Checker for client %s (command "%s")'
126
u' failed with exit code %s'
127
% (self.properties[u"name"], command,
128
os.WEXITSTATUS(condition)))
130
if os.WIFSIGNALED(condition):
131
self.logger(u'Checker for client %s (command "%s")'
132
u' was killed by signal %s'
133
% (self.properties[u"name"], command,
134
os.WTERMSIG(condition)))
136
if os.WCOREDUMP(condition):
137
self.logger(u'Checker for client %s (command "%s")'
139
% (self.properties[u"name"], command))
140
self.logger(u'Checker for client %s completed mysteriously')
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"]))
142
200
def checker_started(self, command):
143
#self.logger(u'Client %s started checker "%s"'
144
# % (self.properties[u"name"], unicode(command)))
201
"""Server signals that a checker started."""
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
147
206
def got_secret(self):
148
self.logger(u'Client %s received its secret'
149
% self.properties[u"name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
151
210
def need_approval(self, timeout, default):
153
message = u'Client %s needs approval within %s seconds'
212
message = 'Client {} needs approval within {} seconds'
155
message = u'Client %s will get its secret in %s seconds'
157
% (self.properties[u"name"], timeout/1000))
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
159
218
def rejected(self, reason):
160
self.logger(u'Client %s was rejected; reason: %s'
161
% (self.properties[u"name"], reason))
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
163
222
def selectable(self):
164
223
"""Make this a "selectable" widget.
165
224
This overrides the method from urwid.FlowWidget."""
168
def rows(self, (maxcol,), focus=False):
227
def rows(self, maxcolrow, focus=False):
169
228
"""How many rows this widget will occupy might depend on
170
229
whether we have focus or not.
171
230
This overrides the method from urwid.FlowWidget"""
172
return self.current_widget(focus).rows((maxcol,), focus=focus)
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
174
233
def current_widget(self, focus=False):
175
234
if focus or self.opened:
179
238
def update(self):
180
239
"Called when what is visible on the screen should be updated."
181
240
# How to add standout mode to a style
182
with_standout = { u"normal": u"standout",
183
u"bold": u"bold-standout",
185
u"underline-blink-standout",
186
u"bold-underline-blink":
187
u"bold-underline-blink-standout",
241
with_standout = { "normal": "standout",
242
"bold": "bold-standout",
244
"underline-blink-standout",
245
"bold-underline-blink":
246
"bold-underline-blink-standout",
190
249
# Rebuild focus and non-focus widgets using current properties
192
251
# Base part of a client. Name!
193
self._text = (u'%(name)s: '
194
% {u"name": self.properties[u"name"]})
196
if self.properties[u"approved_pending"]:
197
if self.properties[u"approved_by_default"]:
198
self._text += u"Connection established to client. (d)eny?"
200
self._text += u"Seeks approval to send secret. (a)pprove?"
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)
202
self._text += (u'%(enabled)s'
205
if self.properties[u"enabled"]
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
207
293
if not urwid.supports_unicode():
208
294
self._text = self._text.encode("ascii", "replace")
209
textlist = [(u"normal", self._text)]
295
textlist = [("normal", self._text)]
210
296
self._text_widget.set_text(textlist)
211
297
self._focus_text_widget.set_text([(with_standout[text[0]],
220
306
if self.update_hook is not None:
221
307
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 = ()
224
322
if self.delete_hook is not None:
225
323
self.delete_hook(self)
324
return super(MandosClientWidget, self).delete(**kwargs)
227
def render(self, (maxcol,), focus=False):
326
def render(self, maxcolrow, focus=False):
228
327
"""Render differently if we have focus.
229
328
This overrides the method from urwid.FlowWidget"""
230
return self.current_widget(focus).render((maxcol,),
329
return self.current_widget(focus).render(maxcolrow,
233
def keypress(self, (maxcol,), key):
332
def keypress(self, maxcolrow, key):
235
334
This overrides the method from urwid.FlowWidget"""
237
self.proxy.Enable(dbus_interface = client_interface)
239
self.proxy.Disable(dbus_interface = client_interface)
336
self.proxy.Enable(dbus_interface = client_interface,
339
self.proxy.Disable(dbus_interface = client_interface,
241
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
242
dbus_interface = client_interface)
343
dbus_interface = client_interface,
244
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
245
dbus_interface = client_interface)
246
elif key == u"r" or key == u"_" or key == u"ctrl k":
347
dbus_interface = client_interface,
349
elif key == "R" or key == "_" or key == "ctrl k":
247
350
self.server_proxy_object.RemoveClient(self.proxy
250
self.proxy.StartChecker(dbus_interface = client_interface)
252
self.proxy.StopChecker(dbus_interface = client_interface)
254
self.proxy.CheckedOK(dbus_interface = client_interface)
354
self.proxy.StartChecker(dbus_interface = client_interface,
357
self.proxy.StopChecker(dbus_interface = client_interface,
360
self.proxy.CheckedOK(dbus_interface = client_interface,
256
# elif key == u"p" or key == "=":
363
# elif key == "p" or key == "=":
257
364
# self.proxy.pause()
258
# elif key == u"u" or key == ":":
365
# elif key == "u" or key == ":":
259
366
# self.proxy.unpause()
260
# elif key == u"RET":
263
# self.proxy.Approve(True)
265
# self.proxy.Approve(False)
269
def property_changed(self, property=None, value=None,
271
"""Call self.update() if old value is not new value.
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
272
374
This overrides the method from MandosClientPropertyCache"""
273
property_name = unicode(property)
274
old_value = self.properties.get(property_name)
275
super(MandosClientWidget, self).property_changed(
276
property=property, value=value, *args, **kwargs)
277
if self.properties.get(property_name) != old_value:
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):
294
397
"""This is the entire user interface - the whole screen
295
398
with boxes, lists of client widgets, etc.
297
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
298
401
DBusGMainLoop(set_as_default=True)
300
403
self.screen = urwid.curses_display.Screen()
302
405
self.screen.register_palette((
304
u"default", u"default", None),
306
u"default", u"default", u"bold"),
308
u"default", u"default", u"underline"),
310
u"default", u"default", u"standout"),
311
(u"bold-underline-blink",
312
u"default", u"default", (u"bold", u"underline")),
314
u"default", u"default", (u"bold", u"standout")),
315
(u"underline-blink-standout",
316
u"default", u"default", (u"underline", u"standout")),
317
(u"bold-underline-blink-standout",
318
u"default", u"default", (u"bold", u"underline",
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"),
322
426
if urwid.supports_unicode():
323
self.divider = u"─" # \u2500
324
#self.divider = u"━" # \u2501
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
326
#self.divider = u"-" # \u002d
327
self.divider = u"_" # \u005f
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
329
433
self.screen.start()
344
450
# This keeps track of whether self.uilist currently has
345
451
# self.logbox in it or not
346
452
self.log_visible = True
347
self.log_wrap = u"any"
453
self.log_wrap = "any"
350
self.log_message_raw((u"bold",
351
u"Mandos Monitor version " + version))
352
self.log_message_raw((u"bold",
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
355
461
self.busname = domain + '.Mandos'
356
462
self.main_loop = gobject.MainLoop()
357
self.bus = dbus.SystemBus()
358
mandos_dbus_objc = self.bus.get_object(
359
self.busname, u"/", follow_name_owner_changes=True)
360
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
364
mandos_clients = (self.mandos_serv
365
.GetAllClientsWithProperties())
366
except dbus.exceptions.DBusException:
367
mandos_clients = dbus.Dictionary()
370
.connect_to_signal(u"ClientRemoved",
371
self.find_and_remove_client,
372
dbus_interface=server_interface,
375
.connect_to_signal(u"ClientAdded",
377
dbus_interface=server_interface,
380
.connect_to_signal(u"ClientNotFound",
381
self.client_not_found,
382
dbus_interface=server_interface,
384
for path, client in mandos_clients.iteritems():
385
client_proxy_object = self.bus.get_object(self.busname,
387
self.add_client(MandosClientWidget(server_proxy_object
390
=client_proxy_object,
400
464
def client_not_found(self, fingerprint, address):
401
self.log_message((u"Client with address %s and fingerprint %s"
402
u" could not be found" % (address,
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
405
469
def rebuild(self):
406
470
"""This rebuilds the User Interface.
407
471
Call this when the widget layout needs to change"""
409
473
#self.uilist.append(urwid.ListBox(self.clients))
410
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
411
476
#header=urwid.Divider(),
413
footer=urwid.Divider(div_char=self.divider)))
479
urwid.Divider(div_char=
414
481
if self.log_visible:
415
482
self.uilist.append(self.logbox)
417
483
self.topwidget = urwid.Pile(self.uilist)
419
def log_message(self, message):
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
420
489
timestamp = datetime.datetime.now().isoformat()
421
self.log_message_raw(timestamp + u": " + message)
490
self.log_message_raw("{}: {}".format(timestamp, message),
423
def log_message_raw(self, markup):
493
def log_message_raw(self, markup, level=1):
424
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
425
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
426
498
if (self.max_log_length
427
499
and len(self.log) > self.max_log_length):
428
500
del self.log[0:len(self.log)-self.max_log_length-1]
429
501
self.logbox.set_focus(len(self.logbox.body.contents),
430
coming_from=u"above")
433
505
def toggle_log_display(self):
434
506
"""Toggle visibility of the log buffer."""
435
507
self.log_visible = not self.log_visible
437
self.log_message(u"Log visibility changed to: "
438
+ unicode(self.log_visible))
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
440
512
def change_log_display(self):
441
513
"""Change type of log display.
442
514
Currently, this toggles wrapping of text lines."""
443
if self.log_wrap == u"clip":
444
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
446
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
447
519
for textwidget in self.log:
448
520
textwidget.set_wrap_mode(self.log_wrap)
449
self.log_message(u"Wrap mode: " + self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
451
524
def find_and_remove_client(self, path, name):
452
"""Find an client from its object path and remove it.
525
"""Find a client by its object path and remove it.
454
527
This is connected to the ClientRemoved signal from the
455
528
Mandos server object."""
503
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,
505
621
self._input_callback_tag = (gobject.io_add_watch
506
622
(sys.stdin.fileno(),
532
648
except KeyError: # :-)
535
if key == u"q" or key == u"Q":
651
if key == "q" or key == "Q":
538
elif key == u"window resize":
654
elif key == "window resize":
539
655
self.size = self.screen.get_cols_rows()
541
elif key == u"\f": # Ctrl-L
657
elif key == "ctrl l":
543
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
544
661
self.toggle_log_display()
546
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
547
664
self.change_log_display()
549
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
550
667
if not self.log_visible:
551
668
self.log_visible = True
553
self.log_message_raw((u"bold",
557
u"l: Log window toggle",
558
u"TAB: Switch window",
560
self.log_message_raw((u"bold",
566
u"s: Start new checker",
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",
573
692
if self.topwidget.get_focus() is self.logbox:
574
693
self.topwidget.set_focus(0)
576
695
self.topwidget.set_focus(self.logbox)
578
#elif (key == u"end" or key == u"meta >" or key == u"G"
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"
580
706
# pass # xxx end-of-buffer
581
#elif (key == u"home" or key == u"meta <" or key == u"g"
707
#elif (key == "home" or key == "meta <" or key == "g"
583
709
# pass # xxx beginning-of-buffer
584
#elif key == u"ctrl e" or key == u"$":
710
#elif key == "ctrl e" or key == "$":
585
711
# pass # xxx move-end-of-line
586
#elif key == u"ctrl a" or key == u"^":
712
#elif key == "ctrl a" or key == "^":
587
713
# pass # xxx move-beginning-of-line
588
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
589
715
# pass # xxx left
590
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
591
717
# pass # xxx right
593
719
# pass # scroll up log
595
721
# pass # scroll down log
596
722
elif self.topwidget.selectable():
597
723
self.topwidget.keypress(self.size, key)