2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 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
41
15
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
51
if sys.version_info[0] == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
59
22
# Some useful constants
60
domain = 'se.recompile'
23
domain = 'se.bsnet.fukt'
61
24
server_interface = domain + '.Mandos'
62
25
client_interface = domain + '.Mandos.Client'
65
def isoformat_to_datetime(iso):
66
"Parse an ISO 8601 date string to a datetime.datetime()"
69
d, t = iso.split("T", 1)
70
year, month, day = d.split("-", 2)
71
hour, minute, second = t.split(":", 2)
72
second, fraction = divmod(float(second), 1)
73
return datetime.datetime(int(year),
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
28
# Always run in monochrome mode
29
urwid.curses_display.curses.has_colors = lambda : False
31
# Urwid doesn't support blinking, but we want it. Since we have no
32
# use for underline on its own, we make underline also always blink.
33
urwid.curses_display.curses.A_UNDERLINE |= (
34
urwid.curses_display.curses.A_BLINK)
81
36
class MandosClientPropertyCache(object):
82
37
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
38
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
41
def __init__(self, proxy_object=None, properties=None, *args,
87
43
self.proxy = proxy_object # Mandos Client proxy object
88
self.properties = dict() if properties is None else properties
89
self.property_changed_match = (
90
self.proxy.connect_to_signal("PropertyChanged",
91
self._property_changed,
95
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
def _property_changed(self, property, value):
104
"""Helper which takes positional arguments"""
105
return self.property_changed(property=property, value=value)
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)
107
62
def property_changed(self, property=None, value=None):
108
63
"""This is called whenever we get a PropertyChanged signal
131
83
self.logger = logger
133
self._update_timer_callback_tag = None
135
85
# The widget shown normally
136
self._text_widget = urwid.Text("")
86
self._text_widget = urwid.Text(u"")
137
87
# The widget shown when we have focus
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
88
self._focus_text_widget = urwid.Text(u"")
89
super(MandosClientWidget, self).__init__(
90
update_hook=update_hook, delete_hook=delete_hook,
141
93
self.opened = False
143
self.match_objects = (
144
self.proxy.connect_to_signal("CheckerCompleted",
145
self.checker_completed,
148
self.proxy.connect_to_signal("CheckerStarted",
149
self.checker_started,
152
self.proxy.connect_to_signal("GotSecret",
156
self.proxy.connect_to_signal("NeedApproval",
160
self.proxy.connect_to_signal("Rejected",
164
#self.logger('Created client {0}'
165
# .format(self.properties["Name"]))
167
def using_timer(self, flag):
168
"""Call this method with True or False when timer should be
169
activated or deactivated.
171
if flag and self._update_timer_callback_tag is None:
172
# Will update the shown timer value every second
173
self._update_timer_callback_tag = (gobject.timeout_add
176
elif not (flag or self._update_timer_callback_tag is None):
177
gobject.source_remove(self._update_timer_callback_tag)
178
self._update_timer_callback_tag = None
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",
180
111
def checker_completed(self, exitstatus, condition, command):
181
112
if exitstatus == 0:
113
self.logger(u'Checker for client %s (command "%s")'
115
% (self.properties[u"name"], command))
185
117
if os.WIFEXITED(condition):
186
self.logger('Checker for client {0} (command "{1}")'
187
' failed with exit code {2}'
188
.format(self.properties["Name"], command,
189
os.WEXITSTATUS(condition)))
190
elif os.WIFSIGNALED(condition):
191
self.logger('Checker for client {0} (command "{1}") was'
192
' killed by signal {2}'
193
.format(self.properties["Name"], command,
194
os.WTERMSIG(condition)))
195
elif os.WCOREDUMP(condition):
196
self.logger('Checker for client {0} (command "{1}")'
198
.format(self.properties["Name"], command))
200
self.logger('Checker for client {0} completed'
202
.format(self.properties["Name"]))
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')
205
135
def checker_started(self, command):
206
"""Server signals that a checker started. This could be useful
207
to log in the future. """
208
#self.logger('Client {0} started checker "{1}"'
209
# .format(self.properties["Name"],
136
self.logger(u'Client %s started checker "%s"'
137
% (self.properties[u"name"], unicode(command)))
213
139
def got_secret(self):
214
self.logger('Client {0} received its secret'
215
.format(self.properties["Name"]))
217
def need_approval(self, timeout, default):
219
message = 'Client {0} needs approval within {1} seconds'
221
message = 'Client {0} will get its secret in {1} seconds'
222
self.logger(message.format(self.properties["Name"],
225
def rejected(self, reason):
226
self.logger('Client {0} was rejected; reason: {1}'
227
.format(self.properties["Name"], reason))
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"])
229
147
def selectable(self):
230
148
"""Make this a "selectable" widget.
231
149
This overrides the method from urwid.FlowWidget."""
234
def rows(self, maxcolrow, focus=False):
152
def rows(self, (maxcol,), focus=False):
235
153
"""How many rows this widget will occupy might depend on
236
154
whether we have focus or not.
237
155
This overrides the method from urwid.FlowWidget"""
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
156
return self.current_widget(focus).rows((maxcol,), focus=focus)
240
158
def current_widget(self, focus=False):
241
159
if focus or self.opened:
245
163
def update(self):
246
164
"Called when what is visible on the screen should be updated."
247
165
# How to add standout mode to a style
248
with_standout = { "normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"bold-underline-blink-standout",
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",
256
174
# Rebuild focus and non-focus widgets using current properties
258
# Base part of a client. Name!
259
base = '{name}: '.format(name=self.properties["Name"])
260
if not self.properties["Enabled"]:
262
self.using_timer(False)
263
elif self.properties["ApprovalPending"]:
264
timeout = datetime.timedelta(milliseconds
267
last_approval_request = isoformat_to_datetime(
268
self.properties["LastApprovalRequest"])
269
if last_approval_request is not None:
270
timer = max(timeout - (datetime.datetime.utcnow()
271
- last_approval_request),
272
datetime.timedelta())
274
timer = datetime.timedelta()
275
if self.properties["ApprovedByDefault"]:
276
message = "Approval in {0}. (d)eny?"
278
message = "Denial in {0}. (a)pprove?"
279
message = message.format(str(timer).rsplit(".", 1)[0])
280
self.using_timer(True)
281
elif self.properties["LastCheckerStatus"] != 0:
282
# When checker has failed, show timer until client expires
283
expires = self.properties["Expires"]
285
timer = datetime.timedelta(0)
287
expires = (datetime.datetime.strptime
288
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
289
timer = max(expires - datetime.datetime.utcnow(),
290
datetime.timedelta())
291
message = ('A checker has failed! Time until client'
292
' gets disabled: {0}'
293
.format(str(timer).rsplit(".", 1)[0]))
294
self.using_timer(True)
297
self.using_timer(False)
298
self._text = "{0}{1}".format(base, message)
175
self._text = (u'%(name)s: %(enabled)s'
176
% { u"name": self.properties[u"name"],
179
if self.properties[u"enabled"]
300
181
if not urwid.supports_unicode():
301
182
self._text = self._text.encode("ascii", "replace")
302
textlist = [("normal", self._text)]
183
textlist = [(u"normal", self._text)]
303
184
self._text_widget.set_text(textlist)
304
185
self._focus_text_widget.set_text([(with_standout[text[0]],
313
194
if self.update_hook is not None:
314
195
self.update_hook()
316
def update_timer(self):
317
"""called by gobject. Will indefinitely loop until
318
gobject.source_remove() on tag is called"""
320
return True # Keep calling this
322
def delete(self, **kwargs):
323
if self._update_timer_callback_tag is not None:
324
gobject.source_remove(self._update_timer_callback_tag)
325
self._update_timer_callback_tag = None
326
for match in self.match_objects:
328
self.match_objects = ()
329
198
if self.delete_hook is not None:
330
199
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
333
def render(self, maxcolrow, focus=False):
201
def render(self, (maxcol,), focus=False):
334
202
"""Render differently if we have focus.
335
203
This overrides the method from urwid.FlowWidget"""
336
return self.current_widget(focus).render(maxcolrow,
204
return self.current_widget(focus).render((maxcol,),
339
def keypress(self, maxcolrow, key):
207
def keypress(self, (maxcol,), key):
341
209
This overrides the method from urwid.FlowWidget"""
343
self.proxy.Enable(dbus_interface = client_interface,
346
self.proxy.Disable(dbus_interface = client_interface,
349
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface = client_interface,
353
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface = client_interface,
356
elif key == "R" or key == "_" or key == "ctrl k":
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":
357
215
self.server_proxy_object.RemoveClient(self.proxy
361
self.proxy.StartChecker(dbus_interface = client_interface,
364
self.proxy.StopChecker(dbus_interface = client_interface,
367
self.proxy.CheckedOK(dbus_interface = client_interface,
218
self.proxy.StartChecker()
220
self.proxy.StopChecker()
222
self.proxy.CheckedOK()
370
# elif key == "p" or key == "=":
224
# elif key == u"p" or key == "=":
371
225
# self.proxy.pause()
372
# elif key == "u" or key == ":":
226
# elif key == u"u" or key == ":":
373
227
# self.proxy.unpause()
228
# elif key == u"RET":
379
def property_changed(self, property=None, **kwargs):
233
def property_changed(self, property=None, value=None,
380
235
"""Call self.update() if old value is not new value.
381
236
This overrides the method from MandosClientPropertyCache"""
382
property_name = str(property)
237
property_name = unicode(property)
383
238
old_value = self.properties.get(property_name)
384
239
super(MandosClientWidget, self).property_changed(
385
property=property, **kwargs)
240
property=property, value=value, *args, **kwargs)
386
241
if self.properties.get(property_name) != old_value:
409
264
self.screen = urwid.curses_display.Screen()
411
266
self.screen.register_palette((
413
"default", "default", None),
415
"bold", "default", "bold"),
417
"underline,blink", "default", "underline,blink"),
419
"standout", "default", "standout"),
420
("bold-underline-blink",
421
"bold,underline,blink", "default", "bold,underline,blink"),
423
"bold,standout", "default", "bold,standout"),
424
("underline-blink-standout",
425
"underline,blink,standout", "default",
426
"underline,blink,standout"),
427
("bold-underline-blink-standout",
428
"bold,underline,blink,standout", "default",
429
"bold,underline,blink,standout"),
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",
432
286
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
287
self.divider = u"─" # \u2500
288
#self.divider = u"━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
290
#self.divider = u"-" # \u002d
291
self.divider = u"_" # \u005f
439
293
self.screen.start()
454
308
# This keeps track of whether self.uilist currently has
455
309
# self.logbox in it or not
456
310
self.log_visible = True
457
self.log_wrap = "any"
311
self.log_wrap = u"any"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
314
self.log_message_raw((u"bold",
315
u"Mandos Monitor version " + version))
316
self.log_message_raw((u"bold",
465
319
self.busname = domain + '.Mandos'
466
320
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,
468
364
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {0} and fingerprint"
470
" {1} could not be found"
471
.format(address, fingerprint))
365
self.log_message((u"Client with address %s and fingerprint %s"
366
u" could not be found" % (address,
473
369
def rebuild(self):
474
370
"""This rebuilds the User Interface.
475
371
Call this when the widget layout needs to change"""
477
373
#self.uilist.append(urwid.ListBox(self.clients))
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
374
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
375
#header=urwid.Divider(),
483
urwid.Divider(div_char=
377
footer=urwid.Divider(div_char=self.divider)))
485
378
if self.log_visible:
486
379
self.uilist.append(self.logbox)
487
381
self.topwidget = urwid.Pile(self.uilist)
489
383
def log_message(self, message):
490
"""Log message formatted with timestamp"""
491
384
timestamp = datetime.datetime.now().isoformat()
492
self.log_message_raw(timestamp + ": " + message)
385
self.log_message_raw(timestamp + u": " + message)
494
387
def log_message_raw(self, markup):
495
388
"""Add a log message to the log buffer."""
498
391
and len(self.log) > self.max_log_length):
499
392
del self.log[0:len(self.log)-self.max_log_length-1]
500
393
self.logbox.set_focus(len(self.logbox.body.contents),
394
coming_from=u"above")
504
397
def toggle_log_display(self):
505
398
"""Toggle visibility of the log buffer."""
506
399
self.log_visible = not self.log_visible
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
401
self.log_message(u"Log visibility changed to: "
402
+ unicode(self.log_visible))
511
404
def change_log_display(self):
512
405
"""Change type of log display.
513
406
Currently, this toggles wrapping of text lines."""
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
407
if self.log_wrap == u"clip":
408
self.log_wrap = u"any"
517
self.log_wrap = "clip"
410
self.log_wrap = u"clip"
518
411
for textwidget in self.log:
519
412
textwidget.set_wrap_mode(self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
413
self.log_message(u"Wrap mode: " + self.log_wrap)
522
415
def find_and_remove_client(self, path, name):
523
"""Find a client by its object path and remove it.
416
"""Find an client from its object path and remove it.
525
418
This is connected to the ClientRemoved signal from the
526
419
Mandos server object."""
571
466
"""Start the main loop and exit when it's done."""
572
self.bus = dbus.SystemBus()
573
mandos_dbus_objc = self.bus.get_object(
574
self.busname, "/", follow_name_owner_changes=True)
575
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
579
mandos_clients = (self.mandos_serv
580
.GetAllClientsWithProperties())
581
if not mandos_clients:
582
self.log_message_raw(("bold", "Note: Server has no clients."))
583
except dbus.exceptions.DBusException:
584
self.log_message_raw(("bold", "Note: No Mandos server running."))
585
mandos_clients = dbus.Dictionary()
588
.connect_to_signal("ClientRemoved",
589
self.find_and_remove_client,
590
dbus_interface=server_interface,
593
.connect_to_signal("ClientAdded",
595
dbus_interface=server_interface,
598
.connect_to_signal("ClientNotFound",
599
self.client_not_found,
600
dbus_interface=server_interface,
602
for path, client in mandos_clients.items():
603
client_proxy_object = self.bus.get_object(self.busname,
605
self.add_client(MandosClientWidget(server_proxy_object
608
=client_proxy_object,
619
468
self._input_callback_tag = (gobject.io_add_watch
620
469
(sys.stdin.fileno(),
646
495
except KeyError: # :-)
649
if key == "q" or key == "Q":
498
if key == u"q" or key == u"Q":
652
elif key == "window resize":
501
elif key == u"window resize":
653
502
self.size = self.screen.get_cols_rows()
655
elif key == "\f": # Ctrl-L
504
elif key == u"\f": # Ctrl-L
657
elif key == "l" or key == "D":
506
elif key == u"l" or key == u"D":
658
507
self.toggle_log_display()
660
elif key == "w" or key == "i":
509
elif key == u"w" or key == u"i":
661
510
self.change_log_display()
663
elif key == "?" or key == "f1" or key == "esc":
512
elif key == u"?" or key == u"f1" or key == u"esc":
664
513
if not self.log_visible:
665
514
self.log_visible = True
667
self.log_message_raw(("bold",
671
"l: Log window toggle",
672
"TAB: Switch window",
674
self.log_message_raw(("bold",
680
"s: Start new checker",
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",
687
534
if self.topwidget.get_focus() is self.logbox:
688
535
self.topwidget.set_focus(0)
690
537
self.topwidget.set_focus(self.logbox)
692
#elif (key == "end" or key == "meta >" or key == "G"
539
#elif (key == u"end" or key == u"meta >" or key == u"G"
694
541
# pass # xxx end-of-buffer
695
#elif (key == "home" or key == "meta <" or key == "g"
542
#elif (key == u"home" or key == u"meta <" or key == u"g"
697
544
# pass # xxx beginning-of-buffer
698
#elif key == "ctrl e" or key == "$":
545
#elif key == u"ctrl e" or key == u"$":
699
546
# pass # xxx move-end-of-line
700
#elif key == "ctrl a" or key == "^":
547
#elif key == u"ctrl a" or key == u"^":
701
548
# pass # xxx move-beginning-of-line
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
549
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
550
# pass # xxx left
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
551
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
552
# pass # xxx right
707
554
# pass # scroll up log
709
556
# pass # scroll down log
710
557
elif self.topwidget.selectable():
711
558
self.topwidget.keypress(self.size, key)