2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2016 Teddy Hogeborn
7
# Copyright © 2009-2016 Björn Påhlsson
6
# Copyright © 2009-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 Björn Påhlsson
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
11
11
# the Free Software Foundation, either version 3 of the License, or
15
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
17
# GNU General Public License for more details.
19
19
# You should have received a copy of the GNU General Public License
20
20
# along with this program. If not, see
21
21
# <http://www.gnu.org/licenses/>.
23
23
# Contact the authors at <mandos@recompile.se>.
26
26
from __future__ import (division, absolute_import, print_function,
41
41
from dbus.mainloop.glib import DBusGMainLoop
42
from gi.repository import GLib
45
from gi.repository import GObject as gobject
50
51
if sys.version_info.major == 2:
53
54
locale.setlocale(locale.LC_ALL, '')
55
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
57
59
# Some useful constants
58
60
domain = 'se.recompile'
59
61
server_interface = domain + '.Mandos'
60
62
client_interface = domain + '.Mandos.Client'
64
dbus.OBJECT_MANAGER_IFACE
65
except AttributeError:
66
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
69
65
def isoformat_to_datetime(iso):
70
66
"Parse an ISO 8601 date string to a datetime.datetime()"
82
int(second), # Whole seconds
83
int(fraction*1000000)) # Microseconds
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
86
81
class MandosClientPropertyCache(object):
87
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
91
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
87
self.proxy = proxy_object # Mandos Client proxy object
93
88
self.properties = dict() if properties is None else properties
94
89
self.property_changed_match = (
95
self.proxy.connect_to_signal("PropertiesChanged",
96
self.properties_changed,
97
dbus.PROPERTIES_IFACE,
90
self.proxy.connect_to_signal("PropertyChanged",
91
self._property_changed,
100
95
if properties is None:
101
self.properties.update(self.proxy.GetAll(
103
dbus_interface=dbus.PROPERTIES_IFACE))
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
105
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
107
def properties_changed(self, interface, properties, invalidated):
108
"""This is called whenever we get a PropertiesChanged signal
109
It updates the changed properties in the "properties" dict.
103
def _property_changed(self, property, value):
104
"""Helper which takes positional arguments"""
105
return self.property_changed(property=property, value=value)
107
def property_changed(self, property=None, value=None):
108
"""This is called whenever we get a PropertyChanged signal
109
It updates the changed property in the "properties" dict.
111
111
# Update properties dict with new value
112
if interface == client_interface:
113
self.properties.update(properties)
112
self.properties[property] = value
115
114
def delete(self):
116
115
self.property_changed_match.remove()
119
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
119
"""A Mandos Client which is visible on the screen.
123
122
def __init__(self, server_proxy_object=None, update_hook=None,
124
123
delete_hook=None, logger=None, **kwargs):
125
124
# Called on update
164
163
byte_arrays=True))
165
164
self.logger('Created client {}'
166
165
.format(self.properties["Name"]), level=0)
168
167
def using_timer(self, flag):
169
168
"""Call this method with True or False when timer should be
170
169
activated or deactivated.
172
171
if flag and self._update_timer_callback_tag is None:
173
172
# Will update the shown timer value every second
174
self._update_timer_callback_tag = (GLib.timeout_add
173
self._update_timer_callback_tag = (gobject.timeout_add
176
175
self.update_timer))
177
176
elif not (flag or self._update_timer_callback_tag is None):
178
GLib.source_remove(self._update_timer_callback_tag)
177
gobject.source_remove(self._update_timer_callback_tag)
179
178
self._update_timer_callback_tag = None
181
180
def checker_completed(self, exitstatus, condition, command):
182
181
if exitstatus == 0:
183
182
self.logger('Checker for client {} (command "{}")'
196
195
' killed by signal {}'
197
196
.format(self.properties["Name"], command,
198
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {} (command "{}") dumped'
200
' core'.format(self.properties["Name"],
203
self.logger('Checker for client {} completed'
205
.format(self.properties["Name"]))
201
208
def checker_started(self, command):
202
209
"""Server signals that a checker started."""
203
210
self.logger('Client {} started checker "{}"'
204
211
.format(self.properties["Name"],
205
212
command), level=0)
207
214
def got_secret(self):
208
215
self.logger('Client {} received its secret'
209
216
.format(self.properties["Name"]))
211
218
def need_approval(self, timeout, default):
213
220
message = 'Client {} needs approval within {} seconds'
215
222
message = 'Client {} will get its secret in {} seconds'
216
223
self.logger(message.format(self.properties["Name"],
219
226
def rejected(self, reason):
220
227
self.logger('Client {} was rejected; reason: {}'
221
228
.format(self.properties["Name"], reason))
223
230
def selectable(self):
224
231
"""Make this a "selectable" widget.
225
232
This overrides the method from urwid.FlowWidget."""
228
235
def rows(self, maxcolrow, focus=False):
229
236
"""How many rows this widget will occupy might depend on
230
237
whether we have focus or not.
231
238
This overrides the method from urwid.FlowWidget"""
232
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
234
241
def current_widget(self, focus=False):
235
242
if focus or self.opened:
236
243
return self._focus_widget
237
244
return self._widget
239
246
def update(self):
240
247
"Called when what is visible on the screen should be updated."
241
248
# How to add standout mode to a style
242
with_standout = {"normal": "standout",
243
"bold": "bold-standout",
245
"underline-blink-standout",
246
"bold-underline-blink":
247
"bold-underline-blink-standout",
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"bold-underline-blink-standout",
250
257
# Rebuild focus and non-focus widgets using current properties
252
259
# Base part of a client. Name!
253
260
base = '{name}: '.format(name=self.properties["Name"])
254
261
if not self.properties["Enabled"]:
255
262
message = "DISABLED"
256
263
self.using_timer(False)
257
264
elif self.properties["ApprovalPending"]:
258
timeout = datetime.timedelta(
259
milliseconds=self.properties["ApprovalDelay"])
265
timeout = datetime.timedelta(milliseconds
260
268
last_approval_request = isoformat_to_datetime(
261
269
self.properties["LastApprovalRequest"])
262
270
if last_approval_request is not None:
305
313
# Run update hook, if any
306
314
if self.update_hook is not None:
307
315
self.update_hook()
309
317
def update_timer(self):
310
"""called by GLib. Will indefinitely loop until
311
GLib.source_remove() on tag is called
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
314
321
return True # Keep calling this
316
323
def delete(self, **kwargs):
317
324
if self._update_timer_callback_tag is not None:
318
GLib.source_remove(self._update_timer_callback_tag)
325
gobject.source_remove(self._update_timer_callback_tag)
319
326
self._update_timer_callback_tag = None
320
327
for match in self.match_objects:
323
330
if self.delete_hook is not None:
324
331
self.delete_hook(self)
325
332
return super(MandosClientWidget, self).delete(**kwargs)
327
334
def render(self, maxcolrow, focus=False):
328
335
"""Render differently if we have focus.
329
336
This overrides the method from urwid.FlowWidget"""
330
337
return self.current_widget(focus).render(maxcolrow,
333
340
def keypress(self, maxcolrow, key):
335
342
This overrides the method from urwid.FlowWidget"""
337
self.proxy.Set(client_interface, "Enabled",
338
dbus.Boolean(True), ignore_reply=True,
339
dbus_interface=dbus.PROPERTIES_IFACE)
344
self.proxy.Enable(dbus_interface = client_interface,
341
self.proxy.Set(client_interface, "Enabled", False,
343
dbus_interface=dbus.PROPERTIES_IFACE)
347
self.proxy.Disable(dbus_interface = client_interface,
345
350
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
346
dbus_interface=client_interface,
351
dbus_interface = client_interface,
347
352
ignore_reply=True)
349
354
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
350
dbus_interface=client_interface,
355
dbus_interface = client_interface,
351
356
ignore_reply=True)
352
357
elif key == "R" or key == "_" or key == "ctrl k":
353
358
self.server_proxy_object.RemoveClient(self.proxy
355
360
ignore_reply=True)
357
self.proxy.Set(client_interface, "CheckerRunning",
358
dbus.Boolean(True), ignore_reply=True,
359
dbus_interface=dbus.PROPERTIES_IFACE)
362
self.proxy.StartChecker(dbus_interface = client_interface,
361
self.proxy.Set(client_interface, "CheckerRunning",
362
dbus.Boolean(False), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
365
self.proxy.StopChecker(dbus_interface = client_interface,
365
self.proxy.CheckedOK(dbus_interface=client_interface,
368
self.proxy.CheckedOK(dbus_interface = client_interface,
366
369
ignore_reply=True)
368
371
# elif key == "p" or key == "=":
377
def properties_changed(self, interface, properties, invalidated):
378
"""Call self.update() if any properties changed.
380
def property_changed(self, property=None, **kwargs):
381
"""Call self.update() if old value is not new value.
379
382
This overrides the method from MandosClientPropertyCache"""
380
old_values = {key: self.properties.get(key)
381
for key in properties.keys()}
382
super(MandosClientWidget, self).properties_changed(
383
interface, properties, invalidated)
384
if any(old_values[key] != self.properties.get(key)
385
for key in old_values):
383
property_name = str(property)
384
old_value = self.properties.get(property_name)
385
super(MandosClientWidget, self).property_changed(
386
property=property, **kwargs)
387
if self.properties.get(property_name) != old_value:
392
394
use them as an excuse to shift focus away from this widget.
394
396
def keypress(self, *args, **kwargs):
395
ret = (super(ConstrainedListBox, self)
396
.keypress(*args, **kwargs))
397
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
397
398
if ret in ("up", "down"):
406
407
def __init__(self, max_log_length=1000, log_level=1):
407
408
DBusGMainLoop(set_as_default=True)
409
410
self.screen = urwid.curses_display.Screen()
411
412
self.screen.register_palette((
413
414
"default", "default", None),
419
420
"standout", "default", "standout"),
420
421
("bold-underline-blink",
421
"bold,underline,blink", "default",
422
"bold,underline,blink"),
422
"bold,underline,blink", "default", "bold,underline,blink"),
423
423
("bold-standout",
424
424
"bold,standout", "default", "bold,standout"),
425
425
("underline-blink-standout",
429
429
"bold,underline,blink,standout", "default",
430
430
"bold,underline,blink,standout"),
433
433
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
436
self.divider = "_" # \u005f
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
438
440
self.screen.start()
440
442
self.size = self.screen.get_cols_rows()
442
444
self.clients = urwid.SimpleListWalker([])
443
445
self.clients_dict = {}
445
447
# We will add Text widgets to this list
447
449
self.max_log_length = max_log_length
449
451
self.log_level = log_level
451
453
# We keep a reference to the log widget so we can remove it
452
454
# from the ListWalker without it getting destroyed
453
455
self.logbox = ConstrainedListBox(self.log)
455
457
# This keeps track of whether self.uilist currently has
456
458
# self.logbox in it or not
457
459
self.log_visible = True
458
460
self.log_wrap = "any"
461
463
self.log_message_raw(("bold",
462
464
"Mandos Monitor version " + version))
463
465
self.log_message_raw(("bold",
464
466
"q: Quit ?: Help"))
466
468
self.busname = domain + '.Mandos'
467
self.main_loop = GLib.MainLoop()
469
self.main_loop = gobject.MainLoop()
469
471
def client_not_found(self, fingerprint, address):
470
472
self.log_message("Client with address {} and fingerprint {}"
471
473
" could not be found"
472
474
.format(address, fingerprint))
474
476
def rebuild(self):
475
477
"""This rebuilds the User Interface.
476
478
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
480
#self.uilist.append(urwid.ListBox(self.clients))
479
481
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
483
#header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
486
urwid.Divider(div_char=
485
488
if self.log_visible:
486
489
self.uilist.append(self.logbox)
487
490
self.topwidget = urwid.Pile(self.uilist)
489
492
def log_message(self, message, level=1):
490
493
"""Log message formatted with timestamp"""
491
494
if level < self.log_level:
493
496
timestamp = datetime.datetime.now().isoformat()
494
497
self.log_message_raw("{}: {}".format(timestamp, message),
497
500
def log_message_raw(self, markup, level=1):
498
501
"""Add a log message to the log buffer."""
499
502
if level < self.log_level:
501
504
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if self.max_log_length:
503
if len(self.log) > self.max_log_length:
504
del self.log[0:len(self.log)-self.max_log_length-1]
505
if (self.max_log_length
506
and len(self.log) > self.max_log_length):
507
del self.log[0:len(self.log)-self.max_log_length-1]
505
508
self.logbox.set_focus(len(self.logbox.body.contents),
506
509
coming_from="above")
509
512
def toggle_log_display(self):
510
513
"""Toggle visibility of the log buffer."""
511
514
self.log_visible = not self.log_visible
513
516
self.log_message("Log visibility changed to: {}"
514
517
.format(self.log_visible), level=0)
516
519
def change_log_display(self):
517
520
"""Change type of log display.
518
521
Currently, this toggles wrapping of text lines."""
524
527
textwidget.set_wrap_mode(self.log_wrap)
525
528
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
531
def find_and_remove_client(self, path, name):
529
532
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
534
This is connected to the ClientRemoved signal from the
532
535
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
537
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
540
self.log_message("Unknown client {!r} ({!r}) removed"
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
545
def add_new_client(self, path):
554
546
client_proxy_object = self.bus.get_object(self.busname, path)
555
self.add_client(MandosClientWidget(
556
server_proxy_object=self.mandos_serv,
557
proxy_object=client_proxy_object,
558
update_hook=self.refresh,
559
delete_hook=self.remove_client,
560
logger=self.log_message,
561
properties=dict(ifs_and_props[client_interface])),
547
self.add_client(MandosClientWidget(server_proxy_object
550
=client_proxy_object,
564
559
def add_client(self, client, path=None):
565
560
self.clients.append(client)
568
563
self.clients_dict[path] = client
569
564
self.clients.sort(key=lambda c: c.properties["Name"])
572
567
def remove_client(self, client, path=None):
573
568
self.clients.remove(client)
575
570
path = client.proxy.object_path
576
571
del self.clients_dict[path]
579
574
def refresh(self):
580
575
"""Redraw the screen"""
581
576
canvas = self.topwidget.render(self.size, focus=True)
582
577
self.screen.draw_screen(self.size, canvas)
585
580
"""Start the main loop and exit when it's done."""
586
581
self.bus = dbus.SystemBus()
587
582
mandos_dbus_objc = self.bus.get_object(
588
583
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
584
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
592
588
mandos_clients = (self.mandos_serv
593
589
.GetAllClientsWithProperties())
594
590
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
591
self.log_message_raw(("bold", "Note: Server has no clients."))
597
592
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
593
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
594
mandos_clients = dbus.Dictionary()
602
596
(self.mandos_serv
603
.connect_to_signal("InterfacesRemoved",
597
.connect_to_signal("ClientRemoved",
604
598
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
599
dbus_interface=server_interface,
606
600
byte_arrays=True))
607
601
(self.mandos_serv
608
.connect_to_signal("InterfacesAdded",
602
.connect_to_signal("ClientAdded",
609
603
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
604
dbus_interface=server_interface,
611
605
byte_arrays=True))
612
606
(self.mandos_serv
613
607
.connect_to_signal("ClientNotFound",
617
611
for path, client in mandos_clients.items():
618
612
client_proxy_object = self.bus.get_object(self.busname,
620
self.add_client(MandosClientWidget(
621
server_proxy_object=self.mandos_serv,
622
proxy_object=client_proxy_object,
624
update_hook=self.refresh,
625
delete_hook=self.remove_client,
626
logger=self.log_message),
614
self.add_client(MandosClientWidget(server_proxy_object
617
=client_proxy_object,
630
self._input_callback_tag = (GLib.io_add_watch
628
self._input_callback_tag = (gobject.io_add_watch
631
629
(sys.stdin.fileno(),
633
631
self.process_input))
634
632
self.main_loop.run()
635
633
# Main loop has finished, we should close everything now
636
GLib.source_remove(self._input_callback_tag)
634
gobject.source_remove(self._input_callback_tag)
637
635
self.screen.stop()
640
638
self.main_loop.quit()
642
640
def process_input(self, source, condition):
643
641
keys = self.screen.get_input()
644
translations = {"ctrl n": "down", # Emacs
645
"ctrl p": "up", # Emacs
646
"ctrl v": "page down", # Emacs
647
"meta v": "page up", # Emacs
648
" ": "page down", # less
649
"f": "page down", # less
650
"b": "page up", # less
642
translations = { "ctrl n": "down", # Emacs
643
"ctrl p": "up", # Emacs
644
"ctrl v": "page down", # Emacs
645
"meta v": "page up", # Emacs
646
" ": "page down", # less
647
"f": "page down", # less
648
"b": "page up", # less
656
654
key = translations[key]
657
655
except KeyError: # :-)
660
658
if key == "q" or key == "Q":
711
709
self.log_level = 0
712
710
self.log_message("Verbose mode: On")
713
# elif (key == "end" or key == "meta >" or key == "G"
715
# pass # xxx end-of-buffer
716
# elif (key == "home" or key == "meta <" or key == "g"
718
# pass # xxx beginning-of-buffer
719
# elif key == "ctrl e" or key == "$":
720
# pass # xxx move-end-of-line
721
# elif key == "ctrl a" or key == "^":
722
# pass # xxx move-beginning-of-line
723
# elif key == "ctrl b" or key == "meta (" or key == "h":
725
# elif key == "ctrl f" or key == "meta )" or key == "l":
728
# pass # scroll up log
730
# pass # scroll down log
711
#elif (key == "end" or key == "meta >" or key == "G"
713
# pass # xxx end-of-buffer
714
#elif (key == "home" or key == "meta <" or key == "g"
716
# pass # xxx beginning-of-buffer
717
#elif key == "ctrl e" or key == "$":
718
# pass # xxx move-end-of-line
719
#elif key == "ctrl a" or key == "^":
720
# pass # xxx move-beginning-of-line
721
#elif key == "ctrl b" or key == "meta (" or key == "h":
723
#elif key == "ctrl f" or key == "meta )" or key == "l":
726
# pass # scroll up log
728
# pass # scroll down log
731
729
elif self.topwidget.selectable():
732
730
self.topwidget.keypress(self.size, key)