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
137
self._update_timer_callback_lock = 0
102
139
# The widget shown normally
103
self._text_widget = urwid.Text(u"")
140
self._text_widget = urwid.Text("")
104
141
# 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,
142
self._focus_text_widget = urwid.Text("")
143
super(MandosClientWidget, self).__init__(**kwargs)
110
145
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
147
last_checked_ok = isoformat_to_datetime(self.properties
129
if last_checked_ok is None:
130
self.last_checker_failed = True
150
if self.properties ["LastCheckerStatus"] != 0:
151
self.using_timer(True)
153
if self.need_approval:
154
self.using_timer(True)
156
self.match_objects = (
157
self.proxy.connect_to_signal("CheckerCompleted",
158
self.checker_completed,
161
self.proxy.connect_to_signal("CheckerStarted",
162
self.checker_started,
165
self.proxy.connect_to_signal("GotSecret",
169
self.proxy.connect_to_signal("NeedApproval",
173
self.proxy.connect_to_signal("Rejected",
177
#self.logger('Created client {0}'
178
# .format(self.properties["Name"]))
180
def property_changed(self, property=None, value=None):
181
super(self, MandosClientWidget).property_changed(property,
183
if property == "ApprovalPending":
184
using_timer(bool(value))
185
if property == "LastCheckerStatus":
186
using_timer(value != 0)
187
#self.logger('Checker for client {0} (command "{1}") was '
188
# ' successful'.format(self.properties["Name"],
191
def using_timer(self, flag):
192
"""Call this method with True or False when timer should be
193
activated or deactivated.
195
old = self._update_timer_callback_lock
197
self._update_timer_callback_lock += 1
132
self.last_checker_failed = ((datetime.datetime.utcnow()
136
self.properties["interval"]))
137
if self.last_checker_failed:
199
self._update_timer_callback_lock -= 1
200
if old == 0 and self._update_timer_callback_lock:
201
# Will update the shown timer value every second
138
202
self._update_timer_callback_tag = (gobject.timeout_add
140
204
self.update_timer))
205
elif old and self._update_timer_callback_lock == 0:
206
gobject.source_remove(self._update_timer_callback_tag)
207
self._update_timer_callback_tag = None
142
209
def checker_completed(self, exitstatus, condition, command):
143
210
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
214
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)))
215
self.logger('Checker for client {0} (command "{1}")'
216
' failed with exit code {2}'
217
.format(self.properties["Name"], command,
218
os.WEXITSTATUS(condition)))
164
219
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)))
220
self.logger('Checker for client {0} (command "{1}") was'
221
' killed by signal {2}'
222
.format(self.properties["Name"], command,
223
os.WTERMSIG(condition)))
169
224
elif os.WCOREDUMP(condition):
170
self.logger(u'Checker for client %s (command "%s")'
172
% (self.properties[u"name"], command))
225
self.logger('Checker for client {0} (command "{1}")'
227
.format(self.properties["Name"], command))
174
self.logger(u'Checker for client %s completed mysteriously')
229
self.logger('Checker for client {0} completed'
231
.format(self.properties["Name"]))
177
234
def checker_started(self, command):
178
self.logger(u'Client %s started checker "%s"'
179
% (self.properties[u"name"], unicode(command)))
235
"""Server signals that a checker started. This could be useful
236
to log in the future. """
237
#self.logger('Client {0} started checker "{1}"'
238
# .format(self.properties["Name"],
181
242
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"])
243
self.logger('Client {0} received its secret'
244
.format(self.properties["Name"]))
246
def need_approval(self, timeout, default):
248
message = 'Client {0} needs approval within {1} seconds'
250
message = 'Client {0} will get its secret in {1} seconds'
251
self.logger(message.format(self.properties["Name"],
253
self.using_timer(True)
255
def rejected(self, reason):
256
self.logger('Client {0} was rejected; reason: {1}'
257
.format(self.properties["Name"], reason))
189
259
def selectable(self):
190
260
"""Make this a "selectable" widget.
191
261
This overrides the method from urwid.FlowWidget."""
194
def rows(self, (maxcol,), focus=False):
264
def rows(self, maxcolrow, focus=False):
195
265
"""How many rows this widget will occupy might depend on
196
266
whether we have focus or not.
197
267
This overrides the method from urwid.FlowWidget"""
198
return self.current_widget(focus).rows((maxcol,), focus=focus)
268
return self.current_widget(focus).rows(maxcolrow, focus=focus)
200
270
def current_widget(self, focus=False):
201
271
if focus or self.opened:
205
275
def update(self):
206
276
"Called when what is visible on the screen should be updated."
207
277
# 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",
278
with_standout = { "normal": "standout",
279
"bold": "bold-standout",
281
"underline-blink-standout",
282
"bold-underline-blink":
283
"bold-underline-blink-standout",
216
286
# 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
288
# Base part of a client. Name!
289
base = '{name}: '.format(name=self.properties["Name"])
290
if not self.properties["Enabled"]:
292
elif self.properties["ApprovalPending"]:
293
timeout = datetime.timedelta(milliseconds
296
last_approval_request = isoformat_to_datetime(
297
self.properties["LastApprovalRequest"])
298
if last_approval_request is not None:
299
timer = timeout - (datetime.datetime.utcnow()
300
- last_approval_request)
302
timer = datetime.timedelta()
303
if self.properties["ApprovedByDefault"]:
304
message = "Approval in {0}. (d)eny?"
306
message = "Denial in {0}. (a)pprove?"
307
message = message.format(unicode(timer).rsplit(".", 1)[0])
308
elif self.properties["LastCheckerStatus"] != 0:
309
# When checker has failed, show timer until client expires
310
expires = self.properties["Expires"]
312
timer = datetime.timedelta(0)
314
expires = (datetime.datetime.strptime
315
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
316
timer = expires - datetime.datetime.utcnow()
317
message = ('A checker has failed! Time until client'
318
' gets disabled: {0}'
319
.format(unicode(timer).rsplit(".", 1)[0]))
322
self._text = "{0}{1}".format(base, message)
240
324
if not urwid.supports_unicode():
241
325
self._text = self._text.encode("ascii", "replace")
242
textlist = [(u"normal", self._text)]
326
textlist = [("normal", self._text)]
243
327
self._text_widget.set_text(textlist)
244
328
self._focus_text_widget.set_text([(with_standout[text[0]],
254
338
self.update_hook()
256
340
def update_timer(self):
341
"""called by gobject. Will indefinitely loop until
342
gobject.source_remove() on tag is called"""
259
344
return True # Keep calling this
346
def delete(self, **kwargs):
262
347
if self._update_timer_callback_tag is not None:
263
348
gobject.source_remove(self._update_timer_callback_tag)
264
349
self._update_timer_callback_tag = None
350
for match in self.match_objects:
352
self.match_objects = ()
265
353
if self.delete_hook is not None:
266
354
self.delete_hook(self)
355
return super(MandosClientWidget, self).delete(**kwargs)
268
def render(self, (maxcol,), focus=False):
357
def render(self, maxcolrow, focus=False):
269
358
"""Render differently if we have focus.
270
359
This overrides the method from urwid.FlowWidget"""
271
return self.current_widget(focus).render((maxcol,),
360
return self.current_widget(focus).render(maxcolrow,
274
def keypress(self, (maxcol,), key):
363
def keypress(self, maxcolrow, key):
276
365
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":
367
self.proxy.Enable(dbus_interface = client_interface,
370
self.proxy.Disable(dbus_interface = client_interface,
373
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
374
dbus_interface = client_interface,
377
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
378
dbus_interface = client_interface,
380
elif key == "R" or key == "_" or key == "ctrl k":
282
381
self.server_proxy_object.RemoveClient(self.proxy
285
self.proxy.StartChecker()
287
self.proxy.StopChecker()
289
self.proxy.CheckedOK()
385
self.proxy.StartChecker(dbus_interface = client_interface,
388
self.proxy.StopChecker(dbus_interface = client_interface,
391
self.proxy.CheckedOK(dbus_interface = client_interface,
291
# elif key == u"p" or key == "=":
394
# elif key == "p" or key == "=":
292
395
# self.proxy.pause()
293
# elif key == u"u" or key == ":":
396
# elif key == "u" or key == ":":
294
397
# self.proxy.unpause()
295
# elif key == u"RET":
300
def property_changed(self, property=None, value=None,
403
def property_changed(self, property=None, **kwargs):
302
404
"""Call self.update() if old value is not new value.
303
405
This overrides the method from MandosClientPropertyCache"""
304
406
property_name = unicode(property)
305
407
old_value = self.properties.get(property_name)
306
408
super(MandosClientWidget, self).property_changed(
307
property=property, value=value, *args, **kwargs)
409
property=property, **kwargs)
308
410
if self.properties.get(property_name) != old_value:
331
433
self.screen = urwid.curses_display.Screen()
333
435
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",
437
"default", "default", None),
439
"default", "default", "bold"),
441
"default", "default", "underline"),
443
"default", "default", "standout"),
444
("bold-underline-blink",
445
"default", "default", ("bold", "underline")),
447
"default", "default", ("bold", "standout")),
448
("underline-blink-standout",
449
"default", "default", ("underline", "standout")),
450
("bold-underline-blink-standout",
451
"default", "default", ("bold", "underline",
353
455
if urwid.supports_unicode():
354
self.divider = u"─" # \u2500
355
#self.divider = u"━" # \u2501
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
357
#self.divider = u"-" # \u002d
358
self.divider = u"_" # \u005f
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
360
462
self.screen.start()
375
477
# This keeps track of whether self.uilist currently has
376
478
# self.logbox in it or not
377
479
self.log_visible = True
378
self.log_wrap = u"any"
480
self.log_wrap = "any"
381
self.log_message_raw((u"bold",
382
u"Mandos Monitor version " + version))
383
self.log_message_raw((u"bold",
483
self.log_message_raw(("bold",
484
"Mandos Monitor version " + version))
485
self.log_message_raw(("bold",
386
488
self.busname = domain + '.Mandos'
387
489
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
491
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,
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
494
.format(address, fingerprint))
436
496
def rebuild(self):
437
497
"""This rebuilds the User Interface.
438
498
Call this when the widget layout needs to change"""
440
500
#self.uilist.append(urwid.ListBox(self.clients))
441
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
442
503
#header=urwid.Divider(),
444
footer=urwid.Divider(div_char=self.divider)))
506
urwid.Divider(div_char=
445
508
if self.log_visible:
446
509
self.uilist.append(self.logbox)
448
510
self.topwidget = urwid.Pile(self.uilist)
450
512
def log_message(self, message):
451
513
timestamp = datetime.datetime.now().isoformat()
452
self.log_message_raw(timestamp + u": " + message)
514
self.log_message_raw(timestamp + ": " + message)
454
516
def log_message_raw(self, markup):
455
517
"""Add a log message to the log buffer."""
458
520
and len(self.log) > self.max_log_length):
459
521
del self.log[0:len(self.log)-self.max_log_length-1]
460
522
self.logbox.set_focus(len(self.logbox.body.contents),
461
coming_from=u"above")
464
526
def toggle_log_display(self):
465
527
"""Toggle visibility of the log buffer."""
466
528
self.log_visible = not self.log_visible
468
self.log_message(u"Log visibility changed to: "
469
+ unicode(self.log_visible))
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
471
533
def change_log_display(self):
472
534
"""Change type of log display.
473
535
Currently, this toggles wrapping of text lines."""
474
if self.log_wrap == u"clip":
475
self.log_wrap = u"any"
536
if self.log_wrap == "clip":
537
self.log_wrap = "any"
477
self.log_wrap = u"clip"
539
self.log_wrap = "clip"
478
540
for textwidget in self.log:
479
541
textwidget.set_wrap_mode(self.log_wrap)
480
self.log_message(u"Wrap mode: " + self.log_wrap)
542
#self.log_message("Wrap mode: " + self.log_wrap)
482
544
def find_and_remove_client(self, path, name):
483
"""Find an client from its object path and remove it.
545
"""Find a client by its object path and remove it.
485
547
This is connected to the ClientRemoved signal from the
486
548
Mandos server object."""
534
598
"""Start the main loop and exit when it's done."""
599
self.bus = dbus.SystemBus()
600
mandos_dbus_objc = self.bus.get_object(
601
self.busname, "/", follow_name_owner_changes=True)
602
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
606
mandos_clients = (self.mandos_serv
607
.GetAllClientsWithProperties())
608
except dbus.exceptions.DBusException:
609
mandos_clients = dbus.Dictionary()
612
.connect_to_signal("ClientRemoved",
613
self.find_and_remove_client,
614
dbus_interface=server_interface,
617
.connect_to_signal("ClientAdded",
619
dbus_interface=server_interface,
622
.connect_to_signal("ClientNotFound",
623
self.client_not_found,
624
dbus_interface=server_interface,
626
for path, client in mandos_clients.iteritems():
627
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
536
643
self._input_callback_tag = (gobject.io_add_watch
537
644
(sys.stdin.fileno(),
563
670
except KeyError: # :-)
566
if key == u"q" or key == u"Q":
673
if key == "q" or key == "Q":
569
elif key == u"window resize":
676
elif key == "window resize":
570
677
self.size = self.screen.get_cols_rows()
572
elif key == u"\f": # Ctrl-L
679
elif key == "\f": # Ctrl-L
574
elif key == u"l" or key == u"D":
681
elif key == "l" or key == "D":
575
682
self.toggle_log_display()
577
elif key == u"w" or key == u"i":
684
elif key == "w" or key == "i":
578
685
self.change_log_display()
580
elif key == u"?" or key == u"f1" or key == u"esc":
687
elif key == "?" or key == "f1" or key == "esc":
581
688
if not self.log_visible:
582
689
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",
691
self.log_message_raw(("bold",
695
"l: Log window toggle",
696
"TAB: Switch window",
698
self.log_message_raw(("bold",
704
"s: Start new checker",
602
711
if self.topwidget.get_focus() is self.logbox:
603
712
self.topwidget.set_focus(0)
605
714
self.topwidget.set_focus(self.logbox)
607
#elif (key == u"end" or key == u"meta >" or key == u"G"
716
#elif (key == "end" or key == "meta >" or key == "G"
609
718
# pass # xxx end-of-buffer
610
#elif (key == u"home" or key == u"meta <" or key == u"g"
719
#elif (key == "home" or key == "meta <" or key == "g"
612
721
# pass # xxx beginning-of-buffer
613
#elif key == u"ctrl e" or key == u"$":
722
#elif key == "ctrl e" or key == "$":
614
723
# pass # xxx move-end-of-line
615
#elif key == u"ctrl a" or key == u"^":
724
#elif key == "ctrl a" or key == "^":
616
725
# pass # xxx move-beginning-of-line
617
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
726
#elif key == "ctrl b" or key == "meta (" or key == "h":
618
727
# pass # xxx left
619
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
728
#elif key == "ctrl f" or key == "meta )" or key == "l":
620
729
# pass # xxx right
622
731
# pass # scroll up log
624
733
# pass # scroll down log
625
734
elif self.topwidget.selectable():
626
735
self.topwidget.keypress(self.size, key)