2
2
# -*- mode: python; coding: utf-8 -*-
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 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
37
9
import urwid.curses_display
65
30
urwid.curses_display.curses.A_UNDERLINE |= (
66
31
urwid.curses_display.curses.A_BLINK)
68
def isoformat_to_datetime(iso):
69
"Parse an ISO 8601 date string to a datetime.datetime()"
72
d, t = iso.split("T", 1)
73
year, month, day = d.split("-", 2)
74
hour, minute, second = t.split(":", 2)
75
second, fraction = divmod(float(second), 1)
76
return datetime.datetime(int(year),
81
int(second), # Whole seconds
82
int(fraction*1000000)) # Microseconds
84
33
class MandosClientPropertyCache(object):
85
34
"""This wraps a Mandos Client D-Bus proxy object, caches the
86
35
properties and calls a hook function when any of them are
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
38
def __init__(self, proxy_object=None, properties=None, *args,
90
40
self.proxy = proxy_object # Mandos Client proxy object
91
self.properties = dict() if properties is None else properties
92
self.property_changed_match = (
93
self.proxy.connect_to_signal("PropertyChanged",
94
self._property_changed,
98
if properties is None:
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
102
= dbus.PROPERTIES_IFACE))
104
super(MandosClientPropertyCache, self).__init__(**kwargs)
106
def _property_changed(self, property, value):
107
"""Helper which takes positional arguments"""
108
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)
110
59
def property_changed(self, property=None, value=None):
111
60
"""This is called whenever we get a PropertyChanged signal
125
71
def __init__(self, server_proxy_object=None, update_hook=None,
126
delete_hook=None, logger=None, **kwargs):
72
delete_hook=None, *args, **kwargs):
127
73
# Called on update
128
74
self.update_hook = update_hook
129
75
# Called on delete
130
76
self.delete_hook = delete_hook
131
77
# Mandos Server proxy object
132
78
self.server_proxy_object = server_proxy_object
136
self._update_timer_callback_tag = None
138
80
# The widget shown normally
139
81
self._text_widget = urwid.Text("")
140
82
# The widget shown when we have focus
141
83
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
84
super(MandosClientWidget, self).__init__(
85
update_hook=update_hook, delete_hook=delete_hook,
144
88
self.opened = False
146
self.match_objects = (
147
self.proxy.connect_to_signal("CheckerCompleted",
148
self.checker_completed,
151
self.proxy.connect_to_signal("CheckerStarted",
152
self.checker_started,
155
self.proxy.connect_to_signal("GotSecret",
159
self.proxy.connect_to_signal("NeedApproval",
163
self.proxy.connect_to_signal("Rejected",
167
#self.logger('Created client {0}'
168
# .format(self.properties["Name"]))
170
def using_timer(self, flag):
171
"""Call this method with True or False when timer should be
172
activated or deactivated.
174
if flag and self._update_timer_callback_tag is None:
175
# Will update the shown timer value every second
176
self._update_timer_callback_tag = (gobject.timeout_add
179
elif not (flag or self._update_timer_callback_tag is None):
180
gobject.source_remove(self._update_timer_callback_tag)
181
self._update_timer_callback_tag = None
183
def checker_completed(self, exitstatus, condition, command):
188
if os.WIFEXITED(condition):
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
191
.format(self.properties["Name"], command,
192
os.WEXITSTATUS(condition)))
193
elif os.WIFSIGNALED(condition):
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
196
.format(self.properties["Name"], command,
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
208
def checker_started(self, command):
209
"""Server signals that a checker started. This could be useful
210
to log in the future. """
211
#self.logger('Client {0} started checker "{1}"'
212
# .format(self.properties["Name"],
216
def got_secret(self):
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
220
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
228
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
232
90
def selectable(self):
233
91
"""Make this a "selectable" widget.
234
92
This overrides the method from urwid.FlowWidget."""
237
def rows(self, maxcolrow, focus=False):
95
def rows(self, (maxcol,), focus=False):
238
96
"""How many rows this widget will occupy might depend on
239
97
whether we have focus or not.
240
98
This overrides the method from urwid.FlowWidget"""
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
99
return self.current_widget(focus).rows((maxcol,), focus=focus)
243
101
def current_widget(self, focus=False):
244
102
if focus or self.opened:
248
106
def update(self):
249
107
"Called when what is visible on the screen should be updated."
250
108
# How to add standout mode to a style
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"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",
259
117
# Rebuild focus and non-focus widgets using current properties
261
# Base part of a client. Name!
262
base = '{name}: '.format(name=self.properties["Name"])
263
if not self.properties["Enabled"]:
265
self.using_timer(False)
266
elif self.properties["ApprovalPending"]:
267
timeout = datetime.timedelta(milliseconds
270
last_approval_request = isoformat_to_datetime(
271
self.properties["LastApprovalRequest"])
272
if last_approval_request is not None:
273
timer = max(timeout - (datetime.datetime.utcnow()
274
- last_approval_request),
275
datetime.timedelta())
277
timer = datetime.timedelta()
278
if self.properties["ApprovedByDefault"]:
279
message = "Approval in {0}. (d)eny?"
281
message = "Denial in {0}. (a)pprove?"
282
message = message.format(unicode(timer).rsplit(".", 1)[0])
283
self.using_timer(True)
284
elif self.properties["LastCheckerStatus"] != 0:
285
# When checker has failed, show timer until client expires
286
expires = self.properties["Expires"]
288
timer = datetime.timedelta(0)
290
expires = (datetime.datetime.strptime
291
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
292
timer = max(expires - datetime.datetime.utcnow(),
293
datetime.timedelta())
294
message = ('A checker has failed! Time until client'
295
' gets disabled: {0}'
296
.format(unicode(timer).rsplit(".", 1)[0]))
297
self.using_timer(True)
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
118
self._text = (u'name="%(name)s", enabled=%(enabled)s'
303
120
if not urwid.supports_unicode():
304
121
self._text = self._text.encode("ascii", "replace")
305
textlist = [("normal", self._text)]
122
textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
306
123
self._text_widget.set_text(textlist)
307
124
self._focus_text_widget.set_text([(with_standout[text[0]],
316
133
if self.update_hook is not None:
317
134
self.update_hook()
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
323
return True # Keep calling this
325
def delete(self, **kwargs):
326
if self._update_timer_callback_tag is not None:
327
gobject.source_remove(self._update_timer_callback_tag)
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
331
self.match_objects = ()
332
137
if self.delete_hook is not None:
333
138
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
336
def render(self, maxcolrow, focus=False):
140
def render(self, (maxcol,), focus=False):
337
141
"""Render differently if we have focus.
338
142
This overrides the method from urwid.FlowWidget"""
339
return self.current_widget(focus).render(maxcolrow,
143
return self.current_widget(focus).render((maxcol,),
342
def keypress(self, maxcolrow, key):
146
def keypress(self, (maxcol,), key):
344
148
This overrides the method from urwid.FlowWidget"""
346
self.proxy.Enable(dbus_interface = client_interface,
349
self.proxy.Disable(dbus_interface = client_interface,
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
359
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"_":
360
154
self.server_proxy_object.RemoveClient(self.proxy
364
self.proxy.StartChecker(dbus_interface = client_interface,
367
self.proxy.StopChecker(dbus_interface = client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
157
self.proxy.StartChecker()
159
self.proxy.StopChecker()
161
self.proxy.CheckedOK()
373
# elif key == "p" or key == "=":
163
# elif key == u"p" or key == "=":
374
164
# self.proxy.pause()
375
# elif key == "u" or key == ":":
165
# elif key == u"u" or key == ":":
376
166
# self.proxy.unpause()
167
# elif key == u"RET":
382
def property_changed(self, property=None, **kwargs):
172
def property_changed(self, property=None, value=None,
383
174
"""Call self.update() if old value is not new value.
384
175
This overrides the method from MandosClientPropertyCache"""
385
176
property_name = unicode(property)
386
177
old_value = self.properties.get(property_name)
387
178
super(MandosClientWidget, self).property_changed(
388
property=property, **kwargs)
179
property=property, value=value, *args, **kwargs)
389
180
if self.properties.get(property_name) != old_value:
412
203
self.screen = urwid.curses_display.Screen()
414
205
self.screen.register_palette((
416
"default", "default", None),
418
"default", "default", "bold"),
420
"default", "default", "underline"),
422
"default", "default", "standout"),
423
("bold-underline-blink",
424
"default", "default", ("bold", "underline")),
426
"default", "default", ("bold", "standout")),
427
("underline-blink-standout",
428
"default", "default", ("underline", "standout")),
429
("bold-underline-blink-standout",
430
"default", "default", ("bold", "underline",
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",
434
225
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
226
#self.divider = u"─" # \u2500
227
self.divider = u"━" # \u2501
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
229
#self.divider = u"-" # \u002d
230
self.divider = u"_" # \u005f
441
232
self.screen.start()
456
247
# This keeps track of whether self.uilist currently has
457
248
# self.logbox in it or not
458
249
self.log_visible = True
459
self.log_wrap = "any"
250
self.log_wrap = u"any"
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
253
self.log_message((u"bold",
254
u"Mandos Monitor version " + version))
255
self.log_message((u"bold",
467
258
self.busname = domain + '.Mandos'
468
259
self.main_loop = gobject.MainLoop()
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} could not be found"
473
.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),
475
296
def rebuild(self):
476
297
"""This rebuilds the User Interface.
477
298
Call this when the widget layout needs to change"""
479
300
#self.uilist.append(urwid.ListBox(self.clients))
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
301
self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
482
302
#header=urwid.Divider(),
485
urwid.Divider(div_char=
304
footer=urwid.Divider(div_char=self.divider)))
487
305
if self.log_visible:
488
306
self.uilist.append(self.logbox)
489
308
self.topwidget = urwid.Pile(self.uilist)
491
def log_message(self, message):
492
"""Log message formatted with timestamp"""
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw(timestamp + ": " + message)
496
def log_message_raw(self, markup):
310
def log_message(self, markup):
497
311
"""Add a log message to the log buffer."""
498
312
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
499
313
if (self.max_log_length
500
314
and len(self.log) > self.max_log_length):
501
315
del self.log[0:len(self.log)-self.max_log_length-1]
502
self.logbox.set_focus(len(self.logbox.body.contents),
506
317
def toggle_log_display(self):
507
318
"""Toggle visibility of the log buffer."""
508
319
self.log_visible = not self.log_visible
510
#self.log_message("Log visibility changed to: "
511
# + unicode(self.log_visible))
321
self.log_message(u"Log visibility changed to: "
322
+ unicode(self.log_visible))
513
324
def change_log_display(self):
514
325
"""Change type of log display.
515
326
Currently, this toggles wrapping of text lines."""
516
if self.log_wrap == "clip":
517
self.log_wrap = "any"
327
if self.log_wrap == u"clip":
328
self.log_wrap = u"any"
519
self.log_wrap = "clip"
330
self.log_wrap = u"clip"
520
331
for textwidget in self.log:
521
332
textwidget.set_wrap_mode(self.log_wrap)
522
#self.log_message("Wrap mode: " + self.log_wrap)
333
self.log_message(u"Wrap mode: " + self.log_wrap)
524
335
def find_and_remove_client(self, path, name):
525
"""Find a client by its object path and remove it.
336
"""Find an client from its object path and remove it.
527
338
This is connected to the ClientRemoved signal from the
528
339
Mandos server object."""
578
386
"""Start the main loop and exit when it's done."""
579
self.bus = dbus.SystemBus()
580
mandos_dbus_objc = self.bus.get_object(
581
self.busname, "/", follow_name_owner_changes=True)
582
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
586
mandos_clients = (self.mandos_serv
587
.GetAllClientsWithProperties())
588
if not mandos_clients:
589
self.log_message_raw(("bold", "Note: Server has no clients."))
590
except dbus.exceptions.DBusException:
591
self.log_message_raw(("bold", "Note: No Mandos servers running."))
592
mandos_clients = dbus.Dictionary()
595
.connect_to_signal("ClientRemoved",
596
self.find_and_remove_client,
597
dbus_interface=server_interface,
600
.connect_to_signal("ClientAdded",
602
dbus_interface=server_interface,
605
.connect_to_signal("ClientNotFound",
606
self.client_not_found,
607
dbus_interface=server_interface,
609
for path, client in mandos_clients.iteritems():
610
client_proxy_object = self.bus.get_object(self.busname,
612
self.add_client(MandosClientWidget(server_proxy_object
615
=client_proxy_object,
626
388
self._input_callback_tag = (gobject.io_add_watch
627
389
(sys.stdin.fileno(),
638
400
def process_input(self, source, condition):
639
401
keys = self.screen.get_input()
640
translations = { "ctrl n": "down", # Emacs
641
"ctrl p": "up", # Emacs
642
"ctrl v": "page down", # Emacs
643
"meta v": "page up", # Emacs
644
" ": "page down", # less
645
"f": "page down", # less
646
"b": "page up", # less
402
translations = { u"ctrl n": u"down", # Emacs
403
u"ctrl p": u"up", # Emacs
404
u"ctrl v": u"page down", # Emacs
405
u"meta v": u"page up", # Emacs
406
u" ": u"page down", # less
407
u"f": u"page down", # less
408
u"b": u"page up", # less
653
415
except KeyError: # :-)
656
if key == "q" or key == "Q":
418
if key == u"q" or key == u"Q":
659
elif key == "window resize":
421
elif key == u"window resize":
660
422
self.size = self.screen.get_cols_rows()
662
elif key == "\f": # Ctrl-L
424
elif key == u"\f": # Ctrl-L
664
elif key == "l" or key == "D":
426
elif key == u"l" or key == u"D":
665
427
self.toggle_log_display()
667
elif key == "w" or key == "i":
429
elif key == u"w" or key == u"i":
668
430
self.change_log_display()
670
elif key == "?" or key == "f1" or key == "esc":
432
elif key == u"?" or key == u"f1":
671
433
if not self.log_visible:
672
434
self.log_visible = True
674
self.log_message_raw(("bold",
678
"l: Log window toggle",
679
"TAB: Switch window",
681
self.log_message_raw(("bold",
687
"s: Start new checker",
436
self.log_message((u"bold",
437
u" ".join((u"q: Quit",
439
u"l: Log window toggle",
440
u"TAB: Switch window",
442
self.log_message((u"bold",
443
u" ".join((u"Clients:",
447
u"s: Start new checker",
694
452
if self.topwidget.get_focus() is self.logbox:
695
453
self.topwidget.set_focus(0)
697
455
self.topwidget.set_focus(self.logbox)
699
#elif (key == "end" or key == "meta >" or key == "G"
457
#elif (key == u"end" or key == u"meta >" or key == u"G"
701
459
# pass # xxx end-of-buffer
702
#elif (key == "home" or key == "meta <" or key == "g"
460
#elif (key == u"home" or key == u"meta <" or key == u"g"
704
462
# pass # xxx beginning-of-buffer
705
#elif key == "ctrl e" or key == "$":
463
#elif key == u"ctrl e" or key == u"$":
706
464
# pass # xxx move-end-of-line
707
#elif key == "ctrl a" or key == "^":
465
#elif key == u"ctrl a" or key == u"^":
708
466
# pass # xxx move-beginning-of-line
709
#elif key == "ctrl b" or key == "meta (" or key == "h":
467
#elif key == u"ctrl b" or key == u"meta (" or key == u"h":
710
468
# pass # xxx left
711
#elif key == "ctrl f" or key == "meta )" or key == "l":
469
#elif key == u"ctrl f" or key == u"meta )" or key == u"l":
712
470
# pass # xxx right
714
472
# pass # scroll up log
716
474
# pass # scroll down log
717
475
elif self.topwidget.selectable():
718
476
self.topwidget.keypress(self.size, key)