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.major == 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,
40
# Type conversion mapping
42
dbus.ObjectPath: unicode,
44
dbus.Signature: unicode,
52
dbus.Dictionary: dict,
87
59
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("PropertiesChanged",
91
self.properties_changed,
92
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,
95
72
if properties is None:
96
73
self.properties.update(
74
self.convert_property(prop, val)
97
76
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
101
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)
103
def properties_changed(self, interface, properties, invalidated):
104
"""This is called whenever we get a PropertiesChanged signal
105
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)
107
104
# Update properties dict with new value
108
self.properties.update(properties)
111
self.property_changed_match.remove()
105
self.properties[property_name] = cvalue
114
108
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
118
112
def __init__(self, server_proxy_object=None, update_hook=None,
119
delete_hook=None, logger=None, **kwargs):
113
delete_hook=None, *args, **kwargs):
120
114
# Called on update
121
115
self.update_hook = update_hook
122
116
# Called on delete
123
117
self.delete_hook = delete_hook
124
118
# Mandos Server proxy object
125
119
self.server_proxy_object = server_proxy_object
129
self._update_timer_callback_tag = None
131
121
# The widget shown normally
132
122
self._text_widget = urwid.Text("")
133
123
# The widget shown when we have focus
134
124
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
125
super(MandosClientWidget, self).__init__(
126
update_hook=update_hook, delete_hook=delete_hook,
137
129
self.opened = False
139
self.match_objects = (
140
self.proxy.connect_to_signal("CheckerCompleted",
141
self.checker_completed,
144
self.proxy.connect_to_signal("CheckerStarted",
145
self.checker_started,
148
self.proxy.connect_to_signal("GotSecret",
152
self.proxy.connect_to_signal("NeedApproval",
156
self.proxy.connect_to_signal("Rejected",
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
163
def using_timer(self, flag):
164
"""Call this method with True or False when timer should be
165
activated or deactivated.
167
if flag and self._update_timer_callback_tag is None:
168
# Will update the shown timer value every second
169
self._update_timer_callback_tag = (gobject.timeout_add
172
elif not (flag or self._update_timer_callback_tag is None):
173
gobject.source_remove(self._update_timer_callback_tag)
174
self._update_timer_callback_tag = None
176
def checker_completed(self, exitstatus, condition, command):
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
184
if os.WIFEXITED(condition):
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
188
os.WEXITSTATUS(condition)))
189
elif os.WIFSIGNALED(condition):
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
os.WTERMSIG(condition)))
194
elif os.WCOREDUMP(condition):
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
199
self.logger('Checker for client {} completed'
201
.format(self.properties["Name"]))
204
def checker_started(self, command):
205
"""Server signals that a checker started."""
206
self.logger('Client {} started checker "{}"'
207
.format(self.properties["Name"],
210
def got_secret(self):
211
self.logger('Client {} received its secret'
212
.format(self.properties["Name"]))
214
def need_approval(self, timeout, default):
216
message = 'Client {} needs approval within {} seconds'
218
message = 'Client {} will get its secret in {} seconds'
219
self.logger(message.format(self.properties["Name"],
222
def rejected(self, reason):
223
self.logger('Client {} was rejected; reason: {}'
224
.format(self.properties["Name"], reason))
226
131
def selectable(self):
227
132
"""Make this a "selectable" widget.
228
133
This overrides the method from urwid.FlowWidget."""
231
def rows(self, maxcolrow, focus=False):
136
def rows(self, (maxcol,), focus=False):
232
137
"""How many rows this widget will occupy might depend on
233
138
whether we have focus or not.
234
139
This overrides the method from urwid.FlowWidget"""
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
140
return self.current_widget(focus).rows((maxcol,), focus=focus)
237
142
def current_widget(self, focus=False):
238
143
if focus or self.opened:
242
147
def update(self):
243
148
"Called when what is visible on the screen should be updated."
244
149
# How to add standout mode to a style
245
with_standout = { "normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"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",
253
158
# Rebuild focus and non-focus widgets using current properties
255
# Base part of a client. Name!
256
base = '{name}: '.format(name=self.properties["Name"])
257
if not self.properties["Enabled"]:
259
self.using_timer(False)
260
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(milliseconds
264
last_approval_request = isoformat_to_datetime(
265
self.properties["LastApprovalRequest"])
266
if last_approval_request is not None:
267
timer = max(timeout - (datetime.datetime.utcnow()
268
- last_approval_request),
269
datetime.timedelta())
271
timer = datetime.timedelta()
272
if self.properties["ApprovedByDefault"]:
273
message = "Approval in {}. (d)eny?"
275
message = "Denial in {}. (a)pprove?"
276
message = message.format(str(timer).rsplit(".", 1)[0])
277
self.using_timer(True)
278
elif self.properties["LastCheckerStatus"] != 0:
279
# When checker has failed, show timer until client expires
280
expires = self.properties["Expires"]
282
timer = datetime.timedelta(0)
284
expires = (datetime.datetime.strptime
285
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
timer = max(expires - datetime.datetime.utcnow(),
287
datetime.timedelta())
288
message = ('A checker has failed! Time until client'
290
.format(str(timer).rsplit(".", 1)[0]))
291
self.using_timer(True)
294
self.using_timer(False)
295
self._text = "{}{}".format(base, message)
159
self._text = (u'name="%(name)s", enabled=%(enabled)s'
297
161
if not urwid.supports_unicode():
298
162
self._text = self._text.encode("ascii", "replace")
299
textlist = [("normal", self._text)]
163
textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
300
164
self._text_widget.set_text(textlist)
301
165
self._focus_text_widget.set_text([(with_standout[text[0]],
310
174
if self.update_hook is not None:
311
175
self.update_hook()
313
def update_timer(self):
314
"""called by gobject. Will indefinitely loop until
315
gobject.source_remove() on tag is called"""
317
return True # Keep calling this
319
def delete(self, **kwargs):
320
if self._update_timer_callback_tag is not None:
321
gobject.source_remove(self._update_timer_callback_tag)
322
self._update_timer_callback_tag = None
323
for match in self.match_objects:
325
self.match_objects = ()
326
178
if self.delete_hook is not None:
327
179
self.delete_hook(self)
328
return super(MandosClientWidget, self).delete(**kwargs)
330
def render(self, maxcolrow, focus=False):
181
def render(self, (maxcol,), focus=False):
331
182
"""Render differently if we have focus.
332
183
This overrides the method from urwid.FlowWidget"""
333
return self.current_widget(focus).render(maxcolrow,
184
return self.current_widget(focus).render((maxcol,),
336
def keypress(self, maxcolrow, key):
187
def keypress(self, (maxcol,), key):
338
189
This overrides the method from urwid.FlowWidget"""
340
self.proxy.Enable(dbus_interface = client_interface,
343
self.proxy.Disable(dbus_interface = client_interface,
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":
190
if key == u"e" or key == u"+":
192
elif key == u"d" or key == u"-":
194
elif key == u"r" or key == u"_":
354
195
self.server_proxy_object.RemoveClient(self.proxy
358
self.proxy.StartChecker(dbus_interface = client_interface,
361
self.proxy.StopChecker(dbus_interface = client_interface,
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
264
self.main_loop = gobject.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),
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),
528
301
def find_and_remove_client(self, path, name):
529
"""Find a client by its object path and remove it.
302
"""Find an client from its object path and remove it.
531
304
This is connected to the ClientRemoved signal from the
532
305
Mandos server object."""