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, '')
24
locale.setlocale(locale.LC_ALL, u'')
57
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
59
29
# Some useful constants
60
domain = 'se.recompile'
30
domain = 'se.bsnet.fukt'
61
31
server_interface = domain + '.Mandos'
62
32
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
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)
81
43
class MandosClientPropertyCache(object):
82
44
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
45
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
48
def __init__(self, proxy_object=None, *args, **kwargs):
87
49
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)
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))
61
#XXX This break good super behaviour!
62
# super(MandosClientPropertyCache, self).__init__(
107
65
def property_changed(self, property=None, value=None):
108
66
"""This is called whenever we get a PropertyChanged signal
131
86
self.logger = logger
133
self._update_timer_callback_tag = None
135
88
# The widget shown normally
136
self._text_widget = urwid.Text("")
89
self._text_widget = urwid.Text(u"")
137
90
# The widget shown when we have focus
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
91
self._focus_text_widget = urwid.Text(u"")
92
super(MandosClientWidget, self).__init__(
93
update_hook=update_hook, delete_hook=delete_hook,
141
96
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
97
self.proxy.connect_to_signal(u"CheckerCompleted",
98
self.checker_completed,
101
self.proxy.connect_to_signal(u"CheckerStarted",
102
self.checker_started,
105
self.proxy.connect_to_signal(u"GotSecret",
109
self.proxy.connect_to_signal(u"NeedApproval",
113
self.proxy.connect_to_signal(u"Rejected",
180
118
def checker_completed(self, exitstatus, condition, command):
181
119
if exitstatus == 0:
120
#self.logger(u'Checker for client %s (command "%s")'
122
# % (self.properties[u"name"], command))
185
124
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"]))
125
self.logger(u'Checker for client %s (command "%s")'
126
u' failed with exit code %s'
127
% (self.properties[u"name"], command,
128
os.WEXITSTATUS(condition)))
130
if os.WIFSIGNALED(condition):
131
self.logger(u'Checker for client %s (command "%s")'
132
u' was killed by signal %s'
133
% (self.properties[u"name"], command,
134
os.WTERMSIG(condition)))
136
if os.WCOREDUMP(condition):
137
self.logger(u'Checker for client %s (command "%s")'
139
% (self.properties[u"name"], command))
140
self.logger(u'Checker for client %s completed mysteriously')
205
142
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"],
143
#self.logger(u'Client %s started checker "%s"'
144
# % (self.properties[u"name"], unicode(command)))
213
147
def got_secret(self):
214
self.logger('Client {0} received its secret'
215
.format(self.properties["Name"]))
148
self.logger(u'Client %s received its secret'
149
% self.properties[u"name"])
217
151
def need_approval(self, timeout, default):
219
message = 'Client {0} needs approval within {1} seconds'
153
message = u'Client %s needs approval within %s seconds'
221
message = 'Client {0} will get its secret in {1} seconds'
222
self.logger(message.format(self.properties["Name"],
155
message = u'Client %s will get its secret in %s seconds'
157
% (self.properties[u"name"], timeout/1000))
225
159
def rejected(self, reason):
226
self.logger('Client {0} was rejected; reason: {1}'
227
.format(self.properties["Name"], reason))
160
self.logger(u'Client %s was rejected; reason: %s'
161
% (self.properties[u"name"], reason))
229
163
def selectable(self):
230
164
"""Make this a "selectable" widget.
231
165
This overrides the method from urwid.FlowWidget."""
234
def rows(self, maxcolrow, focus=False):
168
def rows(self, (maxcol,), focus=False):
235
169
"""How many rows this widget will occupy might depend on
236
170
whether we have focus or not.
237
171
This overrides the method from urwid.FlowWidget"""
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
172
return self.current_widget(focus).rows((maxcol,), focus=focus)
240
174
def current_widget(self, focus=False):
241
175
if focus or self.opened:
245
179
def update(self):
246
180
"Called when what is visible on the screen should be updated."
247
181
# 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",
182
with_standout = { u"normal": u"standout",
183
u"bold": u"bold-standout",
185
u"underline-blink-standout",
186
u"bold-underline-blink":
187
u"bold-underline-blink-standout",
256
190
# Rebuild focus and non-focus widgets using current properties
258
192
# 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)
193
self._text = (u'%(name)s: '
194
% {u"name": self.properties[u"name"]})
196
if self.properties[u"approved_pending"]:
197
if self.properties[u"approved_by_default"]:
198
self._text += u"Connection established to client. (d)eny?"
200
self._text += u"Seeks approval to send secret. (a)pprove?"
297
self.using_timer(False)
298
self._text = "{0}{1}".format(base, message)
202
self._text += (u'%(enabled)s'
205
if self.properties[u"enabled"]
300
207
if not urwid.supports_unicode():
301
208
self._text = self._text.encode("ascii", "replace")
302
textlist = [("normal", self._text)]
209
textlist = [(u"normal", self._text)]
303
210
self._text_widget.set_text(textlist)
304
211
self._focus_text_widget.set_text([(with_standout[text[0]],
313
220
if self.update_hook is not None:
314
221
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
224
if self.delete_hook is not None:
330
225
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
333
def render(self, maxcolrow, focus=False):
227
def render(self, (maxcol,), focus=False):
334
228
"""Render differently if we have focus.
335
229
This overrides the method from urwid.FlowWidget"""
336
return self.current_widget(focus).render(maxcolrow,
230
return self.current_widget(focus).render((maxcol,),
339
def keypress(self, maxcolrow, key):
233
def keypress(self, (maxcol,), key):
341
235
This overrides the method from urwid.FlowWidget"""
343
self.proxy.Enable(dbus_interface = client_interface,
346
self.proxy.Disable(dbus_interface = client_interface,
237
self.proxy.Enable(dbus_interface = client_interface)
239
self.proxy.Disable(dbus_interface = client_interface)
349
241
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface = client_interface,
242
dbus_interface = client_interface)
353
244
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface = client_interface,
356
elif key == "R" or key == "_" or key == "ctrl k":
245
dbus_interface = client_interface)
246
elif key == u"r" or key == u"_" or key == u"ctrl k":
357
247
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,
250
self.proxy.StartChecker(dbus_interface = client_interface)
252
self.proxy.StopChecker(dbus_interface = client_interface)
254
self.proxy.CheckedOK(dbus_interface = client_interface)
370
# elif key == "p" or key == "=":
256
# elif key == u"p" or key == "=":
371
257
# self.proxy.pause()
372
# elif key == "u" or key == ":":
258
# elif key == u"u" or key == ":":
373
259
# self.proxy.unpause()
260
# elif key == u"RET":
263
# self.proxy.Approve(True)
265
# self.proxy.Approve(False)
379
def property_changed(self, property=None, **kwargs):
269
def property_changed(self, property=None, value=None,
380
271
"""Call self.update() if old value is not new value.
381
272
This overrides the method from MandosClientPropertyCache"""
382
property_name = str(property)
273
property_name = unicode(property)
383
274
old_value = self.properties.get(property_name)
384
275
super(MandosClientWidget, self).property_changed(
385
property=property, **kwargs)
276
property=property, value=value, *args, **kwargs)
386
277
if self.properties.get(property_name) != old_value:
409
300
self.screen = urwid.curses_display.Screen()
411
302
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"),
304
u"default", u"default", None),
306
u"default", u"default", u"bold"),
308
u"default", u"default", u"underline"),
310
u"default", u"default", u"standout"),
311
(u"bold-underline-blink",
312
u"default", u"default", (u"bold", u"underline")),
314
u"default", u"default", (u"bold", u"standout")),
315
(u"underline-blink-standout",
316
u"default", u"default", (u"underline", u"standout")),
317
(u"bold-underline-blink-standout",
318
u"default", u"default", (u"bold", u"underline",
432
322
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
323
self.divider = u"─" # \u2500
324
#self.divider = u"━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
326
#self.divider = u"-" # \u002d
327
self.divider = u"_" # \u005f
439
329
self.screen.start()
454
344
# This keeps track of whether self.uilist currently has
455
345
# self.logbox in it or not
456
346
self.log_visible = True
457
self.log_wrap = "any"
347
self.log_wrap = u"any"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
350
self.log_message_raw((u"bold",
351
u"Mandos Monitor version " + version))
352
self.log_message_raw((u"bold",
465
355
self.busname = domain + '.Mandos'
466
356
self.main_loop = gobject.MainLoop()
357
self.bus = dbus.SystemBus()
358
mandos_dbus_objc = self.bus.get_object(
359
self.busname, u"/", follow_name_owner_changes=True)
360
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
364
mandos_clients = (self.mandos_serv
365
.GetAllClientsWithProperties())
366
except dbus.exceptions.DBusException:
367
mandos_clients = dbus.Dictionary()
370
.connect_to_signal(u"ClientRemoved",
371
self.find_and_remove_client,
372
dbus_interface=server_interface,
375
.connect_to_signal(u"ClientAdded",
377
dbus_interface=server_interface,
380
.connect_to_signal(u"ClientNotFound",
381
self.client_not_found,
382
dbus_interface=server_interface,
384
for path, client in mandos_clients.iteritems():
385
client_proxy_object = self.bus.get_object(self.busname,
387
self.add_client(MandosClientWidget(server_proxy_object
390
=client_proxy_object,
468
400
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))
401
self.log_message((u"Client with address %s and fingerprint %s"
402
u" could not be found" % (address,
473
405
def rebuild(self):
474
406
"""This rebuilds the User Interface.
475
407
Call this when the widget layout needs to change"""
477
409
#self.uilist.append(urwid.ListBox(self.clients))
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
410
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
411
#header=urwid.Divider(),
483
urwid.Divider(div_char=
413
footer=urwid.Divider(div_char=self.divider)))
485
414
if self.log_visible:
486
415
self.uilist.append(self.logbox)
487
417
self.topwidget = urwid.Pile(self.uilist)
489
419
def log_message(self, message):
490
"""Log message formatted with timestamp"""
491
420
timestamp = datetime.datetime.now().isoformat()
492
self.log_message_raw(timestamp + ": " + message)
421
self.log_message_raw(timestamp + u": " + message)
494
423
def log_message_raw(self, markup):
495
424
"""Add a log message to the log buffer."""
498
427
and len(self.log) > self.max_log_length):
499
428
del self.log[0:len(self.log)-self.max_log_length-1]
500
429
self.logbox.set_focus(len(self.logbox.body.contents),
430
coming_from=u"above")
504
433
def toggle_log_display(self):
505
434
"""Toggle visibility of the log buffer."""
506
435
self.log_visible = not self.log_visible
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
437
self.log_message(u"Log visibility changed to: "
438
+ unicode(self.log_visible))
511
440
def change_log_display(self):
512
441
"""Change type of log display.
513
442
Currently, this toggles wrapping of text lines."""
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
443
if self.log_wrap == u"clip":
444
self.log_wrap = u"any"
517
self.log_wrap = "clip"
446
self.log_wrap = u"clip"
518
447
for textwidget in self.log:
519
448
textwidget.set_wrap_mode(self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
449
self.log_message(u"Wrap mode: " + self.log_wrap)
522
451
def find_and_remove_client(self, path, name):
523
"""Find a client by its object path and remove it.
452
"""Find an client from its object path and remove it.
525
454
This is connected to the ClientRemoved signal from the
526
455
Mandos server object."""
571
503
"""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
505
self._input_callback_tag = (gobject.io_add_watch
620
506
(sys.stdin.fileno(),
646
532
except KeyError: # :-)
649
if key == "q" or key == "Q":
535
if key == u"q" or key == u"Q":
652
elif key == "window resize":
538
elif key == u"window resize":
653
539
self.size = self.screen.get_cols_rows()
655
elif key == "\f": # Ctrl-L
541
elif key == u"\f": # Ctrl-L
657
elif key == "l" or key == "D":
543
elif key == u"l" or key == u"D":
658
544
self.toggle_log_display()
660
elif key == "w" or key == "i":
546
elif key == u"w" or key == u"i":
661
547
self.change_log_display()
663
elif key == "?" or key == "f1" or key == "esc":
549
elif key == u"?" or key == u"f1" or key == u"esc":
664
550
if not self.log_visible:
665
551
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",
553
self.log_message_raw((u"bold",
557
u"l: Log window toggle",
558
u"TAB: Switch window",
560
self.log_message_raw((u"bold",
566
u"s: Start new checker",
687
573
if self.topwidget.get_focus() is self.logbox:
688
574
self.topwidget.set_focus(0)
690
576
self.topwidget.set_focus(self.logbox)
692
#elif (key == "end" or key == "meta >" or key == "G"
578
#elif (key == u"end" or key == u"meta >" or key == u"G"
694
580
# pass # xxx end-of-buffer
695
#elif (key == "home" or key == "meta <" or key == "g"
581
#elif (key == u"home" or key == u"meta <" or key == u"g"
697
583
# pass # xxx beginning-of-buffer
698
#elif key == "ctrl e" or key == "$":
584
#elif key == u"ctrl e" or key == u"$":
699
585
# pass # xxx move-end-of-line
700
#elif key == "ctrl a" or key == "^":
586
#elif key == u"ctrl a" or key == u"^":
701
587
# pass # xxx move-beginning-of-line
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
588
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
589
# pass # xxx left
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
590
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
591
# pass # xxx right
707
593
# pass # scroll up log
709
595
# pass # scroll down log
710
596
elif self.topwidget.selectable():
711
597
self.topwidget.keypress(self.size, key)