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 *
61
86
properties and calls a hook function when any of them are
64
def __init__(self, proxy_object=None, *args, **kwargs):
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
65
90
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__(
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)
81
110
def property_changed(self, property=None, value=None):
82
111
"""This is called whenever we get a PropertyChanged signal
102
134
self.logger = logger
104
136
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
107
138
# The widget shown normally
108
self._text_widget = urwid.Text(u"")
139
self._text_widget = urwid.Text("")
109
140
# 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,
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
115
144
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()
145
self.properties["interval"]))
146
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
147
176
self._update_timer_callback_tag = (gobject.timeout_add
149
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
151
183
def checker_completed(self, exitstatus, condition, command):
152
184
if exitstatus == 0:
153
if self.last_checker_failed:
154
self.last_checker_failed = False
155
gobject.source_remove(self._update_timer_callback_tag)
156
self._update_timer_callback_tag = None
157
self.logger(u'Checker for client %s (command "%s")'
159
% (self.properties[u"name"], command))
163
if not self.last_checker_failed:
164
self.last_checker_failed = True
165
self._update_timer_callback_tag = (gobject.timeout_add
168
188
if os.WIFEXITED(condition):
169
self.logger(u'Checker for client %s (command "%s")'
170
u' failed with exit code %s'
171
% (self.properties[u"name"], command,
172
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)))
173
193
elif os.WIFSIGNALED(condition):
174
self.logger(u'Checker for client %s (command "%s")'
175
u' was killed by signal %s'
176
% (self.properties[u"name"], command,
177
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)))
178
198
elif os.WCOREDUMP(condition):
179
self.logger(u'Checker for client %s (command "%s")'
181
% (self.properties[u"name"], command))
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
183
self.logger(u'Checker for client %s completed mysteriously')
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
186
208
def checker_started(self, command):
187
#self.logger(u'Client %s started checker "%s"'
188
# % (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"],
191
216
def got_secret(self):
192
self.last_checker_failed = False
193
self.logger(u'Client %s received its secret'
194
% self.properties[u"name"])
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
196
220
def need_approval(self, timeout, default):
198
message = u'Client %s needs approval within %s seconds'
222
message = 'Client {0} needs approval within {1} seconds'
200
message = u'Client %s will get its secret in %s seconds'
202
% (self.properties[u"name"], timeout/1000))
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
204
228
def rejected(self, reason):
205
self.logger(u'Client %s was rejected; reason: %s'
206
% (self.properties[u"name"], reason))
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
208
232
def selectable(self):
209
233
"""Make this a "selectable" widget.
210
234
This overrides the method from urwid.FlowWidget."""
213
def rows(self, (maxcol,), focus=False):
237
def rows(self, maxcolrow, focus=False):
214
238
"""How many rows this widget will occupy might depend on
215
239
whether we have focus or not.
216
240
This overrides the method from urwid.FlowWidget"""
217
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
219
243
def current_widget(self, focus=False):
220
244
if focus or self.opened:
224
248
def update(self):
225
249
"Called when what is visible on the screen should be updated."
226
250
# How to add standout mode to a style
227
with_standout = { u"normal": u"standout",
228
u"bold": u"bold-standout",
230
u"underline-blink-standout",
231
u"bold-underline-blink":
232
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",
235
259
# Rebuild focus and non-focus widgets using current properties
237
261
# Base part of a client. Name!
238
base = (u'%(name)s: '
239
% {u"name": self.properties[u"name"]})
240
if not self.properties[u"enabled"]:
241
message = u"DISABLED"
242
elif self.properties[u"approved_pending"]:
243
if self.properties[u"approved_by_default"]:
244
message = u"Connection established to client. (d)eny?"
246
message = u"Seeks approval to send secret. (a)pprove?"
247
elif self.last_checker_failed:
262
base = '{name}: '.format(name=self.properties["Name"])
263
if not self.properties["Enabled"]:
265
self.using_timer(False)
266
elif self.properties["ApprovalPending"]:
248
267
timeout = datetime.timedelta(milliseconds
249
= self.properties[u"timeout"])
250
last_ok = isoformat_to_datetime(
251
max((self.properties["last_checked_ok"]
252
or self.properties["created"]),
253
self.properties[u"last_enabled"]))
254
timer = timeout - (datetime.datetime.utcnow() - last_ok)
255
message = (u'A checker has failed! Time until client gets diabled: %s'
256
% unicode(timer).rsplit(".", 1)[0])
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)
259
self._text = "%s%s" % (base, message)
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
261
303
if not urwid.supports_unicode():
262
304
self._text = self._text.encode("ascii", "replace")
263
textlist = [(u"normal", self._text)]
305
textlist = [("normal", self._text)]
264
306
self._text_widget.set_text(textlist)
265
307
self._focus_text_widget.set_text([(with_standout[text[0]],
275
317
self.update_hook()
277
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
280
323
return True # Keep calling this
325
def delete(self, **kwargs):
283
326
if self._update_timer_callback_tag is not None:
284
327
gobject.source_remove(self._update_timer_callback_tag)
285
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
286
332
if self.delete_hook is not None:
287
333
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
289
def render(self, (maxcol,), focus=False):
336
def render(self, maxcolrow, focus=False):
290
337
"""Render differently if we have focus.
291
338
This overrides the method from urwid.FlowWidget"""
292
return self.current_widget(focus).render((maxcol,),
339
return self.current_widget(focus).render(maxcolrow,
295
def keypress(self, (maxcol,), key):
342
def keypress(self, maxcolrow, key):
297
344
This overrides the method from urwid.FlowWidget"""
299
self.proxy.Enable(dbus_interface = client_interface)
301
self.proxy.Disable(dbus_interface = client_interface)
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
303
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
304
dbus_interface = client_interface)
353
dbus_interface = client_interface,
306
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
307
dbus_interface = client_interface)
308
elif key == u"r" or key == u"_" or key == u"ctrl k":
357
dbus_interface = client_interface,
359
elif key == "R" or key == "_" or key == "ctrl k":
309
360
self.server_proxy_object.RemoveClient(self.proxy
312
self.proxy.StartChecker(dbus_interface = client_interface)
314
self.proxy.StopChecker(dbus_interface = client_interface)
316
self.proxy.CheckedOK(dbus_interface = client_interface)
364
self.proxy.StartChecker(dbus_interface = client_interface,
367
self.proxy.StopChecker(dbus_interface = client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
318
# elif key == u"p" or key == "=":
373
# elif key == "p" or key == "=":
319
374
# self.proxy.pause()
320
# elif key == u"u" or key == ":":
375
# elif key == "u" or key == ":":
321
376
# self.proxy.unpause()
322
# elif key == u"RET":
325
# self.proxy.Approve(True)
327
# self.proxy.Approve(False)
331
def property_changed(self, property=None, value=None,
382
def property_changed(self, property=None, **kwargs):
333
383
"""Call self.update() if old value is not new value.
334
384
This overrides the method from MandosClientPropertyCache"""
335
385
property_name = unicode(property)
336
386
old_value = self.properties.get(property_name)
337
387
super(MandosClientWidget, self).property_changed(
338
property=property, value=value, *args, **kwargs)
388
property=property, **kwargs)
339
389
if self.properties.get(property_name) != old_value:
362
412
self.screen = urwid.curses_display.Screen()
364
414
self.screen.register_palette((
366
u"default", u"default", None),
368
u"default", u"default", u"bold"),
370
u"default", u"default", u"underline"),
372
u"default", u"default", u"standout"),
373
(u"bold-underline-blink",
374
u"default", u"default", (u"bold", u"underline")),
376
u"default", u"default", (u"bold", u"standout")),
377
(u"underline-blink-standout",
378
u"default", u"default", (u"underline", u"standout")),
379
(u"bold-underline-blink-standout",
380
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",
384
434
if urwid.supports_unicode():
385
self.divider = u"─" # \u2500
386
#self.divider = u"━" # \u2501
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
388
#self.divider = u"-" # \u002d
389
self.divider = u"_" # \u005f
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
391
441
self.screen.start()
406
456
# This keeps track of whether self.uilist currently has
407
457
# self.logbox in it or not
408
458
self.log_visible = True
409
self.log_wrap = u"any"
459
self.log_wrap = "any"
412
self.log_message_raw((u"bold",
413
u"Mandos Monitor version " + version))
414
self.log_message_raw((u"bold",
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
417
467
self.busname = domain + '.Mandos'
418
468
self.main_loop = gobject.MainLoop()
419
self.bus = dbus.SystemBus()
420
mandos_dbus_objc = self.bus.get_object(
421
self.busname, u"/", follow_name_owner_changes=True)
422
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
426
mandos_clients = (self.mandos_serv
427
.GetAllClientsWithProperties())
428
except dbus.exceptions.DBusException:
429
mandos_clients = dbus.Dictionary()
432
.connect_to_signal(u"ClientRemoved",
433
self.find_and_remove_client,
434
dbus_interface=server_interface,
437
.connect_to_signal(u"ClientAdded",
439
dbus_interface=server_interface,
442
.connect_to_signal(u"ClientNotFound",
443
self.client_not_found,
444
dbus_interface=server_interface,
446
for path, client in mandos_clients.iteritems():
447
client_proxy_object = self.bus.get_object(self.busname,
449
self.add_client(MandosClientWidget(server_proxy_object
452
=client_proxy_object,
462
470
def client_not_found(self, fingerprint, address):
463
self.log_message((u"Client with address %s and fingerprint %s"
464
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))
467
475
def rebuild(self):
468
476
"""This rebuilds the User Interface.
469
477
Call this when the widget layout needs to change"""
471
479
#self.uilist.append(urwid.ListBox(self.clients))
472
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
473
482
#header=urwid.Divider(),
475
footer=urwid.Divider(div_char=self.divider)))
485
urwid.Divider(div_char=
476
487
if self.log_visible:
477
488
self.uilist.append(self.logbox)
479
489
self.topwidget = urwid.Pile(self.uilist)
481
491
def log_message(self, message):
482
492
timestamp = datetime.datetime.now().isoformat()
483
self.log_message_raw(timestamp + u": " + message)
493
self.log_message_raw(timestamp + ": " + message)
485
495
def log_message_raw(self, markup):
486
496
"""Add a log message to the log buffer."""
489
499
and len(self.log) > self.max_log_length):
490
500
del self.log[0:len(self.log)-self.max_log_length-1]
491
501
self.logbox.set_focus(len(self.logbox.body.contents),
492
coming_from=u"above")
495
505
def toggle_log_display(self):
496
506
"""Toggle visibility of the log buffer."""
497
507
self.log_visible = not self.log_visible
499
self.log_message(u"Log visibility changed to: "
500
+ unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
502
512
def change_log_display(self):
503
513
"""Change type of log display.
504
514
Currently, this toggles wrapping of text lines."""
505
if self.log_wrap == u"clip":
506
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
508
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
509
519
for textwidget in self.log:
510
520
textwidget.set_wrap_mode(self.log_wrap)
511
self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
513
523
def find_and_remove_client(self, path, name):
514
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
516
526
This is connected to the ClientRemoved signal from the
517
527
Mandos server object."""
565
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,
567
622
self._input_callback_tag = (gobject.io_add_watch
568
623
(sys.stdin.fileno(),
594
649
except KeyError: # :-)
597
if key == u"q" or key == u"Q":
652
if key == "q" or key == "Q":
600
elif key == u"window resize":
655
elif key == "window resize":
601
656
self.size = self.screen.get_cols_rows()
603
elif key == u"\f": # Ctrl-L
658
elif key == "\f": # Ctrl-L
605
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
606
661
self.toggle_log_display()
608
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
609
664
self.change_log_display()
611
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
612
667
if not self.log_visible:
613
668
self.log_visible = True
615
self.log_message_raw((u"bold",
619
u"l: Log window toggle",
620
u"TAB: Switch window",
622
self.log_message_raw((u"bold",
628
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",
635
690
if self.topwidget.get_focus() is self.logbox:
636
691
self.topwidget.set_focus(0)
638
693
self.topwidget.set_focus(self.logbox)
640
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
#elif (key == "end" or key == "meta >" or key == "G"
642
697
# pass # xxx end-of-buffer
643
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
#elif (key == "home" or key == "meta <" or key == "g"
645
700
# pass # xxx beginning-of-buffer
646
#elif key == u"ctrl e" or key == u"$":
701
#elif key == "ctrl e" or key == "$":
647
702
# pass # xxx move-end-of-line
648
#elif key == u"ctrl a" or key == u"^":
703
#elif key == "ctrl a" or key == "^":
649
704
# pass # xxx move-beginning-of-line
650
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
651
706
# pass # xxx left
652
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
653
708
# pass # xxx right
655
710
# pass # scroll up log
657
712
# pass # scroll down log
658
713
elif self.topwidget.selectable():
659
714
self.topwidget.keypress(self.size, key)