2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 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
42
15
from dbus.mainloop.glib import DBusGMainLoop
46
from gi.repository import GObject as gobject
52
if sys.version_info[0] == 2:
55
locale.setlocale(locale.LC_ALL, '')
58
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
24
locale.setlocale(locale.LC_ALL, u'')
60
26
# Some useful constants
61
domain = 'se.recompile'
27
domain = 'se.bsnet.fukt'
62
28
server_interface = domain + '.Mandos'
63
29
client_interface = domain + '.Mandos.Client'
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)
66
40
def isoformat_to_datetime(iso):
67
41
"Parse an ISO 8601 date string to a datetime.datetime()"
70
d, t = iso.split("T", 1)
71
year, month, day = d.split("-", 2)
72
hour, minute, second = t.split(":", 2)
44
d, t = iso.split(u"T", 1)
45
year, month, day = d.split(u"-", 2)
46
hour, minute, second = t.split(u":", 2)
73
47
second, fraction = divmod(float(second), 1)
74
48
return datetime.datetime(int(year),
84
58
properties and calls a hook function when any of them are
87
def __init__(self, proxy_object=None, properties=None, **kwargs):
61
def __init__(self, proxy_object=None, *args, **kwargs):
88
62
self.proxy = proxy_object # Mandos Client proxy object
89
self.properties = dict() if properties is None else properties
90
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self._property_changed,
96
if properties is None:
97
self.properties.update(
98
self.proxy.GetAll(client_interface,
100
= dbus.PROPERTIES_IFACE))
102
super(MandosClientPropertyCache, self).__init__(**kwargs)
104
def _property_changed(self, property, value):
105
"""Helper which takes positional arguments"""
106
return self.property_changed(property=property, value=value)
64
self.properties = dict()
65
self.proxy.connect_to_signal(u"PropertyChanged",
66
self.property_changed,
70
self.properties.update(
71
self.proxy.GetAll(client_interface,
72
dbus_interface = dbus.PROPERTIES_IFACE))
73
super(MandosClientPropertyCache, self).__init__(
74
proxy_object=proxy_object, *args, **kwargs)
108
76
def property_changed(self, property=None, value=None):
109
77
"""This is called whenever we get a PropertyChanged signal
132
97
self.logger = logger
134
99
self._update_timer_callback_tag = None
100
self.last_checker_failed = False
136
102
# The widget shown normally
137
self._text_widget = urwid.Text("")
103
self._text_widget = urwid.Text(u"")
138
104
# The widget shown when we have focus
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(**kwargs)
105
self._focus_text_widget = urwid.Text(u"")
106
super(MandosClientWidget, self).__init__(
107
update_hook=update_hook, delete_hook=delete_hook,
142
110
self.opened = False
144
self.match_objects = (
145
self.proxy.connect_to_signal("CheckerCompleted",
146
self.checker_completed,
149
self.proxy.connect_to_signal("CheckerStarted",
150
self.checker_started,
153
self.proxy.connect_to_signal("GotSecret",
157
self.proxy.connect_to_signal("NeedApproval",
161
self.proxy.connect_to_signal("Rejected",
165
#self.logger('Created client {0}'
166
# .format(self.properties["Name"]))
168
def using_timer(self, flag):
169
"""Call this method with True or False when timer should be
170
activated or deactivated.
172
if flag and self._update_timer_callback_tag is None:
173
# Will update the shown timer value every second
111
self.proxy.connect_to_signal(u"CheckerCompleted",
112
self.checker_completed,
115
self.proxy.connect_to_signal(u"CheckerStarted",
116
self.checker_started,
119
self.proxy.connect_to_signal(u"GotSecret",
123
self.proxy.connect_to_signal(u"Rejected",
127
last_checked_ok = isoformat_to_datetime(self.properties
129
if last_checked_ok is None:
130
self.last_checker_failed = True
132
self.last_checker_failed = ((datetime.datetime.utcnow()
136
self.properties["interval"]))
137
if self.last_checker_failed:
174
138
self._update_timer_callback_tag = (gobject.timeout_add
176
140
self.update_timer))
177
elif not (flag or self._update_timer_callback_tag is None):
178
gobject.source_remove(self._update_timer_callback_tag)
179
self._update_timer_callback_tag = None
181
142
def checker_completed(self, exitstatus, condition, command):
182
143
if exitstatus == 0:
144
if self.last_checker_failed:
145
self.last_checker_failed = False
146
gobject.source_remove(self._update_timer_callback_tag)
147
self._update_timer_callback_tag = None
148
self.logger(u'Checker for client %s (command "%s")'
150
% (self.properties[u"name"], command))
154
if not self.last_checker_failed:
155
self.last_checker_failed = True
156
self._update_timer_callback_tag = (gobject.timeout_add
186
159
if os.WIFEXITED(condition):
187
self.logger('Checker for client {0} (command "{1}")'
188
' failed with exit code {2}'
189
.format(self.properties["Name"], command,
190
os.WEXITSTATUS(condition)))
160
self.logger(u'Checker for client %s (command "%s")'
161
u' failed with exit code %s'
162
% (self.properties[u"name"], command,
163
os.WEXITSTATUS(condition)))
191
164
elif os.WIFSIGNALED(condition):
192
self.logger('Checker for client {0} (command "{1}") was'
193
' killed by signal {2}'
194
.format(self.properties["Name"], command,
195
os.WTERMSIG(condition)))
165
self.logger(u'Checker for client %s (command "%s")'
166
u' was killed by signal %s'
167
% (self.properties[u"name"], command,
168
os.WTERMSIG(condition)))
196
169
elif os.WCOREDUMP(condition):
197
self.logger('Checker for client {0} (command "{1}")'
199
.format(self.properties["Name"], command))
170
self.logger(u'Checker for client %s (command "%s")'
172
% (self.properties[u"name"], command))
201
self.logger('Checker for client {0} completed'
203
.format(self.properties["Name"]))
174
self.logger(u'Checker for client %s completed mysteriously')
206
177
def checker_started(self, command):
207
"""Server signals that a checker started. This could be useful
208
to log in the future. """
209
#self.logger('Client {0} started checker "{1}"'
210
# .format(self.properties["Name"],
178
self.logger(u'Client %s started checker "%s"'
179
% (self.properties[u"name"], unicode(command)))
214
181
def got_secret(self):
215
self.logger('Client {0} received its secret'
216
.format(self.properties["Name"]))
218
def need_approval(self, timeout, default):
220
message = 'Client {0} needs approval within {1} seconds'
222
message = 'Client {0} will get its secret in {1} seconds'
223
self.logger(message.format(self.properties["Name"],
226
def rejected(self, reason):
227
self.logger('Client {0} was rejected; reason: {1}'
228
.format(self.properties["Name"], reason))
182
self.logger(u'Client %s received its secret'
183
% self.properties[u"name"])
186
self.logger(u'Client %s was rejected'
187
% self.properties[u"name"])
230
189
def selectable(self):
231
190
"""Make this a "selectable" widget.
232
191
This overrides the method from urwid.FlowWidget."""
235
def rows(self, maxcolrow, focus=False):
194
def rows(self, (maxcol,), focus=False):
236
195
"""How many rows this widget will occupy might depend on
237
196
whether we have focus or not.
238
197
This overrides the method from urwid.FlowWidget"""
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
198
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
200
def current_widget(self, focus=False):
242
201
if focus or self.opened:
246
205
def update(self):
247
206
"Called when what is visible on the screen should be updated."
248
207
# 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",
208
with_standout = { u"normal": u"standout",
209
u"bold": u"bold-standout",
211
u"underline-blink-standout",
212
u"bold-underline-blink":
213
u"bold-underline-blink-standout",
257
216
# 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 {0}. (d)eny?"
279
message = "Denial in {0}. (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'
293
' gets disabled: {0}'
294
.format(str(timer).rsplit(".", 1)[0]))
295
self.using_timer(True)
298
self.using_timer(False)
299
self._text = "{0}{1}".format(base, message)
217
self._text = (u'%(name)s: %(enabled)s%(timer)s'
218
% { u"name": self.properties[u"name"],
221
if self.properties[u"enabled"]
223
u"timer": (unicode(datetime.timedelta
229
- isoformat_to_datetime
230
(max((self.properties
235
self.properties[u"last_enabled"]))))
236
if (self.last_checker_failed
301
240
if not urwid.supports_unicode():
302
241
self._text = self._text.encode("ascii", "replace")
303
textlist = [("normal", self._text)]
242
textlist = [(u"normal", self._text)]
304
243
self._text_widget.set_text(textlist)
305
244
self._focus_text_widget.set_text([(with_standout[text[0]],
315
254
self.update_hook()
317
256
def update_timer(self):
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
321
259
return True # Keep calling this
323
def delete(self, **kwargs):
324
262
if self._update_timer_callback_tag is not None:
325
263
gobject.source_remove(self._update_timer_callback_tag)
326
264
self._update_timer_callback_tag = None
327
for match in self.match_objects:
329
self.match_objects = ()
330
265
if self.delete_hook is not None:
331
266
self.delete_hook(self)
332
return super(MandosClientWidget, self).delete(**kwargs)
334
def render(self, maxcolrow, focus=False):
268
def render(self, (maxcol,), focus=False):
335
269
"""Render differently if we have focus.
336
270
This overrides the method from urwid.FlowWidget"""
337
return self.current_widget(focus).render(maxcolrow,
271
return self.current_widget(focus).render((maxcol,),
340
def keypress(self, maxcolrow, key):
274
def keypress(self, (maxcol,), key):
342
276
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":
277
if key == u"e" or key == u"+":
279
elif key == u"d" or key == u"-":
281
elif key == u"r" or key == u"_" or key == u"ctrl k":
358
282
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,
285
self.proxy.StartChecker()
287
self.proxy.StopChecker()
289
self.proxy.CheckedOK()
371
# elif key == "p" or key == "=":
291
# elif key == u"p" or key == "=":
372
292
# self.proxy.pause()
373
# elif key == "u" or key == ":":
293
# elif key == u"u" or key == ":":
374
294
# self.proxy.unpause()
295
# elif key == u"RET":
380
def property_changed(self, property=None, **kwargs):
300
def property_changed(self, property=None, value=None,
381
302
"""Call self.update() if old value is not new value.
382
303
This overrides the method from MandosClientPropertyCache"""
383
property_name = str(property)
304
property_name = unicode(property)
384
305
old_value = self.properties.get(property_name)
385
306
super(MandosClientWidget, self).property_changed(
386
property=property, **kwargs)
307
property=property, value=value, *args, **kwargs)
387
308
if self.properties.get(property_name) != old_value:
410
331
self.screen = urwid.curses_display.Screen()
412
333
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"),
335
u"default", u"default", None),
337
u"default", u"default", u"bold"),
339
u"default", u"default", u"underline"),
341
u"default", u"default", u"standout"),
342
(u"bold-underline-blink",
343
u"default", u"default", (u"bold", u"underline")),
345
u"default", u"default", (u"bold", u"standout")),
346
(u"underline-blink-standout",
347
u"default", u"default", (u"underline", u"standout")),
348
(u"bold-underline-blink-standout",
349
u"default", u"default", (u"bold", u"underline",
433
353
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
354
self.divider = u"─" # \u2500
355
#self.divider = u"━" # \u2501
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
357
#self.divider = u"-" # \u002d
358
self.divider = u"_" # \u005f
440
360
self.screen.start()
455
375
# This keeps track of whether self.uilist currently has
456
376
# self.logbox in it or not
457
377
self.log_visible = True
458
self.log_wrap = "any"
378
self.log_wrap = u"any"
461
self.log_message_raw(("bold",
462
"Mandos Monitor version " + version))
463
self.log_message_raw(("bold",
381
self.log_message_raw((u"bold",
382
u"Mandos Monitor version " + version))
383
self.log_message_raw((u"bold",
466
386
self.busname = domain + '.Mandos'
467
387
self.main_loop = gobject.MainLoop()
388
self.bus = dbus.SystemBus()
389
mandos_dbus_objc = self.bus.get_object(
390
self.busname, u"/", follow_name_owner_changes=True)
391
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
395
mandos_clients = (self.mandos_serv
396
.GetAllClientsWithProperties())
397
except dbus.exceptions.DBusException:
398
mandos_clients = dbus.Dictionary()
401
.connect_to_signal(u"ClientRemoved",
402
self.find_and_remove_client,
403
dbus_interface=server_interface,
406
.connect_to_signal(u"ClientAdded",
408
dbus_interface=server_interface,
411
.connect_to_signal(u"ClientNotFound",
412
self.client_not_found,
413
dbus_interface=server_interface,
415
for path, client in mandos_clients.iteritems():
416
client_proxy_object = self.bus.get_object(self.busname,
418
self.add_client(MandosClientWidget(server_proxy_object
421
=client_proxy_object,
469
431
def client_not_found(self, fingerprint, address):
470
self.log_message("Client with address {0} and fingerprint"
471
" {1} could not be found"
472
.format(address, fingerprint))
432
self.log_message((u"Client with address %s and fingerprint %s"
433
u" could not be found" % (address,
474
436
def rebuild(self):
475
437
"""This rebuilds the User Interface.
476
438
Call this when the widget layout needs to change"""
478
440
#self.uilist.append(urwid.ListBox(self.clients))
479
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
441
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
481
442
#header=urwid.Divider(),
484
urwid.Divider(div_char=
444
footer=urwid.Divider(div_char=self.divider)))
486
445
if self.log_visible:
487
446
self.uilist.append(self.logbox)
488
448
self.topwidget = urwid.Pile(self.uilist)
490
450
def log_message(self, message):
491
"""Log message formatted with timestamp"""
492
451
timestamp = datetime.datetime.now().isoformat()
493
self.log_message_raw(timestamp + ": " + message)
452
self.log_message_raw(timestamp + u": " + message)
495
454
def log_message_raw(self, markup):
496
455
"""Add a log message to the log buffer."""
499
458
and len(self.log) > self.max_log_length):
500
459
del self.log[0:len(self.log)-self.max_log_length-1]
501
460
self.logbox.set_focus(len(self.logbox.body.contents),
461
coming_from=u"above")
505
464
def toggle_log_display(self):
506
465
"""Toggle visibility of the log buffer."""
507
466
self.log_visible = not self.log_visible
509
#self.log_message("Log visibility changed to: "
510
# + str(self.log_visible))
468
self.log_message(u"Log visibility changed to: "
469
+ unicode(self.log_visible))
512
471
def change_log_display(self):
513
472
"""Change type of log display.
514
473
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
474
if self.log_wrap == u"clip":
475
self.log_wrap = u"any"
518
self.log_wrap = "clip"
477
self.log_wrap = u"clip"
519
478
for textwidget in self.log:
520
479
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
480
self.log_message(u"Wrap mode: " + self.log_wrap)
523
482
def find_and_remove_client(self, path, name):
524
"""Find a client by its object path and remove it.
483
"""Find an client from its object path and remove it.
526
485
This is connected to the ClientRemoved signal from the
527
486
Mandos server object."""
572
534
"""Start the main loop and exit when it's done."""
573
self.bus = dbus.SystemBus()
574
mandos_dbus_objc = self.bus.get_object(
575
self.busname, "/", follow_name_owner_changes=True)
576
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
580
mandos_clients = (self.mandos_serv
581
.GetAllClientsWithProperties())
582
if not mandos_clients:
583
self.log_message_raw(("bold", "Note: Server has no clients."))
584
except dbus.exceptions.DBusException:
585
self.log_message_raw(("bold", "Note: No Mandos server running."))
586
mandos_clients = dbus.Dictionary()
589
.connect_to_signal("ClientRemoved",
590
self.find_and_remove_client,
591
dbus_interface=server_interface,
594
.connect_to_signal("ClientAdded",
596
dbus_interface=server_interface,
599
.connect_to_signal("ClientNotFound",
600
self.client_not_found,
601
dbus_interface=server_interface,
603
for path, client in mandos_clients.items():
604
client_proxy_object = self.bus.get_object(self.busname,
606
self.add_client(MandosClientWidget(server_proxy_object
609
=client_proxy_object,
620
536
self._input_callback_tag = (gobject.io_add_watch
621
537
(sys.stdin.fileno(),
647
563
except KeyError: # :-)
650
if key == "q" or key == "Q":
566
if key == u"q" or key == u"Q":
653
elif key == "window resize":
569
elif key == u"window resize":
654
570
self.size = self.screen.get_cols_rows()
656
elif key == "\f": # Ctrl-L
572
elif key == u"\f": # Ctrl-L
658
elif key == "l" or key == "D":
574
elif key == u"l" or key == u"D":
659
575
self.toggle_log_display()
661
elif key == "w" or key == "i":
577
elif key == u"w" or key == u"i":
662
578
self.change_log_display()
664
elif key == "?" or key == "f1" or key == "esc":
580
elif key == u"?" or key == u"f1" or key == u"esc":
665
581
if not self.log_visible:
666
582
self.log_visible = True
668
self.log_message_raw(("bold",
672
"l: Log window toggle",
673
"TAB: Switch window",
675
self.log_message_raw(("bold",
681
"s: Start new checker",
584
self.log_message_raw((u"bold",
588
u"l: Log window toggle",
589
u"TAB: Switch window",
591
self.log_message_raw((u"bold",
597
u"s: Start new checker",
688
602
if self.topwidget.get_focus() is self.logbox:
689
603
self.topwidget.set_focus(0)
691
605
self.topwidget.set_focus(self.logbox)
693
#elif (key == "end" or key == "meta >" or key == "G"
607
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
609
# pass # xxx end-of-buffer
696
#elif (key == "home" or key == "meta <" or key == "g"
610
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
612
# pass # xxx beginning-of-buffer
699
#elif key == "ctrl e" or key == "$":
613
#elif key == u"ctrl e" or key == u"$":
700
614
# pass # xxx move-end-of-line
701
#elif key == "ctrl a" or key == "^":
615
#elif key == u"ctrl a" or key == u"^":
702
616
# pass # xxx move-beginning-of-line
703
#elif key == "ctrl b" or key == "meta (" or key == "h":
617
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
704
618
# pass # xxx left
705
#elif key == "ctrl f" or key == "meta )" or key == "l":
619
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
706
620
# pass # xxx right
708
622
# pass # scroll up log
710
624
# pass # scroll down log
711
625
elif self.topwidget.selectable():
712
626
self.topwidget.keypress(self.size, key)