2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
6
# Copyright © 2009-2016 Teddy Hogeborn
7
7
# Copyright © 2009-2016 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
66
dbus.OBJECT_MANAGER_IFACE
65
67
except AttributeError:
66
68
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
69
70
def isoformat_to_datetime(iso):
70
71
"Parse an ISO 8601 date string to a datetime.datetime()"
82
int(second), # Whole seconds
83
int(fraction*1000000)) # Microseconds
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
86
class MandosClientPropertyCache(object):
87
87
"""This wraps a Mandos Client D-Bus proxy object, caches the
91
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
92
self.proxy = proxy_object # Mandos Client proxy object
93
93
self.properties = dict() if properties is None else properties
94
94
self.property_changed_match = (
95
95
self.proxy.connect_to_signal("PropertiesChanged",
96
96
self.properties_changed,
97
97
dbus.PROPERTIES_IFACE,
100
100
if properties is None:
101
self.properties.update(self.proxy.GetAll(
103
dbus_interface=dbus.PROPERTIES_IFACE))
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
105
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
107
108
def properties_changed(self, interface, properties, invalidated):
108
109
"""This is called whenever we get a PropertiesChanged signal
109
110
It updates the changed properties in the "properties" dict.
119
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
121
"""A Mandos Client which is visible on the screen.
123
124
def __init__(self, server_proxy_object=None, update_hook=None,
124
125
delete_hook=None, logger=None, **kwargs):
125
126
# Called on update
164
165
byte_arrays=True))
165
166
self.logger('Created client {}'
166
167
.format(self.properties["Name"]), level=0)
168
169
def using_timer(self, flag):
169
170
"""Call this method with True or False when timer should be
170
171
activated or deactivated.
172
173
if flag and self._update_timer_callback_tag is None:
173
174
# Will update the shown timer value every second
174
self._update_timer_callback_tag = (GLib.timeout_add
175
self._update_timer_callback_tag = (gobject.timeout_add
176
177
self.update_timer))
177
178
elif not (flag or self._update_timer_callback_tag is None):
178
GLib.source_remove(self._update_timer_callback_tag)
179
gobject.source_remove(self._update_timer_callback_tag)
179
180
self._update_timer_callback_tag = None
181
182
def checker_completed(self, exitstatus, condition, command):
182
183
if exitstatus == 0:
183
184
self.logger('Checker for client {} (command "{}")'
197
198
.format(self.properties["Name"], command,
198
199
os.WTERMSIG(condition)))
201
202
def checker_started(self, command):
202
203
"""Server signals that a checker started."""
203
204
self.logger('Client {} started checker "{}"'
204
205
.format(self.properties["Name"],
205
206
command), level=0)
207
208
def got_secret(self):
208
209
self.logger('Client {} received its secret'
209
210
.format(self.properties["Name"]))
211
212
def need_approval(self, timeout, default):
213
214
message = 'Client {} needs approval within {} seconds'
215
216
message = 'Client {} will get its secret in {} seconds'
216
217
self.logger(message.format(self.properties["Name"],
219
220
def rejected(self, reason):
220
221
self.logger('Client {} was rejected; reason: {}'
221
222
.format(self.properties["Name"], reason))
223
224
def selectable(self):
224
225
"""Make this a "selectable" widget.
225
226
This overrides the method from urwid.FlowWidget."""
228
229
def rows(self, maxcolrow, focus=False):
229
230
"""How many rows this widget will occupy might depend on
230
231
whether we have focus or not.
231
232
This overrides the method from urwid.FlowWidget"""
232
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
234
235
def current_widget(self, focus=False):
235
236
if focus or self.opened:
236
237
return self._focus_widget
237
238
return self._widget
239
240
def update(self):
240
241
"Called when what is visible on the screen should be updated."
241
242
# 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",
243
with_standout = { "normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
250
251
# Rebuild focus and non-focus widgets using current properties
252
253
# Base part of a client. Name!
253
254
base = '{name}: '.format(name=self.properties["Name"])
254
255
if not self.properties["Enabled"]:
255
256
message = "DISABLED"
256
257
self.using_timer(False)
257
258
elif self.properties["ApprovalPending"]:
258
timeout = datetime.timedelta(
259
milliseconds=self.properties["ApprovalDelay"])
259
timeout = datetime.timedelta(milliseconds
260
262
last_approval_request = isoformat_to_datetime(
261
263
self.properties["LastApprovalRequest"])
262
264
if last_approval_request is not None:
305
307
# Run update hook, if any
306
308
if self.update_hook is not None:
307
309
self.update_hook()
309
311
def update_timer(self):
310
"""called by GLib. Will indefinitely loop until
311
GLib.source_remove() on tag is called
312
"""called by gobject. Will indefinitely loop until
313
gobject.source_remove() on tag is called"""
314
315
return True # Keep calling this
316
317
def delete(self, **kwargs):
317
318
if self._update_timer_callback_tag is not None:
318
GLib.source_remove(self._update_timer_callback_tag)
319
gobject.source_remove(self._update_timer_callback_tag)
319
320
self._update_timer_callback_tag = None
320
321
for match in self.match_objects:
323
324
if self.delete_hook is not None:
324
325
self.delete_hook(self)
325
326
return super(MandosClientWidget, self).delete(**kwargs)
327
328
def render(self, maxcolrow, focus=False):
328
329
"""Render differently if we have focus.
329
330
This overrides the method from urwid.FlowWidget"""
330
331
return self.current_widget(focus).render(maxcolrow,
333
334
def keypress(self, maxcolrow, key):
335
336
This overrides the method from urwid.FlowWidget"""
337
338
self.proxy.Set(client_interface, "Enabled",
338
dbus.Boolean(True), ignore_reply=True,
339
dbus_interface=dbus.PROPERTIES_IFACE)
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
341
342
self.proxy.Set(client_interface, "Enabled", False,
343
dbus_interface=dbus.PROPERTIES_IFACE)
344
dbus_interface = dbus.PROPERTIES_IFACE)
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
358
self.proxy.Set(client_interface, "CheckerRunning",
358
dbus.Boolean(True), ignore_reply=True,
359
dbus_interface=dbus.PROPERTIES_IFACE)
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
361
362
self.proxy.Set(client_interface, "CheckerRunning",
362
dbus.Boolean(False), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
365
self.proxy.CheckedOK(dbus_interface=client_interface,
366
self.proxy.CheckedOK(dbus_interface = client_interface,
366
367
ignore_reply=True)
368
369
# elif key == "p" or key == "=":
377
378
def properties_changed(self, interface, properties, invalidated):
378
379
"""Call self.update() if any properties changed.
379
380
This overrides the method from MandosClientPropertyCache"""
380
old_values = {key: self.properties.get(key)
381
for key in properties.keys()}
381
old_values = { key: self.properties.get(key)
382
for key in properties.keys() }
382
383
super(MandosClientWidget, self).properties_changed(
383
384
interface, properties, invalidated)
384
385
if any(old_values[key] != self.properties.get(key)
392
393
use them as an excuse to shift focus away from this widget.
394
395
def keypress(self, *args, **kwargs):
395
ret = (super(ConstrainedListBox, self)
396
.keypress(*args, **kwargs))
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
397
397
if ret in ("up", "down"):
406
406
def __init__(self, max_log_length=1000, log_level=1):
407
407
DBusGMainLoop(set_as_default=True)
409
409
self.screen = urwid.curses_display.Screen()
411
411
self.screen.register_palette((
413
413
"default", "default", None),
419
419
"standout", "default", "standout"),
420
420
("bold-underline-blink",
421
"bold,underline,blink", "default",
422
"bold,underline,blink"),
421
"bold,underline,blink", "default", "bold,underline,blink"),
423
422
("bold-standout",
424
423
"bold,standout", "default", "bold,standout"),
425
424
("underline-blink-standout",
429
428
"bold,underline,blink,standout", "default",
430
429
"bold,underline,blink,standout"),
433
432
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
436
self.divider = "_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
438
439
self.screen.start()
440
441
self.size = self.screen.get_cols_rows()
442
443
self.clients = urwid.SimpleListWalker([])
443
444
self.clients_dict = {}
445
446
# We will add Text widgets to this list
447
448
self.max_log_length = max_log_length
449
450
self.log_level = log_level
451
452
# We keep a reference to the log widget so we can remove it
452
453
# from the ListWalker without it getting destroyed
453
454
self.logbox = ConstrainedListBox(self.log)
455
456
# This keeps track of whether self.uilist currently has
456
457
# self.logbox in it or not
457
458
self.log_visible = True
458
459
self.log_wrap = "any"
461
462
self.log_message_raw(("bold",
462
463
"Mandos Monitor version " + version))
463
464
self.log_message_raw(("bold",
464
465
"q: Quit ?: Help"))
466
467
self.busname = domain + '.Mandos'
467
self.main_loop = GLib.MainLoop()
468
self.main_loop = gobject.MainLoop()
469
470
def client_not_found(self, fingerprint, address):
470
471
self.log_message("Client with address {} and fingerprint {}"
471
472
" could not be found"
472
473
.format(address, fingerprint))
474
475
def rebuild(self):
475
476
"""This rebuilds the User Interface.
476
477
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
479
#self.uilist.append(urwid.ListBox(self.clients))
479
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
482
#header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
485
urwid.Divider(div_char=
485
487
if self.log_visible:
486
488
self.uilist.append(self.logbox)
487
489
self.topwidget = urwid.Pile(self.uilist)
489
491
def log_message(self, message, level=1):
490
492
"""Log message formatted with timestamp"""
491
493
if level < self.log_level:
493
495
timestamp = datetime.datetime.now().isoformat()
494
496
self.log_message_raw("{}: {}".format(timestamp, message),
497
499
def log_message_raw(self, markup, level=1):
498
500
"""Add a log message to the log buffer."""
499
501
if level < self.log_level:
501
503
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]
504
if (self.max_log_length
505
and len(self.log) > self.max_log_length):
506
del self.log[0:len(self.log)-self.max_log_length-1]
505
507
self.logbox.set_focus(len(self.logbox.body.contents),
506
508
coming_from="above")
509
511
def toggle_log_display(self):
510
512
"""Toggle visibility of the log buffer."""
511
513
self.log_visible = not self.log_visible
513
515
self.log_message("Log visibility changed to: {}"
514
516
.format(self.log_visible), level=0)
516
518
def change_log_display(self):
517
519
"""Change type of log display.
518
520
Currently, this toggles wrapping of text lines."""
524
526
textwidget.set_wrap_mode(self.log_wrap)
525
527
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
530
def find_and_remove_client(self, path, interfaces):
529
531
"""Find a client by its object path and remove it.
531
533
This is connected to the InterfacesRemoved signal from the
532
534
Mandos server object."""
533
535
if client_interface not in interfaces:
552
554
# Not a Mandos client object; ignore
554
556
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])),
557
self.add_client(MandosClientWidget(server_proxy_object
560
=client_proxy_object,
568
= dict(ifs_and_props[
564
572
def add_client(self, client, path=None):
565
573
self.clients.append(client)
568
576
self.clients_dict[path] = client
569
577
self.clients.sort(key=lambda c: c.properties["Name"])
572
580
def remove_client(self, client, path=None):
573
581
self.clients.remove(client)
575
583
path = client.proxy.object_path
576
584
del self.clients_dict[path]
579
587
def refresh(self):
580
588
"""Redraw the screen"""
581
589
canvas = self.topwidget.render(self.size, focus=True)
582
590
self.screen.draw_screen(self.size, canvas)
585
593
"""Start the main loop and exit when it's done."""
586
594
self.bus = dbus.SystemBus()
587
595
mandos_dbus_objc = self.bus.get_object(
588
596
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
592
601
mandos_clients = (self.mandos_serv
593
602
.GetAllClientsWithProperties())
594
603
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
604
self.log_message_raw(("bold", "Note: Server has no clients."))
597
605
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
607
mandos_clients = dbus.Dictionary()
602
609
(self.mandos_serv
603
610
.connect_to_signal("InterfacesRemoved",
604
611
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
613
= dbus.OBJECT_MANAGER_IFACE,
606
614
byte_arrays=True))
607
615
(self.mandos_serv
608
616
.connect_to_signal("InterfacesAdded",
609
617
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
619
= dbus.OBJECT_MANAGER_IFACE,
611
620
byte_arrays=True))
612
621
(self.mandos_serv
613
622
.connect_to_signal("ClientNotFound",
617
626
for path, client in mandos_clients.items():
618
627
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),
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
630
self._input_callback_tag = (GLib.io_add_watch
643
self._input_callback_tag = (gobject.io_add_watch
631
644
(sys.stdin.fileno(),
633
646
self.process_input))
634
647
self.main_loop.run()
635
648
# Main loop has finished, we should close everything now
636
GLib.source_remove(self._input_callback_tag)
649
gobject.source_remove(self._input_callback_tag)
637
650
self.screen.stop()
640
653
self.main_loop.quit()
642
655
def process_input(self, source, condition):
643
656
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
657
translations = { "ctrl n": "down", # Emacs
658
"ctrl p": "up", # Emacs
659
"ctrl v": "page down", # Emacs
660
"meta v": "page up", # Emacs
661
" ": "page down", # less
662
"f": "page down", # less
663
"b": "page up", # less
656
669
key = translations[key]
657
670
except KeyError: # :-)
660
673
if key == "q" or key == "Q":
711
724
self.log_level = 0
712
725
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
726
#elif (key == "end" or key == "meta >" or key == "G"
728
# pass # xxx end-of-buffer
729
#elif (key == "home" or key == "meta <" or key == "g"
731
# pass # xxx beginning-of-buffer
732
#elif key == "ctrl e" or key == "$":
733
# pass # xxx move-end-of-line
734
#elif key == "ctrl a" or key == "^":
735
# pass # xxx move-beginning-of-line
736
#elif key == "ctrl b" or key == "meta (" or key == "h":
738
#elif key == "ctrl f" or key == "meta )" or key == "l":
741
# pass # scroll up log
743
# pass # scroll down log
731
744
elif self.topwidget.selectable():
732
745
self.topwidget.keypress(self.size, key)
737
749
ui = UserInterface()