2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2019 Teddy Hogeborn
7
# Copyright © 2009-2019 Björn Påhlsson
9
# This file is part of Mandos.
11
# Mandos is free software: you can redistribute it and/or modify it
12
# under the terms of the GNU General Public License as published by
6
# Copyright © 2009-2016 Teddy Hogeborn
7
# Copyright © 2009-2016 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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
17
# GNU General Public License for more details.
21
19
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
24
23
# Contact the authors at <mandos@recompile.se>.
27
26
from __future__ import (division, absolute_import, print_function,
51
48
if sys.version_info.major == 2:
54
51
locale.setlocale(locale.LC_ALL, '')
56
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
58
56
# Some useful constants
59
57
domain = 'se.recompile'
60
58
server_interface = domain + '.Mandos'
61
59
client_interface = domain + '.Mandos.Client'
65
63
dbus.OBJECT_MANAGER_IFACE
66
64
except AttributeError:
67
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
67
def isoformat_to_datetime(iso):
71
68
"Parse an ISO 8601 date string to a datetime.datetime()"
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
80
int(second), # Whole seconds
81
int(fraction*1000000)) # Microseconds
87
83
class MandosClientPropertyCache(object):
88
84
"""This wraps a Mandos Client D-Bus proxy object, caches the
92
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
93
self.proxy = proxy_object # Mandos Client proxy object
89
self.proxy = proxy_object # Mandos Client proxy object
94
90
self.properties = dict() if properties is None else properties
95
91
self.property_changed_match = (
96
92
self.proxy.connect_to_signal("PropertiesChanged",
97
93
self.properties_changed,
98
94
dbus.PROPERTIES_IFACE,
101
97
if properties is None:
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
106
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
105
def properties_changed(self, interface, properties, invalidated):
109
106
"""This is called whenever we get a PropertiesChanged signal
110
107
It updates the changed properties in the "properties" dict.
120
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
121
118
"""A Mandos Client which is visible on the screen.
124
121
def __init__(self, server_proxy_object=None, update_hook=None,
125
122
delete_hook=None, logger=None, **kwargs):
126
123
# Called on update
178
175
elif not (flag or self._update_timer_callback_tag is None):
179
176
GLib.source_remove(self._update_timer_callback_tag)
180
177
self._update_timer_callback_tag = None
182
179
def checker_completed(self, exitstatus, condition, command):
183
180
if exitstatus == 0:
184
181
self.logger('Checker for client {} (command "{}")'
198
195
.format(self.properties["Name"], command,
199
196
os.WTERMSIG(condition)))
202
199
def checker_started(self, command):
203
200
"""Server signals that a checker started."""
204
201
self.logger('Client {} started checker "{}"'
205
202
.format(self.properties["Name"],
206
203
command), level=0)
208
205
def got_secret(self):
209
206
self.logger('Client {} received its secret'
210
207
.format(self.properties["Name"]))
212
209
def need_approval(self, timeout, default):
214
211
message = 'Client {} needs approval within {} seconds'
216
213
message = 'Client {} will get its secret in {} seconds'
217
214
self.logger(message.format(self.properties["Name"],
220
217
def rejected(self, reason):
221
218
self.logger('Client {} was rejected; reason: {}'
222
219
.format(self.properties["Name"], reason))
224
221
def selectable(self):
225
222
"""Make this a "selectable" widget.
226
223
This overrides the method from urwid.FlowWidget."""
229
226
def rows(self, maxcolrow, focus=False):
230
227
"""How many rows this widget will occupy might depend on
231
228
whether we have focus or not.
232
229
This overrides the method from urwid.FlowWidget"""
233
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
232
def current_widget(self, focus=False):
236
233
if focus or self.opened:
237
234
return self._focus_widget
238
235
return self._widget
240
237
def update(self):
241
238
"Called when what is visible on the screen should be updated."
242
239
# How to add standout mode to a style
243
with_standout = {"normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
251
248
# Rebuild focus and non-focus widgets using current properties
253
250
# Base part of a client. Name!
254
251
base = '{name}: '.format(name=self.properties["Name"])
255
252
if not self.properties["Enabled"]:
256
253
message = "DISABLED"
257
254
self.using_timer(False)
258
255
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
256
timeout = datetime.timedelta(milliseconds
261
259
last_approval_request = isoformat_to_datetime(
262
260
self.properties["LastApprovalRequest"])
263
261
if last_approval_request is not None:
306
304
# Run update hook, if any
307
305
if self.update_hook is not None:
308
306
self.update_hook()
310
308
def update_timer(self):
311
309
"""called by GLib. Will indefinitely loop until
312
310
GLib.source_remove() on tag is called
315
313
return True # Keep calling this
317
315
def delete(self, **kwargs):
318
316
if self._update_timer_callback_tag is not None:
319
317
GLib.source_remove(self._update_timer_callback_tag)
324
322
if self.delete_hook is not None:
325
323
self.delete_hook(self)
326
324
return super(MandosClientWidget, self).delete(**kwargs)
328
326
def render(self, maxcolrow, focus=False):
329
327
"""Render differently if we have focus.
330
328
This overrides the method from urwid.FlowWidget"""
331
329
return self.current_widget(focus).render(maxcolrow,
334
332
def keypress(self, maxcolrow, key):
336
334
This overrides the method from urwid.FlowWidget"""
338
336
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply=True,
340
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
342
340
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
346
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
345
dbus_interface = client_interface,
348
346
ignore_reply=True)
350
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
349
dbus_interface = client_interface,
352
350
ignore_reply=True)
353
351
elif key == "R" or key == "_" or key == "ctrl k":
354
352
self.server_proxy_object.RemoveClient(self.proxy
356
354
ignore_reply=True)
358
356
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
362
360
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply=True,
364
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
367
365
ignore_reply=True)
369
367
# elif key == "p" or key == "=":
378
376
def properties_changed(self, interface, properties, invalidated):
379
377
"""Call self.update() if any properties changed.
380
378
This overrides the method from MandosClientPropertyCache"""
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
383
381
super(MandosClientWidget, self).properties_changed(
384
382
interface, properties, invalidated)
385
383
if any(old_values[key] != self.properties.get(key)
393
391
use them as an excuse to shift focus away from this widget.
395
393
def keypress(self, *args, **kwargs):
396
ret = (super(ConstrainedListBox, self)
397
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
398
395
if ret in ("up", "down"):
407
404
def __init__(self, max_log_length=1000, log_level=1):
408
405
DBusGMainLoop(set_as_default=True)
410
407
self.screen = urwid.curses_display.Screen()
412
409
self.screen.register_palette((
414
411
"default", "default", None),
420
417
"standout", "default", "standout"),
421
418
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
419
"bold,underline,blink", "default", "bold,underline,blink"),
424
420
("bold-standout",
425
421
"bold,standout", "default", "bold,standout"),
426
422
("underline-blink-standout",
430
426
"bold,underline,blink,standout", "default",
431
427
"bold,underline,blink,standout"),
434
430
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
437
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
439
437
self.screen.start()
441
439
self.size = self.screen.get_cols_rows()
443
441
self.clients = urwid.SimpleListWalker([])
444
442
self.clients_dict = {}
446
444
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
446
self.max_log_length = max_log_length
450
448
self.log_level = log_level
452
450
# We keep a reference to the log widget so we can remove it
453
451
# from the ListWalker without it getting destroyed
454
452
self.logbox = ConstrainedListBox(self.log)
456
454
# This keeps track of whether self.uilist currently has
457
455
# self.logbox in it or not
458
456
self.log_visible = True
459
457
self.log_wrap = "any"
462
460
self.log_message_raw(("bold",
463
461
"Mandos Monitor version " + version))
464
462
self.log_message_raw(("bold",
465
463
"q: Quit ?: Help"))
467
465
self.busname = domain + '.Mandos'
468
466
self.main_loop = GLib.MainLoop()
470
468
def client_not_found(self, fingerprint, address):
471
469
self.log_message("Client with address {} and fingerprint {}"
472
470
" could not be found"
473
471
.format(address, fingerprint))
475
473
def rebuild(self):
476
474
"""This rebuilds the User Interface.
477
475
Call this when the widget layout needs to change"""
479
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
480
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
# header=urwid.Divider(),
480
#header=urwid.Divider(),
484
footer=urwid.Divider(
485
div_char=self.divider)))
483
urwid.Divider(div_char=
486
485
if self.log_visible:
487
486
self.uilist.append(self.logbox)
488
487
self.topwidget = urwid.Pile(self.uilist)
490
489
def log_message(self, message, level=1):
491
490
"""Log message formatted with timestamp"""
492
491
if level < self.log_level:
494
493
timestamp = datetime.datetime.now().isoformat()
495
494
self.log_message_raw("{}: {}".format(timestamp, message),
498
497
def log_message_raw(self, markup, level=1):
499
498
"""Add a log message to the log buffer."""
500
499
if level < self.log_level:
502
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
503
if self.max_log_length:
504
if len(self.log) > self.max_log_length:
505
del self.log[0:len(self.log)-self.max_log_length-1]
506
self.logbox.set_focus(len(self.logbox.body.contents)-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
self.logbox.set_focus(len(self.logbox.body.contents),
507
506
coming_from="above")
510
509
def toggle_log_display(self):
511
510
"""Toggle visibility of the log buffer."""
512
511
self.log_visible = not self.log_visible
514
513
self.log_message("Log visibility changed to: {}"
515
514
.format(self.log_visible), level=0)
517
516
def change_log_display(self):
518
517
"""Change type of log display.
519
518
Currently, this toggles wrapping of text lines."""
525
524
textwidget.set_wrap_mode(self.log_wrap)
526
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
529
528
def find_and_remove_client(self, path, interfaces):
530
529
"""Find a client by its object path and remove it.
532
531
This is connected to the InterfacesRemoved signal from the
533
532
Mandos server object."""
534
533
if client_interface not in interfaces:
553
552
# Not a Mandos client object; ignore
555
554
client_proxy_object = self.bus.get_object(self.busname, path)
556
self.add_client(MandosClientWidget(
557
server_proxy_object=self.mandos_serv,
558
proxy_object=client_proxy_object,
559
update_hook=self.refresh,
560
delete_hook=self.remove_client,
561
logger=self.log_message,
562
properties=dict(ifs_and_props[client_interface])),
555
self.add_client(MandosClientWidget(server_proxy_object
558
=client_proxy_object,
566
= dict(ifs_and_props[
565
570
def add_client(self, client, path=None):
566
571
self.clients.append(client)
569
574
self.clients_dict[path] = client
570
575
self.clients.sort(key=lambda c: c.properties["Name"])
573
578
def remove_client(self, client, path=None):
574
579
self.clients.remove(client)
576
581
path = client.proxy.object_path
577
582
del self.clients_dict[path]
580
585
def refresh(self):
581
586
"""Redraw the screen"""
582
587
canvas = self.topwidget.render(self.size, focus=True)
583
588
self.screen.draw_screen(self.size, canvas)
586
591
"""Start the main loop and exit when it's done."""
587
592
self.bus = dbus.SystemBus()
588
593
mandos_dbus_objc = self.bus.get_object(
589
594
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
599
mandos_clients = (self.mandos_serv
594
600
.GetAllClientsWithProperties())
595
601
if not mandos_clients:
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
602
self.log_message_raw(("bold", "Note: Server has no clients."))
598
603
except dbus.exceptions.DBusException:
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
601
605
mandos_clients = dbus.Dictionary()
603
607
(self.mandos_serv
604
608
.connect_to_signal("InterfacesRemoved",
605
609
self.find_and_remove_client,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
= dbus.OBJECT_MANAGER_IFACE,
607
612
byte_arrays=True))
608
613
(self.mandos_serv
609
614
.connect_to_signal("InterfacesAdded",
610
615
self.add_new_client,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
617
= dbus.OBJECT_MANAGER_IFACE,
612
618
byte_arrays=True))
613
619
(self.mandos_serv
614
620
.connect_to_signal("ClientNotFound",
618
624
for path, client in mandos_clients.items():
619
625
client_proxy_object = self.bus.get_object(self.busname,
621
self.add_client(MandosClientWidget(
622
server_proxy_object=self.mandos_serv,
623
proxy_object=client_proxy_object,
625
update_hook=self.refresh,
626
delete_hook=self.remove_client,
627
logger=self.log_message),
627
self.add_client(MandosClientWidget(server_proxy_object
630
=client_proxy_object,
631
641
self._input_callback_tag = (GLib.io_add_watch
632
642
(sys.stdin.fileno(),
636
646
# Main loop has finished, we should close everything now
637
647
GLib.source_remove(self._input_callback_tag)
638
648
self.screen.stop()
641
651
self.main_loop.quit()
643
653
def process_input(self, source, condition):
644
654
keys = self.screen.get_input()
645
translations = {"ctrl n": "down", # Emacs
646
"ctrl p": "up", # Emacs
647
"ctrl v": "page down", # Emacs
648
"meta v": "page up", # Emacs
649
" ": "page down", # less
650
"f": "page down", # less
651
"b": "page up", # less
655
translations = { "ctrl n": "down", # Emacs
656
"ctrl p": "up", # Emacs
657
"ctrl v": "page down", # Emacs
658
"meta v": "page up", # Emacs
659
" ": "page down", # less
660
"f": "page down", # less
661
"b": "page up", # less
657
667
key = translations[key]
658
668
except KeyError: # :-)
661
671
if key == "q" or key == "Q":
712
722
self.log_level = 0
713
723
self.log_message("Verbose mode: On")
714
# elif (key == "end" or key == "meta >" or key == "G"
716
# pass # xxx end-of-buffer
717
# elif (key == "home" or key == "meta <" or key == "g"
719
# pass # xxx beginning-of-buffer
720
# elif key == "ctrl e" or key == "$":
721
# pass # xxx move-end-of-line
722
# elif key == "ctrl a" or key == "^":
723
# pass # xxx move-beginning-of-line
724
# elif key == "ctrl b" or key == "meta (" or key == "h":
726
# elif key == "ctrl f" or key == "meta )" or key == "l":
729
# pass # scroll up log
731
# pass # scroll down log
724
#elif (key == "end" or key == "meta >" or key == "G"
726
# pass # xxx end-of-buffer
727
#elif (key == "home" or key == "meta <" or key == "g"
729
# pass # xxx beginning-of-buffer
730
#elif key == "ctrl e" or key == "$":
731
# pass # xxx move-end-of-line
732
#elif key == "ctrl a" or key == "^":
733
# pass # xxx move-beginning-of-line
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
739
# pass # scroll up log
741
# pass # scroll down log
732
742
elif self.topwidget.selectable():
733
743
self.topwidget.keypress(self.size, key)
738
747
ui = UserInterface()