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()
145
self.properties["interval"]))
146
if self.last_checker_failed:
176
147
self._update_timer_callback_tag = (gobject.timeout_add
178
149
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
151
def checker_completed(self, exitstatus, condition, command):
184
152
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
188
168
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)))
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)))
193
173
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)))
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)))
198
178
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
179
self.logger(u'Checker for client %s (command "%s")'
181
% (self.properties[u"name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
183
self.logger(u'Checker for client %s completed mysteriously')
208
186
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"],
187
#self.logger(u'Client %s started checker "%s"'
188
# % (self.properties[u"name"], unicode(command)))
216
191
def got_secret(self):
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
192
self.logger(u'Client %s received its secret'
193
% self.properties[u"name"])
220
195
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
197
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"],
199
message = u'Client %s will get its secret in %s seconds'
201
% (self.properties[u"name"], timeout/1000))
228
203
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
204
self.logger(u'Client %s was rejected; reason: %s'
205
% (self.properties[u"name"], reason))
232
207
def selectable(self):
233
208
"""Make this a "selectable" widget.
234
209
This overrides the method from urwid.FlowWidget."""
237
def rows(self, maxcolrow, focus=False):
212
def rows(self, (maxcol,), focus=False):
238
213
"""How many rows this widget will occupy might depend on
239
214
whether we have focus or not.
240
215
This overrides the method from urwid.FlowWidget"""
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
216
return self.current_widget(focus).rows((maxcol,), focus=focus)
243
218
def current_widget(self, focus=False):
244
219
if focus or self.opened:
248
223
def update(self):
249
224
"Called when what is visible on the screen should be updated."
250
225
# 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",
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",
259
234
# Rebuild focus and non-focus widgets using current properties
261
236
# 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"]:
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:
267
242
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)
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?"
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
258
self._text = "%s%s" % (base, message)
303
260
if not urwid.supports_unicode():
304
261
self._text = self._text.encode("ascii", "replace")
305
textlist = [("normal", self._text)]
262
textlist = [(u"normal", self._text)]
306
263
self._text_widget.set_text(textlist)
307
264
self._focus_text_widget.set_text([(with_standout[text[0]],
317
274
self.update_hook()
319
276
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
323
279
return True # Keep calling this
325
def delete(self, **kwargs):
326
282
if self._update_timer_callback_tag is not None:
327
283
gobject.source_remove(self._update_timer_callback_tag)
328
284
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
332
285
if self.delete_hook is not None:
333
286
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
336
def render(self, maxcolrow, focus=False):
288
def render(self, (maxcol,), focus=False):
337
289
"""Render differently if we have focus.
338
290
This overrides the method from urwid.FlowWidget"""
339
return self.current_widget(focus).render(maxcolrow,
291
return self.current_widget(focus).render((maxcol,),
342
def keypress(self, maxcolrow, key):
294
def keypress(self, (maxcol,), key):
344
296
This overrides the method from urwid.FlowWidget"""
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
298
self.proxy.Enable(dbus_interface = client_interface)
300
self.proxy.Disable(dbus_interface = client_interface)
352
302
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
303
dbus_interface = client_interface)
356
305
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
359
elif key == "R" or key == "_" or key == "ctrl k":
306
dbus_interface = client_interface)
307
elif key == u"r" or key == u"_" or key == u"ctrl k":
360
308
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,
311
self.proxy.StartChecker(dbus_interface = client_interface)
313
self.proxy.StopChecker(dbus_interface = client_interface)
315
self.proxy.CheckedOK(dbus_interface = client_interface)
373
# elif key == "p" or key == "=":
317
# elif key == u"p" or key == "=":
374
318
# self.proxy.pause()
375
# elif key == "u" or key == ":":
319
# elif key == u"u" or key == ":":
376
320
# self.proxy.unpause()
321
# elif key == u"RET":
324
# self.proxy.Approve(True)
326
# self.proxy.Approve(False)
382
def property_changed(self, property=None, **kwargs):
330
def property_changed(self, property=None, value=None,
383
332
"""Call self.update() if old value is not new value.
384
333
This overrides the method from MandosClientPropertyCache"""
385
334
property_name = unicode(property)
386
335
old_value = self.properties.get(property_name)
387
336
super(MandosClientWidget, self).property_changed(
388
property=property, **kwargs)
337
property=property, value=value, *args, **kwargs)
389
338
if self.properties.get(property_name) != old_value:
412
361
self.screen = urwid.curses_display.Screen()
414
363
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",
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",
434
383
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
384
self.divider = u"─" # \u2500
385
#self.divider = u"━" # \u2501
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
387
#self.divider = u"-" # \u002d
388
self.divider = u"_" # \u005f
441
390
self.screen.start()
456
405
# This keeps track of whether self.uilist currently has
457
406
# self.logbox in it or not
458
407
self.log_visible = True
459
self.log_wrap = "any"
408
self.log_wrap = u"any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
411
self.log_message_raw((u"bold",
412
u"Mandos Monitor version " + version))
413
self.log_message_raw((u"bold",
467
416
self.busname = domain + '.Mandos'
468
417
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,
470
461
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))
462
self.log_message((u"Client with address %s and fingerprint %s"
463
u" could not be found" % (address,
475
466
def rebuild(self):
476
467
"""This rebuilds the User Interface.
477
468
Call this when the widget layout needs to change"""
479
470
#self.uilist.append(urwid.ListBox(self.clients))
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
471
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
482
472
#header=urwid.Divider(),
485
urwid.Divider(div_char=
474
footer=urwid.Divider(div_char=self.divider)))
487
475
if self.log_visible:
488
476
self.uilist.append(self.logbox)
489
478
self.topwidget = urwid.Pile(self.uilist)
491
480
def log_message(self, message):
492
481
timestamp = datetime.datetime.now().isoformat()
493
self.log_message_raw(timestamp + ": " + message)
482
self.log_message_raw(timestamp + u": " + message)
495
484
def log_message_raw(self, markup):
496
485
"""Add a log message to the log buffer."""
499
488
and len(self.log) > self.max_log_length):
500
489
del self.log[0:len(self.log)-self.max_log_length-1]
501
490
self.logbox.set_focus(len(self.logbox.body.contents),
491
coming_from=u"above")
505
494
def toggle_log_display(self):
506
495
"""Toggle visibility of the log buffer."""
507
496
self.log_visible = not self.log_visible
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
498
self.log_message(u"Log visibility changed to: "
499
+ unicode(self.log_visible))
512
501
def change_log_display(self):
513
502
"""Change type of log display.
514
503
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
504
if self.log_wrap == u"clip":
505
self.log_wrap = u"any"
518
self.log_wrap = "clip"
507
self.log_wrap = u"clip"
519
508
for textwidget in self.log:
520
509
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
510
self.log_message(u"Wrap mode: " + self.log_wrap)
523
512
def find_and_remove_client(self, path, name):
524
"""Find a client by its object path and remove it.
513
"""Find an client from its object path and remove it.
526
515
This is connected to the ClientRemoved signal from the
527
516
Mandos server object."""
577
564
"""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
566
self._input_callback_tag = (gobject.io_add_watch
623
567
(sys.stdin.fileno(),
649
593
except KeyError: # :-)
652
if key == "q" or key == "Q":
596
if key == u"q" or key == u"Q":
655
elif key == "window resize":
599
elif key == u"window resize":
656
600
self.size = self.screen.get_cols_rows()
658
elif key == "\f": # Ctrl-L
602
elif key == u"\f": # Ctrl-L
660
elif key == "l" or key == "D":
604
elif key == u"l" or key == u"D":
661
605
self.toggle_log_display()
663
elif key == "w" or key == "i":
607
elif key == u"w" or key == u"i":
664
608
self.change_log_display()
666
elif key == "?" or key == "f1" or key == "esc":
610
elif key == u"?" or key == u"f1" or key == u"esc":
667
611
if not self.log_visible:
668
612
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",
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",
690
634
if self.topwidget.get_focus() is self.logbox:
691
635
self.topwidget.set_focus(0)
693
637
self.topwidget.set_focus(self.logbox)
695
#elif (key == "end" or key == "meta >" or key == "G"
639
#elif (key == u"end" or key == u"meta >" or key == u"G"
697
641
# pass # xxx end-of-buffer
698
#elif (key == "home" or key == "meta <" or key == "g"
642
#elif (key == u"home" or key == u"meta <" or key == u"g"
700
644
# pass # xxx beginning-of-buffer
701
#elif key == "ctrl e" or key == "$":
645
#elif key == u"ctrl e" or key == u"$":
702
646
# pass # xxx move-end-of-line
703
#elif key == "ctrl a" or key == "^":
647
#elif key == u"ctrl a" or key == u"^":
704
648
# pass # xxx move-beginning-of-line
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
649
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
706
650
# pass # xxx left
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
651
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
708
652
# pass # xxx right
710
654
# pass # scroll up log
712
656
# pass # scroll down log
713
657
elif self.topwidget.selectable():
714
658
self.topwidget.keypress(self.size, key)