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, '')
24
locale.setlocale(locale.LC_ALL, u'')
58
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
60
29
# Some useful constants
61
domain = 'se.recompile'
30
domain = 'se.bsnet.fukt'
62
31
server_interface = domain + '.Mandos'
63
32
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)
66
43
def isoformat_to_datetime(iso):
67
44
"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)
47
d, t = iso.split(u"T", 1)
48
year, month, day = d.split(u"-", 2)
49
hour, minute, second = t.split(u":", 2)
73
50
second, fraction = divmod(float(second), 1)
74
51
return datetime.datetime(int(year),
84
61
properties and calls a hook function when any of them are
87
def __init__(self, proxy_object=None, properties=None, **kwargs):
64
def __init__(self, proxy_object=None, *args, **kwargs):
88
65
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)
67
self.properties = dict()
68
self.proxy.connect_to_signal(u"PropertyChanged",
69
self.property_changed,
73
self.properties.update(
74
self.proxy.GetAll(client_interface,
75
dbus_interface = dbus.PROPERTIES_IFACE))
77
#XXX This break good super behaviour!
78
# super(MandosClientPropertyCache, self).__init__(
108
81
def property_changed(self, property=None, value=None):
109
82
"""This is called whenever we get a PropertyChanged signal
132
102
self.logger = logger
134
104
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
136
107
# The widget shown normally
137
self._text_widget = urwid.Text("")
108
self._text_widget = urwid.Text(u"")
138
109
# The widget shown when we have focus
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(**kwargs)
110
self._focus_text_widget = urwid.Text(u"")
111
super(MandosClientWidget, self).__init__(
112
update_hook=update_hook, delete_hook=delete_hook,
142
115
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
116
self.proxy.connect_to_signal(u"CheckerCompleted",
117
self.checker_completed,
120
self.proxy.connect_to_signal(u"CheckerStarted",
121
self.checker_started,
124
self.proxy.connect_to_signal(u"GotSecret",
128
self.proxy.connect_to_signal(u"NeedApproval",
132
self.proxy.connect_to_signal(u"Rejected",
136
last_checked_ok = isoformat_to_datetime(self.properties
138
if last_checked_ok is None:
139
self.last_checker_failed = True
141
self.last_checker_failed = ((datetime.datetime.utcnow()
145
self.properties["interval"]))
146
if self.last_checker_failed:
174
147
self._update_timer_callback_tag = (gobject.timeout_add
176
149
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
151
def checker_completed(self, exitstatus, condition, command):
182
152
if exitstatus == 0:
153
if self.last_checker_failed:
154
self.last_checker_failed = False
155
gobject.source_remove(self._update_timer_callback_tag)
156
self._update_timer_callback_tag = None
157
self.logger(u'Checker for client %s (command "%s")'
159
% (self.properties[u"name"], command))
163
if not self.last_checker_failed:
164
self.last_checker_failed = True
165
self._update_timer_callback_tag = (gobject.timeout_add
186
168
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)))
169
self.logger(u'Checker for client %s (command "%s")'
170
u' failed with exit code %s'
171
% (self.properties[u"name"], command,
172
os.WEXITSTATUS(condition)))
191
173
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)))
174
self.logger(u'Checker for client %s (command "%s")'
175
u' was killed by signal %s'
176
% (self.properties[u"name"], command,
177
os.WTERMSIG(condition)))
196
178
elif os.WCOREDUMP(condition):
197
self.logger('Checker for client {0} (command "{1}")'
199
.format(self.properties["Name"], command))
179
self.logger(u'Checker for client %s (command "%s")'
181
% (self.properties[u"name"], command))
201
self.logger('Checker for client {0} completed'
203
.format(self.properties["Name"]))
183
self.logger(u'Checker for client %s completed mysteriously')
206
186
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"],
187
#self.logger(u'Client %s started checker "%s"'
188
# % (self.properties[u"name"], unicode(command)))
214
191
def got_secret(self):
215
self.logger('Client {0} received its secret'
216
.format(self.properties["Name"]))
192
self.logger(u'Client %s received its secret'
193
% self.properties[u"name"])
218
195
def need_approval(self, timeout, default):
220
message = 'Client {0} needs approval within {1} seconds'
197
message = u'Client %s needs approval within %s seconds'
222
message = 'Client {0} will get its secret in {1} seconds'
223
self.logger(message.format(self.properties["Name"],
199
message = u'Client %s will get its secret in %s seconds'
201
% (self.properties[u"name"], timeout/1000))
226
203
def rejected(self, reason):
227
self.logger('Client {0} was rejected; reason: {1}'
228
.format(self.properties["Name"], reason))
204
self.logger(u'Client %s was rejected; reason: %s'
205
% (self.properties[u"name"], reason))
230
207
def selectable(self):
231
208
"""Make this a "selectable" widget.
232
209
This overrides the method from urwid.FlowWidget."""
235
def rows(self, maxcolrow, focus=False):
212
def rows(self, (maxcol,), focus=False):
236
213
"""How many rows this widget will occupy might depend on
237
214
whether we have focus or not.
238
215
This overrides the method from urwid.FlowWidget"""
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
216
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
218
def current_widget(self, focus=False):
242
219
if focus or self.opened:
246
223
def update(self):
247
224
"Called when what is visible on the screen should be updated."
248
225
# 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",
226
with_standout = { u"normal": u"standout",
227
u"bold": u"bold-standout",
229
u"underline-blink-standout",
230
u"bold-underline-blink":
231
u"bold-underline-blink-standout",
257
234
# Rebuild focus and non-focus widgets using current properties
259
236
# 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"]:
237
base = (u'%(name)s: '
238
% {u"name": self.properties[u"name"]})
239
if not self.properties[u"enabled"]:
240
message = u"DISABLED"
241
elif self.last_checker_failed:
265
242
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)
243
= self.properties[u"timeout"])
244
last_ok = isoformat_to_datetime(
245
max((self.properties["last_checked_ok"]
246
or self.properties["created"]),
247
self.properties[u"last_enabled"]))
248
timer = timeout - (datetime.datetime.utcnow() - last_ok)
249
message = (u'A checker has failed! Time until client gets diabled: %s'
250
% unicode(timer).rsplit(".", 1)[0])
251
elif self.properties[u"approved_pending"]:
252
if self.properties[u"approved_by_default"]:
253
message = u"Connection established to client. (d)eny?"
255
message = u"Seeks approval to send secret. (a)pprove?"
298
self.using_timer(False)
299
self._text = "{0}{1}".format(base, message)
258
self._text = "%s%s" % (base, message)
301
260
if not urwid.supports_unicode():
302
261
self._text = self._text.encode("ascii", "replace")
303
textlist = [("normal", self._text)]
262
textlist = [(u"normal", self._text)]
304
263
self._text_widget.set_text(textlist)
305
264
self._focus_text_widget.set_text([(with_standout[text[0]],
315
274
self.update_hook()
317
276
def update_timer(self):
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
321
279
return True # Keep calling this
323
def delete(self, **kwargs):
324
282
if self._update_timer_callback_tag is not None:
325
283
gobject.source_remove(self._update_timer_callback_tag)
326
284
self._update_timer_callback_tag = None
327
for match in self.match_objects:
329
self.match_objects = ()
330
285
if self.delete_hook is not None:
331
286
self.delete_hook(self)
332
return super(MandosClientWidget, self).delete(**kwargs)
334
def render(self, maxcolrow, focus=False):
288
def render(self, (maxcol,), focus=False):
335
289
"""Render differently if we have focus.
336
290
This overrides the method from urwid.FlowWidget"""
337
return self.current_widget(focus).render(maxcolrow,
291
return self.current_widget(focus).render((maxcol,),
340
def keypress(self, maxcolrow, key):
294
def keypress(self, (maxcol,), key):
342
296
This overrides the method from urwid.FlowWidget"""
344
self.proxy.Enable(dbus_interface = client_interface,
347
self.proxy.Disable(dbus_interface = client_interface,
298
self.proxy.Enable(dbus_interface = client_interface)
300
self.proxy.Disable(dbus_interface = client_interface)
350
302
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
351
dbus_interface = client_interface,
303
dbus_interface = client_interface)
354
305
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
355
dbus_interface = client_interface,
357
elif key == "R" or key == "_" or key == "ctrl k":
306
dbus_interface = client_interface)
307
elif key == u"r" or key == u"_" or key == u"ctrl k":
358
308
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,
311
self.proxy.StartChecker(dbus_interface = client_interface)
313
self.proxy.StopChecker(dbus_interface = client_interface)
315
self.proxy.CheckedOK(dbus_interface = client_interface)
371
# elif key == "p" or key == "=":
317
# elif key == u"p" or key == "=":
372
318
# self.proxy.pause()
373
# elif key == "u" or key == ":":
319
# elif key == u"u" or key == ":":
374
320
# self.proxy.unpause()
321
# elif key == u"RET":
324
# self.proxy.Approve(True)
326
# self.proxy.Approve(False)
380
def property_changed(self, property=None, **kwargs):
330
def property_changed(self, property=None, value=None,
381
332
"""Call self.update() if old value is not new value.
382
333
This overrides the method from MandosClientPropertyCache"""
383
property_name = str(property)
334
property_name = unicode(property)
384
335
old_value = self.properties.get(property_name)
385
336
super(MandosClientWidget, self).property_changed(
386
property=property, **kwargs)
337
property=property, value=value, *args, **kwargs)
387
338
if self.properties.get(property_name) != old_value:
410
361
self.screen = urwid.curses_display.Screen()
412
363
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"),
365
u"default", u"default", None),
367
u"default", u"default", u"bold"),
369
u"default", u"default", u"underline"),
371
u"default", u"default", u"standout"),
372
(u"bold-underline-blink",
373
u"default", u"default", (u"bold", u"underline")),
375
u"default", u"default", (u"bold", u"standout")),
376
(u"underline-blink-standout",
377
u"default", u"default", (u"underline", u"standout")),
378
(u"bold-underline-blink-standout",
379
u"default", u"default", (u"bold", u"underline",
433
383
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
384
self.divider = u"─" # \u2500
385
#self.divider = u"━" # \u2501
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
387
#self.divider = u"-" # \u002d
388
self.divider = u"_" # \u005f
440
390
self.screen.start()
455
405
# This keeps track of whether self.uilist currently has
456
406
# self.logbox in it or not
457
407
self.log_visible = True
458
self.log_wrap = "any"
408
self.log_wrap = u"any"
461
self.log_message_raw(("bold",
462
"Mandos Monitor version " + version))
463
self.log_message_raw(("bold",
411
self.log_message_raw((u"bold",
412
u"Mandos Monitor version " + version))
413
self.log_message_raw((u"bold",
466
416
self.busname = domain + '.Mandos'
467
417
self.main_loop = gobject.MainLoop()
418
self.bus = dbus.SystemBus()
419
mandos_dbus_objc = self.bus.get_object(
420
self.busname, u"/", follow_name_owner_changes=True)
421
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
425
mandos_clients = (self.mandos_serv
426
.GetAllClientsWithProperties())
427
except dbus.exceptions.DBusException:
428
mandos_clients = dbus.Dictionary()
431
.connect_to_signal(u"ClientRemoved",
432
self.find_and_remove_client,
433
dbus_interface=server_interface,
436
.connect_to_signal(u"ClientAdded",
438
dbus_interface=server_interface,
441
.connect_to_signal(u"ClientNotFound",
442
self.client_not_found,
443
dbus_interface=server_interface,
445
for path, client in mandos_clients.iteritems():
446
client_proxy_object = self.bus.get_object(self.busname,
448
self.add_client(MandosClientWidget(server_proxy_object
451
=client_proxy_object,
469
461
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))
462
self.log_message((u"Client with address %s and fingerprint %s"
463
u" could not be found" % (address,
474
466
def rebuild(self):
475
467
"""This rebuilds the User Interface.
476
468
Call this when the widget layout needs to change"""
478
470
#self.uilist.append(urwid.ListBox(self.clients))
479
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
471
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
481
472
#header=urwid.Divider(),
484
urwid.Divider(div_char=
474
footer=urwid.Divider(div_char=self.divider)))
486
475
if self.log_visible:
487
476
self.uilist.append(self.logbox)
488
478
self.topwidget = urwid.Pile(self.uilist)
490
480
def log_message(self, message):
491
"""Log message formatted with timestamp"""
492
481
timestamp = datetime.datetime.now().isoformat()
493
self.log_message_raw(timestamp + ": " + message)
482
self.log_message_raw(timestamp + u": " + message)
495
484
def log_message_raw(self, markup):
496
485
"""Add a log message to the log buffer."""
499
488
and len(self.log) > self.max_log_length):
500
489
del self.log[0:len(self.log)-self.max_log_length-1]
501
490
self.logbox.set_focus(len(self.logbox.body.contents),
491
coming_from=u"above")
505
494
def toggle_log_display(self):
506
495
"""Toggle visibility of the log buffer."""
507
496
self.log_visible = not self.log_visible
509
#self.log_message("Log visibility changed to: "
510
# + str(self.log_visible))
498
self.log_message(u"Log visibility changed to: "
499
+ unicode(self.log_visible))
512
501
def change_log_display(self):
513
502
"""Change type of log display.
514
503
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
504
if self.log_wrap == u"clip":
505
self.log_wrap = u"any"
518
self.log_wrap = "clip"
507
self.log_wrap = u"clip"
519
508
for textwidget in self.log:
520
509
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
510
self.log_message(u"Wrap mode: " + self.log_wrap)
523
512
def find_and_remove_client(self, path, name):
524
"""Find a client by its object path and remove it.
513
"""Find an client from its object path and remove it.
526
515
This is connected to the ClientRemoved signal from the
527
516
Mandos server object."""
572
564
"""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
566
self._input_callback_tag = (gobject.io_add_watch
621
567
(sys.stdin.fileno(),
647
593
except KeyError: # :-)
650
if key == "q" or key == "Q":
596
if key == u"q" or key == u"Q":
653
elif key == "window resize":
599
elif key == u"window resize":
654
600
self.size = self.screen.get_cols_rows()
656
elif key == "\f": # Ctrl-L
602
elif key == u"\f": # Ctrl-L
658
elif key == "l" or key == "D":
604
elif key == u"l" or key == u"D":
659
605
self.toggle_log_display()
661
elif key == "w" or key == "i":
607
elif key == u"w" or key == u"i":
662
608
self.change_log_display()
664
elif key == "?" or key == "f1" or key == "esc":
610
elif key == u"?" or key == u"f1" or key == u"esc":
665
611
if not self.log_visible:
666
612
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",
614
self.log_message_raw((u"bold",
618
u"l: Log window toggle",
619
u"TAB: Switch window",
621
self.log_message_raw((u"bold",
627
u"s: Start new checker",
688
634
if self.topwidget.get_focus() is self.logbox:
689
635
self.topwidget.set_focus(0)
691
637
self.topwidget.set_focus(self.logbox)
693
#elif (key == "end" or key == "meta >" or key == "G"
639
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
641
# pass # xxx end-of-buffer
696
#elif (key == "home" or key == "meta <" or key == "g"
642
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
644
# pass # xxx beginning-of-buffer
699
#elif key == "ctrl e" or key == "$":
645
#elif key == u"ctrl e" or key == u"$":
700
646
# pass # xxx move-end-of-line
701
#elif key == "ctrl a" or key == "^":
647
#elif key == u"ctrl a" or key == u"^":
702
648
# pass # xxx move-beginning-of-line
703
#elif key == "ctrl b" or key == "meta (" or key == "h":
649
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
704
650
# pass # xxx left
705
#elif key == "ctrl f" or key == "meta )" or key == "l":
651
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
706
652
# pass # xxx right
708
654
# pass # scroll up log
710
656
# pass # scroll down log
711
657
elif self.topwidget.selectable():
712
658
self.topwidget.keypress(self.size, key)