2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2017 Teddy Hogeborn
7
# Copyright © 2009-2017 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
90
self.proxy.connect_to_signal("PropertiesChanged",
96
91
self.properties_changed,
97
92
dbus.PROPERTIES_IFACE,
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
103
def properties_changed(self, interface, properties, invalidated):
108
104
"""This is called whenever we get a PropertiesChanged signal
109
105
It updates the changed properties in the "properties" dict.
111
107
# Update properties dict with new value
112
if interface == client_interface:
113
self.properties.update(properties)
108
self.properties.update(properties)
115
110
def delete(self):
116
111
self.property_changed_match.remove()
119
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
115
"""A Mandos Client which is visible on the screen.
123
118
def __init__(self, server_proxy_object=None, update_hook=None,
124
119
delete_hook=None, logger=None, **kwargs):
125
120
# Called on update
164
159
byte_arrays=True))
165
160
self.logger('Created client {}'
166
161
.format(self.properties["Name"]), level=0)
168
163
def using_timer(self, flag):
169
164
"""Call this method with True or False when timer should be
170
165
activated or deactivated.
172
167
if flag and self._update_timer_callback_tag is None:
173
168
# Will update the shown timer value every second
174
self._update_timer_callback_tag = (GLib.timeout_add
169
self._update_timer_callback_tag = (gobject.timeout_add
176
171
self.update_timer))
177
172
elif not (flag or self._update_timer_callback_tag is None):
178
GLib.source_remove(self._update_timer_callback_tag)
173
gobject.source_remove(self._update_timer_callback_tag)
179
174
self._update_timer_callback_tag = None
181
176
def checker_completed(self, exitstatus, condition, command):
182
177
if exitstatus == 0:
183
178
self.logger('Checker for client {} (command "{}")'
196
191
' killed by signal {}'
197
192
.format(self.properties["Name"], command,
198
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"]))
201
204
def checker_started(self, command):
202
205
"""Server signals that a checker started."""
203
206
self.logger('Client {} started checker "{}"'
204
207
.format(self.properties["Name"],
205
208
command), level=0)
207
210
def got_secret(self):
208
211
self.logger('Client {} received its secret'
209
212
.format(self.properties["Name"]))
211
214
def need_approval(self, timeout, default):
213
216
message = 'Client {} needs approval within {} seconds'
215
218
message = 'Client {} will get its secret in {} seconds'
216
219
self.logger(message.format(self.properties["Name"],
219
222
def rejected(self, reason):
220
223
self.logger('Client {} was rejected; reason: {}'
221
224
.format(self.properties["Name"], reason))
223
226
def selectable(self):
224
227
"""Make this a "selectable" widget.
225
228
This overrides the method from urwid.FlowWidget."""
228
231
def rows(self, maxcolrow, focus=False):
229
232
"""How many rows this widget will occupy might depend on
230
233
whether we have focus or not.
231
234
This overrides the method from urwid.FlowWidget"""
232
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
234
237
def current_widget(self, focus=False):
235
238
if focus or self.opened:
236
239
return self._focus_widget
237
240
return self._widget
239
242
def update(self):
240
243
"Called when what is visible on the screen should be updated."
241
244
# 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",
245
with_standout = { "normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
250
253
# Rebuild focus and non-focus widgets using current properties
252
255
# Base part of a client. Name!
253
256
base = '{name}: '.format(name=self.properties["Name"])
254
257
if not self.properties["Enabled"]:
255
258
message = "DISABLED"
256
259
self.using_timer(False)
257
260
elif self.properties["ApprovalPending"]:
258
timeout = datetime.timedelta(
259
milliseconds=self.properties["ApprovalDelay"])
261
timeout = datetime.timedelta(milliseconds
260
264
last_approval_request = isoformat_to_datetime(
261
265
self.properties["LastApprovalRequest"])
262
266
if last_approval_request is not None:
305
309
# Run update hook, if any
306
310
if self.update_hook is not None:
307
311
self.update_hook()
309
313
def update_timer(self):
310
"""called by GLib. Will indefinitely loop until
311
GLib.source_remove() on tag is called
314
"""called by gobject. Will indefinitely loop until
315
gobject.source_remove() on tag is called"""
314
317
return True # Keep calling this
316
319
def delete(self, **kwargs):
317
320
if self._update_timer_callback_tag is not None:
318
GLib.source_remove(self._update_timer_callback_tag)
321
gobject.source_remove(self._update_timer_callback_tag)
319
322
self._update_timer_callback_tag = None
320
323
for match in self.match_objects:
323
326
if self.delete_hook is not None:
324
327
self.delete_hook(self)
325
328
return super(MandosClientWidget, self).delete(**kwargs)
327
330
def render(self, maxcolrow, focus=False):
328
331
"""Render differently if we have focus.
329
332
This overrides the method from urwid.FlowWidget"""
330
333
return self.current_widget(focus).render(maxcolrow,
333
336
def keypress(self, maxcolrow, key):
335
338
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)
340
self.proxy.Enable(dbus_interface = client_interface,
341
self.proxy.Set(client_interface, "Enabled", False,
343
dbus_interface=dbus.PROPERTIES_IFACE)
343
self.proxy.Disable(dbus_interface = client_interface,
345
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
346
dbus_interface=client_interface,
347
dbus_interface = client_interface,
347
348
ignore_reply=True)
349
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
350
dbus_interface=client_interface,
351
dbus_interface = client_interface,
351
352
ignore_reply=True)
352
353
elif key == "R" or key == "_" or key == "ctrl k":
353
354
self.server_proxy_object.RemoveClient(self.proxy
355
356
ignore_reply=True)
357
self.proxy.Set(client_interface, "CheckerRunning",
358
dbus.Boolean(True), ignore_reply=True,
359
dbus_interface=dbus.PROPERTIES_IFACE)
358
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)
361
self.proxy.StopChecker(dbus_interface = client_interface,
365
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
366
365
ignore_reply=True)
368
367
# elif key == "p" or key == "=":
377
376
def properties_changed(self, interface, properties, invalidated):
378
377
"""Call self.update() if any properties changed.
379
378
This overrides the method from MandosClientPropertyCache"""
380
old_values = {key: self.properties.get(key)
381
for key in properties.keys()}
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
382
381
super(MandosClientWidget, self).properties_changed(
383
382
interface, properties, invalidated)
384
383
if any(old_values[key] != self.properties.get(key)
392
391
use them as an excuse to shift focus away from this widget.
394
393
def keypress(self, *args, **kwargs):
395
ret = (super(ConstrainedListBox, self)
396
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
397
395
if ret in ("up", "down"):
406
404
def __init__(self, max_log_length=1000, log_level=1):
407
405
DBusGMainLoop(set_as_default=True)
409
407
self.screen = urwid.curses_display.Screen()
411
409
self.screen.register_palette((
413
411
"default", "default", None),
419
417
"standout", "default", "standout"),
420
418
("bold-underline-blink",
421
"bold,underline,blink", "default",
422
"bold,underline,blink"),
419
"bold,underline,blink", "default", "bold,underline,blink"),
423
420
("bold-standout",
424
421
"bold,standout", "default", "bold,standout"),
425
422
("underline-blink-standout",
429
426
"bold,underline,blink,standout", "default",
430
427
"bold,underline,blink,standout"),
433
430
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
436
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
438
437
self.screen.start()
440
439
self.size = self.screen.get_cols_rows()
442
441
self.clients = urwid.SimpleListWalker([])
443
442
self.clients_dict = {}
445
444
# We will add Text widgets to this list
447
446
self.max_log_length = max_log_length
449
448
self.log_level = log_level
451
450
# We keep a reference to the log widget so we can remove it
452
451
# from the ListWalker without it getting destroyed
453
452
self.logbox = ConstrainedListBox(self.log)
455
454
# This keeps track of whether self.uilist currently has
456
455
# self.logbox in it or not
457
456
self.log_visible = True
458
457
self.log_wrap = "any"
461
460
self.log_message_raw(("bold",
462
461
"Mandos Monitor version " + version))
463
462
self.log_message_raw(("bold",
464
463
"q: Quit ?: Help"))
466
465
self.busname = domain + '.Mandos'
467
self.main_loop = GLib.MainLoop()
466
self.main_loop = gobject.MainLoop()
469
468
def client_not_found(self, fingerprint, address):
470
469
self.log_message("Client with address {} and fingerprint {}"
471
470
" could not be found"
472
471
.format(address, fingerprint))
474
473
def rebuild(self):
475
474
"""This rebuilds the User Interface.
476
475
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
479
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
480
#header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
483
urwid.Divider(div_char=
485
485
if self.log_visible:
486
486
self.uilist.append(self.logbox)
487
487
self.topwidget = urwid.Pile(self.uilist)
489
489
def log_message(self, message, level=1):
490
490
"""Log message formatted with timestamp"""
491
491
if level < self.log_level:
493
493
timestamp = datetime.datetime.now().isoformat()
494
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
497
def log_message_raw(self, markup, level=1):
498
498
"""Add a log message to the log buffer."""
499
499
if level < self.log_level:
501
501
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]
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
505
self.logbox.set_focus(len(self.logbox.body.contents),
506
506
coming_from="above")
509
509
def toggle_log_display(self):
510
510
"""Toggle visibility of the log buffer."""
511
511
self.log_visible = not self.log_visible
513
513
self.log_message("Log visibility changed to: {}"
514
514
.format(self.log_visible), level=0)
516
516
def change_log_display(self):
517
517
"""Change type of log display.
518
518
Currently, this toggles wrapping of text lines."""
524
524
textwidget.set_wrap_mode(self.log_wrap)
525
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
528
def find_and_remove_client(self, path, name):
529
529
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
531
This is connected to the ClientRemoved signal from the
532
532
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
534
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
537
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
542
def add_new_client(self, path):
554
543
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])),
544
self.add_client(MandosClientWidget(server_proxy_object
547
=client_proxy_object,
564
556
def add_client(self, client, path=None):
565
557
self.clients.append(client)
568
560
self.clients_dict[path] = client
569
561
self.clients.sort(key=lambda c: c.properties["Name"])
572
564
def remove_client(self, client, path=None):
573
565
self.clients.remove(client)
575
567
path = client.proxy.object_path
576
568
del self.clients_dict[path]
579
571
def refresh(self):
580
572
"""Redraw the screen"""
581
573
canvas = self.topwidget.render(self.size, focus=True)
582
574
self.screen.draw_screen(self.size, canvas)
585
577
"""Start the main loop and exit when it's done."""
586
578
self.bus = dbus.SystemBus()
587
579
mandos_dbus_objc = self.bus.get_object(
588
580
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
592
585
mandos_clients = (self.mandos_serv
593
586
.GetAllClientsWithProperties())
594
587
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
588
self.log_message_raw(("bold", "Note: Server has no clients."))
597
589
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
591
mandos_clients = dbus.Dictionary()
602
593
(self.mandos_serv
603
.connect_to_signal("InterfacesRemoved",
594
.connect_to_signal("ClientRemoved",
604
595
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
dbus_interface=server_interface,
606
597
byte_arrays=True))
607
598
(self.mandos_serv
608
.connect_to_signal("InterfacesAdded",
599
.connect_to_signal("ClientAdded",
609
600
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
601
dbus_interface=server_interface,
611
602
byte_arrays=True))
612
603
(self.mandos_serv
613
604
.connect_to_signal("ClientNotFound",
617
608
for path, client in mandos_clients.items():
618
609
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),
611
self.add_client(MandosClientWidget(server_proxy_object
614
=client_proxy_object,
630
self._input_callback_tag = (GLib.io_add_watch
625
self._input_callback_tag = (gobject.io_add_watch
631
626
(sys.stdin.fileno(),
633
628
self.process_input))
634
629
self.main_loop.run()
635
630
# Main loop has finished, we should close everything now
636
GLib.source_remove(self._input_callback_tag)
631
gobject.source_remove(self._input_callback_tag)
637
632
self.screen.stop()
640
635
self.main_loop.quit()
642
637
def process_input(self, source, condition):
643
638
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
639
translations = { "ctrl n": "down", # Emacs
640
"ctrl p": "up", # Emacs
641
"ctrl v": "page down", # Emacs
642
"meta v": "page up", # Emacs
643
" ": "page down", # less
644
"f": "page down", # less
645
"b": "page up", # less
656
651
key = translations[key]
657
652
except KeyError: # :-)
660
655
if key == "q" or key == "Q":
711
706
self.log_level = 0
712
707
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
708
#elif (key == "end" or key == "meta >" or key == "G"
710
# pass # xxx end-of-buffer
711
#elif (key == "home" or key == "meta <" or key == "g"
713
# pass # xxx beginning-of-buffer
714
#elif key == "ctrl e" or key == "$":
715
# pass # xxx move-end-of-line
716
#elif key == "ctrl a" or key == "^":
717
# pass # xxx move-beginning-of-line
718
#elif key == "ctrl b" or key == "meta (" or key == "h":
720
#elif key == "ctrl f" or key == "meta )" or key == "l":
723
# pass # scroll up log
725
# pass # scroll down log
731
726
elif self.topwidget.selectable():
732
727
self.topwidget.keypress(self.size, key)
737
731
ui = UserInterface()