2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 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))
60
super(MandosClientPropertyCache, self).__init__(
61
proxy_object=proxy_object, *args, **kwargs)
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)
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.
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.
67
107
# Update properties dict with new value
68
self.properties[property] = value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
71
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
84
127
self.logger = logger
129
self._update_timer_callback_tag = None
86
131
# The widget shown normally
87
self._text_widget = urwid.Text(u"")
132
self._text_widget = urwid.Text("")
88
133
# The widget shown when we have focus
89
self._focus_text_widget = urwid.Text(u"")
90
super(MandosClientWidget, self).__init__(
91
update_hook=update_hook, delete_hook=delete_hook,
134
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
94
137
self.opened = False
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",
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
112
176
def checker_completed(self, exitstatus, condition, command):
113
177
if exitstatus == 0:
114
self.logger(u'Checker for client %s (command "%s")'
116
% (self.properties[u"name"], command))
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
118
184
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')
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)))
194
elif os.WCOREDUMP(condition):
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
199
self.logger('Checker for client {} completed'
201
.format(self.properties["Name"]))
136
204
def checker_started(self, command):
137
self.logger(u'Client %s started checker "%s"'
138
% (self.properties[u"name"], unicode(command)))
205
"""Server signals that a checker started."""
206
self.logger('Client {} started checker "{}"'
207
.format(self.properties["Name"],
140
210
def got_secret(self):
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"])
211
self.logger('Client {} received its secret'
212
.format(self.properties["Name"]))
214
def need_approval(self, timeout, default):
216
message = 'Client {} needs approval within {} seconds'
218
message = 'Client {} will get its secret in {} seconds'
219
self.logger(message.format(self.properties["Name"],
222
def rejected(self, reason):
223
self.logger('Client {} was rejected; reason: {}'
224
.format(self.properties["Name"], reason))
148
226
def selectable(self):
149
227
"""Make this a "selectable" widget.
150
228
This overrides the method from urwid.FlowWidget."""
153
def rows(self, (maxcol,), focus=False):
231
def rows(self, maxcolrow, focus=False):
154
232
"""How many rows this widget will occupy might depend on
155
233
whether we have focus or not.
156
234
This overrides the method from urwid.FlowWidget"""
157
return self.current_widget(focus).rows((maxcol,), focus=focus)
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
159
237
def current_widget(self, focus=False):
160
238
if focus or self.opened:
164
242
def update(self):
165
243
"Called when what is visible on the screen should be updated."
166
244
# How to add standout mode to a style
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",
245
with_standout = { "normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
175
253
# Rebuild focus and non-focus widgets using current properties
176
self._text = (u'%(name)s: %(enabled)s'
177
% { u"name": self.properties[u"name"],
180
if self.properties[u"enabled"]
255
# Base part of a client. Name!
256
base = '{name}: '.format(name=self.properties["Name"])
257
if not self.properties["Enabled"]:
259
self.using_timer(False)
260
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(milliseconds
264
last_approval_request = isoformat_to_datetime(
265
self.properties["LastApprovalRequest"])
266
if last_approval_request is not None:
267
timer = max(timeout - (datetime.datetime.utcnow()
268
- last_approval_request),
269
datetime.timedelta())
271
timer = datetime.timedelta()
272
if self.properties["ApprovedByDefault"]:
273
message = "Approval in {}. (d)eny?"
275
message = "Denial in {}. (a)pprove?"
276
message = message.format(str(timer).rsplit(".", 1)[0])
277
self.using_timer(True)
278
elif self.properties["LastCheckerStatus"] != 0:
279
# When checker has failed, show timer until client expires
280
expires = self.properties["Expires"]
282
timer = datetime.timedelta(0)
284
expires = (datetime.datetime.strptime
285
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
timer = max(expires - datetime.datetime.utcnow(),
287
datetime.timedelta())
288
message = ('A checker has failed! Time until client'
290
.format(str(timer).rsplit(".", 1)[0]))
291
self.using_timer(True)
294
self.using_timer(False)
295
self._text = "{}{}".format(base, message)
182
297
if not urwid.supports_unicode():
183
298
self._text = self._text.encode("ascii", "replace")
184
textlist = [(u"normal", self._text)]
299
textlist = [("normal", self._text)]
185
300
self._text_widget.set_text(textlist)
186
301
self._focus_text_widget.set_text([(with_standout[text[0]],
195
310
if self.update_hook is not None:
196
311
self.update_hook()
313
def update_timer(self):
314
"""called by gobject. Will indefinitely loop until
315
gobject.source_remove() on tag is called"""
317
return True # Keep calling this
319
def delete(self, **kwargs):
320
if self._update_timer_callback_tag is not None:
321
gobject.source_remove(self._update_timer_callback_tag)
322
self._update_timer_callback_tag = None
323
for match in self.match_objects:
325
self.match_objects = ()
199
326
if self.delete_hook is not None:
200
327
self.delete_hook(self)
328
return super(MandosClientWidget, self).delete(**kwargs)
202
def render(self, (maxcol,), focus=False):
330
def render(self, maxcolrow, focus=False):
203
331
"""Render differently if we have focus.
204
332
This overrides the method from urwid.FlowWidget"""
205
return self.current_widget(focus).render((maxcol,),
333
return self.current_widget(focus).render(maxcolrow,
208
def keypress(self, (maxcol,), key):
336
def keypress(self, maxcolrow, key):
210
338
This overrides the method from urwid.FlowWidget"""
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":
340
self.proxy.Enable(dbus_interface = client_interface,
343
self.proxy.Disable(dbus_interface = client_interface,
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":
216
354
self.server_proxy_object.RemoveClient(self.proxy
219
self.proxy.StartChecker()
221
self.proxy.StopChecker()
223
self.proxy.CheckedOK()
358
self.proxy.StartChecker(dbus_interface = client_interface,
361
self.proxy.StopChecker(dbus_interface = client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
225
# elif key == u"p" or key == "=":
367
# elif key == "p" or key == "=":
226
368
# self.proxy.pause()
227
# elif key == u"u" or key == ":":
369
# elif key == "u" or key == ":":
228
370
# self.proxy.unpause()
229
# elif key == u"RET":
234
def property_changed(self, property=None, value=None,
236
"""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.
237
378
This overrides the method from MandosClientPropertyCache"""
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:
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):
259
401
"""This is the entire user interface - the whole screen
260
402
with boxes, lists of client widgets, etc.
262
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
263
405
DBusGMainLoop(set_as_default=True)
265
407
self.screen = urwid.curses_display.Screen()
267
409
self.screen.register_palette((
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",
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"),
287
430
if urwid.supports_unicode():
288
self.divider = u"─" # \u2500
289
#self.divider = u"━" # \u2501
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
291
#self.divider = u"-" # \u002d
292
self.divider = u"_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
294
437
self.screen.start()
309
454
# This keeps track of whether self.uilist currently has
310
455
# self.logbox in it or not
311
456
self.log_visible = True
312
self.log_wrap = u"any"
457
self.log_wrap = "any"
315
self.log_message_raw((u"bold",
316
u"Mandos Monitor version " + version))
317
self.log_message_raw((u"bold",
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
320
465
self.busname = domain + '.Mandos'
321
466
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,
365
468
def client_not_found(self, fingerprint, address):
366
self.log_message((u"Client with address %s and fingerprint %s"
367
u" could not be found" % (address,
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
370
473
def rebuild(self):
371
474
"""This rebuilds the User Interface.
372
475
Call this when the widget layout needs to change"""
374
477
#self.uilist.append(urwid.ListBox(self.clients))
375
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
376
480
#header=urwid.Divider(),
378
footer=urwid.Divider(div_char=self.divider)))
483
urwid.Divider(div_char=
379
485
if self.log_visible:
380
486
self.uilist.append(self.logbox)
382
487
self.topwidget = urwid.Pile(self.uilist)
384
def log_message(self, message):
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
385
493
timestamp = datetime.datetime.now().isoformat()
386
self.log_message_raw(timestamp + u": " + message)
494
self.log_message_raw("{}: {}".format(timestamp, message),
388
def log_message_raw(self, markup):
497
def log_message_raw(self, markup, level=1):
389
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
390
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
391
502
if (self.max_log_length
392
503
and len(self.log) > self.max_log_length):
393
504
del self.log[0:len(self.log)-self.max_log_length-1]
394
505
self.logbox.set_focus(len(self.logbox.body.contents),
395
coming_from=u"above")
398
509
def toggle_log_display(self):
399
510
"""Toggle visibility of the log buffer."""
400
511
self.log_visible = not self.log_visible
402
self.log_message(u"Log visibility changed to: "
403
+ unicode(self.log_visible))
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
405
516
def change_log_display(self):
406
517
"""Change type of log display.
407
518
Currently, this toggles wrapping of text lines."""
408
if self.log_wrap == u"clip":
409
self.log_wrap = u"any"
519
if self.log_wrap == "clip":
520
self.log_wrap = "any"
411
self.log_wrap = u"clip"
522
self.log_wrap = "clip"
412
523
for textwidget in self.log:
413
524
textwidget.set_wrap_mode(self.log_wrap)
414
self.log_message(u"Wrap mode: " + self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
416
528
def find_and_remove_client(self, path, name):
417
"""Find an client from its object path and remove it.
529
"""Find a client by its object path and remove it.
419
531
This is connected to the ClientRemoved signal from the
420
532
Mandos server object."""
468
577
"""Start the main loop and exit when it's done."""
578
self.bus = dbus.SystemBus()
579
mandos_dbus_objc = self.bus.get_object(
580
self.busname, "/", follow_name_owner_changes=True)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
585
mandos_clients = (self.mandos_serv
586
.GetAllClientsWithProperties())
587
if not mandos_clients:
588
self.log_message_raw(("bold", "Note: Server has no clients."))
589
except dbus.exceptions.DBusException:
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
591
mandos_clients = dbus.Dictionary()
594
.connect_to_signal("ClientRemoved",
595
self.find_and_remove_client,
596
dbus_interface=server_interface,
599
.connect_to_signal("ClientAdded",
601
dbus_interface=server_interface,
604
.connect_to_signal("ClientNotFound",
605
self.client_not_found,
606
dbus_interface=server_interface,
608
for path, client in mandos_clients.items():
609
client_proxy_object = self.bus.get_object(self.busname,
611
self.add_client(MandosClientWidget(server_proxy_object
614
=client_proxy_object,
470
625
self._input_callback_tag = (gobject.io_add_watch
471
626
(sys.stdin.fileno(),
497
652
except KeyError: # :-)
500
if key == u"q" or key == u"Q":
655
if key == "q" or key == "Q":
503
elif key == u"window resize":
658
elif key == "window resize":
504
659
self.size = self.screen.get_cols_rows()
506
elif key == u"\f": # Ctrl-L
661
elif key == "ctrl l":
508
elif key == u"l" or key == u"D":
664
elif key == "l" or key == "D":
509
665
self.toggle_log_display()
511
elif key == u"w" or key == u"i":
667
elif key == "w" or key == "i":
512
668
self.change_log_display()
514
elif key == u"?" or key == u"f1" or key == u"esc":
670
elif key == "?" or key == "f1" or key == "esc":
515
671
if not self.log_visible:
516
672
self.log_visible = True
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",
674
self.log_message_raw(("bold",
678
"l: Log window toggle",
679
"TAB: Switch window",
680
"w: Wrap (log lines)",
681
"v: Toggle verbose log",
683
self.log_message_raw(("bold",
689
"s: Start new checker",
536
696
if self.topwidget.get_focus() is self.logbox:
537
697
self.topwidget.set_focus(0)
539
699
self.topwidget.set_focus(self.logbox)
541
#elif (key == u"end" or key == u"meta >" or key == u"G"
702
if self.log_level == 0:
704
self.log_message("Verbose mode: Off")
707
self.log_message("Verbose mode: On")
708
#elif (key == "end" or key == "meta >" or key == "G"
543
710
# pass # xxx end-of-buffer
544
#elif (key == u"home" or key == u"meta <" or key == u"g"
711
#elif (key == "home" or key == "meta <" or key == "g"
546
713
# pass # xxx beginning-of-buffer
547
#elif key == u"ctrl e" or key == u"$":
714
#elif key == "ctrl e" or key == "$":
548
715
# pass # xxx move-end-of-line
549
#elif key == u"ctrl a" or key == u"^":
716
#elif key == "ctrl a" or key == "^":
550
717
# pass # xxx move-beginning-of-line
551
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
718
#elif key == "ctrl b" or key == "meta (" or key == "h":
552
719
# pass # xxx left
553
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
720
#elif key == "ctrl f" or key == "meta )" or key == "l":
554
721
# pass # xxx right
556
723
# pass # scroll up log
558
725
# pass # scroll down log
559
726
elif self.topwidget.selectable():
560
727
self.topwidget.keypress(self.size, key)