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
38
9
import urwid.curses_display
41
12
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
19
# Some useful constants
60
domain = 'se.recompile'
20
domain = 'se.bsnet.fukt'
61
21
server_interface = domain + '.Mandos'
62
22
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
25
# Always run in monochrome mode
26
urwid.curses_display.curses.has_colors = lambda : False
28
# Urwid doesn't support blinking, but we want it. Since we have no
29
# use for underline on its own, we make underline also always blink.
30
urwid.curses_display.curses.A_UNDERLINE |= (
31
urwid.curses_display.curses.A_BLINK)
81
33
class MandosClientPropertyCache(object):
82
34
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
35
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
38
def __init__(self, proxy_object=None, properties=None, *args,
87
40
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)
42
if properties is None:
43
self.properties = dict()
45
self.properties = properties
46
self.proxy.connect_to_signal("PropertyChanged",
47
self.property_changed,
51
if properties is None:
52
self.properties.update(self.proxy.GetAll(client_interface,
54
dbus.PROPERTIES_IFACE))
55
super(MandosClientPropertyCache, self).__init__(
56
proxy_object=proxy_object,
57
properties=properties, *args, **kwargs)
107
59
def property_changed(self, property=None, value=None):
108
60
"""This is called whenever we get a PropertyChanged signal
122
71
def __init__(self, server_proxy_object=None, update_hook=None,
123
delete_hook=None, logger=None, **kwargs):
72
delete_hook=None, *args, **kwargs):
124
73
# Called on update
125
74
self.update_hook = update_hook
126
75
# Called on delete
127
76
self.delete_hook = delete_hook
128
77
# Mandos Server proxy object
129
78
self.server_proxy_object = server_proxy_object
133
self._update_timer_callback_tag = None
135
80
# The widget shown normally
136
81
self._text_widget = urwid.Text("")
137
82
# The widget shown when we have focus
138
83
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(**kwargs)
84
super(MandosClientWidget, self).__init__(
85
update_hook=update_hook, delete_hook=delete_hook,
141
88
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
180
def checker_completed(self, exitstatus, condition, command):
185
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"]))
205
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"],
213
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))
229
90
def selectable(self):
230
91
"""Make this a "selectable" widget.
231
92
This overrides the method from urwid.FlowWidget."""
234
def rows(self, maxcolrow, focus=False):
95
def rows(self, (maxcol,), focus=False):
235
96
"""How many rows this widget will occupy might depend on
236
97
whether we have focus or not.
237
98
This overrides the method from urwid.FlowWidget"""
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
240
101
def current_widget(self, focus=False):
241
102
if focus or self.opened:
245
106
def update(self):
246
107
"Called when what is visible on the screen should be updated."
247
108
# 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",
109
with_standout = { u"normal": u"standout",
110
u"bold": u"bold-standout",
112
u"underline-blink-standout",
113
u"bold-underline-blink":
114
u"bold-underline-blink-standout",
256
117
# 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)
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
300
120
if not urwid.supports_unicode():
301
121
self._text = self._text.encode("ascii", "replace")
302
textlist = [("normal", self._text)]
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
303
123
self._text_widget.set_text(textlist)
304
124
self._focus_text_widget.set_text([(with_standout[text[0]],
313
133
if self.update_hook is not None:
314
134
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
137
if self.delete_hook is not None:
330
138
self.delete_hook(self)
331
return super(MandosClientWidget, self).delete(**kwargs)
333
def render(self, maxcolrow, focus=False):
140
def render(self, (maxcol,), focus=False):
334
141
"""Render differently if we have focus.
335
142
This overrides the method from urwid.FlowWidget"""
336
return self.current_widget(focus).render(maxcolrow,
143
return self.current_widget(focus).render((maxcol,),
339
def keypress(self, maxcolrow, key):
146
def keypress(self, (maxcol,), key):
341
148
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":
149
if key == u"e" or key == u"+":
151
elif key == u"d" or key == u"-":
153
elif key == u"r" or key == u"_" or key == u"ctrl k":
357
154
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,
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
370
# elif key == "p" or key == "=":
163
# elif key == u"p" or key == "=":
371
164
# self.proxy.pause()
372
# elif key == "u" or key == ":":
165
# elif key == u"u" or key == ":":
373
166
# self.proxy.unpause()
167
# elif key == u"RET":
379
def property_changed(self, property=None, **kwargs):
172
def property_changed(self, property=None, value=None,
380
174
"""Call self.update() if old value is not new value.
381
175
This overrides the method from MandosClientPropertyCache"""
382
property_name = str(property)
176
property_name = unicode(property)
383
177
old_value = self.properties.get(property_name)
384
178
super(MandosClientWidget, self).property_changed(
385
property=property, **kwargs)
179
property=property, value=value, *args, **kwargs)
386
180
if self.properties.get(property_name) != old_value:
409
203
self.screen = urwid.curses_display.Screen()
411
205
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"),
207
u"default", u"default", None),
209
u"default", u"default", u"bold"),
211
u"default", u"default", u"underline"),
213
u"default", u"default", u"standout"),
214
(u"bold-underline-blink",
215
u"default", u"default", (u"bold", u"underline")),
217
u"default", u"default", (u"bold", u"standout")),
218
(u"underline-blink-standout",
219
u"default", u"default", (u"underline", u"standout")),
220
(u"bold-underline-blink-standout",
221
u"default", u"default", (u"bold", u"underline",
432
225
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
226
self.divider = u"─" # \u2500
227
#self.divider = u"━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
439
232
self.screen.start()
454
247
# This keeps track of whether self.uilist currently has
455
248
# self.logbox in it or not
456
249
self.log_visible = True
457
self.log_wrap = "any"
250
self.log_wrap = u"any"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
465
258
self.busname = domain + '.Mandos'
466
259
self.main_loop = gobject.MainLoop()
468
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))
260
self.bus = dbus.SystemBus()
261
mandos_dbus_objc = self.bus.get_object(
262
self.busname, u"/", follow_name_owner_changes=True)
263
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
267
mandos_clients = (self.mandos_serv
268
.GetAllClientsWithProperties())
269
except dbus.exceptions.DBusException:
270
mandos_clients = dbus.Dictionary()
273
.connect_to_signal("ClientRemoved",
274
self.find_and_remove_client,
275
dbus_interface=server_interface,
278
.connect_to_signal("ClientAdded",
280
dbus_interface=server_interface,
282
for path, client in mandos_clients.iteritems():
283
client_proxy_object = self.bus.get_object(self.busname,
285
self.add_client(MandosClientWidget(server_proxy_object
288
=client_proxy_object,
293
=self.remove_client),
473
296
def rebuild(self):
474
297
"""This rebuilds the User Interface.
475
298
Call this when the widget layout needs to change"""
477
300
#self.uilist.append(urwid.ListBox(self.clients))
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
480
302
#header=urwid.Divider(),
483
urwid.Divider(div_char=
304
footer=urwid.Divider(div_char=self.divider)))
485
305
if self.log_visible:
486
306
self.uilist.append(self.logbox)
487
308
self.topwidget = urwid.Pile(self.uilist)
489
def log_message(self, message):
490
"""Log message formatted with timestamp"""
491
timestamp = datetime.datetime.now().isoformat()
492
self.log_message_raw(timestamp + ": " + message)
494
def log_message_raw(self, markup):
310
def log_message(self, markup):
495
311
"""Add a log message to the log buffer."""
496
312
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
313
if (self.max_log_length
498
314
and len(self.log) > self.max_log_length):
499
315
del self.log[0:len(self.log)-self.max_log_length-1]
500
316
self.logbox.set_focus(len(self.logbox.body.contents),
317
coming_from=u"above")
504
319
def toggle_log_display(self):
505
320
"""Toggle visibility of the log buffer."""
506
321
self.log_visible = not self.log_visible
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
323
self.log_message(u"Log visibility changed to: "
324
+ unicode(self.log_visible))
511
326
def change_log_display(self):
512
327
"""Change type of log display.
513
328
Currently, this toggles wrapping of text lines."""
514
if self.log_wrap == "clip":
515
self.log_wrap = "any"
329
if self.log_wrap == u"clip":
330
self.log_wrap = u"any"
517
self.log_wrap = "clip"
332
self.log_wrap = u"clip"
518
333
for textwidget in self.log:
519
334
textwidget.set_wrap_mode(self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
335
self.log_message(u"Wrap mode: " + self.log_wrap)
522
337
def find_and_remove_client(self, path, name):
523
"""Find a client by its object path and remove it.
338
"""Find an client from its object path and remove it.
525
340
This is connected to the ClientRemoved signal from the
526
341
Mandos server object."""
571
388
"""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
390
self._input_callback_tag = (gobject.io_add_watch
620
391
(sys.stdin.fileno(),
631
402
def process_input(self, source, condition):
632
403
keys = self.screen.get_input()
633
translations = { "ctrl n": "down", # Emacs
634
"ctrl p": "up", # Emacs
635
"ctrl v": "page down", # Emacs
636
"meta v": "page up", # Emacs
637
" ": "page down", # less
638
"f": "page down", # less
639
"b": "page up", # less
404
translations = { u"ctrl n": u"down", # Emacs
405
u"ctrl p": u"up", # Emacs
406
u"ctrl v": u"page down", # Emacs
407
u"meta v": u"page up", # Emacs
408
u" ": u"page down", # less
409
u"f": u"page down", # less
410
u"b": u"page up", # less
646
417
except KeyError: # :-)
649
if key == "q" or key == "Q":
420
if key == u"q" or key == u"Q":
652
elif key == "window resize":
423
elif key == u"window resize":
653
424
self.size = self.screen.get_cols_rows()
655
elif key == "\f": # Ctrl-L
426
elif key == u"\f": # Ctrl-L
657
elif key == "l" or key == "D":
428
elif key == u"l" or key == u"D":
658
429
self.toggle_log_display()
660
elif key == "w" or key == "i":
431
elif key == u"w" or key == u"i":
661
432
self.change_log_display()
663
elif key == "?" or key == "f1" or key == "esc":
434
elif key == u"?" or key == u"f1" or key == u"esc":
664
435
if not self.log_visible:
665
436
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",
438
self.log_message((u"bold",
439
u" ".join((u"q: Quit",
441
u"l: Log window toggle",
442
u"TAB: Switch window",
444
self.log_message((u"bold",
445
u" ".join((u"Clients:",
449
u"s: Start new checker",
687
454
if self.topwidget.get_focus() is self.logbox:
688
455
self.topwidget.set_focus(0)
690
457
self.topwidget.set_focus(self.logbox)
692
#elif (key == "end" or key == "meta >" or key == "G"
459
#elif (key == u"end" or key == u"meta >" or key == u"G"
694
461
# pass # xxx end-of-buffer
695
#elif (key == "home" or key == "meta <" or key == "g"
462
#elif (key == u"home" or key == u"meta <" or key == u"g"
697
464
# pass # xxx beginning-of-buffer
698
#elif key == "ctrl e" or key == "$":
465
#elif key == u"ctrl e" or key == u"$":
699
466
# pass # xxx move-end-of-line
700
#elif key == "ctrl a" or key == "^":
467
#elif key == u"ctrl a" or key == u"^":
701
468
# pass # xxx move-beginning-of-line
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
469
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
703
470
# pass # xxx left
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
471
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
705
472
# pass # xxx right
707
474
# pass # scroll up log
709
476
# pass # scroll down log
710
477
elif self.topwidget.selectable():
711
478
self.topwidget.keypress(self.size, key)