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>.
4
from __future__ import division, absolute_import, with_statement
26
from __future__ import (division, absolute_import, print_function,
29
from future_builtins import *
15
41
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
24
locale.setlocale(locale.LC_ALL, u'')
51
if sys.version_info[0] == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
26
59
# Some useful constants
27
domain = 'se.bsnet.fukt'
60
domain = 'se.recompile'
28
61
server_interface = domain + '.Mandos'
29
62
client_interface = domain + '.Mandos.Client'
32
# Always run in monochrome mode
33
urwid.curses_display.curses.has_colors = lambda : False
35
# Urwid doesn't support blinking, but we want it. Since we have no
36
# use for underline on its own, we make underline also always blink.
37
urwid.curses_display.curses.A_UNDERLINE |= (
38
urwid.curses_display.curses.A_BLINK)
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
40
81
class MandosClientPropertyCache(object):
41
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
42
83
properties and calls a hook function when any of them are
45
def __init__(self, proxy_object=None, *args, **kwargs):
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
46
87
self.proxy = proxy_object # Mandos Client proxy object
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)
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)
60
107
def property_changed(self, property=None, value=None):
61
108
"""This is called whenever we get a PropertyChanged signal
81
131
self.logger = logger
133
self._update_timer_callback_tag = None
83
135
# The widget shown normally
84
self._text_widget = urwid.Text(u"")
136
self._text_widget = urwid.Text("")
85
137
# The widget shown when we have focus
86
self._focus_text_widget = urwid.Text(u"")
87
super(MandosClientWidget, self).__init__(
88
update_hook=update_hook, delete_hook=delete_hook,
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
91
141
self.opened = False
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",
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
109
180
def checker_completed(self, exitstatus, condition, command):
110
181
if exitstatus == 0:
111
self.logger(u'Checker for client %s (command "%s")'
113
% (self.properties[u"name"], command))
115
185
if os.WIFEXITED(condition):
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')
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"]))
133
205
def checker_started(self, command):
134
self.logger(u'Client %s started checker "%s"'
135
% (self.properties[u"name"], unicode(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"],
137
213
def got_secret(self):
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"])
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))
145
229
def selectable(self):
146
230
"""Make this a "selectable" widget.
147
231
This overrides the method from urwid.FlowWidget."""
150
def rows(self, (maxcol,), focus=False):
234
def rows(self, maxcolrow, focus=False):
151
235
"""How many rows this widget will occupy might depend on
152
236
whether we have focus or not.
153
237
This overrides the method from urwid.FlowWidget"""
154
return self.current_widget(focus).rows((maxcol,), focus=focus)
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
156
240
def current_widget(self, focus=False):
157
241
if focus or self.opened:
161
245
def update(self):
162
246
"Called when what is visible on the screen should be updated."
163
247
# How to add standout mode to a style
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",
248
with_standout = { "normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"bold-underline-blink-standout",
172
256
# Rebuild focus and non-focus widgets using current properties
173
self._text = (u'%(name)s: %(enabled)s'
174
% { u"name": self.properties[u"name"],
177
if self.properties[u"enabled"]
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)
179
300
if not urwid.supports_unicode():
180
301
self._text = self._text.encode("ascii", "replace")
181
textlist = [(u"normal", self._text)]
302
textlist = [("normal", self._text)]
182
303
self._text_widget.set_text(textlist)
183
304
self._focus_text_widget.set_text([(with_standout[text[0]],
192
313
if self.update_hook is not None:
193
314
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 = ()
196
329
if self.delete_hook is not None:
197
330
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
199
def render(self, (maxcol,), focus=False):
333
def render(self, maxcolrow, focus=False):
200
334
"""Render differently if we have focus.
201
335
This overrides the method from urwid.FlowWidget"""
202
return self.current_widget(focus).render((maxcol,),
336
return self.current_widget(focus).render(maxcolrow,
205
def keypress(self, (maxcol,), key):
339
def keypress(self, maxcolrow, key):
207
341
This overrides the method from urwid.FlowWidget"""
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":
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":
213
357
self.server_proxy_object.RemoveClient(self.proxy
216
self.proxy.StartChecker()
218
self.proxy.StopChecker()
220
self.proxy.CheckedOK()
361
self.proxy.StartChecker(dbus_interface = client_interface,
364
self.proxy.StopChecker(dbus_interface = client_interface,
367
self.proxy.CheckedOK(dbus_interface = client_interface,
222
# elif key == u"p" or key == "=":
370
# elif key == "p" or key == "=":
223
371
# self.proxy.pause()
224
# elif key == u"u" or key == ":":
372
# elif key == "u" or key == ":":
225
373
# self.proxy.unpause()
226
# elif key == u"RET":
231
def property_changed(self, property=None, value=None,
379
def property_changed(self, property=None, **kwargs):
233
380
"""Call self.update() if old value is not new value.
234
381
This overrides the method from MandosClientPropertyCache"""
235
property_name = unicode(property)
382
property_name = str(property)
236
383
old_value = self.properties.get(property_name)
237
384
super(MandosClientWidget, self).property_changed(
238
property=property, value=value, *args, **kwargs)
385
property=property, **kwargs)
239
386
if self.properties.get(property_name) != old_value:
262
409
self.screen = urwid.curses_display.Screen()
264
411
self.screen.register_palette((
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",
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"),
284
432
if urwid.supports_unicode():
285
self.divider = u"─" # \u2500
286
#self.divider = u"━" # \u2501
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
288
#self.divider = u"-" # \u002d
289
self.divider = u"_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
291
439
self.screen.start()
306
454
# This keeps track of whether self.uilist currently has
307
455
# self.logbox in it or not
308
456
self.log_visible = True
309
self.log_wrap = u"any"
457
self.log_wrap = "any"
312
self.log_message_raw((u"bold",
313
u"Mandos Monitor version " + version))
314
self.log_message_raw((u"bold",
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
317
465
self.busname = domain + '.Mandos'
318
466
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,
362
468
def client_not_found(self, fingerprint, address):
363
self.log_message((u"Client with address %s and fingerprint %s"
364
u" could not be found" % (address,
469
self.log_message("Client with address {0} and fingerprint"
470
" {1} could not be found"
471
.format(address, fingerprint))
367
473
def rebuild(self):
368
474
"""This rebuilds the User Interface.
369
475
Call this when the widget layout needs to change"""
371
477
#self.uilist.append(urwid.ListBox(self.clients))
372
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
373
480
#header=urwid.Divider(),
375
footer=urwid.Divider(div_char=self.divider)))
483
urwid.Divider(div_char=
376
485
if self.log_visible:
377
486
self.uilist.append(self.logbox)
379
487
self.topwidget = urwid.Pile(self.uilist)
381
489
def log_message(self, message):
490
"""Log message formatted with timestamp"""
382
491
timestamp = datetime.datetime.now().isoformat()
383
self.log_message_raw(timestamp + u": " + message)
492
self.log_message_raw(timestamp + ": " + message)
385
494
def log_message_raw(self, markup):
386
495
"""Add a log message to the log buffer."""
389
498
and len(self.log) > self.max_log_length):
390
499
del self.log[0:len(self.log)-self.max_log_length-1]
391
500
self.logbox.set_focus(len(self.logbox.body.contents),
392
coming_from=u"above")
395
504
def toggle_log_display(self):
396
505
"""Toggle visibility of the log buffer."""
397
506
self.log_visible = not self.log_visible
399
self.log_message(u"Log visibility changed to: "
400
+ unicode(self.log_visible))
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
402
511
def change_log_display(self):
403
512
"""Change type of log display.
404
513
Currently, this toggles wrapping of text lines."""
405
if self.log_wrap == u"clip":
406
self.log_wrap = u"any"
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
408
self.log_wrap = u"clip"
517
self.log_wrap = "clip"
409
518
for textwidget in self.log:
410
519
textwidget.set_wrap_mode(self.log_wrap)
411
self.log_message(u"Wrap mode: " + self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
413
522
def find_and_remove_client(self, path, name):
414
"""Find an client from its object path and remove it.
523
"""Find a client by its object path and remove it.
416
525
This is connected to the ClientRemoved signal from the
417
526
Mandos server object."""
465
571
"""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,
467
619
self._input_callback_tag = (gobject.io_add_watch
468
620
(sys.stdin.fileno(),
494
646
except KeyError: # :-)
497
if key == u"q" or key == u"Q":
649
if key == "q" or key == "Q":
500
elif key == u"window resize":
652
elif key == "window resize":
501
653
self.size = self.screen.get_cols_rows()
503
elif key == u"\f": # Ctrl-L
655
elif key == "\f": # Ctrl-L
505
elif key == u"l" or key == u"D":
657
elif key == "l" or key == "D":
506
658
self.toggle_log_display()
508
elif key == u"w" or key == u"i":
660
elif key == "w" or key == "i":
509
661
self.change_log_display()
511
elif key == u"?" or key == u"f1" or key == u"esc":
663
elif key == "?" or key == "f1" or key == "esc":
512
664
if not self.log_visible:
513
665
self.log_visible = True
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",
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",
533
687
if self.topwidget.get_focus() is self.logbox:
534
688
self.topwidget.set_focus(0)
536
690
self.topwidget.set_focus(self.logbox)
538
#elif (key == u"end" or key == u"meta >" or key == u"G"
692
#elif (key == "end" or key == "meta >" or key == "G"
540
694
# pass # xxx end-of-buffer
541
#elif (key == u"home" or key == u"meta <" or key == u"g"
695
#elif (key == "home" or key == "meta <" or key == "g"
543
697
# pass # xxx beginning-of-buffer
544
#elif key == u"ctrl e" or key == u"$":
698
#elif key == "ctrl e" or key == "$":
545
699
# pass # xxx move-end-of-line
546
#elif key == u"ctrl a" or key == u"^":
700
#elif key == "ctrl a" or key == "^":
547
701
# pass # xxx move-beginning-of-line
548
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
549
703
# pass # xxx left
550
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
551
705
# pass # xxx right
553
707
# pass # scroll up log
555
709
# pass # scroll down log
556
710
elif self.topwidget.selectable():
557
711
self.topwidget.keypress(self.size, key)