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.logger(u'Client %s received its secret'
193
% self.properties[u"name"])
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
195
220
def need_approval(self, timeout, default):
197
message = u'Client %s needs approval within %s seconds'
222
message = 'Client {0} needs approval within {1} seconds'
199
message = u'Client %s will get its secret in %s seconds'
201
% (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"],
203
228
def rejected(self, reason):
204
self.logger(u'Client %s was rejected; reason: %s'
205
% (self.properties[u"name"], reason))
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
207
232
def selectable(self):
208
233
"""Make this a "selectable" widget.
209
234
This overrides the method from urwid.FlowWidget."""
212
def rows(self, (maxcol,), focus=False):
237
def rows(self, maxcolrow, focus=False):
213
238
"""How many rows this widget will occupy might depend on
214
239
whether we have focus or not.
215
240
This overrides the method from urwid.FlowWidget"""
216
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
218
243
def current_widget(self, focus=False):
219
244
if focus or self.opened:
223
248
def update(self):
224
249
"Called when what is visible on the screen should be updated."
225
250
# How to add standout mode to a style
226
with_standout = { u"normal": u"standout",
227
u"bold": u"bold-standout",
229
u"underline-blink-standout",
230
u"bold-underline-blink":
231
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",
234
259
# Rebuild focus and non-focus widgets using current properties
236
261
# Base part of a client. Name!
237
base = (u'%(name)s: '
238
% {u"name": self.properties[u"name"]})
239
if not self.properties[u"enabled"]:
240
message = u"DISABLED"
241
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"]:
242
267
timeout = datetime.timedelta(milliseconds
243
= self.properties[u"timeout"])
244
last_ok = isoformat_to_datetime(
245
max((self.properties["last_checked_ok"]
246
or self.properties["created"]),
247
self.properties[u"last_enabled"]))
248
timer = timeout - (datetime.datetime.utcnow() - last_ok)
249
message = (u'A checker has failed! Time until client gets diabled: %s'
250
% unicode(timer).rsplit(".", 1)[0])
251
elif self.properties[u"approved_pending"]:
252
if self.properties[u"approved_by_default"]:
253
message = u"Connection established to client. (d)eny?"
255
message = u"Seeks approval to send secret. (a)pprove?"
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)
258
self._text = "%s%s" % (base, message)
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
260
303
if not urwid.supports_unicode():
261
304
self._text = self._text.encode("ascii", "replace")
262
textlist = [(u"normal", self._text)]
305
textlist = [("normal", self._text)]
263
306
self._text_widget.set_text(textlist)
264
307
self._focus_text_widget.set_text([(with_standout[text[0]],
274
317
self.update_hook()
276
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
279
323
return True # Keep calling this
325
def delete(self, **kwargs):
282
326
if self._update_timer_callback_tag is not None:
283
327
gobject.source_remove(self._update_timer_callback_tag)
284
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
285
332
if self.delete_hook is not None:
286
333
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
288
def render(self, (maxcol,), focus=False):
336
def render(self, maxcolrow, focus=False):
289
337
"""Render differently if we have focus.
290
338
This overrides the method from urwid.FlowWidget"""
291
return self.current_widget(focus).render((maxcol,),
339
return self.current_widget(focus).render(maxcolrow,
294
def keypress(self, (maxcol,), key):
342
def keypress(self, maxcolrow, key):
296
344
This overrides the method from urwid.FlowWidget"""
298
self.proxy.Enable(dbus_interface = client_interface)
300
self.proxy.Disable(dbus_interface = client_interface)
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
302
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
303
dbus_interface = client_interface)
353
dbus_interface = client_interface,
305
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
306
dbus_interface = client_interface)
307
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":
308
360
self.server_proxy_object.RemoveClient(self.proxy
311
self.proxy.StartChecker(dbus_interface = client_interface)
313
self.proxy.StopChecker(dbus_interface = client_interface)
315
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,
317
# elif key == u"p" or key == "=":
373
# elif key == "p" or key == "=":
318
374
# self.proxy.pause()
319
# elif key == u"u" or key == ":":
375
# elif key == "u" or key == ":":
320
376
# self.proxy.unpause()
321
# elif key == u"RET":
324
# self.proxy.Approve(True)
326
# self.proxy.Approve(False)
330
def property_changed(self, property=None, value=None,
382
def property_changed(self, property=None, **kwargs):
332
383
"""Call self.update() if old value is not new value.
333
384
This overrides the method from MandosClientPropertyCache"""
334
385
property_name = unicode(property)
335
386
old_value = self.properties.get(property_name)
336
387
super(MandosClientWidget, self).property_changed(
337
property=property, value=value, *args, **kwargs)
388
property=property, **kwargs)
338
389
if self.properties.get(property_name) != old_value:
361
412
self.screen = urwid.curses_display.Screen()
363
414
self.screen.register_palette((
365
u"default", u"default", None),
367
u"default", u"default", u"bold"),
369
u"default", u"default", u"underline"),
371
u"default", u"default", u"standout"),
372
(u"bold-underline-blink",
373
u"default", u"default", (u"bold", u"underline")),
375
u"default", u"default", (u"bold", u"standout")),
376
(u"underline-blink-standout",
377
u"default", u"default", (u"underline", u"standout")),
378
(u"bold-underline-blink-standout",
379
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",
383
434
if urwid.supports_unicode():
384
self.divider = u"─" # \u2500
385
#self.divider = u"━" # \u2501
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
387
#self.divider = u"-" # \u002d
388
self.divider = u"_" # \u005f
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
390
441
self.screen.start()
405
456
# This keeps track of whether self.uilist currently has
406
457
# self.logbox in it or not
407
458
self.log_visible = True
408
self.log_wrap = u"any"
459
self.log_wrap = "any"
411
self.log_message_raw((u"bold",
412
u"Mandos Monitor version " + version))
413
self.log_message_raw((u"bold",
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
416
467
self.busname = domain + '.Mandos'
417
468
self.main_loop = gobject.MainLoop()
418
self.bus = dbus.SystemBus()
419
mandos_dbus_objc = self.bus.get_object(
420
self.busname, u"/", follow_name_owner_changes=True)
421
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
425
mandos_clients = (self.mandos_serv
426
.GetAllClientsWithProperties())
427
except dbus.exceptions.DBusException:
428
mandos_clients = dbus.Dictionary()
431
.connect_to_signal(u"ClientRemoved",
432
self.find_and_remove_client,
433
dbus_interface=server_interface,
436
.connect_to_signal(u"ClientAdded",
438
dbus_interface=server_interface,
441
.connect_to_signal(u"ClientNotFound",
442
self.client_not_found,
443
dbus_interface=server_interface,
445
for path, client in mandos_clients.iteritems():
446
client_proxy_object = self.bus.get_object(self.busname,
448
self.add_client(MandosClientWidget(server_proxy_object
451
=client_proxy_object,
461
470
def client_not_found(self, fingerprint, address):
462
self.log_message((u"Client with address %s and fingerprint %s"
463
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))
466
475
def rebuild(self):
467
476
"""This rebuilds the User Interface.
468
477
Call this when the widget layout needs to change"""
470
479
#self.uilist.append(urwid.ListBox(self.clients))
471
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
472
482
#header=urwid.Divider(),
474
footer=urwid.Divider(div_char=self.divider)))
485
urwid.Divider(div_char=
475
487
if self.log_visible:
476
488
self.uilist.append(self.logbox)
478
489
self.topwidget = urwid.Pile(self.uilist)
480
491
def log_message(self, message):
481
492
timestamp = datetime.datetime.now().isoformat()
482
self.log_message_raw(timestamp + u": " + message)
493
self.log_message_raw(timestamp + ": " + message)
484
495
def log_message_raw(self, markup):
485
496
"""Add a log message to the log buffer."""
488
499
and len(self.log) > self.max_log_length):
489
500
del self.log[0:len(self.log)-self.max_log_length-1]
490
501
self.logbox.set_focus(len(self.logbox.body.contents),
491
coming_from=u"above")
494
505
def toggle_log_display(self):
495
506
"""Toggle visibility of the log buffer."""
496
507
self.log_visible = not self.log_visible
498
self.log_message(u"Log visibility changed to: "
499
+ unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
501
512
def change_log_display(self):
502
513
"""Change type of log display.
503
514
Currently, this toggles wrapping of text lines."""
504
if self.log_wrap == u"clip":
505
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
507
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
508
519
for textwidget in self.log:
509
520
textwidget.set_wrap_mode(self.log_wrap)
510
self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
512
523
def find_and_remove_client(self, path, name):
513
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
515
526
This is connected to the ClientRemoved signal from the
516
527
Mandos server object."""
564
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,
566
622
self._input_callback_tag = (gobject.io_add_watch
567
623
(sys.stdin.fileno(),
593
649
except KeyError: # :-)
596
if key == u"q" or key == u"Q":
652
if key == "q" or key == "Q":
599
elif key == u"window resize":
655
elif key == "window resize":
600
656
self.size = self.screen.get_cols_rows()
602
elif key == u"\f": # Ctrl-L
658
elif key == "\f": # Ctrl-L
604
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
605
661
self.toggle_log_display()
607
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
608
664
self.change_log_display()
610
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
611
667
if not self.log_visible:
612
668
self.log_visible = True
614
self.log_message_raw((u"bold",
618
u"l: Log window toggle",
619
u"TAB: Switch window",
621
self.log_message_raw((u"bold",
627
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",
634
690
if self.topwidget.get_focus() is self.logbox:
635
691
self.topwidget.set_focus(0)
637
693
self.topwidget.set_focus(self.logbox)
639
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
#elif (key == "end" or key == "meta >" or key == "G"
641
697
# pass # xxx end-of-buffer
642
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
#elif (key == "home" or key == "meta <" or key == "g"
644
700
# pass # xxx beginning-of-buffer
645
#elif key == u"ctrl e" or key == u"$":
701
#elif key == "ctrl e" or key == "$":
646
702
# pass # xxx move-end-of-line
647
#elif key == u"ctrl a" or key == u"^":
703
#elif key == "ctrl a" or key == "^":
648
704
# pass # xxx move-beginning-of-line
649
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
650
706
# pass # xxx left
651
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
652
708
# pass # xxx right
654
710
# pass # scroll up log
656
712
# pass # scroll down log
657
713
elif self.topwidget.selectable():
658
714
self.topwidget.keypress(self.size, key)