2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2016 Teddy Hogeborn
7
# Copyright © 2009-2016 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 *
9
38
import urwid.curses_display
12
41
from dbus.mainloop.glib import DBusGMainLoop
43
from gi.repository import GObject
45
import gobject as GObject
51
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
19
59
# Some useful constants
20
domain = 'se.bsnet.fukt'
60
domain = 'se.recompile'
21
61
server_interface = domain + '.Mandos'
22
62
client_interface = domain + '.Mandos.Client'
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)
66
dbus.OBJECT_MANAGER_IFACE
67
except AttributeError:
68
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
def isoformat_to_datetime(iso):
71
"Parse an ISO 8601 date string to a datetime.datetime()"
74
d, t = iso.split("T", 1)
75
year, month, day = d.split("-", 2)
76
hour, minute, second = t.split(":", 2)
77
second, fraction = divmod(float(second), 1)
78
return datetime.datetime(int(year),
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
33
86
class MandosClientPropertyCache(object):
34
87
"""This wraps a Mandos Client D-Bus proxy object, caches the
35
88
properties and calls a hook function when any of them are
38
def __init__(self, proxy_object=None, properties=None, *args,
40
# Type conversion mapping
42
dbus.ObjectPath: unicode,
44
dbus.Signature: unicode,
52
dbus.Dictionary: dict,
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
59
92
self.proxy = proxy_object # Mandos Client proxy object
61
if properties is None:
62
self.properties = dict()
64
self.properties = dict(self.convert_property(prop, val)
66
properties.iteritems())
67
self.proxy.connect_to_signal("PropertyChanged",
68
self.property_changed,
93
self.properties = dict() if properties is None else properties
94
self.property_changed_match = (
95
self.proxy.connect_to_signal("PropertiesChanged",
96
self.properties_changed,
97
dbus.PROPERTIES_IFACE,
72
100
if properties is None:
73
101
self.properties.update(
74
self.convert_property(prop, val)
76
102
self.proxy.GetAll(client_interface,
78
dbus.PROPERTIES_IFACE).iteritems())
79
super(MandosClientPropertyCache, self).__init__(
80
proxy_object=proxy_object,
81
properties=properties, *args, **kwargs)
104
= dbus.PROPERTIES_IFACE))
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
83
def convert_property(self, property, value):
84
"""This converts the arguments from a D-Bus signal, which are
85
D-Bus types, into normal Python types, using a conversion
86
function from "self.type_map".
88
property_name = unicode(property) # Always a dbus.String
89
if isinstance(value, dbus.UTF8String):
90
# Should not happen, but prepare for it anyway
91
value = dbus.String(str(value).decode("utf-8"))
93
convfunc = self.type_map[type(value)]
95
# Unknown type, return unmodified
96
return property_name, value
97
return property_name, convfunc(value)
98
def property_changed(self, property=None, value=None):
99
"""This is called whenever we get a PropertyChanged signal
100
It updates the changed property in the "properties" dict.
102
# Convert name and value
103
property_name, cvalue = self.convert_property(property, value)
108
def properties_changed(self, interface, properties, invalidated):
109
"""This is called whenever we get a PropertiesChanged signal
110
It updates the changed properties in the "properties" dict.
104
112
# Update properties dict with new value
105
self.properties[property_name] = cvalue
113
if interface == client_interface:
114
self.properties.update(properties)
117
self.property_changed_match.remove()
108
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
112
124
def __init__(self, server_proxy_object=None, update_hook=None,
113
delete_hook=None, *args, **kwargs):
125
delete_hook=None, logger=None, **kwargs):
114
126
# Called on update
115
127
self.update_hook = update_hook
116
128
# Called on delete
117
129
self.delete_hook = delete_hook
118
130
# Mandos Server proxy object
119
131
self.server_proxy_object = server_proxy_object
135
self._update_timer_callback_tag = None
121
137
# The widget shown normally
122
138
self._text_widget = urwid.Text("")
123
139
# The widget shown when we have focus
124
140
self._focus_text_widget = urwid.Text("")
125
super(MandosClientWidget, self).__init__(
126
update_hook=update_hook, delete_hook=delete_hook,
141
super(MandosClientWidget, self).__init__(**kwargs)
129
143
self.opened = False
145
self.match_objects = (
146
self.proxy.connect_to_signal("CheckerCompleted",
147
self.checker_completed,
150
self.proxy.connect_to_signal("CheckerStarted",
151
self.checker_started,
154
self.proxy.connect_to_signal("GotSecret",
158
self.proxy.connect_to_signal("NeedApproval",
162
self.proxy.connect_to_signal("Rejected",
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
169
def using_timer(self, flag):
170
"""Call this method with True or False when timer should be
171
activated or deactivated.
173
if flag and self._update_timer_callback_tag is None:
174
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GObject.timeout_add
178
elif not (flag or self._update_timer_callback_tag is None):
179
GObject.source_remove(self._update_timer_callback_tag)
180
self._update_timer_callback_tag = None
182
def checker_completed(self, exitstatus, condition, command):
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
195
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
202
def checker_started(self, command):
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
208
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
212
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
220
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
131
224
def selectable(self):
132
225
"""Make this a "selectable" widget.
133
226
This overrides the method from urwid.FlowWidget."""
136
def rows(self, (maxcol,), focus=False):
229
def rows(self, maxcolrow, focus=False):
137
230
"""How many rows this widget will occupy might depend on
138
231
whether we have focus or not.
139
232
This overrides the method from urwid.FlowWidget"""
140
return self.current_widget(focus).rows((maxcol,), focus=focus)
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
142
235
def current_widget(self, focus=False):
143
236
if focus or self.opened:
147
240
def update(self):
148
241
"Called when what is visible on the screen should be updated."
149
242
# How to add standout mode to a style
150
with_standout = { u"normal": u"standout",
151
u"bold": u"bold-standout",
153
u"underline-blink-standout",
154
u"bold-underline-blink":
155
u"bold-underline-blink-standout",
243
with_standout = { "normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
158
251
# Rebuild focus and non-focus widgets using current properties
159
self._text = (u'name="%(name)s", enabled=%(enabled)s'
253
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
255
if not self.properties["Enabled"]:
257
self.using_timer(False)
258
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(milliseconds
262
last_approval_request = isoformat_to_datetime(
263
self.properties["LastApprovalRequest"])
264
if last_approval_request is not None:
265
timer = max(timeout - (datetime.datetime.utcnow()
266
- last_approval_request),
267
datetime.timedelta())
269
timer = datetime.timedelta()
270
if self.properties["ApprovedByDefault"]:
271
message = "Approval in {}. (d)eny?"
273
message = "Denial in {}. (a)pprove?"
274
message = message.format(str(timer).rsplit(".", 1)[0])
275
self.using_timer(True)
276
elif self.properties["LastCheckerStatus"] != 0:
277
# When checker has failed, show timer until client expires
278
expires = self.properties["Expires"]
280
timer = datetime.timedelta(0)
282
expires = (datetime.datetime.strptime
283
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
284
timer = max(expires - datetime.datetime.utcnow(),
285
datetime.timedelta())
286
message = ('A checker has failed! Time until client'
288
.format(str(timer).rsplit(".", 1)[0]))
289
self.using_timer(True)
292
self.using_timer(False)
293
self._text = "{}{}".format(base, message)
161
295
if not urwid.supports_unicode():
162
296
self._text = self._text.encode("ascii", "replace")
163
textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
297
textlist = [("normal", self._text)]
164
298
self._text_widget.set_text(textlist)
165
299
self._focus_text_widget.set_text([(with_standout[text[0]],
174
308
if self.update_hook is not None:
175
309
self.update_hook()
311
def update_timer(self):
312
"""called by GObject. Will indefinitely loop until
313
GObject.source_remove() on tag is called"""
315
return True # Keep calling this
317
def delete(self, **kwargs):
318
if self._update_timer_callback_tag is not None:
319
GObject.source_remove(self._update_timer_callback_tag)
320
self._update_timer_callback_tag = None
321
for match in self.match_objects:
323
self.match_objects = ()
178
324
if self.delete_hook is not None:
179
325
self.delete_hook(self)
326
return super(MandosClientWidget, self).delete(**kwargs)
181
def render(self, (maxcol,), focus=False):
328
def render(self, maxcolrow, focus=False):
182
329
"""Render differently if we have focus.
183
330
This overrides the method from urwid.FlowWidget"""
184
return self.current_widget(focus).render((maxcol,),
331
return self.current_widget(focus).render(maxcolrow,
187
def keypress(self, (maxcol,), key):
334
def keypress(self, maxcolrow, key):
189
336
This overrides the method from urwid.FlowWidget"""
190
if key == u"e" or key == u"+":
192
elif key == u"d" or key == u"-":
194
elif key == u"r" or key == u"_":
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface = dbus.PROPERTIES_IFACE)
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
353
elif key == "R" or key == "_" or key == "ctrl k":
195
354
self.server_proxy_object.RemoveClient(self.proxy
198
self.proxy.StartChecker()
200
self.proxy.StopChecker()
202
self.proxy.CheckedOK()
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
362
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface = client_interface,
204
# elif key == u"p" or key == "=":
369
# elif key == "p" or key == "=":
205
370
# self.proxy.pause()
206
# elif key == u"u" or key == ":":
371
# elif key == "u" or key == ":":
207
372
# self.proxy.unpause()
208
# elif key == u"RET":
213
def property_changed(self, property=None, value=None,
215
"""Call self.update() if old value is not new value.
378
def properties_changed(self, interface, properties, invalidated):
379
"""Call self.update() if any properties changed.
216
380
This overrides the method from MandosClientPropertyCache"""
217
property_name = unicode(property)
218
old_value = self.properties.get(property_name)
219
super(MandosClientWidget, self).property_changed(
220
property=property, value=value, *args, **kwargs)
221
if self.properties.get(property_name) != old_value:
381
old_values = { key: self.properties.get(key)
382
for key in properties.keys() }
383
super(MandosClientWidget, self).properties_changed(
384
interface, properties, invalidated)
385
if any(old_values[key] != self.properties.get(key)
386
for key in old_values):
390
class ConstrainedListBox(urwid.ListBox):
391
"""Like a normal urwid.ListBox, but will consume all "up" or
392
"down" key presses, thus not allowing any containing widgets to
393
use them as an excuse to shift focus away from this widget.
395
def keypress(self, *args, **kwargs):
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
397
if ret in ("up", "down"):
225
402
class UserInterface(object):
226
403
"""This is the entire user interface - the whole screen
227
404
with boxes, lists of client widgets, etc.
230
DBusGMainLoop(set_as_default=True )
406
def __init__(self, max_log_length=1000, log_level=1):
407
DBusGMainLoop(set_as_default=True)
232
409
self.screen = urwid.curses_display.Screen()
234
411
self.screen.register_palette((
236
u"default", u"default", None),
238
u"default", u"default", u"bold"),
240
u"default", u"default", u"underline"),
242
u"default", u"default", u"standout"),
243
(u"bold-underline-blink",
244
u"default", u"default", (u"bold", u"underline")),
246
u"default", u"default", (u"bold", u"standout")),
247
(u"underline-blink-standout",
248
u"default", u"default", (u"underline", u"standout")),
249
(u"bold-underline-blink-standout",
250
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"),
432
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
254
439
self.screen.start()
256
441
self.size = self.screen.get_cols_rows()
258
443
self.clients = urwid.SimpleListWalker([])
259
444
self.clients_dict = {}
260
self.topwidget = urwid.LineBox(urwid.ListBox(self.clients))
261
#self.topwidget = urwid.ListBox(clients)
446
# We will add Text widgets to this list
448
self.max_log_length = max_log_length
450
self.log_level = log_level
452
# We keep a reference to the log widget so we can remove it
453
# from the ListWalker without it getting destroyed
454
self.logbox = ConstrainedListBox(self.log)
456
# This keeps track of whether self.uilist currently has
457
# self.logbox in it or not
458
self.log_visible = True
459
self.log_wrap = "any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
263
467
self.busname = domain + '.Mandos'
264
self.main_loop = gobject.MainLoop()
265
self.bus = dbus.SystemBus()
266
mandos_dbus_objc = self.bus.get_object(
267
self.busname, u"/", follow_name_owner_changes=True)
268
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
272
mandos_clients = (self.mandos_serv
273
.GetAllClientsWithProperties())
274
except dbus.exceptions.DBusException:
275
mandos_clients = dbus.Dictionary()
278
.connect_to_signal("ClientRemoved",
279
self.find_and_remove_client,
280
dbus_interface=server_interface,
283
.connect_to_signal("ClientAdded",
285
dbus_interface=server_interface,
287
for path, client in (mandos_clients.iteritems()):
288
client_proxy_object = self.bus.get_object(self.busname,
290
self.add_client(MandosClientWidget(server_proxy_object
293
=client_proxy_object,
298
=self.remove_client),
301
def find_and_remove_client(self, path, name):
302
"""Find an client from its object path and remove it.
304
This is connected to the ClientRemoved signal from the
468
self.main_loop = GObject.MainLoop()
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
473
.format(address, fingerprint))
476
"""This rebuilds the User Interface.
477
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
485
urwid.Divider(div_char=
488
self.uilist.append(self.logbox)
489
self.topwidget = urwid.Pile(self.uilist)
491
def log_message(self, message, level=1):
492
"""Log message formatted with timestamp"""
493
if level < self.log_level:
495
timestamp = datetime.datetime.now().isoformat()
496
self.log_message_raw("{}: {}".format(timestamp, message),
499
def log_message_raw(self, markup, level=1):
500
"""Add a log message to the log buffer."""
501
if level < self.log_level:
503
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
504
if (self.max_log_length
505
and len(self.log) > self.max_log_length):
506
del self.log[0:len(self.log)-self.max_log_length-1]
507
self.logbox.set_focus(len(self.logbox.body.contents),
511
def toggle_log_display(self):
512
"""Toggle visibility of the log buffer."""
513
self.log_visible = not self.log_visible
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
518
def change_log_display(self):
519
"""Change type of log display.
520
Currently, this toggles wrapping of text lines."""
521
if self.log_wrap == "clip":
522
self.log_wrap = "any"
524
self.log_wrap = "clip"
525
for textwidget in self.log:
526
textwidget.set_wrap_mode(self.log_wrap)
527
self.log_message("Wrap mode: {}".format(self.log_wrap),
530
def find_and_remove_client(self, path, interfaces):
531
"""Find a client by its object path and remove it.
533
This is connected to the InterfacesRemoved signal from the
305
534
Mandos server object."""
535
if client_interface not in interfaces:
536
# Not a Mandos client object; ignore
307
539
client = self.clients_dict[path]
542
self.log_message("Unknown client {!r} removed"
311
self.remove_client(client, path)
313
def add_new_client(self, path, properties):
547
def add_new_client(self, path, ifs_and_props):
548
"""Find a client by its object path and remove it.
550
This is connected to the InterfacesAdded signal from the
551
Mandos server object.
553
if client_interface not in ifs_and_props:
554
# Not a Mandos client object; ignore
314
556
client_proxy_object = self.bus.get_object(self.busname, path)
315
557
self.add_client(MandosClientWidget(server_proxy_object
316
558
=self.mandos_serv,
318
560
=client_proxy_object,
319
properties=properties,
323
=self.remove_client),
568
= dict(ifs_and_props[
326
572
def add_client(self, client, path=None):