2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2013 Teddy Hogeborn
7
# Copyright © 2009-2013 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
42
from dbus.mainloop.glib import DBusGMainLoop
46
from gi.repository import GObject as gobject
24
locale.setlocale(locale.LC_ALL, u'')
52
if sys.version_info[0] == 2:
55
locale.setlocale(locale.LC_ALL, '')
27
58
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
29
60
# Some useful constants
30
domain = 'se.bsnet.fukt'
61
domain = 'se.recompile'
31
62
server_interface = domain + '.Mandos'
32
63
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)
43
66
def isoformat_to_datetime(iso):
44
67
"Parse an ISO 8601 date string to a datetime.datetime()"
47
d, t = iso.split(u"T", 1)
48
year, month, day = d.split(u"-", 2)
49
hour, minute, second = t.split(u":", 2)
70
d, t = iso.split("T", 1)
71
year, month, day = d.split("-", 2)
72
hour, minute, second = t.split(":", 2)
50
73
second, fraction = divmod(float(second), 1)
51
74
return datetime.datetime(int(year),
61
84
properties and calls a hook function when any of them are
64
def __init__(self, proxy_object=None, *args, **kwargs):
87
def __init__(self, proxy_object=None, properties=None, **kwargs):
65
88
self.proxy = proxy_object # Mandos Client proxy object
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__(
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)
81
108
def property_changed(self, property=None, value=None):
82
109
"""This is called whenever we get a PropertyChanged signal
102
132
self.logger = logger
104
134
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
107
136
# The widget shown normally
108
self._text_widget = urwid.Text(u"")
137
self._text_widget = urwid.Text("")
109
138
# The widget shown when we have focus
110
self._focus_text_widget = urwid.Text(u"")
111
super(MandosClientWidget, self).__init__(
112
update_hook=update_hook, delete_hook=delete_hook,
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(**kwargs)
115
142
self.opened = False
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()
147
if self.last_checker_failed:
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
148
174
self._update_timer_callback_tag = (gobject.timeout_add
150
176
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
152
181
def checker_completed(self, exitstatus, condition, command):
153
182
if exitstatus == 0:
154
if self.last_checker_failed:
155
self.last_checker_failed = False
156
gobject.source_remove(self._update_timer_callback_tag)
157
self._update_timer_callback_tag = None
158
#self.logger(u'Checker for client %s (command "%s")'
160
# % (self.properties[u"Name"], command))
164
if not self.last_checker_failed:
165
self.last_checker_failed = True
166
self._update_timer_callback_tag = (gobject.timeout_add
169
186
if os.WIFEXITED(condition):
170
self.logger(u'Checker for client %s (command "%s")'
171
u' failed with exit code %s'
172
% (self.properties[u"Name"], command,
173
os.WEXITSTATUS(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)))
174
191
elif os.WIFSIGNALED(condition):
175
self.logger(u'Checker for client %s (command "%s")'
176
u' was killed by signal %s'
177
% (self.properties[u"Name"], command,
178
os.WTERMSIG(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)))
179
196
elif os.WCOREDUMP(condition):
180
self.logger(u'Checker for client %s (command "%s")'
182
% (self.properties[u"Name"], command))
197
self.logger('Checker for client {0} (command "{1}")'
199
.format(self.properties["Name"], command))
184
self.logger(u'Checker for client %s completed'
201
self.logger('Checker for client {0} completed'
203
.format(self.properties["Name"]))
188
206
def checker_started(self, command):
189
#self.logger(u'Client %s started checker "%s"'
190
# % (self.properties[u"Name"], unicode(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"],
193
214
def got_secret(self):
194
self.last_checker_failed = False
195
self.logger(u'Client %s received its secret'
196
% self.properties[u"Name"])
215
self.logger('Client {0} received its secret'
216
.format(self.properties["Name"]))
198
218
def need_approval(self, timeout, default):
200
message = u'Client %s needs approval within %s seconds'
220
message = 'Client {0} needs approval within {1} seconds'
202
message = u'Client %s will get its secret in %s seconds'
204
% (self.properties[u"Name"], timeout/1000))
222
message = 'Client {0} will get its secret in {1} seconds'
223
self.logger(message.format(self.properties["Name"],
206
226
def rejected(self, reason):
207
self.logger(u'Client %s was rejected; reason: %s'
208
% (self.properties[u"Name"], reason))
227
self.logger('Client {0} was rejected; reason: {1}'
228
.format(self.properties["Name"], reason))
210
230
def selectable(self):
211
231
"""Make this a "selectable" widget.
212
232
This overrides the method from urwid.FlowWidget."""
215
def rows(self, (maxcol,), focus=False):
235
def rows(self, maxcolrow, focus=False):
216
236
"""How many rows this widget will occupy might depend on
217
237
whether we have focus or not.
218
238
This overrides the method from urwid.FlowWidget"""
219
return self.current_widget(focus).rows((maxcol,), focus=focus)
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
221
241
def current_widget(self, focus=False):
222
242
if focus or self.opened:
226
246
def update(self):
227
247
"Called when what is visible on the screen should be updated."
228
248
# How to add standout mode to a style
229
with_standout = { u"normal": u"standout",
230
u"bold": u"bold-standout",
232
u"underline-blink-standout",
233
u"bold-underline-blink":
234
u"bold-underline-blink-standout",
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"bold-underline-blink-standout",
237
257
# Rebuild focus and non-focus widgets using current properties
239
259
# Base part of a client. Name!
240
base = (u'%(name)s: '
241
% {u"name": self.properties[u"Name"]})
242
if not self.properties[u"Enabled"]:
243
message = u"DISABLED"
244
elif self.properties[u"ApprovalPending"]:
245
if self.properties[u"ApprovedByDefault"]:
246
message = u"Connection established to client. (d)eny?"
248
message = u"Seeks approval to send secret. (a)pprove?"
249
elif self.last_checker_failed:
260
base = '{name}: '.format(name=self.properties["Name"])
261
if not self.properties["Enabled"]:
263
self.using_timer(False)
264
elif self.properties["ApprovalPending"]:
250
265
timeout = datetime.timedelta(milliseconds
251
266
= self.properties
253
last_ok = isoformat_to_datetime(
254
max((self.properties[u"LastCheckedOK"]
255
or self.properties[u"Created"]),
256
self.properties[u"LastEnabled"]))
257
timer = timeout - (datetime.datetime.utcnow() - last_ok)
258
message = (u'A checker has failed! Time until client'
259
u' gets disabled: %s'
260
% unicode(timer).rsplit(".", 1)[0])
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)
263
self._text = "%s%s" % (base, message)
298
self.using_timer(False)
299
self._text = "{0}{1}".format(base, message)
265
301
if not urwid.supports_unicode():
266
302
self._text = self._text.encode("ascii", "replace")
267
textlist = [(u"normal", self._text)]
303
textlist = [("normal", self._text)]
268
304
self._text_widget.set_text(textlist)
269
305
self._focus_text_widget.set_text([(with_standout[text[0]],
279
315
self.update_hook()
281
317
def update_timer(self):
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
284
321
return True # Keep calling this
323
def delete(self, **kwargs):
287
324
if self._update_timer_callback_tag is not None:
288
325
gobject.source_remove(self._update_timer_callback_tag)
289
326
self._update_timer_callback_tag = None
327
for match in self.match_objects:
329
self.match_objects = ()
290
330
if self.delete_hook is not None:
291
331
self.delete_hook(self)
332
return super(MandosClientWidget, self).delete(**kwargs)
293
def render(self, (maxcol,), focus=False):
334
def render(self, maxcolrow, focus=False):
294
335
"""Render differently if we have focus.
295
336
This overrides the method from urwid.FlowWidget"""
296
return self.current_widget(focus).render((maxcol,),
337
return self.current_widget(focus).render(maxcolrow,
299
def keypress(self, (maxcol,), key):
340
def keypress(self, maxcolrow, key):
301
342
This overrides the method from urwid.FlowWidget"""
303
self.proxy.Enable(dbus_interface = client_interface)
305
self.proxy.Disable(dbus_interface = client_interface)
344
self.proxy.Enable(dbus_interface = client_interface,
347
self.proxy.Disable(dbus_interface = client_interface,
307
350
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
308
dbus_interface = client_interface)
351
dbus_interface = client_interface,
310
354
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
311
dbus_interface = client_interface)
312
elif key == u"r" or key == u"_" or key == u"ctrl k":
355
dbus_interface = client_interface,
357
elif key == "R" or key == "_" or key == "ctrl k":
313
358
self.server_proxy_object.RemoveClient(self.proxy
316
self.proxy.StartChecker(dbus_interface = client_interface)
318
self.proxy.StopChecker(dbus_interface = client_interface)
320
self.proxy.CheckedOK(dbus_interface = client_interface)
362
self.proxy.StartChecker(dbus_interface = client_interface,
365
self.proxy.StopChecker(dbus_interface = client_interface,
368
self.proxy.CheckedOK(dbus_interface = client_interface,
322
# elif key == u"p" or key == "=":
371
# elif key == "p" or key == "=":
323
372
# self.proxy.pause()
324
# elif key == u"u" or key == ":":
373
# elif key == "u" or key == ":":
325
374
# self.proxy.unpause()
326
# elif key == u"RET":
331
def property_changed(self, property=None, value=None,
380
def property_changed(self, property=None, **kwargs):
333
381
"""Call self.update() if old value is not new value.
334
382
This overrides the method from MandosClientPropertyCache"""
335
property_name = unicode(property)
383
property_name = str(property)
336
384
old_value = self.properties.get(property_name)
337
385
super(MandosClientWidget, self).property_changed(
338
property=property, value=value, *args, **kwargs)
386
property=property, **kwargs)
339
387
if self.properties.get(property_name) != old_value:
363
410
self.screen = urwid.curses_display.Screen()
365
412
self.screen.register_palette((
367
u"default", u"default", None),
369
u"default", u"default", u"bold"),
371
u"default", u"default", u"underline"),
373
u"default", u"default", u"standout"),
374
(u"bold-underline-blink",
375
u"default", u"default", (u"bold", u"underline")),
377
u"default", u"default", (u"bold", u"standout")),
378
(u"underline-blink-standout",
379
u"default", u"default", (u"underline", u"standout")),
380
(u"bold-underline-blink-standout",
381
u"default", u"default", (u"bold", u"underline",
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"),
385
433
if urwid.supports_unicode():
386
self.divider = u"─" # \u2500
387
#self.divider = u"━" # \u2501
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
389
#self.divider = u"-" # \u002d
390
self.divider = u"_" # \u005f
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
392
440
self.screen.start()
407
455
# This keeps track of whether self.uilist currently has
408
456
# self.logbox in it or not
409
457
self.log_visible = True
410
self.log_wrap = u"any"
458
self.log_wrap = "any"
413
self.log_message_raw((u"bold",
414
u"Mandos Monitor version " + version))
415
self.log_message_raw((u"bold",
461
self.log_message_raw(("bold",
462
"Mandos Monitor version " + version))
463
self.log_message_raw(("bold",
418
466
self.busname = domain + '.Mandos'
419
467
self.main_loop = gobject.MainLoop()
420
self.bus = dbus.SystemBus()
421
mandos_dbus_objc = self.bus.get_object(
422
self.busname, u"/", follow_name_owner_changes=True)
423
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
427
mandos_clients = (self.mandos_serv
428
.GetAllClientsWithProperties())
429
except dbus.exceptions.DBusException:
430
mandos_clients = dbus.Dictionary()
433
.connect_to_signal(u"ClientRemoved",
434
self.find_and_remove_client,
435
dbus_interface=server_interface,
438
.connect_to_signal(u"ClientAdded",
440
dbus_interface=server_interface,
443
.connect_to_signal(u"ClientNotFound",
444
self.client_not_found,
445
dbus_interface=server_interface,
447
for path, client in mandos_clients.iteritems():
448
client_proxy_object = self.bus.get_object(self.busname,
450
self.add_client(MandosClientWidget(server_proxy_object
453
=client_proxy_object,
463
469
def client_not_found(self, fingerprint, address):
464
self.log_message((u"Client with address %s and fingerprint %s"
465
u" could not be found" % (address,
470
self.log_message("Client with address {0} and fingerprint"
471
" {1} could not be found"
472
.format(address, fingerprint))
468
474
def rebuild(self):
469
475
"""This rebuilds the User Interface.
493
499
and len(self.log) > self.max_log_length):
494
500
del self.log[0:len(self.log)-self.max_log_length-1]
495
501
self.logbox.set_focus(len(self.logbox.body.contents),
496
coming_from=u"above")
499
505
def toggle_log_display(self):
500
506
"""Toggle visibility of the log buffer."""
501
507
self.log_visible = not self.log_visible
503
#self.log_message(u"Log visibility changed to: "
504
# + unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + str(self.log_visible))
506
512
def change_log_display(self):
507
513
"""Change type of log display.
508
514
Currently, this toggles wrapping of text lines."""
509
if self.log_wrap == u"clip":
510
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
512
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
513
519
for textwidget in self.log:
514
520
textwidget.set_wrap_mode(self.log_wrap)
515
#self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
517
523
def find_and_remove_client(self, path, name):
518
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
520
526
This is connected to the ClientRemoved signal from the
521
527
Mandos server object."""
569
572
"""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,
571
620
self._input_callback_tag = (gobject.io_add_watch
572
621
(sys.stdin.fileno(),
598
647
except KeyError: # :-)
601
if key == u"q" or key == u"Q":
650
if key == "q" or key == "Q":
604
elif key == u"window resize":
653
elif key == "window resize":
605
654
self.size = self.screen.get_cols_rows()
607
elif key == u"\f": # Ctrl-L
656
elif key == "\f": # Ctrl-L
609
elif key == u"l" or key == u"D":
658
elif key == "l" or key == "D":
610
659
self.toggle_log_display()
612
elif key == u"w" or key == u"i":
661
elif key == "w" or key == "i":
613
662
self.change_log_display()
615
elif key == u"?" or key == u"f1" or key == u"esc":
664
elif key == "?" or key == "f1" or key == "esc":
616
665
if not self.log_visible:
617
666
self.log_visible = True
619
self.log_message_raw((u"bold",
623
u"l: Log window toggle",
624
u"TAB: Switch window",
626
self.log_message_raw((u"bold",
632
u"s: Start new checker",
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",
639
688
if self.topwidget.get_focus() is self.logbox:
640
689
self.topwidget.set_focus(0)
642
691
self.topwidget.set_focus(self.logbox)
644
#elif (key == u"end" or key == u"meta >" or key == u"G"
693
#elif (key == "end" or key == "meta >" or key == "G"
646
695
# pass # xxx end-of-buffer
647
#elif (key == u"home" or key == u"meta <" or key == u"g"
696
#elif (key == "home" or key == "meta <" or key == "g"
649
698
# pass # xxx beginning-of-buffer
650
#elif key == u"ctrl e" or key == u"$":
699
#elif key == "ctrl e" or key == "$":
651
700
# pass # xxx move-end-of-line
652
#elif key == u"ctrl a" or key == u"^":
701
#elif key == "ctrl a" or key == "^":
653
702
# pass # xxx move-beginning-of-line
654
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
#elif key == "ctrl b" or key == "meta (" or key == "h":
655
704
# pass # xxx left
656
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
#elif key == "ctrl f" or key == "meta )" or key == "l":
657
706
# pass # xxx right
659
708
# pass # scroll up log
661
710
# pass # scroll down log
662
711
elif self.topwidget.selectable():
663
712
self.topwidget.keypress(self.size, key)