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
65
37
urwid.curses_display.curses.A_UNDERLINE |= (
66
38
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
84
40
class MandosClientPropertyCache(object):
85
41
"""This wraps a Mandos Client D-Bus proxy object, caches the
86
42
properties and calls a hook function when any of them are
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
45
def __init__(self, proxy_object=None, *args, **kwargs):
90
46
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)
48
self.properties = dict()
49
self.proxy.connect_to_signal(u"PropertyChanged",
50
self.property_changed,
54
self.properties.update(
55
self.proxy.GetAll(client_interface,
56
dbus_interface = dbus.PROPERTIES_IFACE))
57
super(MandosClientPropertyCache, self).__init__(
58
proxy_object=proxy_object, *args, **kwargs)
110
60
def property_changed(self, property=None, value=None):
111
61
"""This is called whenever we get a PropertyChanged signal
134
81
self.logger = logger
136
self._update_timer_callback_tag = None
137
self._update_timer_callback_lock = 0
139
83
# The widget shown normally
140
self._text_widget = urwid.Text("")
84
self._text_widget = urwid.Text(u"")
141
85
# The widget shown when we have focus
142
self._focus_text_widget = urwid.Text("")
143
super(MandosClientWidget, self).__init__(**kwargs)
86
self._focus_text_widget = urwid.Text(u"")
87
super(MandosClientWidget, self).__init__(
88
update_hook=update_hook, delete_hook=delete_hook,
145
91
self.opened = False
147
last_checked_ok = isoformat_to_datetime(self.properties
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
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
202
self._update_timer_callback_tag = (gobject.timeout_add
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
92
self.proxy.connect_to_signal(u"CheckerCompleted",
93
self.checker_completed,
96
self.proxy.connect_to_signal(u"CheckerStarted",
100
self.proxy.connect_to_signal(u"GotSecret",
104
self.proxy.connect_to_signal(u"Rejected",
209
109
def checker_completed(self, exitstatus, condition, command):
210
110
if exitstatus == 0:
111
self.logger(u'Checker for client %s (command "%s")'
113
% (self.properties[u"name"], command))
214
115
if os.WIFEXITED(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)))
219
elif os.WIFSIGNALED(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)))
224
elif os.WCOREDUMP(condition):
225
self.logger('Checker for client {0} (command "{1}")'
227
.format(self.properties["Name"], command))
229
self.logger('Checker for client {0} completed'
231
.format(self.properties["Name"]))
116
self.logger(u'Checker for client %s (command "%s")'
117
u' failed with exit code %s'
118
% (self.properties[u"name"], command,
119
os.WEXITSTATUS(condition)))
121
if os.WIFSIGNALED(condition):
122
self.logger(u'Checker for client %s (command "%s")'
123
u' was killed by signal %s'
124
% (self.properties[u"name"], command,
125
os.WTERMSIG(condition)))
127
if os.WCOREDUMP(condition):
128
self.logger(u'Checker for client %s (command "%s")'
130
% (self.properties[u"name"], command))
131
self.logger(u'Checker for client %s completed mysteriously')
234
133
def checker_started(self, 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"],
134
self.logger(u'Client %s started checker "%s"'
135
% (self.properties[u"name"], unicode(command)))
242
137
def got_secret(self):
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))
138
self.logger(u'Client %s received its secret'
139
% self.properties[u"name"])
142
self.logger(u'Client %s was rejected'
143
% self.properties[u"name"])
259
145
def selectable(self):
260
146
"""Make this a "selectable" widget.
261
147
This overrides the method from urwid.FlowWidget."""
264
def rows(self, maxcolrow, focus=False):
150
def rows(self, (maxcol,), focus=False):
265
151
"""How many rows this widget will occupy might depend on
266
152
whether we have focus or not.
267
153
This overrides the method from urwid.FlowWidget"""
268
return self.current_widget(focus).rows(maxcolrow, focus=focus)
154
return self.current_widget(focus).rows((maxcol,), focus=focus)
270
156
def current_widget(self, focus=False):
271
157
if focus or self.opened:
275
161
def update(self):
276
162
"Called when what is visible on the screen should be updated."
277
163
# How to add standout mode to a style
278
with_standout = { "normal": "standout",
279
"bold": "bold-standout",
281
"underline-blink-standout",
282
"bold-underline-blink":
283
"bold-underline-blink-standout",
164
with_standout = { u"normal": u"standout",
165
u"bold": u"bold-standout",
167
u"underline-blink-standout",
168
u"bold-underline-blink":
169
u"bold-underline-blink-standout",
286
172
# Rebuild focus and non-focus widgets using current properties
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)
173
self._text = (u'%(name)s: %(enabled)s'
174
% { u"name": self.properties[u"name"],
177
if self.properties[u"enabled"]
324
179
if not urwid.supports_unicode():
325
180
self._text = self._text.encode("ascii", "replace")
326
textlist = [("normal", self._text)]
181
textlist = [(u"normal", self._text)]
327
182
self._text_widget.set_text(textlist)
328
183
self._focus_text_widget.set_text([(with_standout[text[0]],
337
192
if self.update_hook is not None:
338
193
self.update_hook()
340
def update_timer(self):
341
"""called by gobject. Will indefinitely loop until
342
gobject.source_remove() on tag is called"""
344
return True # Keep calling this
346
def delete(self, **kwargs):
347
if self._update_timer_callback_tag is not None:
348
gobject.source_remove(self._update_timer_callback_tag)
349
self._update_timer_callback_tag = None
350
for match in self.match_objects:
352
self.match_objects = ()
353
196
if self.delete_hook is not None:
354
197
self.delete_hook(self)
355
return super(MandosClientWidget, self).delete(**kwargs)
357
def render(self, maxcolrow, focus=False):
199
def render(self, (maxcol,), focus=False):
358
200
"""Render differently if we have focus.
359
201
This overrides the method from urwid.FlowWidget"""
360
return self.current_widget(focus).render(maxcolrow,
202
return self.current_widget(focus).render((maxcol,),
363
def keypress(self, maxcolrow, key):
205
def keypress(self, (maxcol,), key):
365
207
This overrides the method from urwid.FlowWidget"""
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":
208
if key == u"e" or key == u"+":
210
elif key == u"d" or key == u"-":
212
elif key == u"r" or key == u"_" or key == u"ctrl k":
381
213
self.server_proxy_object.RemoveClient(self.proxy
385
self.proxy.StartChecker(dbus_interface = client_interface,
388
self.proxy.StopChecker(dbus_interface = client_interface,
391
self.proxy.CheckedOK(dbus_interface = client_interface,
216
self.proxy.StartChecker()
218
self.proxy.StopChecker()
220
self.proxy.CheckedOK()
394
# elif key == "p" or key == "=":
222
# elif key == u"p" or key == "=":
395
223
# self.proxy.pause()
396
# elif key == "u" or key == ":":
224
# elif key == u"u" or key == ":":
397
225
# self.proxy.unpause()
226
# elif key == u"RET":
403
def property_changed(self, property=None, **kwargs):
231
def property_changed(self, property=None, value=None,
404
233
"""Call self.update() if old value is not new value.
405
234
This overrides the method from MandosClientPropertyCache"""
406
235
property_name = unicode(property)
407
236
old_value = self.properties.get(property_name)
408
237
super(MandosClientWidget, self).property_changed(
409
property=property, **kwargs)
238
property=property, value=value, *args, **kwargs)
410
239
if self.properties.get(property_name) != old_value:
433
262
self.screen = urwid.curses_display.Screen()
435
264
self.screen.register_palette((
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",
266
u"default", u"default", None),
268
u"default", u"default", u"bold"),
270
u"default", u"default", u"underline"),
272
u"default", u"default", u"standout"),
273
(u"bold-underline-blink",
274
u"default", u"default", (u"bold", u"underline")),
276
u"default", u"default", (u"bold", u"standout")),
277
(u"underline-blink-standout",
278
u"default", u"default", (u"underline", u"standout")),
279
(u"bold-underline-blink-standout",
280
u"default", u"default", (u"bold", u"underline",
455
284
if urwid.supports_unicode():
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
285
self.divider = u"─" # \u2500
286
#self.divider = u"━" # \u2501
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
288
#self.divider = u"-" # \u002d
289
self.divider = u"_" # \u005f
462
291
self.screen.start()
477
306
# This keeps track of whether self.uilist currently has
478
307
# self.logbox in it or not
479
308
self.log_visible = True
480
self.log_wrap = "any"
309
self.log_wrap = u"any"
483
self.log_message_raw(("bold",
484
"Mandos Monitor version " + version))
485
self.log_message_raw(("bold",
312
self.log_message_raw((u"bold",
313
u"Mandos Monitor version " + version))
314
self.log_message_raw((u"bold",
488
317
self.busname = domain + '.Mandos'
489
318
self.main_loop = gobject.MainLoop()
319
self.bus = dbus.SystemBus()
320
mandos_dbus_objc = self.bus.get_object(
321
self.busname, u"/", follow_name_owner_changes=True)
322
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
326
mandos_clients = (self.mandos_serv
327
.GetAllClientsWithProperties())
328
except dbus.exceptions.DBusException:
329
mandos_clients = dbus.Dictionary()
332
.connect_to_signal(u"ClientRemoved",
333
self.find_and_remove_client,
334
dbus_interface=server_interface,
337
.connect_to_signal(u"ClientAdded",
339
dbus_interface=server_interface,
342
.connect_to_signal(u"ClientNotFound",
343
self.client_not_found,
344
dbus_interface=server_interface,
346
for path, client in mandos_clients.iteritems():
347
client_proxy_object = self.bus.get_object(self.busname,
349
self.add_client(MandosClientWidget(server_proxy_object
352
=client_proxy_object,
491
362
def client_not_found(self, fingerprint, address):
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
494
.format(address, fingerprint))
363
self.log_message((u"Client with address %s and fingerprint %s"
364
u" could not be found" % (address,
496
367
def rebuild(self):
497
368
"""This rebuilds the User Interface.
498
369
Call this when the widget layout needs to change"""
500
371
#self.uilist.append(urwid.ListBox(self.clients))
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
372
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
503
373
#header=urwid.Divider(),
506
urwid.Divider(div_char=
375
footer=urwid.Divider(div_char=self.divider)))
508
376
if self.log_visible:
509
377
self.uilist.append(self.logbox)
510
379
self.topwidget = urwid.Pile(self.uilist)
512
381
def log_message(self, message):
513
382
timestamp = datetime.datetime.now().isoformat()
514
self.log_message_raw(timestamp + ": " + message)
383
self.log_message_raw(timestamp + u": " + message)
516
385
def log_message_raw(self, markup):
517
386
"""Add a log message to the log buffer."""
520
389
and len(self.log) > self.max_log_length):
521
390
del self.log[0:len(self.log)-self.max_log_length-1]
522
391
self.logbox.set_focus(len(self.logbox.body.contents),
392
coming_from=u"above")
526
395
def toggle_log_display(self):
527
396
"""Toggle visibility of the log buffer."""
528
397
self.log_visible = not self.log_visible
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
399
self.log_message(u"Log visibility changed to: "
400
+ unicode(self.log_visible))
533
402
def change_log_display(self):
534
403
"""Change type of log display.
535
404
Currently, this toggles wrapping of text lines."""
536
if self.log_wrap == "clip":
537
self.log_wrap = "any"
405
if self.log_wrap == u"clip":
406
self.log_wrap = u"any"
539
self.log_wrap = "clip"
408
self.log_wrap = u"clip"
540
409
for textwidget in self.log:
541
410
textwidget.set_wrap_mode(self.log_wrap)
542
#self.log_message("Wrap mode: " + self.log_wrap)
411
self.log_message(u"Wrap mode: " + self.log_wrap)
544
413
def find_and_remove_client(self, path, name):
545
"""Find a client by its object path and remove it.
414
"""Find an client from its object path and remove it.
547
416
This is connected to the ClientRemoved signal from the
548
417
Mandos server object."""
598
465
"""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,
643
467
self._input_callback_tag = (gobject.io_add_watch
644
468
(sys.stdin.fileno(),
670
494
except KeyError: # :-)
673
if key == "q" or key == "Q":
497
if key == u"q" or key == u"Q":
676
elif key == "window resize":
500
elif key == u"window resize":
677
501
self.size = self.screen.get_cols_rows()
679
elif key == "\f": # Ctrl-L
503
elif key == u"\f": # Ctrl-L
681
elif key == "l" or key == "D":
505
elif key == u"l" or key == u"D":
682
506
self.toggle_log_display()
684
elif key == "w" or key == "i":
508
elif key == u"w" or key == u"i":
685
509
self.change_log_display()
687
elif key == "?" or key == "f1" or key == "esc":
511
elif key == u"?" or key == u"f1" or key == u"esc":
688
512
if not self.log_visible:
689
513
self.log_visible = True
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",
515
self.log_message_raw((u"bold",
519
u"l: Log window toggle",
520
u"TAB: Switch window",
522
self.log_message_raw((u"bold",
528
u"s: Start new checker",
711
533
if self.topwidget.get_focus() is self.logbox:
712
534
self.topwidget.set_focus(0)
714
536
self.topwidget.set_focus(self.logbox)
716
#elif (key == "end" or key == "meta >" or key == "G"
538
#elif (key == u"end" or key == u"meta >" or key == u"G"
718
540
# pass # xxx end-of-buffer
719
#elif (key == "home" or key == "meta <" or key == "g"
541
#elif (key == u"home" or key == u"meta <" or key == u"g"
721
543
# pass # xxx beginning-of-buffer
722
#elif key == "ctrl e" or key == "$":
544
#elif key == u"ctrl e" or key == u"$":
723
545
# pass # xxx move-end-of-line
724
#elif key == "ctrl a" or key == "^":
546
#elif key == u"ctrl a" or key == u"^":
725
547
# pass # xxx move-beginning-of-line
726
#elif key == "ctrl b" or key == "meta (" or key == "h":
548
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
727
549
# pass # xxx left
728
#elif key == "ctrl f" or key == "meta )" or key == "l":
550
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
729
551
# pass # xxx right
731
553
# pass # scroll up log
733
555
# pass # scroll down log
734
556
elif self.topwidget.selectable():
735
557
self.topwidget.keypress(self.size, key)