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'
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)
65
43
def isoformat_to_datetime(iso):
66
44
"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)
47
d, t = iso.split(u"T", 1)
48
year, month, day = d.split(u"-", 2)
49
hour, minute, second = t.split(u":", 2)
72
50
second, fraction = divmod(float(second), 1)
73
51
return datetime.datetime(int(year),
83
61
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
64
def __init__(self, proxy_object=None, *args, **kwargs):
87
65
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)
67
self.properties = dict()
68
self.proxy.connect_to_signal(u"PropertyChanged",
69
self.property_changed,
73
self.properties.update(
74
self.proxy.GetAll(client_interface,
75
dbus_interface = dbus.PROPERTIES_IFACE))
77
#XXX This break good super behaviour!
78
# super(MandosClientPropertyCache, self).__init__(
107
81
def property_changed(self, property=None, value=None):
108
82
"""This is called whenever we get a PropertyChanged signal
131
102
self.logger = logger
133
104
self._update_timer_callback_tag = None
105
self.last_checker_failed = False
135
107
# The widget shown normally
136
self._text_widget = urwid.Text("")
108
self._text_widget = urwid.Text(u"")
137
109
# The widget shown when we have focus
138
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
110
self._focus_text_widget = urwid.Text(u"")
111
super(MandosClientWidget, self).__init__(
112
update_hook=update_hook, delete_hook=delete_hook,
141
115
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
116
self.proxy.connect_to_signal(u"CheckerCompleted",
117
self.checker_completed,
120
self.proxy.connect_to_signal(u"CheckerStarted",
121
self.checker_started,
124
self.proxy.connect_to_signal(u"GotSecret",
128
self.proxy.connect_to_signal(u"NeedApproval",
132
self.proxy.connect_to_signal(u"Rejected",
136
last_checked_ok = isoformat_to_datetime(self.properties
138
if last_checked_ok is None:
139
self.last_checker_failed = True
141
self.last_checker_failed = ((datetime.datetime.utcnow()
147
if self.last_checker_failed:
173
148
self._update_timer_callback_tag = (gobject.timeout_add
175
150
self.update_timer))
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
180
152
def checker_completed(self, exitstatus, condition, command):
181
153
if exitstatus == 0:
154
if self.last_checker_failed:
155
self.last_checker_failed = False
156
gobject.source_remove(self._update_timer_callback_tag)
157
self._update_timer_callback_tag = None
158
#self.logger(u'Checker for client %s (command "%s")'
160
# % (self.properties[u"Name"], command))
164
if not self.last_checker_failed:
165
self.last_checker_failed = True
166
self._update_timer_callback_tag = (gobject.timeout_add
185
169
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)))
170
self.logger(u'Checker for client %s (command "%s")'
171
u' failed with exit code %s'
172
% (self.properties[u"Name"], command,
173
os.WEXITSTATUS(condition)))
190
174
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)))
175
self.logger(u'Checker for client %s (command "%s")'
176
u' was killed by signal %s'
177
% (self.properties[u"Name"], command,
178
os.WTERMSIG(condition)))
195
179
elif os.WCOREDUMP(condition):
196
self.logger('Checker for client {0} (command "{1}")'
198
.format(self.properties["Name"], command))
180
self.logger(u'Checker for client %s (command "%s")'
182
% (self.properties[u"Name"], command))
200
self.logger('Checker for client {0} completed'
202
.format(self.properties["Name"]))
184
self.logger(u'Checker for client %s completed'
205
188
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"],
189
#self.logger(u'Client %s started checker "%s"'
190
# % (self.properties[u"Name"], unicode(command)))
213
193
def got_secret(self):
214
self.logger('Client {0} received its secret'
215
.format(self.properties["Name"]))
194
self.last_checker_failed = False
195
self.logger(u'Client %s received its secret'
196
% self.properties[u"Name"])
217
198
def need_approval(self, timeout, default):
219
message = 'Client {0} needs approval within {1} seconds'
200
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"],
202
message = u'Client %s will get its secret in %s seconds'
204
% (self.properties[u"Name"], timeout/1000))
225
206
def rejected(self, reason):
226
self.logger('Client {0} was rejected; reason: {1}'
227
.format(self.properties["Name"], reason))
207
self.logger(u'Client %s was rejected; reason: %s'
208
% (self.properties[u"Name"], reason))
229
210
def selectable(self):
230
211
"""Make this a "selectable" widget.
231
212
This overrides the method from urwid.FlowWidget."""
234
def rows(self, maxcolrow, focus=False):
215
def rows(self, (maxcol,), focus=False):
235
216
"""How many rows this widget will occupy might depend on
236
217
whether we have focus or not.
237
218
This overrides the method from urwid.FlowWidget"""
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
219
return self.current_widget(focus).rows((maxcol,), focus=focus)
240
221
def current_widget(self, focus=False):
241
222
if focus or self.opened:
245
226
def update(self):
246
227
"Called when what is visible on the screen should be updated."
247
228
# 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",
229
with_standout = { u"normal": u"standout",
230
u"bold": u"bold-standout",
232
u"underline-blink-standout",
233
u"bold-underline-blink":
234
u"bold-underline-blink-standout",
256
237
# Rebuild focus and non-focus widgets using current properties
258
239
# 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"]:
240
base = (u'%(name)s: '
241
% {u"name": self.properties[u"Name"]})
242
if not self.properties[u"Enabled"]:
243
message = u"DISABLED"
244
elif self.properties[u"ApprovalPending"]:
245
if self.properties[u"ApprovedByDefault"]:
246
message = u"Connection established to client. (d)eny?"
248
message = u"Seeks approval to send secret. (a)pprove?"
249
elif self.last_checker_failed:
264
250
timeout = datetime.timedelta(milliseconds
265
251
= self.properties
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)
253
last_ok = isoformat_to_datetime(
254
max((self.properties[u"LastCheckedOK"]
255
or self.properties[u"Created"]),
256
self.properties[u"LastEnabled"]))
257
timer = timeout - (datetime.datetime.utcnow() - last_ok)
258
message = (u'A checker has failed! Time until client'
259
u' gets disabled: %s'
260
% unicode(timer).rsplit(".", 1)[0])
297
self.using_timer(False)
298
self._text = "{0}{1}".format(base, message)
263
self._text = "%s%s" % (base, message)
300
265
if not urwid.supports_unicode():
301
266
self._text = self._text.encode("ascii", "replace")
302
textlist = [("normal", self._text)]
267
textlist = [(u"normal", self._text)]
303
268
self._text_widget.set_text(textlist)
304
269
self._focus_text_widget.set_text([(with_standout[text[0]],
314
279
self.update_hook()
316
281
def update_timer(self):
317
"""called by gobject. Will indefinitely loop until
318
gobject.source_remove() on tag is called"""
320
284
return True # Keep calling this
322
def delete(self, **kwargs):
323
287
if self._update_timer_callback_tag is not None:
324
288
gobject.source_remove(self._update_timer_callback_tag)
325
289
self._update_timer_callback_tag = None
326
for match in self.match_objects:
328
self.match_objects = ()
329
290
if self.delete_hook is not None:
330
291
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
333
def render(self, maxcolrow, focus=False):
293
def render(self, (maxcol,), focus=False):
334
294
"""Render differently if we have focus.
335
295
This overrides the method from urwid.FlowWidget"""
336
return self.current_widget(focus).render(maxcolrow,
296
return self.current_widget(focus).render((maxcol,),
339
def keypress(self, maxcolrow, key):
299
def keypress(self, (maxcol,), key):
341
301
This overrides the method from urwid.FlowWidget"""
343
self.proxy.Enable(dbus_interface = client_interface,
346
self.proxy.Disable(dbus_interface = client_interface,
303
self.proxy.Enable(dbus_interface = client_interface)
305
self.proxy.Disable(dbus_interface = client_interface)
349
307
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface = client_interface,
308
dbus_interface = client_interface)
353
310
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface = client_interface,
356
elif key == "R" or key == "_" or key == "ctrl k":
311
dbus_interface = client_interface)
312
elif key == u"r" or key == u"_" or key == u"ctrl k":
357
313
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,
316
self.proxy.StartChecker(dbus_interface = client_interface)
318
self.proxy.StopChecker(dbus_interface = client_interface)
320
self.proxy.CheckedOK(dbus_interface = client_interface)
370
# elif key == "p" or key == "=":
322
# elif key == u"p" or key == "=":
371
323
# self.proxy.pause()
372
# elif key == "u" or key == ":":
324
# elif key == u"u" or key == ":":
373
325
# self.proxy.unpause()
326
# elif key == u"RET":
379
def property_changed(self, property=None, **kwargs):
331
def property_changed(self, property=None, value=None,
380
333
"""Call self.update() if old value is not new value.
381
334
This overrides the method from MandosClientPropertyCache"""
382
property_name = str(property)
335
property_name = unicode(property)
383
336
old_value = self.properties.get(property_name)
384
337
super(MandosClientWidget, self).property_changed(
385
property=property, **kwargs)
338
property=property, value=value, *args, **kwargs)
386
339
if self.properties.get(property_name) != old_value:
409
363
self.screen = urwid.curses_display.Screen()
411
365
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"),
367
u"default", u"default", None),
369
u"default", u"default", u"bold"),
371
u"default", u"default", u"underline"),
373
u"default", u"default", u"standout"),
374
(u"bold-underline-blink",
375
u"default", u"default", (u"bold", u"underline")),
377
u"default", u"default", (u"bold", u"standout")),
378
(u"underline-blink-standout",
379
u"default", u"default", (u"underline", u"standout")),
380
(u"bold-underline-blink-standout",
381
u"default", u"default", (u"bold", u"underline",
432
385
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
386
self.divider = u"─" # \u2500
387
#self.divider = u"━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
389
#self.divider = u"-" # \u002d
390
self.divider = u"_" # \u005f
439
392
self.screen.start()
454
407
# This keeps track of whether self.uilist currently has
455
408
# self.logbox in it or not
456
409
self.log_visible = True
457
self.log_wrap = "any"
410
self.log_wrap = u"any"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
413
self.log_message_raw((u"bold",
414
u"Mandos Monitor version " + version))
415
self.log_message_raw((u"bold",
465
418
self.busname = domain + '.Mandos'
466
419
self.main_loop = gobject.MainLoop()
420
self.bus = dbus.SystemBus()
421
mandos_dbus_objc = self.bus.get_object(
422
self.busname, u"/", follow_name_owner_changes=True)
423
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
427
mandos_clients = (self.mandos_serv
428
.GetAllClientsWithProperties())
429
except dbus.exceptions.DBusException:
430
mandos_clients = dbus.Dictionary()
433
.connect_to_signal(u"ClientRemoved",
434
self.find_and_remove_client,
435
dbus_interface=server_interface,
438
.connect_to_signal(u"ClientAdded",
440
dbus_interface=server_interface,
443
.connect_to_signal(u"ClientNotFound",
444
self.client_not_found,
445
dbus_interface=server_interface,
447
for path, client in mandos_clients.iteritems():
448
client_proxy_object = self.bus.get_object(self.busname,
450
self.add_client(MandosClientWidget(server_proxy_object
453
=client_proxy_object,
468
463
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))
464
self.log_message((u"Client with address %s and fingerprint %s"
465
u" could not be found" % (address,
473
468
def rebuild(self):
474
469
"""This rebuilds the User Interface.
498
493
and len(self.log) > self.max_log_length):
499
494
del self.log[0:len(self.log)-self.max_log_length-1]
500
495
self.logbox.set_focus(len(self.logbox.body.contents),
496
coming_from=u"above")
504
499
def toggle_log_display(self):
505
500
"""Toggle visibility of the log buffer."""
506
501
self.log_visible = not self.log_visible
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
503
#self.log_message(u"Log visibility changed to: "
504
# + unicode(self.log_visible))
511
506
def change_log_display(self):
512
507
"""Change type of log display.
513
508
Currently, this toggles wrapping of text lines."""
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
509
if self.log_wrap == u"clip":
510
self.log_wrap = u"any"
517
self.log_wrap = "clip"
512
self.log_wrap = u"clip"
518
513
for textwidget in self.log:
519
514
textwidget.set_wrap_mode(self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
515
#self.log_message(u"Wrap mode: " + self.log_wrap)
522
517
def find_and_remove_client(self, path, name):
523
"""Find a client by its object path and remove it.
518
"""Find an client from its object path and remove it.
525
520
This is connected to the ClientRemoved signal from the
526
521
Mandos server object."""
571
569
"""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
571
self._input_callback_tag = (gobject.io_add_watch
620
572
(sys.stdin.fileno(),
646
598
except KeyError: # :-)
649
if key == "q" or key == "Q":
601
if key == u"q" or key == u"Q":
652
elif key == "window resize":
604
elif key == u"window resize":
653
605
self.size = self.screen.get_cols_rows()
655
elif key == "\f": # Ctrl-L
607
elif key == u"\f": # Ctrl-L
657
elif key == "l" or key == "D":
609
elif key == u"l" or key == u"D":
658
610
self.toggle_log_display()
660
elif key == "w" or key == "i":
612
elif key == u"w" or key == u"i":
661
613
self.change_log_display()
663
elif key == "?" or key == "f1" or key == "esc":
615
elif key == u"?" or key == u"f1" or key == u"esc":
664
616
if not self.log_visible:
665
617
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",
619
self.log_message_raw((u"bold",
623
u"l: Log window toggle",
624
u"TAB: Switch window",
626
self.log_message_raw((u"bold",
632
u"s: Start new checker",
687
639
if self.topwidget.get_focus() is self.logbox:
688
640
self.topwidget.set_focus(0)
690
642
self.topwidget.set_focus(self.logbox)
692
#elif (key == "end" or key == "meta >" or key == "G"
644
#elif (key == u"end" or key == u"meta >" or key == u"G"
694
646
# pass # xxx end-of-buffer
695
#elif (key == "home" or key == "meta <" or key == "g"
647
#elif (key == u"home" or key == u"meta <" or key == u"g"
697
649
# pass # xxx beginning-of-buffer
698
#elif key == "ctrl e" or key == "$":
650
#elif key == u"ctrl e" or key == u"$":
699
651
# pass # xxx move-end-of-line
700
#elif key == "ctrl a" or key == "^":
652
#elif key == u"ctrl a" or key == u"^":
701
653
# pass # xxx move-beginning-of-line
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
654
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
655
# pass # xxx left
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
656
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
657
# pass # xxx right
707
659
# pass # scroll up log
709
661
# pass # scroll down log
710
662
elif self.topwidget.selectable():
711
663
self.topwidget.keypress(self.size, key)