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>.
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
4
from __future__ import division, absolute_import, with_statement
86
61
properties and calls a hook function when any of them are
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
64
def __init__(self, proxy_object=None, *args, **kwargs):
90
65
self.proxy = proxy_object # Mandos Client proxy object
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)
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__(
110
81
def property_changed(self, property=None, value=None):
111
82
"""This is called whenever we get a PropertyChanged signal
134
102
self.logger = logger
136
104
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
138
107
# The widget shown normally
139
self._text_widget = urwid.Text("")
108
self._text_widget = urwid.Text(u"")
140
109
# The widget shown when we have focus
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
110
self._focus_text_widget = urwid.Text(u"")
111
super(MandosClientWidget, self).__init__(
112
update_hook=update_hook, delete_hook=delete_hook,
144
115
self.opened = False
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
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()
147
if self.last_checker_failed:
176
148
self._update_timer_callback_tag = (gobject.timeout_add
178
150
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
183
152
def checker_completed(self, exitstatus, condition, command):
184
153
if exitstatus == 0:
154
if self.last_checker_failed:
155
self.last_checker_failed = False
156
gobject.source_remove(self._update_timer_callback_tag)
157
self._update_timer_callback_tag = None
158
#self.logger(u'Checker for client %s (command "%s")'
160
# % (self.properties[u"Name"], command))
164
if not self.last_checker_failed:
165
self.last_checker_failed = True
166
self._update_timer_callback_tag = (gobject.timeout_add
188
169
if os.WIFEXITED(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)))
170
self.logger(u'Checker for client %s (command "%s")'
171
u' failed with exit code %s'
172
% (self.properties[u"Name"], command,
173
os.WEXITSTATUS(condition)))
193
174
elif os.WIFSIGNALED(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)))
175
self.logger(u'Checker for client %s (command "%s")'
176
u' was killed by signal %s'
177
% (self.properties[u"Name"], command,
178
os.WTERMSIG(condition)))
198
179
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
180
self.logger(u'Checker for client %s (command "%s")'
182
% (self.properties[u"Name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
184
self.logger(u'Checker for client %s completed'
208
188
def checker_started(self, 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"],
189
#self.logger(u'Client %s started checker "%s"'
190
# % (self.properties[u"Name"], unicode(command)))
216
193
def got_secret(self):
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
194
self.last_checker_failed = False
195
self.logger(u'Client %s received its secret'
196
% self.properties[u"Name"])
220
198
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
200
message = u'Client %s needs approval within %s seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
202
message = u'Client %s will get its secret in %s seconds'
204
% (self.properties[u"Name"], timeout/1000))
228
206
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
207
self.logger(u'Client %s was rejected; reason: %s'
208
% (self.properties[u"Name"], reason))
232
210
def selectable(self):
233
211
"""Make this a "selectable" widget.
234
212
This overrides the method from urwid.FlowWidget."""
237
def rows(self, maxcolrow, focus=False):
215
def rows(self, (maxcol,), focus=False):
238
216
"""How many rows this widget will occupy might depend on
239
217
whether we have focus or not.
240
218
This overrides the method from urwid.FlowWidget"""
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
219
return self.current_widget(focus).rows((maxcol,), focus=focus)
243
221
def current_widget(self, focus=False):
244
222
if focus or self.opened:
248
226
def update(self):
249
227
"Called when what is visible on the screen should be updated."
250
228
# How to add standout mode to a style
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"bold-underline-blink-standout",
229
with_standout = { u"normal": u"standout",
230
u"bold": u"bold-standout",
232
u"underline-blink-standout",
233
u"bold-underline-blink":
234
u"bold-underline-blink-standout",
259
237
# Rebuild focus and non-focus widgets using current properties
261
239
# 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"]:
240
base = (u'%(name)s: '
241
% {u"name": self.properties[u"Name"]})
242
if not self.properties[u"Enabled"]:
243
message = u"DISABLED"
244
elif self.properties[u"ApprovalPending"]:
245
if self.properties[u"ApprovedByDefault"]:
246
message = u"Connection established to client. (d)eny?"
248
message = u"Seeks approval to send secret. (a)pprove?"
249
elif self.last_checker_failed:
267
250
timeout = datetime.timedelta(milliseconds
268
251
= self.properties
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)
253
last_ok = isoformat_to_datetime(
254
max((self.properties[u"LastCheckedOK"]
255
or self.properties[u"Created"]),
256
self.properties[u"LastEnabled"]))
257
timer = timeout - (datetime.datetime.utcnow() - last_ok)
258
message = (u'A checker has failed! Time until client'
260
% unicode(timer).rsplit(".", 1)[0])
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
263
self._text = "%s%s" % (base, message)
303
265
if not urwid.supports_unicode():
304
266
self._text = self._text.encode("ascii", "replace")
305
textlist = [("normal", self._text)]
267
textlist = [(u"normal", self._text)]
306
268
self._text_widget.set_text(textlist)
307
269
self._focus_text_widget.set_text([(with_standout[text[0]],
317
279
self.update_hook()
319
281
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
323
284
return True # Keep calling this
325
def delete(self, **kwargs):
326
287
if self._update_timer_callback_tag is not None:
327
288
gobject.source_remove(self._update_timer_callback_tag)
328
289
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
332
290
if self.delete_hook is not None:
333
291
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
336
def render(self, maxcolrow, focus=False):
293
def render(self, (maxcol,), focus=False):
337
294
"""Render differently if we have focus.
338
295
This overrides the method from urwid.FlowWidget"""
339
return self.current_widget(focus).render(maxcolrow,
296
return self.current_widget(focus).render((maxcol,),
342
def keypress(self, maxcolrow, key):
299
def keypress(self, (maxcol,), key):
344
301
This overrides the method from urwid.FlowWidget"""
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
303
self.proxy.Enable(dbus_interface = client_interface)
305
self.proxy.Disable(dbus_interface = client_interface)
352
307
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
308
dbus_interface = client_interface)
356
310
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
359
elif key == "R" or key == "_" or key == "ctrl k":
311
dbus_interface = client_interface)
312
elif key == u"r" or key == u"_" or key == u"ctrl k":
360
313
self.server_proxy_object.RemoveClient(self.proxy
364
self.proxy.StartChecker(dbus_interface = client_interface,
367
self.proxy.StopChecker(dbus_interface = client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
316
self.proxy.StartChecker(dbus_interface = client_interface)
318
self.proxy.StopChecker(dbus_interface = client_interface)
320
self.proxy.CheckedOK(dbus_interface = client_interface)
373
# elif key == "p" or key == "=":
322
# elif key == u"p" or key == "=":
374
323
# self.proxy.pause()
375
# elif key == "u" or key == ":":
324
# elif key == u"u" or key == ":":
376
325
# self.proxy.unpause()
326
# elif key == u"RET":
329
# self.proxy.Approve(True)
331
# self.proxy.Approve(False)
382
def property_changed(self, property=None, **kwargs):
335
def property_changed(self, property=None, value=None,
383
337
"""Call self.update() if old value is not new value.
384
338
This overrides the method from MandosClientPropertyCache"""
385
339
property_name = unicode(property)
386
340
old_value = self.properties.get(property_name)
387
341
super(MandosClientWidget, self).property_changed(
388
property=property, **kwargs)
342
property=property, value=value, *args, **kwargs)
389
343
if self.properties.get(property_name) != old_value:
412
367
self.screen = urwid.curses_display.Screen()
414
369
self.screen.register_palette((
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",
371
u"default", u"default", None),
373
u"default", u"default", u"bold"),
375
u"default", u"default", u"underline"),
377
u"default", u"default", u"standout"),
378
(u"bold-underline-blink",
379
u"default", u"default", (u"bold", u"underline")),
381
u"default", u"default", (u"bold", u"standout")),
382
(u"underline-blink-standout",
383
u"default", u"default", (u"underline", u"standout")),
384
(u"bold-underline-blink-standout",
385
u"default", u"default", (u"bold", u"underline",
434
389
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
390
self.divider = u"─" # \u2500
391
#self.divider = u"━" # \u2501
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
393
#self.divider = u"-" # \u002d
394
self.divider = u"_" # \u005f
441
396
self.screen.start()
456
411
# This keeps track of whether self.uilist currently has
457
412
# self.logbox in it or not
458
413
self.log_visible = True
459
self.log_wrap = "any"
414
self.log_wrap = u"any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
417
self.log_message_raw((u"bold",
418
u"Mandos Monitor version " + version))
419
self.log_message_raw((u"bold",
467
422
self.busname = domain + '.Mandos'
468
423
self.main_loop = gobject.MainLoop()
424
self.bus = dbus.SystemBus()
425
mandos_dbus_objc = self.bus.get_object(
426
self.busname, u"/", follow_name_owner_changes=True)
427
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
431
mandos_clients = (self.mandos_serv
432
.GetAllClientsWithProperties())
433
except dbus.exceptions.DBusException:
434
mandos_clients = dbus.Dictionary()
437
.connect_to_signal(u"ClientRemoved",
438
self.find_and_remove_client,
439
dbus_interface=server_interface,
442
.connect_to_signal(u"ClientAdded",
444
dbus_interface=server_interface,
447
.connect_to_signal(u"ClientNotFound",
448
self.client_not_found,
449
dbus_interface=server_interface,
451
for path, client in mandos_clients.iteritems():
452
client_proxy_object = self.bus.get_object(self.busname,
454
self.add_client(MandosClientWidget(server_proxy_object
457
=client_proxy_object,
470
467
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} could not be found"
473
.format(address, fingerprint))
468
self.log_message((u"Client with address %s and fingerprint %s"
469
u" could not be found" % (address,
475
472
def rebuild(self):
476
473
"""This rebuilds the User Interface.
499
497
and len(self.log) > self.max_log_length):
500
498
del self.log[0:len(self.log)-self.max_log_length-1]
501
499
self.logbox.set_focus(len(self.logbox.body.contents),
500
coming_from=u"above")
505
503
def toggle_log_display(self):
506
504
"""Toggle visibility of the log buffer."""
507
505
self.log_visible = not self.log_visible
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
507
self.log_message(u"Log visibility changed to: "
508
+ unicode(self.log_visible))
512
510
def change_log_display(self):
513
511
"""Change type of log display.
514
512
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
513
if self.log_wrap == u"clip":
514
self.log_wrap = u"any"
518
self.log_wrap = "clip"
516
self.log_wrap = u"clip"
519
517
for textwidget in self.log:
520
518
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
519
self.log_message(u"Wrap mode: " + self.log_wrap)
523
521
def find_and_remove_client(self, path, name):
524
"""Find a client by its object path and remove it.
522
"""Find an client from its object path and remove it.
526
524
This is connected to the ClientRemoved signal from the
527
525
Mandos server object."""
577
573
"""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,
622
575
self._input_callback_tag = (gobject.io_add_watch
623
576
(sys.stdin.fileno(),
649
602
except KeyError: # :-)
652
if key == "q" or key == "Q":
605
if key == u"q" or key == u"Q":
655
elif key == "window resize":
608
elif key == u"window resize":
656
609
self.size = self.screen.get_cols_rows()
658
elif key == "\f": # Ctrl-L
611
elif key == u"\f": # Ctrl-L
660
elif key == "l" or key == "D":
613
elif key == u"l" or key == u"D":
661
614
self.toggle_log_display()
663
elif key == "w" or key == "i":
616
elif key == u"w" or key == u"i":
664
617
self.change_log_display()
666
elif key == "?" or key == "f1" or key == "esc":
619
elif key == u"?" or key == u"f1" or key == u"esc":
667
620
if not self.log_visible:
668
621
self.log_visible = True
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",
623
self.log_message_raw((u"bold",
627
u"l: Log window toggle",
628
u"TAB: Switch window",
630
self.log_message_raw((u"bold",
636
u"s: Start new checker",
690
643
if self.topwidget.get_focus() is self.logbox:
691
644
self.topwidget.set_focus(0)
693
646
self.topwidget.set_focus(self.logbox)
695
#elif (key == "end" or key == "meta >" or key == "G"
648
#elif (key == u"end" or key == u"meta >" or key == u"G"
697
650
# pass # xxx end-of-buffer
698
#elif (key == "home" or key == "meta <" or key == "g"
651
#elif (key == u"home" or key == u"meta <" or key == u"g"
700
653
# pass # xxx beginning-of-buffer
701
#elif key == "ctrl e" or key == "$":
654
#elif key == u"ctrl e" or key == u"$":
702
655
# pass # xxx move-end-of-line
703
#elif key == "ctrl a" or key == "^":
656
#elif key == u"ctrl a" or key == u"^":
704
657
# pass # xxx move-beginning-of-line
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
658
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
706
659
# pass # xxx left
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
660
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
708
661
# pass # xxx right
710
663
# pass # scroll up log
712
665
# pass # scroll down log
713
666
elif self.topwidget.selectable():
714
667
self.topwidget.keypress(self.size, key)