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 <http://www.gnu.org/licenses/>.
22
# Contact the authors at <mandos@recompile.se>.
4
from __future__ import division, absolute_import, with_statement
25
from __future__ import (division, absolute_import, print_function,
9
34
import urwid.curses_display
30
62
urwid.curses_display.curses.A_UNDERLINE |= (
31
63
urwid.curses_display.curses.A_BLINK)
65
def isoformat_to_datetime(iso):
66
"Parse an ISO 8601 date string to a datetime.datetime()"
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
72
second, fraction = divmod(float(second), 1)
73
return datetime.datetime(int(year),
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
33
81
class MandosClientPropertyCache(object):
34
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
35
83
properties and calls a hook function when any of them are
38
def __init__(self, proxy_object=None, properties=None, *args,
86
def __init__(self, proxy_object=None, *args, **kwargs):
40
87
self.proxy = proxy_object # Mandos Client proxy object
42
if properties is None:
43
self.properties = dict()
45
self.properties = properties
46
self.proxy.connect_to_signal("PropertyChanged",
47
self.property_changed,
89
self.properties = dict()
90
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
51
if properties is None:
52
self.properties.update(self.proxy.GetAll(client_interface,
54
dbus.PROPERTIES_IFACE))
55
super(MandosClientPropertyCache, self).__init__(
56
proxy_object=proxy_object,
57
properties=properties, *args, **kwargs)
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
59
104
def property_changed(self, property=None, value=None):
60
105
"""This is called whenever we get a PropertyChanged signal
71
121
def __init__(self, server_proxy_object=None, update_hook=None,
72
delete_hook=None, *args, **kwargs):
122
delete_hook=None, logger=None, *args, **kwargs):
73
123
# Called on update
74
124
self.update_hook = update_hook
75
125
# Called on delete
76
126
self.delete_hook = delete_hook
77
127
# Mandos Server proxy object
78
128
self.server_proxy_object = server_proxy_object
132
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
134
self.last_checker_failed = False
80
136
# The widget shown normally
81
137
self._text_widget = urwid.Text("")
88
144
self.opened = False
146
last_checked_ok = isoformat_to_datetime(self.properties
148
if last_checked_ok is None:
149
self.last_checker_failed = True
151
self.last_checker_failed = ((datetime.datetime.utcnow()
158
if self.last_checker_failed:
159
self.using_timer(True)
161
if self.need_approval:
162
self.using_timer(True)
164
self.match_objects = (
165
self.proxy.connect_to_signal("CheckerCompleted",
166
self.checker_completed,
169
self.proxy.connect_to_signal("CheckerStarted",
170
self.checker_started,
173
self.proxy.connect_to_signal("GotSecret",
177
self.proxy.connect_to_signal("NeedApproval",
181
self.proxy.connect_to_signal("Rejected",
185
#self.logger('Created client %s' % (self.properties["Name"]))
187
def property_changed(self, property=None, value=None):
188
super(self, MandosClientWidget).property_changed(property,
190
if property == "ApprovalPending":
191
using_timer(bool(value))
193
def using_timer(self, flag):
194
"""Call this method with True or False when timer should be
195
activated or deactivated.
197
old = self._update_timer_callback_lock
199
self._update_timer_callback_lock += 1
201
self._update_timer_callback_lock -= 1
202
if old == 0 and self._update_timer_callback_lock:
203
# Will update the shown timer value every second
204
self._update_timer_callback_tag = (gobject.timeout_add
207
elif old and self._update_timer_callback_lock == 0:
208
gobject.source_remove(self._update_timer_callback_tag)
209
self._update_timer_callback_tag = None
211
def checker_completed(self, exitstatus, condition, command):
213
if self.last_checker_failed:
214
self.last_checker_failed = False
215
self.using_timer(False)
216
#self.logger('Checker for client %s (command "%s")'
218
# % (self.properties["Name"], command))
222
if not self.last_checker_failed:
223
self.last_checker_failed = True
224
self.using_timer(True)
225
if os.WIFEXITED(condition):
226
self.logger('Checker for client %s (command "%s")'
227
' failed with exit code %s'
228
% (self.properties["Name"], command,
229
os.WEXITSTATUS(condition)))
230
elif os.WIFSIGNALED(condition):
231
self.logger('Checker for client %s (command "%s")'
232
' was killed by signal %s'
233
% (self.properties["Name"], command,
234
os.WTERMSIG(condition)))
235
elif os.WCOREDUMP(condition):
236
self.logger('Checker for client %s (command "%s")'
238
% (self.properties["Name"], command))
240
self.logger('Checker for client %s completed'
244
def checker_started(self, command):
245
"""Server signals that a checker started. This could be useful
246
to log in the future. """
247
#self.logger('Client %s started checker "%s"'
248
# % (self.properties["Name"], unicode(command)))
251
def got_secret(self):
252
self.last_checker_failed = False
253
self.logger('Client %s received its secret'
254
% self.properties["Name"])
256
def need_approval(self, timeout, default):
258
message = 'Client %s needs approval within %s seconds'
260
message = 'Client %s will get its secret in %s seconds'
262
% (self.properties["Name"], timeout/1000))
263
self.using_timer(True)
265
def rejected(self, reason):
266
self.logger('Client %s was rejected; reason: %s'
267
% (self.properties["Name"], reason))
90
269
def selectable(self):
91
270
"""Make this a "selectable" widget.
92
271
This overrides the method from urwid.FlowWidget."""
95
def rows(self, (maxcol,), focus=False):
274
def rows(self, maxcolrow, focus=False):
96
275
"""How many rows this widget will occupy might depend on
97
276
whether we have focus or not.
98
277
This overrides the method from urwid.FlowWidget"""
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
278
return self.current_widget(focus).rows(maxcolrow, focus=focus)
101
280
def current_widget(self, focus=False):
102
281
if focus or self.opened:
106
285
def update(self):
107
286
"Called when what is visible on the screen should be updated."
108
287
# How to add standout mode to a style
109
with_standout = { u"normal": u"standout",
110
u"bold": u"bold-standout",
112
u"underline-blink-standout",
113
u"bold-underline-blink":
114
u"bold-underline-blink-standout",
288
with_standout = { "normal": "standout",
289
"bold": "bold-standout",
291
"underline-blink-standout",
292
"bold-underline-blink":
293
"bold-underline-blink-standout",
117
296
# Rebuild focus and non-focus widgets using current properties
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
298
# Base part of a client. Name!
300
% {"name": self.properties["Name"]})
301
if not self.properties["Enabled"]:
303
elif self.properties["ApprovalPending"]:
304
timeout = datetime.timedelta(milliseconds
307
last_approval_request = isoformat_to_datetime(
308
self.properties["LastApprovalRequest"])
309
if last_approval_request is not None:
310
timer = timeout - (datetime.datetime.utcnow()
311
- last_approval_request)
313
timer = datetime.timedelta()
314
if self.properties["ApprovedByDefault"]:
315
message = "Approval in %s. (d)eny?"
317
message = "Denial in %s. (a)pprove?"
318
message = message % unicode(timer).rsplit(".", 1)[0]
319
elif self.last_checker_failed:
320
# When checker has failed, print a timer until client expires
321
expires = self.properties["Expires"]
323
timer = datetime.timedelta(0)
325
expires = datetime.datetime.strptime(expires,
326
'%Y-%m-%dT%H:%M:%S.%f')
327
timer = expires - datetime.datetime.utcnow()
328
message = ('A checker has failed! Time until client'
330
% unicode(timer).rsplit(".", 1)[0])
333
self._text = "%s%s" % (base, message)
120
335
if not urwid.supports_unicode():
121
336
self._text = self._text.encode("ascii", "replace")
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
337
textlist = [("normal", self._text)]
123
338
self._text_widget.set_text(textlist)
124
339
self._focus_text_widget.set_text([(with_standout[text[0]],
133
348
if self.update_hook is not None:
134
349
self.update_hook()
351
def update_timer(self):
352
"""called by gobject. Will indefinitely loop until
353
gobject.source_remove() on tag is called"""
355
return True # Keep calling this
357
def delete(self, *args, **kwargs):
358
if self._update_timer_callback_tag is not None:
359
gobject.source_remove(self._update_timer_callback_tag)
360
self._update_timer_callback_tag = None
361
for match in self.match_objects:
363
self.match_objects = ()
137
364
if self.delete_hook is not None:
138
365
self.delete_hook(self)
366
return super(MandosClientWidget, self).delete(*args, **kwargs)
140
def render(self, (maxcol,), focus=False):
368
def render(self, maxcolrow, focus=False):
141
369
"""Render differently if we have focus.
142
370
This overrides the method from urwid.FlowWidget"""
143
return self.current_widget(focus).render((maxcol,),
371
return self.current_widget(focus).render(maxcolrow,
146
def keypress(self, (maxcol,), key):
374
def keypress(self, maxcolrow, key):
148
376
This overrides the method from urwid.FlowWidget"""
149
if key == u"e" or key == u"+":
151
elif key == u"d" or key == u"-":
153
elif key == u"r" or key == u"_" or key == u"ctrl k":
378
self.proxy.Enable(dbus_interface = client_interface,
381
self.proxy.Disable(dbus_interface = client_interface,
384
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
385
dbus_interface = client_interface,
388
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
389
dbus_interface = client_interface,
391
elif key == "R" or key == "_" or key == "ctrl k":
154
392
self.server_proxy_object.RemoveClient(self.proxy
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
396
self.proxy.StartChecker(dbus_interface = client_interface,
399
self.proxy.StopChecker(dbus_interface = client_interface,
402
self.proxy.CheckedOK(dbus_interface = client_interface,
163
# elif key == u"p" or key == "=":
405
# elif key == "p" or key == "=":
164
406
# self.proxy.pause()
165
# elif key == u"u" or key == ":":
407
# elif key == "u" or key == ":":
166
408
# self.proxy.unpause()
167
# elif key == u"RET":
203
445
self.screen = urwid.curses_display.Screen()
205
447
self.screen.register_palette((
207
u"default", u"default", None),
209
u"default", u"default", u"bold"),
211
u"default", u"default", u"underline"),
213
u"default", u"default", u"standout"),
214
(u"bold-underline-blink",
215
u"default", u"default", (u"bold", u"underline")),
217
u"default", u"default", (u"bold", u"standout")),
218
(u"underline-blink-standout",
219
u"default", u"default", (u"underline", u"standout")),
220
(u"bold-underline-blink-standout",
221
u"default", u"default", (u"bold", u"underline",
449
"default", "default", None),
451
"default", "default", "bold"),
453
"default", "default", "underline"),
455
"default", "default", "standout"),
456
("bold-underline-blink",
457
"default", "default", ("bold", "underline")),
459
"default", "default", ("bold", "standout")),
460
("underline-blink-standout",
461
"default", "default", ("underline", "standout")),
462
("bold-underline-blink-standout",
463
"default", "default", ("bold", "underline",
225
467
if urwid.supports_unicode():
226
self.divider = u"─" # \u2500
227
#self.divider = u"━" # \u2501
468
self.divider = "─" # \u2500
469
#self.divider = "━" # \u2501
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
471
#self.divider = "-" # \u002d
472
self.divider = "_" # \u005f
232
474
self.screen.start()
247
489
# This keeps track of whether self.uilist currently has
248
490
# self.logbox in it or not
249
491
self.log_visible = True
250
self.log_wrap = u"any"
492
self.log_wrap = "any"
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
495
self.log_message_raw(("bold",
496
"Mandos Monitor version " + version))
497
self.log_message_raw(("bold",
258
500
self.busname = domain + '.Mandos'
259
501
self.main_loop = gobject.MainLoop()
260
self.bus = dbus.SystemBus()
261
mandos_dbus_objc = self.bus.get_object(
262
self.busname, u"/", follow_name_owner_changes=True)
263
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
267
mandos_clients = (self.mandos_serv
268
.GetAllClientsWithProperties())
269
except dbus.exceptions.DBusException:
270
mandos_clients = dbus.Dictionary()
273
.connect_to_signal("ClientRemoved",
274
self.find_and_remove_client,
275
dbus_interface=server_interface,
278
.connect_to_signal("ClientAdded",
280
dbus_interface=server_interface,
282
for path, client in mandos_clients.iteritems():
283
client_proxy_object = self.bus.get_object(self.busname,
285
self.add_client(MandosClientWidget(server_proxy_object
288
=client_proxy_object,
293
=self.remove_client),
503
def client_not_found(self, fingerprint, address):
504
self.log_message(("Client with address %s and fingerprint %s"
505
" could not be found" % (address,
296
508
def rebuild(self):
297
509
"""This rebuilds the User Interface.
298
510
Call this when the widget layout needs to change"""
300
512
#self.uilist.append(urwid.ListBox(self.clients))
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
513
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
302
515
#header=urwid.Divider(),
304
footer=urwid.Divider(div_char=self.divider)))
518
urwid.Divider(div_char=
305
520
if self.log_visible:
306
521
self.uilist.append(self.logbox)
308
522
self.topwidget = urwid.Pile(self.uilist)
310
def log_message(self, markup):
524
def log_message(self, message):
525
timestamp = datetime.datetime.now().isoformat()
526
self.log_message_raw(timestamp + ": " + message)
528
def log_message_raw(self, markup):
311
529
"""Add a log message to the log buffer."""
312
530
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
313
531
if (self.max_log_length
314
532
and len(self.log) > self.max_log_length):
315
533
del self.log[0:len(self.log)-self.max_log_length-1]
316
534
self.logbox.set_focus(len(self.logbox.body.contents),
317
coming_from=u"above")
319
538
def toggle_log_display(self):
320
539
"""Toggle visibility of the log buffer."""
321
540
self.log_visible = not self.log_visible
323
self.log_message(u"Log visibility changed to: "
324
+ unicode(self.log_visible))
542
#self.log_message("Log visibility changed to: "
543
# + unicode(self.log_visible))
326
545
def change_log_display(self):
327
546
"""Change type of log display.
328
547
Currently, this toggles wrapping of text lines."""
329
if self.log_wrap == u"clip":
330
self.log_wrap = u"any"
548
if self.log_wrap == "clip":
549
self.log_wrap = "any"
332
self.log_wrap = u"clip"
551
self.log_wrap = "clip"
333
552
for textwidget in self.log:
334
553
textwidget.set_wrap_mode(self.log_wrap)
335
self.log_message(u"Wrap mode: " + self.log_wrap)
554
#self.log_message("Wrap mode: " + self.log_wrap)
337
556
def find_and_remove_client(self, path, name):
338
"""Find an client from its object path and remove it.
557
"""Find a client by its object path and remove it.
340
559
This is connected to the ClientRemoved signal from the
341
560
Mandos server object."""
388
610
"""Start the main loop and exit when it's done."""
611
self.bus = dbus.SystemBus()
612
mandos_dbus_objc = self.bus.get_object(
613
self.busname, "/", follow_name_owner_changes=True)
614
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
618
mandos_clients = (self.mandos_serv
619
.GetAllClientsWithProperties())
620
except dbus.exceptions.DBusException:
621
mandos_clients = dbus.Dictionary()
624
.connect_to_signal("ClientRemoved",
625
self.find_and_remove_client,
626
dbus_interface=server_interface,
629
.connect_to_signal("ClientAdded",
631
dbus_interface=server_interface,
634
.connect_to_signal("ClientNotFound",
635
self.client_not_found,
636
dbus_interface=server_interface,
638
for path, client in mandos_clients.iteritems():
639
client_proxy_object = self.bus.get_object(self.busname,
641
self.add_client(MandosClientWidget(server_proxy_object
644
=client_proxy_object,
390
655
self._input_callback_tag = (gobject.io_add_watch
391
656
(sys.stdin.fileno(),
402
667
def process_input(self, source, condition):
403
668
keys = self.screen.get_input()
404
translations = { u"ctrl n": u"down", # Emacs
405
u"ctrl p": u"up", # Emacs
406
u"ctrl v": u"page down", # Emacs
407
u"meta v": u"page up", # Emacs
408
u" ": u"page down", # less
409
u"f": u"page down", # less
410
u"b": u"page up", # less
669
translations = { "ctrl n": "down", # Emacs
670
"ctrl p": "up", # Emacs
671
"ctrl v": "page down", # Emacs
672
"meta v": "page up", # Emacs
673
" ": "page down", # less
674
"f": "page down", # less
675
"b": "page up", # less
417
682
except KeyError: # :-)
420
if key == u"q" or key == u"Q":
685
if key == "q" or key == "Q":
423
elif key == u"window resize":
688
elif key == "window resize":
424
689
self.size = self.screen.get_cols_rows()
426
elif key == u"\f": # Ctrl-L
691
elif key == "\f": # Ctrl-L
428
elif key == u"l" or key == u"D":
693
elif key == "l" or key == "D":
429
694
self.toggle_log_display()
431
elif key == u"w" or key == u"i":
696
elif key == "w" or key == "i":
432
697
self.change_log_display()
434
elif key == u"?" or key == u"f1" or key == u"esc":
699
elif key == "?" or key == "f1" or key == "esc":
435
700
if not self.log_visible:
436
701
self.log_visible = True
438
self.log_message((u"bold",
439
u" ".join((u"q: Quit",
441
u"l: Log window toggle",
442
u"TAB: Switch window",
444
self.log_message((u"bold",
445
u" ".join((u"Clients:",
449
u"s: Start new checker",
703
self.log_message_raw(("bold",
707
"l: Log window toggle",
708
"TAB: Switch window",
710
self.log_message_raw(("bold",
716
"s: Start new checker",
454
723
if self.topwidget.get_focus() is self.logbox:
455
724
self.topwidget.set_focus(0)
457
726
self.topwidget.set_focus(self.logbox)
459
#elif (key == u"end" or key == u"meta >" or key == u"G"
728
#elif (key == "end" or key == "meta >" or key == "G"
461
730
# pass # xxx end-of-buffer
462
#elif (key == u"home" or key == u"meta <" or key == u"g"
731
#elif (key == "home" or key == "meta <" or key == "g"
464
733
# pass # xxx beginning-of-buffer
465
#elif key == u"ctrl e" or key == u"$":
734
#elif key == "ctrl e" or key == "$":
466
735
# pass # xxx move-end-of-line
467
#elif key == u"ctrl a" or key == u"^":
736
#elif key == "ctrl a" or key == "^":
468
737
# pass # xxx move-beginning-of-line
469
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
738
#elif key == "ctrl b" or key == "meta (" or key == "h":
470
739
# pass # xxx left
471
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
740
#elif key == "ctrl f" or key == "meta )" or key == "l":
472
741
# pass # xxx right
474
743
# pass # scroll up log
476
745
# pass # scroll down log
477
746
elif self.topwidget.selectable():
478
747
self.topwidget.keypress(self.size, key)