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>.
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("PropertyChanged",
91
self._property_changed,
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)
103
def _property_changed(self, property, value):
104
"""Helper which takes positional arguments"""
105
return self.property_changed(property=property, value=value)
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)
107
60
def property_changed(self, property=None, value=None):
108
61
"""This is called whenever we get a PropertyChanged signal
131
81
self.logger = logger
133
self._update_timer_callback_tag = None
135
83
# The widget shown normally
136
self._text_widget = urwid.Text("")
84
self._text_widget = urwid.Text(u"")
137
85
# The widget shown when we have focus
138
self._focus_text_widget = urwid.Text("")
139
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,
141
91
self.opened = False
143
self.match_objects = (
144
self.proxy.connect_to_signal("CheckerCompleted",
145
self.checker_completed,
148
self.proxy.connect_to_signal("CheckerStarted",
149
self.checker_started,
152
self.proxy.connect_to_signal("GotSecret",
156
self.proxy.connect_to_signal("NeedApproval",
160
self.proxy.connect_to_signal("Rejected",
164
self.logger('Created client {}'
165
.format(self.properties["Name"]), level=0)
167
def using_timer(self, flag):
168
"""Call this method with True or False when timer should be
169
activated or deactivated.
171
if flag and self._update_timer_callback_tag is None:
172
# Will update the shown timer value every second
173
self._update_timer_callback_tag = (gobject.timeout_add
176
elif not (flag or self._update_timer_callback_tag is None):
177
gobject.source_remove(self._update_timer_callback_tag)
178
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",
180
109
def checker_completed(self, exitstatus, condition, command):
181
110
if exitstatus == 0:
182
self.logger('Checker for client {} (command "{}")'
183
' succeeded'.format(self.properties["Name"],
111
self.logger(u'Checker for client %s (command "%s")'
113
% (self.properties[u"name"], command))
188
115
if os.WIFEXITED(condition):
189
self.logger('Checker for client {} (command "{}") failed'
191
.format(self.properties["Name"], command,
192
os.WEXITSTATUS(condition)))
193
elif os.WIFSIGNALED(condition):
194
self.logger('Checker for client {} (command "{}") was'
195
' killed by signal {}'
196
.format(self.properties["Name"], command,
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {} (command "{}") dumped'
200
' core'.format(self.properties["Name"],
203
self.logger('Checker for client {} completed'
205
.format(self.properties["Name"]))
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')
208
133
def checker_started(self, command):
209
"""Server signals that a checker started."""
210
self.logger('Client {} started checker "{}"'
211
.format(self.properties["Name"],
134
self.logger(u'Client %s started checker "%s"'
135
% (self.properties[u"name"], unicode(command)))
214
137
def got_secret(self):
215
self.logger('Client {} received its secret'
216
.format(self.properties["Name"]))
218
def need_approval(self, timeout, default):
220
message = 'Client {} needs approval within {} seconds'
222
message = 'Client {} will get its secret in {} seconds'
223
self.logger(message.format(self.properties["Name"],
226
def rejected(self, reason):
227
self.logger('Client {} was rejected; reason: {}'
228
.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"])
230
145
def selectable(self):
231
146
"""Make this a "selectable" widget.
232
147
This overrides the method from urwid.FlowWidget."""
235
def rows(self, maxcolrow, focus=False):
150
def rows(self, (maxcol,), focus=False):
236
151
"""How many rows this widget will occupy might depend on
237
152
whether we have focus or not.
238
153
This overrides the method from urwid.FlowWidget"""
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
154
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
156
def current_widget(self, focus=False):
242
157
if focus or self.opened:
246
161
def update(self):
247
162
"Called when what is visible on the screen should be updated."
248
163
# How to add standout mode to a style
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"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",
257
172
# Rebuild focus and non-focus widgets using current properties
259
# Base part of a client. Name!
260
base = '{name}: '.format(name=self.properties["Name"])
261
if not self.properties["Enabled"]:
263
self.using_timer(False)
264
elif self.properties["ApprovalPending"]:
265
timeout = datetime.timedelta(milliseconds
268
last_approval_request = isoformat_to_datetime(
269
self.properties["LastApprovalRequest"])
270
if last_approval_request is not None:
271
timer = max(timeout - (datetime.datetime.utcnow()
272
- last_approval_request),
273
datetime.timedelta())
275
timer = datetime.timedelta()
276
if self.properties["ApprovedByDefault"]:
277
message = "Approval in {}. (d)eny?"
279
message = "Denial in {}. (a)pprove?"
280
message = message.format(str(timer).rsplit(".", 1)[0])
281
self.using_timer(True)
282
elif self.properties["LastCheckerStatus"] != 0:
283
# When checker has failed, show timer until client expires
284
expires = self.properties["Expires"]
286
timer = datetime.timedelta(0)
288
expires = (datetime.datetime.strptime
289
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
timer = max(expires - datetime.datetime.utcnow(),
291
datetime.timedelta())
292
message = ('A checker has failed! Time until client'
294
.format(str(timer).rsplit(".", 1)[0]))
295
self.using_timer(True)
298
self.using_timer(False)
299
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"]
301
179
if not urwid.supports_unicode():
302
180
self._text = self._text.encode("ascii", "replace")
303
textlist = [("normal", self._text)]
181
textlist = [(u"normal", self._text)]
304
182
self._text_widget.set_text(textlist)
305
183
self._focus_text_widget.set_text([(with_standout[text[0]],
314
192
if self.update_hook is not None:
315
193
self.update_hook()
317
def update_timer(self):
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
321
return True # Keep calling this
323
def delete(self, **kwargs):
324
if self._update_timer_callback_tag is not None:
325
gobject.source_remove(self._update_timer_callback_tag)
326
self._update_timer_callback_tag = None
327
for match in self.match_objects:
329
self.match_objects = ()
330
196
if self.delete_hook is not None:
331
197
self.delete_hook(self)
332
return super(MandosClientWidget, self).delete(**kwargs)
334
def render(self, maxcolrow, focus=False):
199
def render(self, (maxcol,), focus=False):
335
200
"""Render differently if we have focus.
336
201
This overrides the method from urwid.FlowWidget"""
337
return self.current_widget(focus).render(maxcolrow,
202
return self.current_widget(focus).render((maxcol,),
340
def keypress(self, maxcolrow, key):
205
def keypress(self, (maxcol,), key):
342
207
This overrides the method from urwid.FlowWidget"""
344
self.proxy.Enable(dbus_interface = client_interface,
347
self.proxy.Disable(dbus_interface = client_interface,
350
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
351
dbus_interface = client_interface,
354
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
355
dbus_interface = client_interface,
357
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":
358
213
self.server_proxy_object.RemoveClient(self.proxy
362
self.proxy.StartChecker(dbus_interface = client_interface,
365
self.proxy.StopChecker(dbus_interface = client_interface,
368
self.proxy.CheckedOK(dbus_interface = client_interface,
216
self.proxy.StartChecker()
218
self.proxy.StopChecker()
220
self.proxy.CheckedOK()
371
# elif key == "p" or key == "=":
222
# elif key == u"p" or key == "=":
372
223
# self.proxy.pause()
373
# elif key == "u" or key == ":":
224
# elif key == u"u" or key == ":":
374
225
# self.proxy.unpause()
226
# elif key == u"RET":
380
def property_changed(self, property=None, **kwargs):
231
def property_changed(self, property=None, value=None,
381
233
"""Call self.update() if old value is not new value.
382
234
This overrides the method from MandosClientPropertyCache"""
383
property_name = str(property)
235
property_name = unicode(property)
384
236
old_value = self.properties.get(property_name)
385
237
super(MandosClientWidget, self).property_changed(
386
property=property, **kwargs)
238
property=property, value=value, *args, **kwargs)
387
239
if self.properties.get(property_name) != old_value:
404
256
"""This is the entire user interface - the whole screen
405
257
with boxes, lists of client widgets, etc.
407
def __init__(self, max_log_length=1000, log_level=1):
259
def __init__(self, max_log_length=1000):
408
260
DBusGMainLoop(set_as_default=True)
410
262
self.screen = urwid.curses_display.Screen()
412
264
self.screen.register_palette((
414
"default", "default", None),
416
"bold", "default", "bold"),
418
"underline,blink", "default", "underline,blink"),
420
"standout", "default", "standout"),
421
("bold-underline-blink",
422
"bold,underline,blink", "default", "bold,underline,blink"),
424
"bold,standout", "default", "bold,standout"),
425
("underline-blink-standout",
426
"underline,blink,standout", "default",
427
"underline,blink,standout"),
428
("bold-underline-blink-standout",
429
"bold,underline,blink,standout", "default",
430
"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",
433
284
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
285
self.divider = u"─" # \u2500
286
#self.divider = u"━" # \u2501
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
288
#self.divider = u"-" # \u002d
289
self.divider = u"_" # \u005f
440
291
self.screen.start()
457
306
# This keeps track of whether self.uilist currently has
458
307
# self.logbox in it or not
459
308
self.log_visible = True
460
self.log_wrap = "any"
309
self.log_wrap = u"any"
463
self.log_message_raw(("bold",
464
"Mandos Monitor version " + version))
465
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",
468
317
self.busname = domain + '.Mandos'
469
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,
471
362
def client_not_found(self, fingerprint, address):
472
self.log_message("Client with address {} and fingerprint {}"
473
" could not be found"
474
.format(address, fingerprint))
363
self.log_message((u"Client with address %s and fingerprint %s"
364
u" could not be found" % (address,
476
367
def rebuild(self):
477
368
"""This rebuilds the User Interface.
478
369
Call this when the widget layout needs to change"""
480
371
#self.uilist.append(urwid.ListBox(self.clients))
481
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
372
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
483
373
#header=urwid.Divider(),
486
urwid.Divider(div_char=
375
footer=urwid.Divider(div_char=self.divider)))
488
376
if self.log_visible:
489
377
self.uilist.append(self.logbox)
490
379
self.topwidget = urwid.Pile(self.uilist)
492
def log_message(self, message, level=1):
493
"""Log message formatted with timestamp"""
494
if level < self.log_level:
381
def log_message(self, message):
496
382
timestamp = datetime.datetime.now().isoformat()
497
self.log_message_raw("{}: {}".format(timestamp, message),
383
self.log_message_raw(timestamp + u": " + message)
500
def log_message_raw(self, markup, level=1):
385
def log_message_raw(self, markup):
501
386
"""Add a log message to the log buffer."""
502
if level < self.log_level:
504
387
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
388
if (self.max_log_length
506
389
and len(self.log) > self.max_log_length):
507
390
del self.log[0:len(self.log)-self.max_log_length-1]
508
391
self.logbox.set_focus(len(self.logbox.body.contents),
392
coming_from=u"above")
512
395
def toggle_log_display(self):
513
396
"""Toggle visibility of the log buffer."""
514
397
self.log_visible = not self.log_visible
516
self.log_message("Log visibility changed to: {}"
517
.format(self.log_visible), level=0)
399
self.log_message(u"Log visibility changed to: "
400
+ unicode(self.log_visible))
519
402
def change_log_display(self):
520
403
"""Change type of log display.
521
404
Currently, this toggles wrapping of text lines."""
522
if self.log_wrap == "clip":
523
self.log_wrap = "any"
405
if self.log_wrap == u"clip":
406
self.log_wrap = u"any"
525
self.log_wrap = "clip"
408
self.log_wrap = u"clip"
526
409
for textwidget in self.log:
527
410
textwidget.set_wrap_mode(self.log_wrap)
528
self.log_message("Wrap mode: {}".format(self.log_wrap),
411
self.log_message(u"Wrap mode: " + self.log_wrap)
531
413
def find_and_remove_client(self, path, name):
532
"""Find a client by its object path and remove it.
414
"""Find an client from its object path and remove it.
534
416
This is connected to the ClientRemoved signal from the
535
417
Mandos server object."""
580
465
"""Start the main loop and exit when it's done."""
581
self.bus = dbus.SystemBus()
582
mandos_dbus_objc = self.bus.get_object(
583
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
588
mandos_clients = (self.mandos_serv
589
.GetAllClientsWithProperties())
590
if not mandos_clients:
591
self.log_message_raw(("bold", "Note: Server has no clients."))
592
except dbus.exceptions.DBusException:
593
self.log_message_raw(("bold", "Note: No Mandos server running."))
594
mandos_clients = dbus.Dictionary()
597
.connect_to_signal("ClientRemoved",
598
self.find_and_remove_client,
599
dbus_interface=server_interface,
602
.connect_to_signal("ClientAdded",
604
dbus_interface=server_interface,
607
.connect_to_signal("ClientNotFound",
608
self.client_not_found,
609
dbus_interface=server_interface,
611
for path, client in mandos_clients.items():
612
client_proxy_object = self.bus.get_object(self.busname,
614
self.add_client(MandosClientWidget(server_proxy_object
617
=client_proxy_object,
628
467
self._input_callback_tag = (gobject.io_add_watch
629
468
(sys.stdin.fileno(),
655
494
except KeyError: # :-)
658
if key == "q" or key == "Q":
497
if key == u"q" or key == u"Q":
661
elif key == "window resize":
500
elif key == u"window resize":
662
501
self.size = self.screen.get_cols_rows()
664
elif key == "ctrl l":
503
elif key == u"\f": # Ctrl-L
667
elif key == "l" or key == "D":
505
elif key == u"l" or key == u"D":
668
506
self.toggle_log_display()
670
elif key == "w" or key == "i":
508
elif key == u"w" or key == u"i":
671
509
self.change_log_display()
673
elif key == "?" or key == "f1" or key == "esc":
511
elif key == u"?" or key == u"f1" or key == u"esc":
674
512
if not self.log_visible:
675
513
self.log_visible = True
677
self.log_message_raw(("bold",
681
"l: Log window toggle",
682
"TAB: Switch window",
683
"w: Wrap (log lines)",
684
"v: Toggle verbose log",
686
self.log_message_raw(("bold",
692
"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",
699
533
if self.topwidget.get_focus() is self.logbox:
700
534
self.topwidget.set_focus(0)
702
536
self.topwidget.set_focus(self.logbox)
705
if self.log_level == 0:
707
self.log_message("Verbose mode: Off")
710
self.log_message("Verbose mode: On")
711
#elif (key == "end" or key == "meta >" or key == "G"
538
#elif (key == u"end" or key == u"meta >" or key == u"G"
713
540
# pass # xxx end-of-buffer
714
#elif (key == "home" or key == "meta <" or key == "g"
541
#elif (key == u"home" or key == u"meta <" or key == u"g"
716
543
# pass # xxx beginning-of-buffer
717
#elif key == "ctrl e" or key == "$":
544
#elif key == u"ctrl e" or key == u"$":
718
545
# pass # xxx move-end-of-line
719
#elif key == "ctrl a" or key == "^":
546
#elif key == u"ctrl a" or key == u"^":
720
547
# pass # xxx move-beginning-of-line
721
#elif key == "ctrl b" or key == "meta (" or key == "h":
548
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
722
549
# pass # xxx left
723
#elif key == "ctrl f" or key == "meta )" or key == "l":
550
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
724
551
# pass # xxx right
726
553
# pass # scroll up log
728
555
# pass # scroll down log
729
556
elif self.topwidget.selectable():
730
557
self.topwidget.keypress(self.size, key)