2
2
# -*- mode: python; coding: utf-8 -*-
4
from __future__ import division, absolute_import, with_statement
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>.
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
58
86
properties and calls a hook function when any of them are
61
def __init__(self, proxy_object=None, *args, **kwargs):
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
62
90
self.proxy = proxy_object # Mandos Client proxy object
64
self.properties = dict()
65
self.proxy.connect_to_signal(u"PropertyChanged",
66
self.property_changed,
70
self.properties.update(
71
self.proxy.GetAll(client_interface,
72
dbus_interface = dbus.PROPERTIES_IFACE))
73
super(MandosClientPropertyCache, self).__init__(
74
proxy_object=proxy_object, *args, **kwargs)
91
self.properties = dict() if properties is None else properties
92
self.property_changed_match = (
93
self.proxy.connect_to_signal("PropertyChanged",
94
self._property_changed,
98
if properties is None:
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
102
= dbus.PROPERTIES_IFACE))
104
super(MandosClientPropertyCache, self).__init__(**kwargs)
106
def _property_changed(self, property, value):
107
"""Helper which takes positional arguments"""
108
return self.property_changed(property=property, value=value)
76
110
def property_changed(self, property=None, value=None):
77
111
"""This is called whenever we get a PropertyChanged signal
97
134
self.logger = logger
99
136
self._update_timer_callback_tag = None
100
self.last_checker_failed = False
102
138
# The widget shown normally
103
self._text_widget = urwid.Text(u"")
139
self._text_widget = urwid.Text("")
104
140
# The widget shown when we have focus
105
self._focus_text_widget = urwid.Text(u"")
106
super(MandosClientWidget, self).__init__(
107
update_hook=update_hook, delete_hook=delete_hook,
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
110
144
self.opened = False
111
self.proxy.connect_to_signal(u"CheckerCompleted",
112
self.checker_completed,
115
self.proxy.connect_to_signal(u"CheckerStarted",
116
self.checker_started,
119
self.proxy.connect_to_signal(u"GotSecret",
123
self.proxy.connect_to_signal(u"Rejected",
127
last_checked_ok = isoformat_to_datetime(self.properties
129
if last_checked_ok is None:
130
self.last_checker_failed = True
132
self.last_checker_failed = ((datetime.datetime.utcnow()
136
self.properties["interval"]))
137
if self.last_checker_failed:
146
self.match_objects = (
147
self.proxy.connect_to_signal("CheckerCompleted",
148
self.checker_completed,
151
self.proxy.connect_to_signal("CheckerStarted",
152
self.checker_started,
155
self.proxy.connect_to_signal("GotSecret",
159
self.proxy.connect_to_signal("NeedApproval",
163
self.proxy.connect_to_signal("Rejected",
167
#self.logger('Created client {0}'
168
# .format(self.properties["Name"]))
170
def using_timer(self, flag):
171
"""Call this method with True or False when timer should be
172
activated or deactivated.
174
if flag and self._update_timer_callback_tag is None:
175
# Will update the shown timer value every second
138
176
self._update_timer_callback_tag = (gobject.timeout_add
140
178
self.update_timer))
179
elif not (flag or self._update_timer_callback_tag is None):
180
gobject.source_remove(self._update_timer_callback_tag)
181
self._update_timer_callback_tag = None
142
183
def checker_completed(self, exitstatus, condition, command):
143
184
if exitstatus == 0:
144
if self.last_checker_failed:
145
self.last_checker_failed = False
146
gobject.source_remove(self._update_timer_callback_tag)
147
self._update_timer_callback_tag = None
148
self.logger(u'Checker for client %s (command "%s")'
150
% (self.properties[u"name"], command))
154
if not self.last_checker_failed:
155
self.last_checker_failed = True
156
self._update_timer_callback_tag = (gobject.timeout_add
159
188
if os.WIFEXITED(condition):
160
self.logger(u'Checker for client %s (command "%s")'
161
u' failed with exit code %s'
162
% (self.properties[u"name"], command,
163
os.WEXITSTATUS(condition)))
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
191
.format(self.properties["Name"], command,
192
os.WEXITSTATUS(condition)))
164
193
elif os.WIFSIGNALED(condition):
165
self.logger(u'Checker for client %s (command "%s")'
166
u' was killed by signal %s'
167
% (self.properties[u"name"], command,
168
os.WTERMSIG(condition)))
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
196
.format(self.properties["Name"], command,
197
os.WTERMSIG(condition)))
169
198
elif os.WCOREDUMP(condition):
170
self.logger(u'Checker for client %s (command "%s")'
172
% (self.properties[u"name"], command))
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
174
self.logger(u'Checker for client %s completed mysteriously')
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
177
208
def checker_started(self, command):
178
self.logger(u'Client %s started checker "%s"'
179
% (self.properties[u"name"], unicode(command)))
209
"""Server signals that a checker started. This could be useful
210
to log in the future. """
211
#self.logger('Client {0} started checker "{1}"'
212
# .format(self.properties["Name"],
181
216
def got_secret(self):
182
self.logger(u'Client %s received its secret'
183
% self.properties[u"name"])
186
self.logger(u'Client %s was rejected'
187
% self.properties[u"name"])
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
220
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
228
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
189
232
def selectable(self):
190
233
"""Make this a "selectable" widget.
191
234
This overrides the method from urwid.FlowWidget."""
194
def rows(self, (maxcol,), focus=False):
237
def rows(self, maxcolrow, focus=False):
195
238
"""How many rows this widget will occupy might depend on
196
239
whether we have focus or not.
197
240
This overrides the method from urwid.FlowWidget"""
198
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
200
243
def current_widget(self, focus=False):
201
244
if focus or self.opened:
205
248
def update(self):
206
249
"Called when what is visible on the screen should be updated."
207
250
# How to add standout mode to a style
208
with_standout = { u"normal": u"standout",
209
u"bold": u"bold-standout",
211
u"underline-blink-standout",
212
u"bold-underline-blink":
213
u"bold-underline-blink-standout",
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"bold-underline-blink-standout",
216
259
# Rebuild focus and non-focus widgets using current properties
217
self._text = (u'%(name)s: %(enabled)s%(timer)s'
218
% { u"name": self.properties[u"name"],
221
if self.properties[u"enabled"]
223
u"timer": (unicode(datetime.timedelta
229
- isoformat_to_datetime
230
(max((self.properties
235
self.properties[u"last_enabled"]))))
236
if (self.last_checker_failed
261
# Base part of a client. Name!
262
base = '{name}: '.format(name=self.properties["Name"])
263
if not self.properties["Enabled"]:
265
self.using_timer(False)
266
elif self.properties["ApprovalPending"]:
267
timeout = datetime.timedelta(milliseconds
270
last_approval_request = isoformat_to_datetime(
271
self.properties["LastApprovalRequest"])
272
if last_approval_request is not None:
273
timer = max(timeout - (datetime.datetime.utcnow()
274
- last_approval_request),
275
datetime.timedelta())
277
timer = datetime.timedelta()
278
if self.properties["ApprovedByDefault"]:
279
message = "Approval in {0}. (d)eny?"
281
message = "Denial in {0}. (a)pprove?"
282
message = message.format(unicode(timer).rsplit(".", 1)[0])
283
self.using_timer(True)
284
elif self.properties["LastCheckerStatus"] != 0:
285
# When checker has failed, show timer until client expires
286
expires = self.properties["Expires"]
288
timer = datetime.timedelta(0)
290
expires = (datetime.datetime.strptime
291
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
292
timer = max(expires - datetime.datetime.utcnow(),
293
datetime.timedelta())
294
message = ('A checker has failed! Time until client'
295
' gets disabled: {0}'
296
.format(unicode(timer).rsplit(".", 1)[0]))
297
self.using_timer(True)
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
240
303
if not urwid.supports_unicode():
241
304
self._text = self._text.encode("ascii", "replace")
242
textlist = [(u"normal", self._text)]
305
textlist = [("normal", self._text)]
243
306
self._text_widget.set_text(textlist)
244
307
self._focus_text_widget.set_text([(with_standout[text[0]],
254
317
self.update_hook()
256
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
259
323
return True # Keep calling this
325
def delete(self, **kwargs):
262
326
if self._update_timer_callback_tag is not None:
263
327
gobject.source_remove(self._update_timer_callback_tag)
264
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
265
332
if self.delete_hook is not None:
266
333
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
268
def render(self, (maxcol,), focus=False):
336
def render(self, maxcolrow, focus=False):
269
337
"""Render differently if we have focus.
270
338
This overrides the method from urwid.FlowWidget"""
271
return self.current_widget(focus).render((maxcol,),
339
return self.current_widget(focus).render(maxcolrow,
274
def keypress(self, (maxcol,), key):
342
def keypress(self, maxcolrow, key):
276
344
This overrides the method from urwid.FlowWidget"""
277
if key == u"e" or key == u"+":
279
elif key == u"d" or key == u"-":
281
elif key == u"r" or key == u"_" or key == u"ctrl k":
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
359
elif key == "R" or key == "_" or key == "ctrl k":
282
360
self.server_proxy_object.RemoveClient(self.proxy
285
self.proxy.StartChecker()
287
self.proxy.StopChecker()
289
self.proxy.CheckedOK()
364
self.proxy.StartChecker(dbus_interface = client_interface,
367
self.proxy.StopChecker(dbus_interface = client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
291
# elif key == u"p" or key == "=":
373
# elif key == "p" or key == "=":
292
374
# self.proxy.pause()
293
# elif key == u"u" or key == ":":
375
# elif key == "u" or key == ":":
294
376
# self.proxy.unpause()
295
# elif key == u"RET":
300
def property_changed(self, property=None, value=None,
382
def property_changed(self, property=None, **kwargs):
302
383
"""Call self.update() if old value is not new value.
303
384
This overrides the method from MandosClientPropertyCache"""
304
385
property_name = unicode(property)
305
386
old_value = self.properties.get(property_name)
306
387
super(MandosClientWidget, self).property_changed(
307
property=property, value=value, *args, **kwargs)
388
property=property, **kwargs)
308
389
if self.properties.get(property_name) != old_value:
331
412
self.screen = urwid.curses_display.Screen()
333
414
self.screen.register_palette((
335
u"default", u"default", None),
337
u"default", u"default", u"bold"),
339
u"default", u"default", u"underline"),
341
u"default", u"default", u"standout"),
342
(u"bold-underline-blink",
343
u"default", u"default", (u"bold", u"underline")),
345
u"default", u"default", (u"bold", u"standout")),
346
(u"underline-blink-standout",
347
u"default", u"default", (u"underline", u"standout")),
348
(u"bold-underline-blink-standout",
349
u"default", u"default", (u"bold", u"underline",
416
"default", "default", None),
418
"default", "default", "bold"),
420
"default", "default", "underline"),
422
"default", "default", "standout"),
423
("bold-underline-blink",
424
"default", "default", ("bold", "underline")),
426
"default", "default", ("bold", "standout")),
427
("underline-blink-standout",
428
"default", "default", ("underline", "standout")),
429
("bold-underline-blink-standout",
430
"default", "default", ("bold", "underline",
353
434
if urwid.supports_unicode():
354
self.divider = u"─" # \u2500
355
#self.divider = u"━" # \u2501
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
357
#self.divider = u"-" # \u002d
358
self.divider = u"_" # \u005f
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
360
441
self.screen.start()
375
456
# This keeps track of whether self.uilist currently has
376
457
# self.logbox in it or not
377
458
self.log_visible = True
378
self.log_wrap = u"any"
459
self.log_wrap = "any"
381
self.log_message_raw((u"bold",
382
u"Mandos Monitor version " + version))
383
self.log_message_raw((u"bold",
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
386
467
self.busname = domain + '.Mandos'
387
468
self.main_loop = gobject.MainLoop()
388
self.bus = dbus.SystemBus()
389
mandos_dbus_objc = self.bus.get_object(
390
self.busname, u"/", follow_name_owner_changes=True)
391
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
395
mandos_clients = (self.mandos_serv
396
.GetAllClientsWithProperties())
397
except dbus.exceptions.DBusException:
398
mandos_clients = dbus.Dictionary()
401
.connect_to_signal(u"ClientRemoved",
402
self.find_and_remove_client,
403
dbus_interface=server_interface,
406
.connect_to_signal(u"ClientAdded",
408
dbus_interface=server_interface,
411
.connect_to_signal(u"ClientNotFound",
412
self.client_not_found,
413
dbus_interface=server_interface,
415
for path, client in mandos_clients.iteritems():
416
client_proxy_object = self.bus.get_object(self.busname,
418
self.add_client(MandosClientWidget(server_proxy_object
421
=client_proxy_object,
431
470
def client_not_found(self, fingerprint, address):
432
self.log_message((u"Client with address %s and fingerprint %s"
433
u" could not be found" % (address,
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} could not be found"
473
.format(address, fingerprint))
436
475
def rebuild(self):
437
476
"""This rebuilds the User Interface.
438
477
Call this when the widget layout needs to change"""
440
479
#self.uilist.append(urwid.ListBox(self.clients))
441
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
442
482
#header=urwid.Divider(),
444
footer=urwid.Divider(div_char=self.divider)))
485
urwid.Divider(div_char=
445
487
if self.log_visible:
446
488
self.uilist.append(self.logbox)
448
489
self.topwidget = urwid.Pile(self.uilist)
450
491
def log_message(self, message):
451
492
timestamp = datetime.datetime.now().isoformat()
452
self.log_message_raw(timestamp + u": " + message)
493
self.log_message_raw(timestamp + ": " + message)
454
495
def log_message_raw(self, markup):
455
496
"""Add a log message to the log buffer."""
458
499
and len(self.log) > self.max_log_length):
459
500
del self.log[0:len(self.log)-self.max_log_length-1]
460
501
self.logbox.set_focus(len(self.logbox.body.contents),
461
coming_from=u"above")
464
505
def toggle_log_display(self):
465
506
"""Toggle visibility of the log buffer."""
466
507
self.log_visible = not self.log_visible
468
self.log_message(u"Log visibility changed to: "
469
+ unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
471
512
def change_log_display(self):
472
513
"""Change type of log display.
473
514
Currently, this toggles wrapping of text lines."""
474
if self.log_wrap == u"clip":
475
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
477
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
478
519
for textwidget in self.log:
479
520
textwidget.set_wrap_mode(self.log_wrap)
480
self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
482
523
def find_and_remove_client(self, path, name):
483
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
485
526
This is connected to the ClientRemoved signal from the
486
527
Mandos server object."""
534
577
"""Start the main loop and exit when it's done."""
578
self.bus = dbus.SystemBus()
579
mandos_dbus_objc = self.bus.get_object(
580
self.busname, "/", follow_name_owner_changes=True)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
585
mandos_clients = (self.mandos_serv
586
.GetAllClientsWithProperties())
587
except dbus.exceptions.DBusException:
588
mandos_clients = dbus.Dictionary()
591
.connect_to_signal("ClientRemoved",
592
self.find_and_remove_client,
593
dbus_interface=server_interface,
596
.connect_to_signal("ClientAdded",
598
dbus_interface=server_interface,
601
.connect_to_signal("ClientNotFound",
602
self.client_not_found,
603
dbus_interface=server_interface,
605
for path, client in mandos_clients.iteritems():
606
client_proxy_object = self.bus.get_object(self.busname,
608
self.add_client(MandosClientWidget(server_proxy_object
611
=client_proxy_object,
536
622
self._input_callback_tag = (gobject.io_add_watch
537
623
(sys.stdin.fileno(),
563
649
except KeyError: # :-)
566
if key == u"q" or key == u"Q":
652
if key == "q" or key == "Q":
569
elif key == u"window resize":
655
elif key == "window resize":
570
656
self.size = self.screen.get_cols_rows()
572
elif key == u"\f": # Ctrl-L
658
elif key == "\f": # Ctrl-L
574
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
575
661
self.toggle_log_display()
577
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
578
664
self.change_log_display()
580
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
581
667
if not self.log_visible:
582
668
self.log_visible = True
584
self.log_message_raw((u"bold",
588
u"l: Log window toggle",
589
u"TAB: Switch window",
591
self.log_message_raw((u"bold",
597
u"s: Start new checker",
670
self.log_message_raw(("bold",
674
"l: Log window toggle",
675
"TAB: Switch window",
677
self.log_message_raw(("bold",
683
"s: Start new checker",
602
690
if self.topwidget.get_focus() is self.logbox:
603
691
self.topwidget.set_focus(0)
605
693
self.topwidget.set_focus(self.logbox)
607
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
#elif (key == "end" or key == "meta >" or key == "G"
609
697
# pass # xxx end-of-buffer
610
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
#elif (key == "home" or key == "meta <" or key == "g"
612
700
# pass # xxx beginning-of-buffer
613
#elif key == u"ctrl e" or key == u"$":
701
#elif key == "ctrl e" or key == "$":
614
702
# pass # xxx move-end-of-line
615
#elif key == u"ctrl a" or key == u"^":
703
#elif key == "ctrl a" or key == "^":
616
704
# pass # xxx move-beginning-of-line
617
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
618
706
# pass # xxx left
619
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
620
708
# pass # xxx right
622
710
# pass # scroll up log
624
712
# pass # scroll down log
625
713
elif self.topwidget.selectable():
626
714
self.topwidget.keypress(self.size, key)