2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2013 Teddy Hogeborn
7
# Copyright © 2009-2013 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
42
from dbus.mainloop.glib import DBusGMainLoop
46
from gi.repository import GObject as gobject
24
locale.setlocale(locale.LC_ALL, u'')
52
if sys.version_info[0] == 2:
55
locale.setlocale(locale.LC_ALL, '')
27
58
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
29
60
# Some useful constants
30
domain = 'se.bsnet.fukt'
61
domain = 'se.recompile'
31
62
server_interface = domain + '.Mandos'
32
63
client_interface = domain + '.Mandos.Client'
35
# Always run in monochrome mode
36
urwid.curses_display.curses.has_colors = lambda : False
38
# Urwid doesn't support blinking, but we want it. Since we have no
39
# use for underline on its own, we make underline also always blink.
40
urwid.curses_display.curses.A_UNDERLINE |= (
41
urwid.curses_display.curses.A_BLINK)
66
def isoformat_to_datetime(iso):
67
"Parse an ISO 8601 date string to a datetime.datetime()"
70
d, t = iso.split("T", 1)
71
year, month, day = d.split("-", 2)
72
hour, minute, second = t.split(":", 2)
73
second, fraction = divmod(float(second), 1)
74
return datetime.datetime(int(year),
79
int(second), # Whole seconds
80
int(fraction*1000000)) # Microseconds
43
82
class MandosClientPropertyCache(object):
44
83
"""This wraps a Mandos Client D-Bus proxy object, caches the
45
84
properties and calls a hook function when any of them are
48
def __init__(self, proxy_object=None, *args, **kwargs):
87
def __init__(self, proxy_object=None, properties=None, **kwargs):
49
88
self.proxy = proxy_object # Mandos Client proxy object
51
self.properties = dict()
52
self.proxy.connect_to_signal(u"PropertyChanged",
53
self.property_changed,
57
self.properties.update(
58
self.proxy.GetAll(client_interface,
59
dbus_interface = dbus.PROPERTIES_IFACE))
60
super(MandosClientPropertyCache, self).__init__(
61
proxy_object=proxy_object, *args, **kwargs)
89
self.properties = dict() if properties is None else properties
90
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self._property_changed,
96
if properties is None:
97
self.properties.update(
98
self.proxy.GetAll(client_interface,
100
= dbus.PROPERTIES_IFACE))
102
super(MandosClientPropertyCache, self).__init__(**kwargs)
104
def _property_changed(self, property, value):
105
"""Helper which takes positional arguments"""
106
return self.property_changed(property=property, value=value)
63
108
def property_changed(self, property=None, value=None):
64
109
"""This is called whenever we get a PropertyChanged signal
84
132
self.logger = logger
134
self._update_timer_callback_tag = None
86
136
# The widget shown normally
87
self._text_widget = urwid.Text(u"")
137
self._text_widget = urwid.Text("")
88
138
# The widget shown when we have focus
89
self._focus_text_widget = urwid.Text(u"")
90
super(MandosClientWidget, self).__init__(
91
update_hook=update_hook, delete_hook=delete_hook,
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(**kwargs)
94
142
self.opened = False
95
self.proxy.connect_to_signal(u"CheckerCompleted",
96
self.checker_completed,
99
self.proxy.connect_to_signal(u"CheckerStarted",
100
self.checker_started,
103
self.proxy.connect_to_signal(u"GotSecret",
107
self.proxy.connect_to_signal(u"Rejected",
144
self.match_objects = (
145
self.proxy.connect_to_signal("CheckerCompleted",
146
self.checker_completed,
149
self.proxy.connect_to_signal("CheckerStarted",
150
self.checker_started,
153
self.proxy.connect_to_signal("GotSecret",
157
self.proxy.connect_to_signal("NeedApproval",
161
self.proxy.connect_to_signal("Rejected",
165
#self.logger('Created client {0}'
166
# .format(self.properties["Name"]))
168
def using_timer(self, flag):
169
"""Call this method with True or False when timer should be
170
activated or deactivated.
172
if flag and self._update_timer_callback_tag is None:
173
# Will update the shown timer value every second
174
self._update_timer_callback_tag = (gobject.timeout_add
177
elif not (flag or self._update_timer_callback_tag is None):
178
gobject.source_remove(self._update_timer_callback_tag)
179
self._update_timer_callback_tag = None
112
181
def checker_completed(self, exitstatus, condition, command):
113
182
if exitstatus == 0:
114
self.logger(u'Checker for client %s (command "%s")'
116
% (self.properties[u"name"], command))
118
186
if os.WIFEXITED(condition):
119
self.logger(u'Checker for client %s (command "%s")'
120
u' failed with exit code %s'
121
% (self.properties[u"name"], command,
122
os.WEXITSTATUS(condition)))
124
if os.WIFSIGNALED(condition):
125
self.logger(u'Checker for client %s (command "%s")'
126
u' was killed by signal %s'
127
% (self.properties[u"name"], command,
128
os.WTERMSIG(condition)))
130
if os.WCOREDUMP(condition):
131
self.logger(u'Checker for client %s (command "%s")'
133
% (self.properties[u"name"], command))
134
self.logger(u'Checker for client %s completed mysteriously')
187
self.logger('Checker for client {0} (command "{1}")'
188
' failed with exit code {2}'
189
.format(self.properties["Name"], command,
190
os.WEXITSTATUS(condition)))
191
elif os.WIFSIGNALED(condition):
192
self.logger('Checker for client {0} (command "{1}") was'
193
' killed by signal {2}'
194
.format(self.properties["Name"], command,
195
os.WTERMSIG(condition)))
196
elif os.WCOREDUMP(condition):
197
self.logger('Checker for client {0} (command "{1}")'
199
.format(self.properties["Name"], command))
201
self.logger('Checker for client {0} completed'
203
.format(self.properties["Name"]))
136
206
def checker_started(self, command):
137
self.logger(u'Client %s started checker "%s"'
138
% (self.properties[u"name"], unicode(command)))
207
"""Server signals that a checker started. This could be useful
208
to log in the future. """
209
#self.logger('Client {0} started checker "{1}"'
210
# .format(self.properties["Name"],
140
214
def got_secret(self):
141
self.logger(u'Client %s received its secret'
142
% self.properties[u"name"])
145
self.logger(u'Client %s was rejected'
146
% self.properties[u"name"])
215
self.logger('Client {0} received its secret'
216
.format(self.properties["Name"]))
218
def need_approval(self, timeout, default):
220
message = 'Client {0} needs approval within {1} seconds'
222
message = 'Client {0} will get its secret in {1} seconds'
223
self.logger(message.format(self.properties["Name"],
226
def rejected(self, reason):
227
self.logger('Client {0} was rejected; reason: {1}'
228
.format(self.properties["Name"], reason))
148
230
def selectable(self):
149
231
"""Make this a "selectable" widget.
150
232
This overrides the method from urwid.FlowWidget."""
153
def rows(self, (maxcol,), focus=False):
235
def rows(self, maxcolrow, focus=False):
154
236
"""How many rows this widget will occupy might depend on
155
237
whether we have focus or not.
156
238
This overrides the method from urwid.FlowWidget"""
157
return self.current_widget(focus).rows((maxcol,), focus=focus)
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
159
241
def current_widget(self, focus=False):
160
242
if focus or self.opened:
164
246
def update(self):
165
247
"Called when what is visible on the screen should be updated."
166
248
# How to add standout mode to a style
167
with_standout = { u"normal": u"standout",
168
u"bold": u"bold-standout",
170
u"underline-blink-standout",
171
u"bold-underline-blink":
172
u"bold-underline-blink-standout",
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"bold-underline-blink-standout",
175
257
# Rebuild focus and non-focus widgets using current properties
176
self._text = (u'%(name)s: %(enabled)s'
177
% { u"name": self.properties[u"name"],
180
if self.properties[u"enabled"]
259
# Base part of a client. Name!
260
base = '{name}: '.format(name=self.properties["Name"])
261
if not self.properties["Enabled"]:
263
self.using_timer(False)
264
elif self.properties["ApprovalPending"]:
265
timeout = datetime.timedelta(milliseconds
268
last_approval_request = isoformat_to_datetime(
269
self.properties["LastApprovalRequest"])
270
if last_approval_request is not None:
271
timer = max(timeout - (datetime.datetime.utcnow()
272
- last_approval_request),
273
datetime.timedelta())
275
timer = datetime.timedelta()
276
if self.properties["ApprovedByDefault"]:
277
message = "Approval in {0}. (d)eny?"
279
message = "Denial in {0}. (a)pprove?"
280
message = message.format(str(timer).rsplit(".", 1)[0])
281
self.using_timer(True)
282
elif self.properties["LastCheckerStatus"] != 0:
283
# When checker has failed, show timer until client expires
284
expires = self.properties["Expires"]
286
timer = datetime.timedelta(0)
288
expires = (datetime.datetime.strptime
289
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
timer = max(expires - datetime.datetime.utcnow(),
291
datetime.timedelta())
292
message = ('A checker has failed! Time until client'
293
' gets disabled: {0}'
294
.format(str(timer).rsplit(".", 1)[0]))
295
self.using_timer(True)
298
self.using_timer(False)
299
self._text = "{0}{1}".format(base, message)
182
301
if not urwid.supports_unicode():
183
302
self._text = self._text.encode("ascii", "replace")
184
textlist = [(u"normal", self._text)]
303
textlist = [("normal", self._text)]
185
304
self._text_widget.set_text(textlist)
186
305
self._focus_text_widget.set_text([(with_standout[text[0]],
195
314
if self.update_hook is not None:
196
315
self.update_hook()
317
def update_timer(self):
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
321
return True # Keep calling this
323
def delete(self, **kwargs):
324
if self._update_timer_callback_tag is not None:
325
gobject.source_remove(self._update_timer_callback_tag)
326
self._update_timer_callback_tag = None
327
for match in self.match_objects:
329
self.match_objects = ()
199
330
if self.delete_hook is not None:
200
331
self.delete_hook(self)
332
return super(MandosClientWidget, self).delete(**kwargs)
202
def render(self, (maxcol,), focus=False):
334
def render(self, maxcolrow, focus=False):
203
335
"""Render differently if we have focus.
204
336
This overrides the method from urwid.FlowWidget"""
205
return self.current_widget(focus).render((maxcol,),
337
return self.current_widget(focus).render(maxcolrow,
208
def keypress(self, (maxcol,), key):
340
def keypress(self, maxcolrow, key):
210
342
This overrides the method from urwid.FlowWidget"""
211
if key == u"e" or key == u"+":
213
elif key == u"d" or key == u"-":
215
elif key == u"r" or key == u"_" or key == u"ctrl k":
344
self.proxy.Enable(dbus_interface = client_interface,
347
self.proxy.Disable(dbus_interface = client_interface,
350
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
351
dbus_interface = client_interface,
354
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
355
dbus_interface = client_interface,
357
elif key == "R" or key == "_" or key == "ctrl k":
216
358
self.server_proxy_object.RemoveClient(self.proxy
219
self.proxy.StartChecker()
221
self.proxy.StopChecker()
223
self.proxy.CheckedOK()
362
self.proxy.StartChecker(dbus_interface = client_interface,
365
self.proxy.StopChecker(dbus_interface = client_interface,
368
self.proxy.CheckedOK(dbus_interface = client_interface,
225
# elif key == u"p" or key == "=":
371
# elif key == "p" or key == "=":
226
372
# self.proxy.pause()
227
# elif key == u"u" or key == ":":
373
# elif key == "u" or key == ":":
228
374
# self.proxy.unpause()
229
# elif key == u"RET":
234
def property_changed(self, property=None, value=None,
380
def property_changed(self, property=None, **kwargs):
236
381
"""Call self.update() if old value is not new value.
237
382
This overrides the method from MandosClientPropertyCache"""
238
property_name = unicode(property)
383
property_name = str(property)
239
384
old_value = self.properties.get(property_name)
240
385
super(MandosClientWidget, self).property_changed(
241
property=property, value=value, *args, **kwargs)
386
property=property, **kwargs)
242
387
if self.properties.get(property_name) != old_value:
265
410
self.screen = urwid.curses_display.Screen()
267
412
self.screen.register_palette((
269
u"default", u"default", None),
271
u"default", u"default", u"bold"),
273
u"default", u"default", u"underline"),
275
u"default", u"default", u"standout"),
276
(u"bold-underline-blink",
277
u"default", u"default", (u"bold", u"underline")),
279
u"default", u"default", (u"bold", u"standout")),
280
(u"underline-blink-standout",
281
u"default", u"default", (u"underline", u"standout")),
282
(u"bold-underline-blink-standout",
283
u"default", u"default", (u"bold", u"underline",
414
"default", "default", None),
416
"bold", "default", "bold"),
418
"underline,blink", "default", "underline,blink"),
420
"standout", "default", "standout"),
421
("bold-underline-blink",
422
"bold,underline,blink", "default", "bold,underline,blink"),
424
"bold,standout", "default", "bold,standout"),
425
("underline-blink-standout",
426
"underline,blink,standout", "default",
427
"underline,blink,standout"),
428
("bold-underline-blink-standout",
429
"bold,underline,blink,standout", "default",
430
"bold,underline,blink,standout"),
287
433
if urwid.supports_unicode():
288
self.divider = u"─" # \u2500
289
#self.divider = u"━" # \u2501
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
291
#self.divider = u"-" # \u002d
292
self.divider = u"_" # \u005f
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
294
440
self.screen.start()
309
455
# This keeps track of whether self.uilist currently has
310
456
# self.logbox in it or not
311
457
self.log_visible = True
312
self.log_wrap = u"any"
458
self.log_wrap = "any"
315
self.log_message_raw((u"bold",
316
u"Mandos Monitor version " + version))
317
self.log_message_raw((u"bold",
461
self.log_message_raw(("bold",
462
"Mandos Monitor version " + version))
463
self.log_message_raw(("bold",
320
466
self.busname = domain + '.Mandos'
321
467
self.main_loop = gobject.MainLoop()
322
self.bus = dbus.SystemBus()
323
mandos_dbus_objc = self.bus.get_object(
324
self.busname, u"/", follow_name_owner_changes=True)
325
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
329
mandos_clients = (self.mandos_serv
330
.GetAllClientsWithProperties())
331
except dbus.exceptions.DBusException:
332
mandos_clients = dbus.Dictionary()
335
.connect_to_signal(u"ClientRemoved",
336
self.find_and_remove_client,
337
dbus_interface=server_interface,
340
.connect_to_signal(u"ClientAdded",
342
dbus_interface=server_interface,
345
.connect_to_signal(u"ClientNotFound",
346
self.client_not_found,
347
dbus_interface=server_interface,
349
for path, client in mandos_clients.iteritems():
350
client_proxy_object = self.bus.get_object(self.busname,
352
self.add_client(MandosClientWidget(server_proxy_object
355
=client_proxy_object,
365
469
def client_not_found(self, fingerprint, address):
366
self.log_message((u"Client with address %s and fingerprint %s"
367
u" could not be found" % (address,
470
self.log_message("Client with address {0} and fingerprint"
471
" {1} could not be found"
472
.format(address, fingerprint))
370
474
def rebuild(self):
371
475
"""This rebuilds the User Interface.
372
476
Call this when the widget layout needs to change"""
374
478
#self.uilist.append(urwid.ListBox(self.clients))
375
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
479
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
376
481
#header=urwid.Divider(),
378
footer=urwid.Divider(div_char=self.divider)))
484
urwid.Divider(div_char=
379
486
if self.log_visible:
380
487
self.uilist.append(self.logbox)
382
488
self.topwidget = urwid.Pile(self.uilist)
384
490
def log_message(self, message):
491
"""Log message formatted with timestamp"""
385
492
timestamp = datetime.datetime.now().isoformat()
386
self.log_message_raw(timestamp + u": " + message)
493
self.log_message_raw(timestamp + ": " + message)
388
495
def log_message_raw(self, markup):
389
496
"""Add a log message to the log buffer."""
392
499
and len(self.log) > self.max_log_length):
393
500
del self.log[0:len(self.log)-self.max_log_length-1]
394
501
self.logbox.set_focus(len(self.logbox.body.contents),
395
coming_from=u"above")
398
505
def toggle_log_display(self):
399
506
"""Toggle visibility of the log buffer."""
400
507
self.log_visible = not self.log_visible
402
self.log_message(u"Log visibility changed to: "
403
+ unicode(self.log_visible))
509
#self.log_message("Log visibility changed to: "
510
# + str(self.log_visible))
405
512
def change_log_display(self):
406
513
"""Change type of log display.
407
514
Currently, this toggles wrapping of text lines."""
408
if self.log_wrap == u"clip":
409
self.log_wrap = u"any"
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
411
self.log_wrap = u"clip"
518
self.log_wrap = "clip"
412
519
for textwidget in self.log:
413
520
textwidget.set_wrap_mode(self.log_wrap)
414
self.log_message(u"Wrap mode: " + self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
416
523
def find_and_remove_client(self, path, name):
417
"""Find an client from its object path and remove it.
524
"""Find a client by its object path and remove it.
419
526
This is connected to the ClientRemoved signal from the
420
527
Mandos server object."""
468
572
"""Start the main loop and exit when it's done."""
573
self.bus = dbus.SystemBus()
574
mandos_dbus_objc = self.bus.get_object(
575
self.busname, "/", follow_name_owner_changes=True)
576
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
580
mandos_clients = (self.mandos_serv
581
.GetAllClientsWithProperties())
582
if not mandos_clients:
583
self.log_message_raw(("bold", "Note: Server has no clients."))
584
except dbus.exceptions.DBusException:
585
self.log_message_raw(("bold", "Note: No Mandos server running."))
586
mandos_clients = dbus.Dictionary()
589
.connect_to_signal("ClientRemoved",
590
self.find_and_remove_client,
591
dbus_interface=server_interface,
594
.connect_to_signal("ClientAdded",
596
dbus_interface=server_interface,
599
.connect_to_signal("ClientNotFound",
600
self.client_not_found,
601
dbus_interface=server_interface,
603
for path, client in mandos_clients.items():
604
client_proxy_object = self.bus.get_object(self.busname,
606
self.add_client(MandosClientWidget(server_proxy_object
609
=client_proxy_object,
470
620
self._input_callback_tag = (gobject.io_add_watch
471
621
(sys.stdin.fileno(),
497
647
except KeyError: # :-)
500
if key == u"q" or key == u"Q":
650
if key == "q" or key == "Q":
503
elif key == u"window resize":
653
elif key == "window resize":
504
654
self.size = self.screen.get_cols_rows()
506
elif key == u"\f": # Ctrl-L
656
elif key == "\f": # Ctrl-L
508
elif key == u"l" or key == u"D":
658
elif key == "l" or key == "D":
509
659
self.toggle_log_display()
511
elif key == u"w" or key == u"i":
661
elif key == "w" or key == "i":
512
662
self.change_log_display()
514
elif key == u"?" or key == u"f1" or key == u"esc":
664
elif key == "?" or key == "f1" or key == "esc":
515
665
if not self.log_visible:
516
666
self.log_visible = True
518
self.log_message_raw((u"bold",
522
u"l: Log window toggle",
523
u"TAB: Switch window",
525
self.log_message_raw((u"bold",
531
u"s: Start new checker",
668
self.log_message_raw(("bold",
672
"l: Log window toggle",
673
"TAB: Switch window",
675
self.log_message_raw(("bold",
681
"s: Start new checker",
536
688
if self.topwidget.get_focus() is self.logbox:
537
689
self.topwidget.set_focus(0)
539
691
self.topwidget.set_focus(self.logbox)
541
#elif (key == u"end" or key == u"meta >" or key == u"G"
693
#elif (key == "end" or key == "meta >" or key == "G"
543
695
# pass # xxx end-of-buffer
544
#elif (key == u"home" or key == u"meta <" or key == u"g"
696
#elif (key == "home" or key == "meta <" or key == "g"
546
698
# pass # xxx beginning-of-buffer
547
#elif key == u"ctrl e" or key == u"$":
699
#elif key == "ctrl e" or key == "$":
548
700
# pass # xxx move-end-of-line
549
#elif key == u"ctrl a" or key == u"^":
701
#elif key == "ctrl a" or key == "^":
550
702
# pass # xxx move-beginning-of-line
551
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
#elif key == "ctrl b" or key == "meta (" or key == "h":
552
704
# pass # xxx left
553
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
#elif key == "ctrl f" or key == "meta )" or key == "l":
554
706
# pass # xxx right
556
708
# pass # scroll up log
558
710
# pass # scroll down log
559
711
elif self.topwidget.selectable():
560
712
self.topwidget.keypress(self.size, key)