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>.
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
42
from gi.repository import GLib
48
if sys.version_info.major == 2:
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
56
19
# Some useful constants
57
domain = 'se.recompile'
20
domain = 'se.bsnet.fukt'
58
21
server_interface = domain + '.Mandos'
59
22
client_interface = domain + '.Mandos.Client'
63
dbus.OBJECT_MANAGER_IFACE
64
except AttributeError:
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
def isoformat_to_datetime(iso):
68
"Parse an ISO 8601 date string to a datetime.datetime()"
71
d, t = iso.split("T", 1)
72
year, month, day = d.split("-", 2)
73
hour, minute, second = t.split(":", 2)
74
second, fraction = divmod(float(second), 1)
75
return datetime.datetime(int(year),
80
int(second), # Whole seconds
81
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)
83
33
class MandosClientPropertyCache(object):
84
34
"""This wraps a Mandos Client D-Bus proxy object, caches the
85
35
properties and calls a hook function when any of them are
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
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,
89
59
self.proxy = proxy_object # Mandos Client proxy object
90
self.properties = dict() if properties is None else properties
91
self.property_changed_match = (
92
self.proxy.connect_to_signal("PropertiesChanged",
93
self.properties_changed,
94
dbus.PROPERTIES_IFACE,
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,
97
72
if properties is None:
98
73
self.properties.update(
74
self.convert_property(prop, val)
99
76
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
78
dbus.PROPERTIES_IFACE).iteritems())
79
super(MandosClientPropertyCache, self).__init__(
80
proxy_object=proxy_object,
81
properties=properties, *args, **kwargs)
105
def properties_changed(self, interface, properties, invalidated):
106
"""This is called whenever we get a PropertiesChanged signal
107
It updates the changed properties in the "properties" dict.
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)
109
104
# Update properties dict with new value
110
if interface == client_interface:
111
self.properties.update(properties)
114
self.property_changed_match.remove()
105
self.properties[property_name] = cvalue
117
108
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
121
112
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, **kwargs):
113
delete_hook=None, *args, **kwargs):
123
114
# Called on update
124
115
self.update_hook = update_hook
125
116
# Called on delete
126
117
self.delete_hook = delete_hook
127
118
# Mandos Server proxy object
128
119
self.server_proxy_object = server_proxy_object
132
self._update_timer_callback_tag = None
134
121
# The widget shown normally
135
122
self._text_widget = urwid.Text("")
136
123
# The widget shown when we have focus
137
124
self._focus_text_widget = urwid.Text("")
138
super(MandosClientWidget, self).__init__(**kwargs)
125
super(MandosClientWidget, self).__init__(
126
update_hook=update_hook, delete_hook=delete_hook,
140
129
self.opened = False
142
self.match_objects = (
143
self.proxy.connect_to_signal("CheckerCompleted",
144
self.checker_completed,
147
self.proxy.connect_to_signal("CheckerStarted",
148
self.checker_started,
151
self.proxy.connect_to_signal("GotSecret",
155
self.proxy.connect_to_signal("NeedApproval",
159
self.proxy.connect_to_signal("Rejected",
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
166
def using_timer(self, flag):
167
"""Call this method with True or False when timer should be
168
activated or deactivated.
170
if flag and self._update_timer_callback_tag is None:
171
# Will update the shown timer value every second
172
self._update_timer_callback_tag = (GLib.timeout_add
175
elif not (flag or self._update_timer_callback_tag is None):
176
GLib.source_remove(self._update_timer_callback_tag)
177
self._update_timer_callback_tag = None
179
def checker_completed(self, exitstatus, condition, command):
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
187
if os.WIFEXITED(condition):
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
192
elif os.WIFSIGNALED(condition):
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
199
def checker_started(self, command):
200
"""Server signals that a checker started."""
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
205
def got_secret(self):
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
209
def need_approval(self, timeout, default):
211
message = 'Client {} needs approval within {} seconds'
213
message = 'Client {} will get its secret in {} seconds'
214
self.logger(message.format(self.properties["Name"],
217
def rejected(self, reason):
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
221
131
def selectable(self):
222
132
"""Make this a "selectable" widget.
223
133
This overrides the method from urwid.FlowWidget."""
226
def rows(self, maxcolrow, focus=False):
136
def rows(self, (maxcol,), focus=False):
227
137
"""How many rows this widget will occupy might depend on
228
138
whether we have focus or not.
229
139
This overrides the method from urwid.FlowWidget"""
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
140
return self.current_widget(focus).rows((maxcol,), focus=focus)
232
142
def current_widget(self, focus=False):
233
143
if focus or self.opened:
237
147
def update(self):
238
148
"Called when what is visible on the screen should be updated."
239
149
# How to add standout mode to a style
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
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",
248
158
# Rebuild focus and non-focus widgets using current properties
250
# Base part of a client. Name!
251
base = '{name}: '.format(name=self.properties["Name"])
252
if not self.properties["Enabled"]:
254
self.using_timer(False)
255
elif self.properties["ApprovalPending"]:
256
timeout = datetime.timedelta(milliseconds
259
last_approval_request = isoformat_to_datetime(
260
self.properties["LastApprovalRequest"])
261
if last_approval_request is not None:
262
timer = max(timeout - (datetime.datetime.utcnow()
263
- last_approval_request),
264
datetime.timedelta())
266
timer = datetime.timedelta()
267
if self.properties["ApprovedByDefault"]:
268
message = "Approval in {}. (d)eny?"
270
message = "Denial in {}. (a)pprove?"
271
message = message.format(str(timer).rsplit(".", 1)[0])
272
self.using_timer(True)
273
elif self.properties["LastCheckerStatus"] != 0:
274
# When checker has failed, show timer until client expires
275
expires = self.properties["Expires"]
277
timer = datetime.timedelta(0)
279
expires = (datetime.datetime.strptime
280
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
281
timer = max(expires - datetime.datetime.utcnow(),
282
datetime.timedelta())
283
message = ('A checker has failed! Time until client'
285
.format(str(timer).rsplit(".", 1)[0]))
286
self.using_timer(True)
289
self.using_timer(False)
290
self._text = "{}{}".format(base, message)
159
self._text = (u'name="%(name)s", enabled=%(enabled)s'
292
161
if not urwid.supports_unicode():
293
162
self._text = self._text.encode("ascii", "replace")
294
textlist = [("normal", self._text)]
163
textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
295
164
self._text_widget.set_text(textlist)
296
165
self._focus_text_widget.set_text([(with_standout[text[0]],
305
174
if self.update_hook is not None:
306
175
self.update_hook()
308
def update_timer(self):
309
"""called by GLib. Will indefinitely loop until
310
GLib.source_remove() on tag is called
313
return True # Keep calling this
315
def delete(self, **kwargs):
316
if self._update_timer_callback_tag is not None:
317
GLib.source_remove(self._update_timer_callback_tag)
318
self._update_timer_callback_tag = None
319
for match in self.match_objects:
321
self.match_objects = ()
322
178
if self.delete_hook is not None:
323
179
self.delete_hook(self)
324
return super(MandosClientWidget, self).delete(**kwargs)
326
def render(self, maxcolrow, focus=False):
181
def render(self, (maxcol,), focus=False):
327
182
"""Render differently if we have focus.
328
183
This overrides the method from urwid.FlowWidget"""
329
return self.current_widget(focus).render(maxcolrow,
184
return self.current_widget(focus).render((maxcol,),
332
def keypress(self, maxcolrow, key):
187
def keypress(self, (maxcol,), key):
334
189
This overrides the method from urwid.FlowWidget"""
336
self.proxy.Set(client_interface, "Enabled",
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
340
self.proxy.Set(client_interface, "Enabled", False,
342
dbus_interface = dbus.PROPERTIES_IFACE)
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
dbus_interface = client_interface,
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
dbus_interface = client_interface,
351
elif key == "R" or key == "_" or key == "ctrl k":
190
if key == u"e" or key == u"+":
192
elif key == u"d" or key == u"-":
194
elif key == u"r" or key == u"_":
352
195
self.server_proxy_object.RemoveClient(self.proxy
356
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
360
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
364
self.proxy.CheckedOK(dbus_interface = client_interface,
198
self.proxy.StartChecker()
200
self.proxy.StopChecker()
202
self.proxy.CheckedOK()
367
# elif key == "p" or key == "=":
204
# elif key == u"p" or key == "=":
368
205
# self.proxy.pause()
369
# elif key == "u" or key == ":":
206
# elif key == u"u" or key == ":":
370
207
# self.proxy.unpause()
208
# elif key == u"RET":
376
def properties_changed(self, interface, properties, invalidated):
377
"""Call self.update() if any properties changed.
213
def property_changed(self, property=None, value=None,
215
"""Call self.update() if old value is not new value.
378
216
This overrides the method from MandosClientPropertyCache"""
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
381
super(MandosClientWidget, self).properties_changed(
382
interface, properties, invalidated)
383
if any(old_values[key] != self.properties.get(key)
384
for key in old_values):
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:
388
class ConstrainedListBox(urwid.ListBox):
389
"""Like a normal urwid.ListBox, but will consume all "up" or
390
"down" key presses, thus not allowing any containing widgets to
391
use them as an excuse to shift focus away from this widget.
393
def keypress(self, *args, **kwargs):
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
395
if ret in ("up", "down"):
400
225
class UserInterface(object):
401
226
"""This is the entire user interface - the whole screen
402
227
with boxes, lists of client widgets, etc.
404
def __init__(self, max_log_length=1000, log_level=1):
405
DBusGMainLoop(set_as_default=True)
230
DBusGMainLoop(set_as_default=True )
407
232
self.screen = urwid.curses_display.Screen()
409
234
self.screen.register_palette((
411
"default", "default", None),
413
"bold", "default", "bold"),
415
"underline,blink", "default", "underline,blink"),
417
"standout", "default", "standout"),
418
("bold-underline-blink",
419
"bold,underline,blink", "default", "bold,underline,blink"),
421
"bold,standout", "default", "bold,standout"),
422
("underline-blink-standout",
423
"underline,blink,standout", "default",
424
"underline,blink,standout"),
425
("bold-underline-blink-standout",
426
"bold,underline,blink,standout", "default",
427
"bold,underline,blink,standout"),
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",
430
if urwid.supports_unicode():
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
437
254
self.screen.start()
439
256
self.size = self.screen.get_cols_rows()
441
258
self.clients = urwid.SimpleListWalker([])
442
259
self.clients_dict = {}
444
# We will add Text widgets to this list
446
self.max_log_length = max_log_length
448
self.log_level = log_level
450
# We keep a reference to the log widget so we can remove it
451
# from the ListWalker without it getting destroyed
452
self.logbox = ConstrainedListBox(self.log)
454
# This keeps track of whether self.uilist currently has
455
# self.logbox in it or not
456
self.log_visible = True
457
self.log_wrap = "any"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
260
self.topwidget = urwid.LineBox(urwid.ListBox(self.clients))
261
#self.topwidget = urwid.ListBox(clients)
465
263
self.busname = domain + '.Mandos'
466
self.main_loop = GLib.MainLoop()
468
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
474
"""This rebuilds the User Interface.
475
Call this when the widget layout needs to change"""
477
#self.uilist.append(urwid.ListBox(self.clients))
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
480
#header=urwid.Divider(),
483
urwid.Divider(div_char=
486
self.uilist.append(self.logbox)
487
self.topwidget = urwid.Pile(self.uilist)
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if (self.max_log_length
503
and len(self.log) > self.max_log_length):
504
del self.log[0:len(self.log)-self.max_log_length-1]
505
self.logbox.set_focus(len(self.logbox.body.contents),
509
def toggle_log_display(self):
510
"""Toggle visibility of the log buffer."""
511
self.log_visible = not self.log_visible
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
516
def change_log_display(self):
517
"""Change type of log display.
518
Currently, this toggles wrapping of text lines."""
519
if self.log_wrap == "clip":
520
self.log_wrap = "any"
522
self.log_wrap = "clip"
523
for textwidget in self.log:
524
textwidget.set_wrap_mode(self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
529
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
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
532
305
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
307
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
311
self.remove_client(client, path)
545
def add_new_client(self, path, ifs_and_props):
546
"""Find a client by its object path and remove it.
548
This is connected to the InterfacesAdded signal from the
549
Mandos server object.
551
if client_interface not in ifs_and_props:
552
# Not a Mandos client object; ignore
313
def add_new_client(self, path, properties):
554
314
client_proxy_object = self.bus.get_object(self.busname, path)
555
315
self.add_client(MandosClientWidget(server_proxy_object
556
316
=self.mandos_serv,
558
318
=client_proxy_object,
319
properties=properties,
566
= dict(ifs_and_props[
323
=self.remove_client),
570
326
def add_client(self, client, path=None):