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>.
4
from __future__ import division, absolute_import, with_statement
26
from __future__ import (division, absolute_import, print_function,
33
63
urwid.curses_display.curses.A_UNDERLINE |= (
34
64
urwid.curses_display.curses.A_BLINK)
66
def isoformat_to_datetime(iso):
67
"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)
73
second, fraction = divmod(float(second), 1)
74
return datetime.datetime(int(year),
79
int(second), # Whole seconds
80
int(fraction*1000000)) # Microseconds
36
82
class MandosClientPropertyCache(object):
37
83
"""This wraps a Mandos Client D-Bus proxy object, caches the
38
84
properties and calls a hook function when any of them are
41
def __init__(self, proxy_object=None, properties=None, *args,
87
def __init__(self, proxy_object=None, *args, **kwargs):
43
88
self.proxy = proxy_object # Mandos Client proxy object
45
if properties is None:
46
self.properties = dict()
48
self.properties = properties
49
self.proxy.connect_to_signal(u"PropertyChanged",
50
self.property_changed,
90
self.properties = dict()
91
self.property_changed_match = (
92
self.proxy.connect_to_signal("PropertyChanged",
93
self.property_changed,
54
if properties is None:
55
self.properties.update(self.proxy.GetAll(client_interface,
57
dbus.PROPERTIES_IFACE))
58
super(MandosClientPropertyCache, self).__init__(
59
proxy_object=proxy_object,
60
properties=properties, *args, **kwargs)
97
self.properties.update(
98
self.proxy.GetAll(client_interface,
99
dbus_interface = dbus.PROPERTIES_IFACE))
101
#XXX This breaks good super behaviour
102
# super(MandosClientPropertyCache, self).__init__(
62
105
def property_changed(self, property=None, value=None):
63
106
"""This is called whenever we get a PropertyChanged signal
83
131
self.logger = logger
133
self._update_timer_callback_tag = None
134
self._update_timer_callback_lock = 0
85
136
# The widget shown normally
86
self._text_widget = urwid.Text(u"")
137
self._text_widget = urwid.Text("")
87
138
# The widget shown when we have focus
88
self._focus_text_widget = urwid.Text(u"")
139
self._focus_text_widget = urwid.Text("")
89
140
super(MandosClientWidget, self).__init__(
90
141
update_hook=update_hook, delete_hook=delete_hook,
93
144
self.opened = False
94
self.proxy.connect_to_signal(u"CheckerCompleted",
95
self.checker_completed,
98
self.proxy.connect_to_signal(u"CheckerStarted",
102
self.proxy.connect_to_signal(u"GotSecret",
106
self.proxy.connect_to_signal(u"Rejected",
146
last_checked_ok = isoformat_to_datetime(self.properties
149
if self.properties ["LastCheckerStatus"] != 0:
150
self.using_timer(True)
152
if self.need_approval:
153
self.using_timer(True)
155
self.match_objects = (
156
self.proxy.connect_to_signal("CheckerCompleted",
157
self.checker_completed,
160
self.proxy.connect_to_signal("CheckerStarted",
161
self.checker_started,
164
self.proxy.connect_to_signal("GotSecret",
168
self.proxy.connect_to_signal("NeedApproval",
172
self.proxy.connect_to_signal("Rejected",
176
#self.logger('Created client {0}'
177
# .format(self.properties["Name"]))
179
def property_changed(self, property=None, value=None):
180
super(self, MandosClientWidget).property_changed(property,
182
if property == "ApprovalPending":
183
using_timer(bool(value))
184
if property == "LastCheckerStatus":
185
using_timer(value != 0)
186
#self.logger('Checker for client {0} (command "{1}") was '
187
# ' successful'.format(self.properties["Name"],
190
def using_timer(self, flag):
191
"""Call this method with True or False when timer should be
192
activated or deactivated.
194
old = self._update_timer_callback_lock
196
self._update_timer_callback_lock += 1
198
self._update_timer_callback_lock -= 1
199
if old == 0 and self._update_timer_callback_lock:
200
# Will update the shown timer value every second
201
self._update_timer_callback_tag = (gobject.timeout_add
204
elif old and self._update_timer_callback_lock == 0:
205
gobject.source_remove(self._update_timer_callback_tag)
206
self._update_timer_callback_tag = None
111
208
def checker_completed(self, exitstatus, condition, command):
112
209
if exitstatus == 0:
113
self.logger(u'Checker for client %s (command "%s")'
115
% (self.properties[u"name"], command))
117
213
if os.WIFEXITED(condition):
118
self.logger(u'Checker for client %s (command "%s")'
119
u' failed with exit code %s'
120
% (self.properties[u"name"], command,
121
os.WEXITSTATUS(condition)))
123
if os.WIFSIGNALED(condition):
124
self.logger(u'Checker for client %s (command "%s")'
125
u' was killed by signal %s'
126
% (self.properties[u"name"], command,
127
os.WTERMSIG(condition)))
129
if os.WCOREDUMP(condition):
130
self.logger(u'Checker for client %s (command "%s")'
132
% (self.properties[u"name"], command))
133
self.logger(u'Checker for client %s completed mysteriously')
214
self.logger('Checker for client {0} (command "{1}")'
215
' failed with exit code {2}'
216
.format(self.properties["Name"], command,
217
os.WEXITSTATUS(condition)))
218
elif os.WIFSIGNALED(condition):
219
self.logger('Checker for client {0} (command "{1}") was'
220
' killed by signal {2}'
221
.format(self.properties["Name"], command,
222
os.WTERMSIG(condition)))
223
elif os.WCOREDUMP(condition):
224
self.logger('Checker for client {0} (command "{1}")'
226
.format(self.properties["Name"], command))
228
self.logger('Checker for client {0} completed'
230
.format(self.properties["Name"]))
135
233
def checker_started(self, command):
136
self.logger(u'Client %s started checker "%s"'
137
% (self.properties[u"name"], unicode(command)))
234
"""Server signals that a checker started. This could be useful
235
to log in the future. """
236
#self.logger('Client {0} started checker "{1}"'
237
# .format(self.properties["Name"],
139
241
def got_secret(self):
140
self.logger(u'Client %s received its secret'
141
% self.properties[u"name"])
144
self.logger(u'Client %s was rejected'
145
% self.properties[u"name"])
242
self.logger('Client {0} received its secret'
243
.format(self.properties["Name"]))
245
def need_approval(self, timeout, default):
247
message = 'Client {0} needs approval within {1} seconds'
249
message = 'Client {0} will get its secret in {1} seconds'
250
self.logger(message.format(self.properties["Name"],
252
self.using_timer(True)
254
def rejected(self, reason):
255
self.logger('Client {0} was rejected; reason: {1}'
256
.format(self.properties["Name"], reason))
147
258
def selectable(self):
148
259
"""Make this a "selectable" widget.
149
260
This overrides the method from urwid.FlowWidget."""
152
def rows(self, (maxcol,), focus=False):
263
def rows(self, maxcolrow, focus=False):
153
264
"""How many rows this widget will occupy might depend on
154
265
whether we have focus or not.
155
266
This overrides the method from urwid.FlowWidget"""
156
return self.current_widget(focus).rows((maxcol,), focus=focus)
267
return self.current_widget(focus).rows(maxcolrow, focus=focus)
158
269
def current_widget(self, focus=False):
159
270
if focus or self.opened:
163
274
def update(self):
164
275
"Called when what is visible on the screen should be updated."
165
276
# How to add standout mode to a style
166
with_standout = { u"normal": u"standout",
167
u"bold": u"bold-standout",
169
u"underline-blink-standout",
170
u"bold-underline-blink":
171
u"bold-underline-blink-standout",
277
with_standout = { "normal": "standout",
278
"bold": "bold-standout",
280
"underline-blink-standout",
281
"bold-underline-blink":
282
"bold-underline-blink-standout",
174
285
# Rebuild focus and non-focus widgets using current properties
175
self._text = (u'%(name)s: %(enabled)s'
176
% { u"name": self.properties[u"name"],
179
if self.properties[u"enabled"]
287
# Base part of a client. Name!
288
base = '{name}: '.format(name=self.properties["Name"])
289
if not self.properties["Enabled"]:
291
elif self.properties["ApprovalPending"]:
292
timeout = datetime.timedelta(milliseconds
295
last_approval_request = isoformat_to_datetime(
296
self.properties["LastApprovalRequest"])
297
if last_approval_request is not None:
298
timer = timeout - (datetime.datetime.utcnow()
299
- last_approval_request)
301
timer = datetime.timedelta()
302
if self.properties["ApprovedByDefault"]:
303
message = "Approval in {0}. (d)eny?"
305
message = "Denial in {0}. (a)pprove?"
306
message = message.format(unicode(timer).rsplit(".", 1)[0])
307
elif self.properties["LastCheckerStatus"] != 0:
308
# When checker has failed, show timer until client expires
309
expires = self.properties["Expires"]
311
timer = datetime.timedelta(0)
313
expires = (datetime.datetime.strptime
314
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
315
timer = expires - datetime.datetime.utcnow()
316
message = ('A checker has failed! Time until client'
317
' gets disabled: {0}'
318
.format(unicode(timer).rsplit(".", 1)[0]))
321
self._text = "{0}{1}".format(base, message)
181
323
if not urwid.supports_unicode():
182
324
self._text = self._text.encode("ascii", "replace")
183
textlist = [(u"normal", self._text)]
325
textlist = [("normal", self._text)]
184
326
self._text_widget.set_text(textlist)
185
327
self._focus_text_widget.set_text([(with_standout[text[0]],
194
336
if self.update_hook is not None:
195
337
self.update_hook()
339
def update_timer(self):
340
"""called by gobject. Will indefinitely loop until
341
gobject.source_remove() on tag is called"""
343
return True # Keep calling this
345
def delete(self, *args, **kwargs):
346
if self._update_timer_callback_tag is not None:
347
gobject.source_remove(self._update_timer_callback_tag)
348
self._update_timer_callback_tag = None
349
for match in self.match_objects:
351
self.match_objects = ()
198
352
if self.delete_hook is not None:
199
353
self.delete_hook(self)
354
return super(MandosClientWidget, self).delete(*args, **kwargs)
201
def render(self, (maxcol,), focus=False):
356
def render(self, maxcolrow, focus=False):
202
357
"""Render differently if we have focus.
203
358
This overrides the method from urwid.FlowWidget"""
204
return self.current_widget(focus).render((maxcol,),
359
return self.current_widget(focus).render(maxcolrow,
207
def keypress(self, (maxcol,), key):
362
def keypress(self, maxcolrow, key):
209
364
This overrides the method from urwid.FlowWidget"""
210
if key == u"e" or key == u"+":
212
elif key == u"d" or key == u"-":
214
elif key == u"r" or key == u"_" or key == u"ctrl k":
366
self.proxy.Enable(dbus_interface = client_interface,
369
self.proxy.Disable(dbus_interface = client_interface,
372
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
373
dbus_interface = client_interface,
376
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
377
dbus_interface = client_interface,
379
elif key == "R" or key == "_" or key == "ctrl k":
215
380
self.server_proxy_object.RemoveClient(self.proxy
218
self.proxy.StartChecker()
220
self.proxy.StopChecker()
222
self.proxy.CheckedOK()
384
self.proxy.StartChecker(dbus_interface = client_interface,
387
self.proxy.StopChecker(dbus_interface = client_interface,
390
self.proxy.CheckedOK(dbus_interface = client_interface,
224
# elif key == u"p" or key == "=":
393
# elif key == "p" or key == "=":
225
394
# self.proxy.pause()
226
# elif key == u"u" or key == ":":
395
# elif key == "u" or key == ":":
227
396
# self.proxy.unpause()
228
# elif key == u"RET":
264
433
self.screen = urwid.curses_display.Screen()
266
435
self.screen.register_palette((
268
u"default", u"default", None),
270
u"default", u"default", u"bold"),
272
u"default", u"default", u"underline"),
274
u"default", u"default", u"standout"),
275
(u"bold-underline-blink",
276
u"default", u"default", (u"bold", u"underline")),
278
u"default", u"default", (u"bold", u"standout")),
279
(u"underline-blink-standout",
280
u"default", u"default", (u"underline", u"standout")),
281
(u"bold-underline-blink-standout",
282
u"default", u"default", (u"bold", u"underline",
437
"default", "default", None),
439
"default", "default", "bold"),
441
"default", "default", "underline"),
443
"default", "default", "standout"),
444
("bold-underline-blink",
445
"default", "default", ("bold", "underline")),
447
"default", "default", ("bold", "standout")),
448
("underline-blink-standout",
449
"default", "default", ("underline", "standout")),
450
("bold-underline-blink-standout",
451
"default", "default", ("bold", "underline",
286
455
if urwid.supports_unicode():
287
self.divider = u"─" # \u2500
288
#self.divider = u"━" # \u2501
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
290
#self.divider = u"-" # \u002d
291
self.divider = u"_" # \u005f
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
293
462
self.screen.start()
308
477
# This keeps track of whether self.uilist currently has
309
478
# self.logbox in it or not
310
479
self.log_visible = True
311
self.log_wrap = u"any"
480
self.log_wrap = "any"
314
self.log_message_raw((u"bold",
315
u"Mandos Monitor version " + version))
316
self.log_message_raw((u"bold",
483
self.log_message_raw(("bold",
484
"Mandos Monitor version " + version))
485
self.log_message_raw(("bold",
319
488
self.busname = domain + '.Mandos'
320
489
self.main_loop = gobject.MainLoop()
321
self.bus = dbus.SystemBus()
322
mandos_dbus_objc = self.bus.get_object(
323
self.busname, u"/", follow_name_owner_changes=True)
324
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
328
mandos_clients = (self.mandos_serv
329
.GetAllClientsWithProperties())
330
except dbus.exceptions.DBusException:
331
mandos_clients = dbus.Dictionary()
334
.connect_to_signal(u"ClientRemoved",
335
self.find_and_remove_client,
336
dbus_interface=server_interface,
339
.connect_to_signal(u"ClientAdded",
341
dbus_interface=server_interface,
344
.connect_to_signal(u"ClientNotFound",
345
self.client_not_found,
346
dbus_interface=server_interface,
348
for path, client in mandos_clients.iteritems():
349
client_proxy_object = self.bus.get_object(self.busname,
351
self.add_client(MandosClientWidget(server_proxy_object
354
=client_proxy_object,
364
491
def client_not_found(self, fingerprint, address):
365
self.log_message((u"Client with address %s and fingerprint %s"
366
u" could not be found" % (address,
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
494
.format(address, fingerprint))
369
496
def rebuild(self):
370
497
"""This rebuilds the User Interface.
371
498
Call this when the widget layout needs to change"""
373
500
#self.uilist.append(urwid.ListBox(self.clients))
374
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
375
503
#header=urwid.Divider(),
377
footer=urwid.Divider(div_char=self.divider)))
506
urwid.Divider(div_char=
378
508
if self.log_visible:
379
509
self.uilist.append(self.logbox)
381
510
self.topwidget = urwid.Pile(self.uilist)
383
512
def log_message(self, message):
384
513
timestamp = datetime.datetime.now().isoformat()
385
self.log_message_raw(timestamp + u": " + message)
514
self.log_message_raw(timestamp + ": " + message)
387
516
def log_message_raw(self, markup):
388
517
"""Add a log message to the log buffer."""
391
520
and len(self.log) > self.max_log_length):
392
521
del self.log[0:len(self.log)-self.max_log_length-1]
393
522
self.logbox.set_focus(len(self.logbox.body.contents),
394
coming_from=u"above")
397
526
def toggle_log_display(self):
398
527
"""Toggle visibility of the log buffer."""
399
528
self.log_visible = not self.log_visible
401
self.log_message(u"Log visibility changed to: "
402
+ unicode(self.log_visible))
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
404
533
def change_log_display(self):
405
534
"""Change type of log display.
406
535
Currently, this toggles wrapping of text lines."""
407
if self.log_wrap == u"clip":
408
self.log_wrap = u"any"
536
if self.log_wrap == "clip":
537
self.log_wrap = "any"
410
self.log_wrap = u"clip"
539
self.log_wrap = "clip"
411
540
for textwidget in self.log:
412
541
textwidget.set_wrap_mode(self.log_wrap)
413
self.log_message(u"Wrap mode: " + self.log_wrap)
542
#self.log_message("Wrap mode: " + self.log_wrap)
415
544
def find_and_remove_client(self, path, name):
416
"""Find an client from its object path and remove it.
545
"""Find a client by its object path and remove it.
418
547
This is connected to the ClientRemoved signal from the
419
548
Mandos server object."""
466
598
"""Start the main loop and exit when it's done."""
599
self.bus = dbus.SystemBus()
600
mandos_dbus_objc = self.bus.get_object(
601
self.busname, "/", follow_name_owner_changes=True)
602
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
606
mandos_clients = (self.mandos_serv
607
.GetAllClientsWithProperties())
608
except dbus.exceptions.DBusException:
609
mandos_clients = dbus.Dictionary()
612
.connect_to_signal("ClientRemoved",
613
self.find_and_remove_client,
614
dbus_interface=server_interface,
617
.connect_to_signal("ClientAdded",
619
dbus_interface=server_interface,
622
.connect_to_signal("ClientNotFound",
623
self.client_not_found,
624
dbus_interface=server_interface,
626
for path, client in mandos_clients.iteritems():
627
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
468
643
self._input_callback_tag = (gobject.io_add_watch
469
644
(sys.stdin.fileno(),
495
670
except KeyError: # :-)
498
if key == u"q" or key == u"Q":
673
if key == "q" or key == "Q":
501
elif key == u"window resize":
676
elif key == "window resize":
502
677
self.size = self.screen.get_cols_rows()
504
elif key == u"\f": # Ctrl-L
679
elif key == "\f": # Ctrl-L
506
elif key == u"l" or key == u"D":
681
elif key == "l" or key == "D":
507
682
self.toggle_log_display()
509
elif key == u"w" or key == u"i":
684
elif key == "w" or key == "i":
510
685
self.change_log_display()
512
elif key == u"?" or key == u"f1" or key == u"esc":
687
elif key == "?" or key == "f1" or key == "esc":
513
688
if not self.log_visible:
514
689
self.log_visible = True
516
self.log_message_raw((u"bold",
520
u"l: Log window toggle",
521
u"TAB: Switch window",
523
self.log_message_raw((u"bold",
529
u"s: Start new checker",
691
self.log_message_raw(("bold",
695
"l: Log window toggle",
696
"TAB: Switch window",
698
self.log_message_raw(("bold",
704
"s: Start new checker",
534
711
if self.topwidget.get_focus() is self.logbox:
535
712
self.topwidget.set_focus(0)
537
714
self.topwidget.set_focus(self.logbox)
539
#elif (key == u"end" or key == u"meta >" or key == u"G"
716
#elif (key == "end" or key == "meta >" or key == "G"
541
718
# pass # xxx end-of-buffer
542
#elif (key == u"home" or key == u"meta <" or key == u"g"
719
#elif (key == "home" or key == "meta <" or key == "g"
544
721
# pass # xxx beginning-of-buffer
545
#elif key == u"ctrl e" or key == u"$":
722
#elif key == "ctrl e" or key == "$":
546
723
# pass # xxx move-end-of-line
547
#elif key == u"ctrl a" or key == u"^":
724
#elif key == "ctrl a" or key == "^":
548
725
# pass # xxx move-beginning-of-line
549
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
726
#elif key == "ctrl b" or key == "meta (" or key == "h":
550
727
# pass # xxx left
551
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
728
#elif key == "ctrl f" or key == "meta )" or key == "l":
552
729
# pass # xxx right
554
731
# pass # scroll up log
556
733
# pass # scroll down log
557
734
elif self.topwidget.selectable():
558
735
self.topwidget.keypress(self.size, key)