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 *
33
65
urwid.curses_display.curses.A_UNDERLINE |= (
34
66
urwid.curses_display.curses.A_BLINK)
68
def isoformat_to_datetime(iso):
69
"Parse an ISO 8601 date string to a datetime.datetime()"
72
d, t = iso.split("T", 1)
73
year, month, day = d.split("-", 2)
74
hour, minute, second = t.split(":", 2)
75
second, fraction = divmod(float(second), 1)
76
return datetime.datetime(int(year),
81
int(second), # Whole seconds
82
int(fraction*1000000)) # Microseconds
36
84
class MandosClientPropertyCache(object):
37
85
"""This wraps a Mandos Client D-Bus proxy object, caches the
38
86
properties and calls a hook function when any of them are
41
def __init__(self, proxy_object=None, properties=None, *args,
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
43
90
self.proxy = proxy_object # Mandos Client proxy object
45
if properties is None:
46
self.properties = dict()
48
self.properties = properties
49
self.proxy.connect_to_signal(u"PropertyChanged",
50
self.property_changed,
54
if properties is None:
55
self.properties.update(self.proxy.GetAll(client_interface,
57
dbus.PROPERTIES_IFACE))
58
super(MandosClientPropertyCache, self).__init__(
59
proxy_object=proxy_object,
60
properties=properties, *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)
62
110
def property_changed(self, property=None, value=None):
63
111
"""This is called whenever we get a PropertyChanged signal
83
134
self.logger = logger
136
self._update_timer_callback_tag = None
85
138
# The widget shown normally
86
self._text_widget = urwid.Text(u"")
139
self._text_widget = urwid.Text("")
87
140
# The widget shown when we have focus
88
self._focus_text_widget = urwid.Text(u"")
89
super(MandosClientWidget, self).__init__(
90
update_hook=update_hook, delete_hook=delete_hook,
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
93
144
self.opened = False
94
self.proxy.connect_to_signal(u"CheckerCompleted",
95
self.checker_completed,
98
self.proxy.connect_to_signal(u"CheckerStarted",
102
self.proxy.connect_to_signal(u"GotSecret",
106
self.proxy.connect_to_signal(u"Rejected",
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
176
self._update_timer_callback_tag = (gobject.timeout_add
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
111
183
def checker_completed(self, exitstatus, condition, command):
112
184
if exitstatus == 0:
113
self.logger(u'Checker for client %s (command "%s")'
115
% (self.properties[u"name"], command))
117
188
if os.WIFEXITED(condition):
118
self.logger(u'Checker for client %s (command "%s")'
119
u' failed with exit code %s'
120
% (self.properties[u"name"], command,
121
os.WEXITSTATUS(condition)))
123
if os.WIFSIGNALED(condition):
124
self.logger(u'Checker for client %s (command "%s")'
125
u' was killed by signal %s'
126
% (self.properties[u"name"], command,
127
os.WTERMSIG(condition)))
129
if os.WCOREDUMP(condition):
130
self.logger(u'Checker for client %s (command "%s")'
132
% (self.properties[u"name"], command))
133
self.logger(u'Checker for client %s completed mysteriously')
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)))
193
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)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
135
208
def checker_started(self, command):
136
self.logger(u'Client %s started checker "%s"'
137
% (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"],
139
216
def got_secret(self):
140
self.logger(u'Client %s received its secret'
141
% self.properties[u"name"])
144
self.logger(u'Client %s was rejected'
145
% self.properties[u"name"])
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
220
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
228
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
147
232
def selectable(self):
148
233
"""Make this a "selectable" widget.
149
234
This overrides the method from urwid.FlowWidget."""
152
def rows(self, (maxcol,), focus=False):
237
def rows(self, maxcolrow, focus=False):
153
238
"""How many rows this widget will occupy might depend on
154
239
whether we have focus or not.
155
240
This overrides the method from urwid.FlowWidget"""
156
return self.current_widget(focus).rows((maxcol,), focus=focus)
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
158
243
def current_widget(self, focus=False):
159
244
if focus or self.opened:
163
248
def update(self):
164
249
"Called when what is visible on the screen should be updated."
165
250
# How to add standout mode to a style
166
with_standout = { u"normal": u"standout",
167
u"bold": u"bold-standout",
169
u"underline-blink-standout",
170
u"bold-underline-blink":
171
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",
174
259
# Rebuild focus and non-focus widgets using current properties
175
self._text = (u'%(name)s: %(enabled)s'
176
% { u"name": self.properties[u"name"],
179
if self.properties[u"enabled"]
261
# 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"]:
267
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)
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
181
303
if not urwid.supports_unicode():
182
304
self._text = self._text.encode("ascii", "replace")
183
textlist = [(u"normal", self._text)]
305
textlist = [("normal", self._text)]
184
306
self._text_widget.set_text(textlist)
185
307
self._focus_text_widget.set_text([(with_standout[text[0]],
194
316
if self.update_hook is not None:
195
317
self.update_hook()
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
323
return True # Keep calling this
325
def delete(self, **kwargs):
326
if self._update_timer_callback_tag is not None:
327
gobject.source_remove(self._update_timer_callback_tag)
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
198
332
if self.delete_hook is not None:
199
333
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
201
def render(self, (maxcol,), focus=False):
336
def render(self, maxcolrow, focus=False):
202
337
"""Render differently if we have focus.
203
338
This overrides the method from urwid.FlowWidget"""
204
return self.current_widget(focus).render((maxcol,),
339
return self.current_widget(focus).render(maxcolrow,
207
def keypress(self, (maxcol,), key):
342
def keypress(self, maxcolrow, key):
209
344
This overrides the method from urwid.FlowWidget"""
210
if key == u"e" or key == u"+":
212
elif key == u"d" or key == u"-":
214
elif key == u"r" or key == u"_" or key == u"ctrl k":
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
359
elif key == "R" or key == "_" or key == "ctrl k":
215
360
self.server_proxy_object.RemoveClient(self.proxy
218
self.proxy.StartChecker()
220
self.proxy.StopChecker()
222
self.proxy.CheckedOK()
364
self.proxy.StartChecker(dbus_interface = client_interface,
367
self.proxy.StopChecker(dbus_interface = client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
224
# elif key == u"p" or key == "=":
373
# elif key == "p" or key == "=":
225
374
# self.proxy.pause()
226
# elif key == u"u" or key == ":":
375
# elif key == "u" or key == ":":
227
376
# self.proxy.unpause()
228
# elif key == u"RET":
233
def property_changed(self, property=None, value=None,
382
def property_changed(self, property=None, **kwargs):
235
383
"""Call self.update() if old value is not new value.
236
384
This overrides the method from MandosClientPropertyCache"""
237
385
property_name = unicode(property)
238
386
old_value = self.properties.get(property_name)
239
387
super(MandosClientWidget, self).property_changed(
240
property=property, value=value, *args, **kwargs)
388
property=property, **kwargs)
241
389
if self.properties.get(property_name) != old_value:
264
412
self.screen = urwid.curses_display.Screen()
266
414
self.screen.register_palette((
268
u"default", u"default", None),
270
u"default", u"default", u"bold"),
272
u"default", u"default", u"underline"),
274
u"default", u"default", u"standout"),
275
(u"bold-underline-blink",
276
u"default", u"default", (u"bold", u"underline")),
278
u"default", u"default", (u"bold", u"standout")),
279
(u"underline-blink-standout",
280
u"default", u"default", (u"underline", u"standout")),
281
(u"bold-underline-blink-standout",
282
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",
286
434
if urwid.supports_unicode():
287
self.divider = u"─" # \u2500
288
#self.divider = u"━" # \u2501
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
290
#self.divider = u"-" # \u002d
291
self.divider = u"_" # \u005f
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
293
441
self.screen.start()
308
456
# This keeps track of whether self.uilist currently has
309
457
# self.logbox in it or not
310
458
self.log_visible = True
311
self.log_wrap = u"any"
459
self.log_wrap = "any"
314
self.log_message_raw((u"bold",
315
u"Mandos Monitor version " + version))
316
self.log_message_raw((u"bold",
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
319
467
self.busname = domain + '.Mandos'
320
468
self.main_loop = gobject.MainLoop()
321
self.bus = dbus.SystemBus()
322
mandos_dbus_objc = self.bus.get_object(
323
self.busname, u"/", follow_name_owner_changes=True)
324
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
328
mandos_clients = (self.mandos_serv
329
.GetAllClientsWithProperties())
330
except dbus.exceptions.DBusException:
331
mandos_clients = dbus.Dictionary()
334
.connect_to_signal(u"ClientRemoved",
335
self.find_and_remove_client,
336
dbus_interface=server_interface,
339
.connect_to_signal(u"ClientAdded",
341
dbus_interface=server_interface,
344
.connect_to_signal(u"ClientNotFound",
345
self.client_not_found,
346
dbus_interface=server_interface,
348
for path, client in mandos_clients.iteritems():
349
client_proxy_object = self.bus.get_object(self.busname,
351
self.add_client(MandosClientWidget(server_proxy_object
354
=client_proxy_object,
364
470
def client_not_found(self, fingerprint, address):
365
self.log_message((u"Client with address %s and fingerprint %s"
366
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))
369
475
def rebuild(self):
370
476
"""This rebuilds the User Interface.
371
477
Call this when the widget layout needs to change"""
373
479
#self.uilist.append(urwid.ListBox(self.clients))
374
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
375
482
#header=urwid.Divider(),
377
footer=urwid.Divider(div_char=self.divider)))
485
urwid.Divider(div_char=
378
487
if self.log_visible:
379
488
self.uilist.append(self.logbox)
381
489
self.topwidget = urwid.Pile(self.uilist)
383
491
def log_message(self, message):
384
492
timestamp = datetime.datetime.now().isoformat()
385
self.log_message_raw(timestamp + u": " + message)
493
self.log_message_raw(timestamp + ": " + message)
387
495
def log_message_raw(self, markup):
388
496
"""Add a log message to the log buffer."""
391
499
and len(self.log) > self.max_log_length):
392
500
del self.log[0:len(self.log)-self.max_log_length-1]
393
501
self.logbox.set_focus(len(self.logbox.body.contents),
394
coming_from=u"above")
397
505
def toggle_log_display(self):
398
506
"""Toggle visibility of the log buffer."""
399
507
self.log_visible = not self.log_visible
401
self.log_message(u"Log visibility changed to: "
402
+ unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
404
512
def change_log_display(self):
405
513
"""Change type of log display.
406
514
Currently, this toggles wrapping of text lines."""
407
if self.log_wrap == u"clip":
408
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
410
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
411
519
for textwidget in self.log:
412
520
textwidget.set_wrap_mode(self.log_wrap)
413
self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
415
523
def find_and_remove_client(self, path, name):
416
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
418
526
This is connected to the ClientRemoved signal from the
419
527
Mandos server object."""
466
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,
468
622
self._input_callback_tag = (gobject.io_add_watch
469
623
(sys.stdin.fileno(),
495
649
except KeyError: # :-)
498
if key == u"q" or key == u"Q":
652
if key == "q" or key == "Q":
501
elif key == u"window resize":
655
elif key == "window resize":
502
656
self.size = self.screen.get_cols_rows()
504
elif key == u"\f": # Ctrl-L
658
elif key == "\f": # Ctrl-L
506
elif key == u"l" or key == u"D":
660
elif key == "l" or key == "D":
507
661
self.toggle_log_display()
509
elif key == u"w" or key == u"i":
663
elif key == "w" or key == "i":
510
664
self.change_log_display()
512
elif key == u"?" or key == u"f1" or key == u"esc":
666
elif key == "?" or key == "f1" or key == "esc":
513
667
if not self.log_visible:
514
668
self.log_visible = True
516
self.log_message_raw((u"bold",
520
u"l: Log window toggle",
521
u"TAB: Switch window",
523
self.log_message_raw((u"bold",
529
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",
534
690
if self.topwidget.get_focus() is self.logbox:
535
691
self.topwidget.set_focus(0)
537
693
self.topwidget.set_focus(self.logbox)
539
#elif (key == u"end" or key == u"meta >" or key == u"G"
695
#elif (key == "end" or key == "meta >" or key == "G"
541
697
# pass # xxx end-of-buffer
542
#elif (key == u"home" or key == u"meta <" or key == u"g"
698
#elif (key == "home" or key == "meta <" or key == "g"
544
700
# pass # xxx beginning-of-buffer
545
#elif key == u"ctrl e" or key == u"$":
701
#elif key == "ctrl e" or key == "$":
546
702
# pass # xxx move-end-of-line
547
#elif key == u"ctrl a" or key == u"^":
703
#elif key == "ctrl a" or key == "^":
548
704
# pass # xxx move-beginning-of-line
549
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
550
706
# pass # xxx left
551
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
552
708
# pass # xxx right
554
710
# pass # scroll up log
556
712
# pass # scroll down log
557
713
elif self.topwidget.selectable():
558
714
self.topwidget.keypress(self.size, key)