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._update_timer_callback_lock = 0
106
self.last_checker_failed = False
108
135
# The widget shown normally
109
self._text_widget = urwid.Text(u"")
136
self._text_widget = urwid.Text("")
110
137
# The widget shown when we have focus
111
self._focus_text_widget = urwid.Text(u"")
112
super(MandosClientWidget, self).__init__(
113
update_hook=update_hook, delete_hook=delete_hook,
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
116
141
self.opened = False
118
last_checked_ok = isoformat_to_datetime(self.properties
120
if last_checked_ok is None:
121
self.last_checker_failed = True
123
self.last_checker_failed = ((datetime.datetime.utcnow()
130
if self.last_checker_failed:
131
self.using_timer(True)
133
if self.need_approval:
134
self.using_timer(True)
136
self.proxy.connect_to_signal(u"CheckerCompleted",
137
self.checker_completed,
140
self.proxy.connect_to_signal(u"CheckerStarted",
141
self.checker_started,
144
self.proxy.connect_to_signal(u"GotSecret",
148
self.proxy.connect_to_signal(u"NeedApproval",
152
self.proxy.connect_to_signal(u"Rejected",
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"]))
157
def property_changed(self, property=None, value=None):
158
super(self, MandosClientWidget).property_changed(property,
160
if property == u"ApprovalPending":
161
using_timer(bool(value))
163
167
def using_timer(self, flag):
164
168
"""Call this method with True or False when timer should be
165
169
activated or deactivated.
167
old = self._update_timer_callback_lock
169
self._update_timer_callback_lock += 1
171
self._update_timer_callback_lock -= 1
172
if old == 0 and self._update_timer_callback_lock:
171
if flag and self._update_timer_callback_tag is None:
172
# Will update the shown timer value every second
173
173
self._update_timer_callback_tag = (gobject.timeout_add
175
175
self.update_timer))
176
elif old and self._update_timer_callback_lock == 0:
176
elif not (flag or self._update_timer_callback_tag is None):
177
177
gobject.source_remove(self._update_timer_callback_tag)
178
178
self._update_timer_callback_tag = None
180
180
def checker_completed(self, exitstatus, condition, command):
181
181
if exitstatus == 0:
182
if self.last_checker_failed:
183
self.last_checker_failed = False
184
self.using_timer(False)
185
#self.logger(u'Checker for client %s (command "%s")'
187
# % (self.properties[u"Name"], command))
191
if not self.last_checker_failed:
192
self.last_checker_failed = True
193
self.using_timer(True)
194
185
if os.WIFEXITED(condition):
195
self.logger(u'Checker for client %s (command "%s")'
196
u' failed with exit code %s'
197
% (self.properties[u"Name"], command,
198
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)))
199
190
elif os.WIFSIGNALED(condition):
200
self.logger(u'Checker for client %s (command "%s")'
201
u' was killed by signal %s'
202
% (self.properties[u"Name"], command,
203
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)))
204
195
elif os.WCOREDUMP(condition):
205
self.logger(u'Checker for client %s (command "%s")'
207
% (self.properties[u"Name"], command))
196
self.logger('Checker for client {0} (command "{1}")'
198
.format(self.properties["Name"], command))
209
self.logger(u'Checker for client %s completed'
200
self.logger('Checker for client {0} completed'
202
.format(self.properties["Name"]))
213
205
def checker_started(self, command):
214
#self.logger(u'Client %s started checker "%s"'
215
# % (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"],
218
213
def got_secret(self):
219
self.last_checker_failed = False
220
self.logger(u'Client %s received its secret'
221
% self.properties[u"Name"])
214
self.logger('Client {0} received its secret'
215
.format(self.properties["Name"]))
223
217
def need_approval(self, timeout, default):
225
message = u'Client %s needs approval within %s seconds'
219
message = 'Client {0} needs approval within {1} seconds'
227
message = u'Client %s will get its secret in %s seconds'
229
% (self.properties[u"Name"], timeout/1000))
230
self.using_timer(True)
221
message = 'Client {0} will get its secret in {1} seconds'
222
self.logger(message.format(self.properties["Name"],
232
225
def rejected(self, reason):
233
self.logger(u'Client %s was rejected; reason: %s'
234
% (self.properties[u"Name"], reason))
226
self.logger('Client {0} was rejected; reason: {1}'
227
.format(self.properties["Name"], reason))
236
229
def selectable(self):
237
230
"""Make this a "selectable" widget.
238
231
This overrides the method from urwid.FlowWidget."""
241
def rows(self, (maxcol,), focus=False):
234
def rows(self, maxcolrow, focus=False):
242
235
"""How many rows this widget will occupy might depend on
243
236
whether we have focus or not.
244
237
This overrides the method from urwid.FlowWidget"""
245
return self.current_widget(focus).rows((maxcol,), focus=focus)
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
247
240
def current_widget(self, focus=False):
248
241
if focus or self.opened:
252
245
def update(self):
253
246
"Called when what is visible on the screen should be updated."
254
247
# How to add standout mode to a style
255
with_standout = { u"normal": u"standout",
256
u"bold": u"bold-standout",
258
u"underline-blink-standout",
259
u"bold-underline-blink":
260
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",
263
256
# Rebuild focus and non-focus widgets using current properties
265
258
# Base part of a client. Name!
266
base = (u'%(name)s: '
267
% {u"name": self.properties[u"Name"]})
268
if not self.properties[u"Enabled"]:
269
message = u"DISABLED"
270
elif self.properties[u"ApprovalPending"]:
259
base = '{name}: '.format(name=self.properties["Name"])
260
if not self.properties["Enabled"]:
262
self.using_timer(False)
263
elif self.properties["ApprovalPending"]:
271
264
timeout = datetime.timedelta(milliseconds
272
265
= self.properties
274
267
last_approval_request = isoformat_to_datetime(
275
self.properties[u"LastApprovalRequest"])
268
self.properties["LastApprovalRequest"])
276
269
if last_approval_request is not None:
277
timer = timeout - (datetime.datetime.utcnow()
278
- last_approval_request)
270
timer = max(timeout - (datetime.datetime.utcnow()
271
- last_approval_request),
272
datetime.timedelta())
280
274
timer = datetime.timedelta()
281
if self.properties[u"ApprovedByDefault"]:
282
message = u"Approval in %s. (d)eny?"
284
message = u"Denial in %s. (a)pprove?"
285
message = message % unicode(timer).rsplit(".", 1)[0]
286
elif self.last_checker_failed:
287
timeout = datetime.timedelta(milliseconds
290
last_ok = isoformat_to_datetime(
291
max((self.properties[u"LastCheckedOK"]
292
or self.properties[u"Created"]),
293
self.properties[u"LastEnabled"]))
294
timer = timeout - (datetime.datetime.utcnow() - last_ok)
295
message = (u'A checker has failed! Time until client'
296
u' gets disabled: %s'
297
% unicode(timer).rsplit(".", 1)[0])
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)
300
self._text = "%s%s" % (base, message)
297
self.using_timer(False)
298
self._text = "{0}{1}".format(base, message)
302
300
if not urwid.supports_unicode():
303
301
self._text = self._text.encode("ascii", "replace")
304
textlist = [(u"normal", self._text)]
302
textlist = [("normal", self._text)]
305
303
self._text_widget.set_text(textlist)
306
304
self._focus_text_widget.set_text([(with_standout[text[0]],
316
314
self.update_hook()
318
316
def update_timer(self):
317
"""called by gobject. Will indefinitely loop until
318
gobject.source_remove() on tag is called"""
321
320
return True # Keep calling this
322
def delete(self, **kwargs):
324
323
if self._update_timer_callback_tag is not None:
325
324
gobject.source_remove(self._update_timer_callback_tag)
326
325
self._update_timer_callback_tag = None
326
for match in self.match_objects:
328
self.match_objects = ()
327
329
if self.delete_hook is not None:
328
330
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
330
def render(self, (maxcol,), focus=False):
333
def render(self, maxcolrow, focus=False):
331
334
"""Render differently if we have focus.
332
335
This overrides the method from urwid.FlowWidget"""
333
return self.current_widget(focus).render((maxcol,),
336
return self.current_widget(focus).render(maxcolrow,
336
def keypress(self, (maxcol,), key):
339
def keypress(self, maxcolrow, key):
338
341
This overrides the method from urwid.FlowWidget"""
340
self.proxy.Enable(dbus_interface = client_interface)
342
self.proxy.Disable(dbus_interface = client_interface)
343
self.proxy.Enable(dbus_interface = client_interface,
346
self.proxy.Disable(dbus_interface = client_interface,
344
349
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
dbus_interface = client_interface)
350
dbus_interface = client_interface,
347
353
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
348
dbus_interface = client_interface)
349
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":
350
357
self.server_proxy_object.RemoveClient(self.proxy
353
self.proxy.StartChecker(dbus_interface = client_interface)
355
self.proxy.StopChecker(dbus_interface = client_interface)
357
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,
359
# elif key == u"p" or key == "=":
370
# elif key == "p" or key == "=":
360
371
# self.proxy.pause()
361
# elif key == u"u" or key == ":":
372
# elif key == "u" or key == ":":
362
373
# self.proxy.unpause()
363
# elif key == u"RET":
368
def property_changed(self, property=None, value=None,
379
def property_changed(self, property=None, **kwargs):
370
380
"""Call self.update() if old value is not new value.
371
381
This overrides the method from MandosClientPropertyCache"""
372
property_name = unicode(property)
382
property_name = str(property)
373
383
old_value = self.properties.get(property_name)
374
384
super(MandosClientWidget, self).property_changed(
375
property=property, value=value, *args, **kwargs)
385
property=property, **kwargs)
376
386
if self.properties.get(property_name) != old_value:
400
409
self.screen = urwid.curses_display.Screen()
402
411
self.screen.register_palette((
404
u"default", u"default", None),
406
u"default", u"default", u"bold"),
408
u"default", u"default", u"underline"),
410
u"default", u"default", u"standout"),
411
(u"bold-underline-blink",
412
u"default", u"default", (u"bold", u"underline")),
414
u"default", u"default", (u"bold", u"standout")),
415
(u"underline-blink-standout",
416
u"default", u"default", (u"underline", u"standout")),
417
(u"bold-underline-blink-standout",
418
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"),
422
432
if urwid.supports_unicode():
423
self.divider = u"─" # \u2500
424
#self.divider = u"━" # \u2501
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
426
#self.divider = u"-" # \u002d
427
self.divider = u"_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
429
439
self.screen.start()
444
454
# This keeps track of whether self.uilist currently has
445
455
# self.logbox in it or not
446
456
self.log_visible = True
447
self.log_wrap = u"any"
457
self.log_wrap = "any"
450
self.log_message_raw((u"bold",
451
u"Mandos Monitor version " + version))
452
self.log_message_raw((u"bold",
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
455
465
self.busname = domain + '.Mandos'
456
466
self.main_loop = gobject.MainLoop()
457
self.bus = dbus.SystemBus()
458
mandos_dbus_objc = self.bus.get_object(
459
self.busname, u"/", follow_name_owner_changes=True)
460
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
464
mandos_clients = (self.mandos_serv
465
.GetAllClientsWithProperties())
466
except dbus.exceptions.DBusException:
467
mandos_clients = dbus.Dictionary()
470
.connect_to_signal(u"ClientRemoved",
471
self.find_and_remove_client,
472
dbus_interface=server_interface,
475
.connect_to_signal(u"ClientAdded",
477
dbus_interface=server_interface,
480
.connect_to_signal(u"ClientNotFound",
481
self.client_not_found,
482
dbus_interface=server_interface,
484
for path, client in mandos_clients.iteritems():
485
client_proxy_object = self.bus.get_object(self.busname,
487
self.add_client(MandosClientWidget(server_proxy_object
490
=client_proxy_object,
500
468
def client_not_found(self, fingerprint, address):
501
self.log_message((u"Client with address %s and fingerprint %s"
502
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))
505
473
def rebuild(self):
506
474
"""This rebuilds the User Interface.
530
498
and len(self.log) > self.max_log_length):
531
499
del self.log[0:len(self.log)-self.max_log_length-1]
532
500
self.logbox.set_focus(len(self.logbox.body.contents),
533
coming_from=u"above")
536
504
def toggle_log_display(self):
537
505
"""Toggle visibility of the log buffer."""
538
506
self.log_visible = not self.log_visible
540
#self.log_message(u"Log visibility changed to: "
541
# + unicode(self.log_visible))
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
543
511
def change_log_display(self):
544
512
"""Change type of log display.
545
513
Currently, this toggles wrapping of text lines."""
546
if self.log_wrap == u"clip":
547
self.log_wrap = u"any"
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
549
self.log_wrap = u"clip"
517
self.log_wrap = "clip"
550
518
for textwidget in self.log:
551
519
textwidget.set_wrap_mode(self.log_wrap)
552
#self.log_message(u"Wrap mode: " + self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
554
522
def find_and_remove_client(self, path, name):
555
"""Find an client from its object path and remove it.
523
"""Find a client by its object path and remove it.
557
525
This is connected to the ClientRemoved signal from the
558
526
Mandos server object."""
606
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,
608
619
self._input_callback_tag = (gobject.io_add_watch
609
620
(sys.stdin.fileno(),
635
646
except KeyError: # :-)
638
if key == u"q" or key == u"Q":
649
if key == "q" or key == "Q":
641
elif key == u"window resize":
652
elif key == "window resize":
642
653
self.size = self.screen.get_cols_rows()
644
elif key == u"\f": # Ctrl-L
655
elif key == "\f": # Ctrl-L
646
elif key == u"l" or key == u"D":
657
elif key == "l" or key == "D":
647
658
self.toggle_log_display()
649
elif key == u"w" or key == u"i":
660
elif key == "w" or key == "i":
650
661
self.change_log_display()
652
elif key == u"?" or key == u"f1" or key == u"esc":
663
elif key == "?" or key == "f1" or key == "esc":
653
664
if not self.log_visible:
654
665
self.log_visible = True
656
self.log_message_raw((u"bold",
660
u"l: Log window toggle",
661
u"TAB: Switch window",
663
self.log_message_raw((u"bold",
669
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",
676
687
if self.topwidget.get_focus() is self.logbox:
677
688
self.topwidget.set_focus(0)
679
690
self.topwidget.set_focus(self.logbox)
681
#elif (key == u"end" or key == u"meta >" or key == u"G"
692
#elif (key == "end" or key == "meta >" or key == "G"
683
694
# pass # xxx end-of-buffer
684
#elif (key == u"home" or key == u"meta <" or key == u"g"
695
#elif (key == "home" or key == "meta <" or key == "g"
686
697
# pass # xxx beginning-of-buffer
687
#elif key == u"ctrl e" or key == u"$":
698
#elif key == "ctrl e" or key == "$":
688
699
# pass # xxx move-end-of-line
689
#elif key == u"ctrl a" or key == u"^":
700
#elif key == "ctrl a" or key == "^":
690
701
# pass # xxx move-beginning-of-line
691
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
692
703
# pass # xxx left
693
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
694
705
# pass # xxx right
696
707
# pass # scroll up log
698
709
# pass # scroll down log
699
710
elif self.topwidget.selectable():
700
711
self.topwidget.keypress(self.size, key)