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[0] == 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)
43
65
def isoformat_to_datetime(iso):
44
66
"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)
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
50
72
second, fraction = divmod(float(second), 1)
51
73
return datetime.datetime(int(year),
61
83
properties and calls a hook function when any of them are
64
def __init__(self, proxy_object=None, *args, **kwargs):
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
65
87
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__(
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)
81
107
def property_changed(self, property=None, value=None):
82
108
"""This is called whenever we get a PropertyChanged signal
102
131
self.logger = logger
104
133
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
107
135
# The widget shown normally
108
self._text_widget = urwid.Text(u"")
136
self._text_widget = urwid.Text("")
109
137
# 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,
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
115
141
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:
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 {0}'
165
# .format(self.properties["Name"]))
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
148
173
self._update_timer_callback_tag = (gobject.timeout_add
150
175
self.update_timer))
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
152
180
def checker_completed(self, exitstatus, condition, command):
153
181
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
185
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)))
186
self.logger('Checker for client {0} (command "{1}")'
187
' failed with exit code {2}'
188
.format(self.properties["Name"], command,
189
os.WEXITSTATUS(condition)))
174
190
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)))
191
self.logger('Checker for client {0} (command "{1}") was'
192
' killed by signal {2}'
193
.format(self.properties["Name"], command,
194
os.WTERMSIG(condition)))
179
195
elif os.WCOREDUMP(condition):
180
self.logger(u'Checker for client %s (command "%s")'
182
% (self.properties[u"Name"], command))
196
self.logger('Checker for client {0} (command "{1}")'
198
.format(self.properties["Name"], command))
184
self.logger(u'Checker for client %s completed'
200
self.logger('Checker for client {0} completed'
202
.format(self.properties["Name"]))
188
205
def checker_started(self, command):
189
#self.logger(u'Client %s started checker "%s"'
190
# % (self.properties[u"Name"], unicode(command)))
206
"""Server signals that a checker started. This could be useful
207
to log in the future. """
208
#self.logger('Client {0} started checker "{1}"'
209
# .format(self.properties["Name"],
193
213
def got_secret(self):
194
self.last_checker_failed = False
195
self.logger(u'Client %s received its secret'
196
% self.properties[u"Name"])
214
self.logger('Client {0} received its secret'
215
.format(self.properties["Name"]))
198
217
def need_approval(self, timeout, default):
200
message = u'Client %s needs approval within %s seconds'
219
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))
221
message = 'Client {0} will get its secret in {1} seconds'
222
self.logger(message.format(self.properties["Name"],
206
225
def rejected(self, reason):
207
self.logger(u'Client %s was rejected; reason: %s'
208
% (self.properties[u"Name"], reason))
226
self.logger('Client {0} was rejected; reason: {1}'
227
.format(self.properties["Name"], reason))
210
229
def selectable(self):
211
230
"""Make this a "selectable" widget.
212
231
This overrides the method from urwid.FlowWidget."""
215
def rows(self, (maxcol,), focus=False):
234
def rows(self, maxcolrow, focus=False):
216
235
"""How many rows this widget will occupy might depend on
217
236
whether we have focus or not.
218
237
This overrides the method from urwid.FlowWidget"""
219
return self.current_widget(focus).rows((maxcol,), focus=focus)
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
221
240
def current_widget(self, focus=False):
222
241
if focus or self.opened:
226
245
def update(self):
227
246
"Called when what is visible on the screen should be updated."
228
247
# 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",
248
with_standout = { "normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"bold-underline-blink-standout",
237
256
# Rebuild focus and non-focus widgets using current properties
239
258
# 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:
259
base = '{name}: '.format(name=self.properties["Name"])
260
if not self.properties["Enabled"]:
262
self.using_timer(False)
263
elif self.properties["ApprovalPending"]:
250
264
timeout = datetime.timedelta(milliseconds
251
265
= 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'
260
% unicode(timer).rsplit(".", 1)[0])
267
last_approval_request = isoformat_to_datetime(
268
self.properties["LastApprovalRequest"])
269
if last_approval_request is not None:
270
timer = max(timeout - (datetime.datetime.utcnow()
271
- last_approval_request),
272
datetime.timedelta())
274
timer = datetime.timedelta()
275
if self.properties["ApprovedByDefault"]:
276
message = "Approval in {0}. (d)eny?"
278
message = "Denial in {0}. (a)pprove?"
279
message = message.format(str(timer).rsplit(".", 1)[0])
280
self.using_timer(True)
281
elif self.properties["LastCheckerStatus"] != 0:
282
# When checker has failed, show timer until client expires
283
expires = self.properties["Expires"]
285
timer = datetime.timedelta(0)
287
expires = (datetime.datetime.strptime
288
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
289
timer = max(expires - datetime.datetime.utcnow(),
290
datetime.timedelta())
291
message = ('A checker has failed! Time until client'
292
' gets disabled: {0}'
293
.format(str(timer).rsplit(".", 1)[0]))
294
self.using_timer(True)
263
self._text = "%s%s" % (base, message)
297
self.using_timer(False)
298
self._text = "{0}{1}".format(base, message)
265
300
if not urwid.supports_unicode():
266
301
self._text = self._text.encode("ascii", "replace")
267
textlist = [(u"normal", self._text)]
302
textlist = [("normal", self._text)]
268
303
self._text_widget.set_text(textlist)
269
304
self._focus_text_widget.set_text([(with_standout[text[0]],
279
314
self.update_hook()
281
316
def update_timer(self):
317
"""called by gobject. Will indefinitely loop until
318
gobject.source_remove() on tag is called"""
284
320
return True # Keep calling this
322
def delete(self, **kwargs):
287
323
if self._update_timer_callback_tag is not None:
288
324
gobject.source_remove(self._update_timer_callback_tag)
289
325
self._update_timer_callback_tag = None
326
for match in self.match_objects:
328
self.match_objects = ()
290
329
if self.delete_hook is not None:
291
330
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
293
def render(self, (maxcol,), focus=False):
333
def render(self, maxcolrow, focus=False):
294
334
"""Render differently if we have focus.
295
335
This overrides the method from urwid.FlowWidget"""
296
return self.current_widget(focus).render((maxcol,),
336
return self.current_widget(focus).render(maxcolrow,
299
def keypress(self, (maxcol,), key):
339
def keypress(self, maxcolrow, key):
301
341
This overrides the method from urwid.FlowWidget"""
303
self.proxy.Enable(dbus_interface = client_interface)
305
self.proxy.Disable(dbus_interface = client_interface)
343
self.proxy.Enable(dbus_interface = client_interface,
346
self.proxy.Disable(dbus_interface = client_interface,
307
349
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
308
dbus_interface = client_interface)
350
dbus_interface = client_interface,
310
353
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":
354
dbus_interface = client_interface,
356
elif key == "R" or key == "_" or key == "ctrl k":
313
357
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)
361
self.proxy.StartChecker(dbus_interface = client_interface,
364
self.proxy.StopChecker(dbus_interface = client_interface,
367
self.proxy.CheckedOK(dbus_interface = client_interface,
322
# elif key == u"p" or key == "=":
370
# elif key == "p" or key == "=":
323
371
# self.proxy.pause()
324
# elif key == u"u" or key == ":":
372
# elif key == "u" or key == ":":
325
373
# self.proxy.unpause()
326
# elif key == u"RET":
331
def property_changed(self, property=None, value=None,
379
def property_changed(self, property=None, **kwargs):
333
380
"""Call self.update() if old value is not new value.
334
381
This overrides the method from MandosClientPropertyCache"""
335
property_name = unicode(property)
382
property_name = str(property)
336
383
old_value = self.properties.get(property_name)
337
384
super(MandosClientWidget, self).property_changed(
338
property=property, value=value, *args, **kwargs)
385
property=property, **kwargs)
339
386
if self.properties.get(property_name) != old_value:
363
409
self.screen = urwid.curses_display.Screen()
365
411
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",
413
"default", "default", None),
415
"bold", "default", "bold"),
417
"underline,blink", "default", "underline,blink"),
419
"standout", "default", "standout"),
420
("bold-underline-blink",
421
"bold,underline,blink", "default", "bold,underline,blink"),
423
"bold,standout", "default", "bold,standout"),
424
("underline-blink-standout",
425
"underline,blink,standout", "default",
426
"underline,blink,standout"),
427
("bold-underline-blink-standout",
428
"bold,underline,blink,standout", "default",
429
"bold,underline,blink,standout"),
385
432
if urwid.supports_unicode():
386
self.divider = u"─" # \u2500
387
#self.divider = u"━" # \u2501
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
389
#self.divider = u"-" # \u002d
390
self.divider = u"_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
392
439
self.screen.start()
407
454
# This keeps track of whether self.uilist currently has
408
455
# self.logbox in it or not
409
456
self.log_visible = True
410
self.log_wrap = u"any"
457
self.log_wrap = "any"
413
self.log_message_raw((u"bold",
414
u"Mandos Monitor version " + version))
415
self.log_message_raw((u"bold",
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
418
465
self.busname = domain + '.Mandos'
419
466
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
468
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,
469
self.log_message("Client with address {0} and fingerprint"
470
" {1} could not be found"
471
.format(address, fingerprint))
468
473
def rebuild(self):
469
474
"""This rebuilds the User Interface.
493
498
and len(self.log) > self.max_log_length):
494
499
del self.log[0:len(self.log)-self.max_log_length-1]
495
500
self.logbox.set_focus(len(self.logbox.body.contents),
496
coming_from=u"above")
499
504
def toggle_log_display(self):
500
505
"""Toggle visibility of the log buffer."""
501
506
self.log_visible = not self.log_visible
503
#self.log_message(u"Log visibility changed to: "
504
# + unicode(self.log_visible))
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
506
511
def change_log_display(self):
507
512
"""Change type of log display.
508
513
Currently, this toggles wrapping of text lines."""
509
if self.log_wrap == u"clip":
510
self.log_wrap = u"any"
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
512
self.log_wrap = u"clip"
517
self.log_wrap = "clip"
513
518
for textwidget in self.log:
514
519
textwidget.set_wrap_mode(self.log_wrap)
515
#self.log_message(u"Wrap mode: " + self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
517
522
def find_and_remove_client(self, path, name):
518
"""Find an client from its object path and remove it.
523
"""Find a client by its object path and remove it.
520
525
This is connected to the ClientRemoved signal from the
521
526
Mandos server object."""
569
571
"""Start the main loop and exit when it's done."""
572
self.bus = dbus.SystemBus()
573
mandos_dbus_objc = self.bus.get_object(
574
self.busname, "/", follow_name_owner_changes=True)
575
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
579
mandos_clients = (self.mandos_serv
580
.GetAllClientsWithProperties())
581
if not mandos_clients:
582
self.log_message_raw(("bold", "Note: Server has no clients."))
583
except dbus.exceptions.DBusException:
584
self.log_message_raw(("bold", "Note: No Mandos server running."))
585
mandos_clients = dbus.Dictionary()
588
.connect_to_signal("ClientRemoved",
589
self.find_and_remove_client,
590
dbus_interface=server_interface,
593
.connect_to_signal("ClientAdded",
595
dbus_interface=server_interface,
598
.connect_to_signal("ClientNotFound",
599
self.client_not_found,
600
dbus_interface=server_interface,
602
for path, client in mandos_clients.items():
603
client_proxy_object = self.bus.get_object(self.busname,
605
self.add_client(MandosClientWidget(server_proxy_object
608
=client_proxy_object,
571
619
self._input_callback_tag = (gobject.io_add_watch
572
620
(sys.stdin.fileno(),
598
646
except KeyError: # :-)
601
if key == u"q" or key == u"Q":
649
if key == "q" or key == "Q":
604
elif key == u"window resize":
652
elif key == "window resize":
605
653
self.size = self.screen.get_cols_rows()
607
elif key == u"\f": # Ctrl-L
655
elif key == "\f": # Ctrl-L
609
elif key == u"l" or key == u"D":
657
elif key == "l" or key == "D":
610
658
self.toggle_log_display()
612
elif key == u"w" or key == u"i":
660
elif key == "w" or key == "i":
613
661
self.change_log_display()
615
elif key == u"?" or key == u"f1" or key == u"esc":
663
elif key == "?" or key == "f1" or key == "esc":
616
664
if not self.log_visible:
617
665
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",
667
self.log_message_raw(("bold",
671
"l: Log window toggle",
672
"TAB: Switch window",
674
self.log_message_raw(("bold",
680
"s: Start new checker",
639
687
if self.topwidget.get_focus() is self.logbox:
640
688
self.topwidget.set_focus(0)
642
690
self.topwidget.set_focus(self.logbox)
644
#elif (key == u"end" or key == u"meta >" or key == u"G"
692
#elif (key == "end" or key == "meta >" or key == "G"
646
694
# pass # xxx end-of-buffer
647
#elif (key == u"home" or key == u"meta <" or key == u"g"
695
#elif (key == "home" or key == "meta <" or key == "g"
649
697
# pass # xxx beginning-of-buffer
650
#elif key == u"ctrl e" or key == u"$":
698
#elif key == "ctrl e" or key == "$":
651
699
# pass # xxx move-end-of-line
652
#elif key == u"ctrl a" or key == u"^":
700
#elif key == "ctrl a" or key == "^":
653
701
# pass # xxx move-beginning-of-line
654
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
655
703
# pass # xxx left
656
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
657
705
# pass # xxx right
659
707
# pass # scroll up log
661
709
# pass # scroll down log
662
710
elif self.topwidget.selectable():
663
711
self.topwidget.keypress(self.size, key)