1
#!/usr/bin/python3 -bbI
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
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
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (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
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
19
# GNU General Public License for more details.
19
21
# 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/>.
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
24
# Contact the authors at <mandos@recompile.se>.
26
26
from __future__ import (division, absolute_import, print_function,
29
30
from future_builtins import *
30
31
except ImportError:
38
41
import urwid.curses_display
41
44
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
45
from gi.repository import GLib
51
49
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
54
# Show warnings by default
55
if not sys.warnoptions:
56
warnings.simplefilter("default")
58
log = logging.getLogger(os.path.basename(sys.argv[0]))
59
logging.basicConfig(level="NOTSET", # Show all messages
60
format="%(message)s") # Show basic log messages
62
logging.captureWarnings(True) # Show warnings via the logging system
64
locale.setlocale(locale.LC_ALL, "")
66
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
67
logging.getLogger("urwid").setLevel(logging.INFO)
59
69
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
70
domain = "se.recompile"
71
server_interface = domain + ".Mandos"
72
client_interface = domain + ".Mandos.Client"
66
76
dbus.OBJECT_MANAGER_IFACE
67
77
except AttributeError:
68
78
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
81
def isoformat_to_datetime(iso):
71
82
"Parse an ISO 8601 date string to a datetime.datetime()"
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
class MandosClientPropertyCache(object):
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
87
99
"""This wraps a Mandos Client D-Bus proxy object, caches the
88
100
properties and calls a hook function when any of them are
91
103
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
104
self.proxy = proxy_object # Mandos Client proxy object
93
105
self.properties = dict() if properties is None else properties
94
106
self.property_changed_match = (
95
107
self.proxy.connect_to_signal("PropertiesChanged",
96
108
self.properties_changed,
97
109
dbus.PROPERTIES_IFACE,
98
110
byte_arrays=True))
100
112
if properties is None:
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
106
117
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
119
def properties_changed(self, interface, properties, invalidated):
109
120
"""This is called whenever we get a PropertiesChanged signal
110
121
It updates the changed properties in the "properties" dict.
164
173
client_interface,
165
174
byte_arrays=True))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
175
log.debug("Created client %s", self.properties["Name"])
169
177
def using_timer(self, flag):
170
178
"""Call this method with True or False when timer should be
171
179
activated or deactivated.
173
181
if flag and self._update_timer_callback_tag is None:
174
182
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (gobject.timeout_add
183
self._update_timer_callback_tag = (
184
GLib.timeout_add(1000,
185
glib_safely(self.update_timer)))
178
186
elif not (flag or self._update_timer_callback_tag is None):
179
gobject.source_remove(self._update_timer_callback_tag)
187
GLib.source_remove(self._update_timer_callback_tag)
180
188
self._update_timer_callback_tag = None
182
190
def checker_completed(self, exitstatus, condition, command):
183
191
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
192
log.debug('Checker for client %s (command "%s")'
193
" succeeded", self.properties["Name"], command)
190
197
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
198
log.info('Checker for client %s (command "%s") failed'
199
" with exit code %d", self.properties["Name"],
200
command, os.WEXITSTATUS(condition))
195
201
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
202
log.info('Checker for client %s (command "%s") was'
203
" killed by signal %d", self.properties["Name"],
204
command, os.WTERMSIG(condition))
202
207
def checker_started(self, command):
203
208
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
209
log.debug('Client %s started checker "%s"',
210
self.properties["Name"], command)
208
212
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
213
log.info("Client %s received its secret",
214
self.properties["Name"])
212
216
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
218
message = "Client %s needs approval within %f seconds"
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
220
message = "Client %s will get its secret in %f seconds"
221
log.info(message, self.properties["Name"], timeout/1000)
220
223
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
224
log.info("Client %s was rejected; reason: %s",
225
self.properties["Name"], reason)
224
227
def selectable(self):
225
228
"""Make this a "selectable" widget.
226
229
This overrides the method from urwid.FlowWidget."""
229
232
def rows(self, maxcolrow, focus=False):
230
233
"""How many rows this widget will occupy might depend on
231
234
whether we have focus or not.
232
235
This overrides the method from urwid.FlowWidget"""
233
236
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
238
def current_widget(self, focus=False):
236
239
if focus or self.opened:
237
240
return self._focus_widget
238
241
return self._widget
240
243
def update(self):
241
244
"Called when what is visible on the screen should be updated."
242
245
# 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",
246
with_standout = {"normal": "standout",
247
"bold": "bold-standout",
249
"underline-blink-standout",
250
"bold-underline-blink":
251
"bold-underline-blink-standout",
251
254
# Rebuild focus and non-focus widgets using current properties
253
256
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
257
base = "{name}: ".format(name=self.properties["Name"])
255
258
if not self.properties["Enabled"]:
256
259
message = "DISABLED"
257
260
self.using_timer(False)
258
261
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(milliseconds
262
timeout = datetime.timedelta(
263
milliseconds=self.properties["ApprovalDelay"])
262
264
last_approval_request = isoformat_to_datetime(
263
265
self.properties["LastApprovalRequest"])
264
266
if last_approval_request is not None:
324
327
if self.delete_hook is not None:
325
328
self.delete_hook(self)
326
329
return super(MandosClientWidget, self).delete(**kwargs)
328
331
def render(self, maxcolrow, focus=False):
329
332
"""Render differently if we have focus.
330
333
This overrides the method from urwid.FlowWidget"""
331
334
return self.current_widget(focus).render(maxcolrow,
334
337
def keypress(self, maxcolrow, key):
336
339
This overrides the method from urwid.FlowWidget"""
338
341
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
342
dbus.Boolean(True), ignore_reply=True,
343
dbus_interface=dbus.PROPERTIES_IFACE)
342
345
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface = dbus.PROPERTIES_IFACE)
347
dbus_interface=dbus.PROPERTIES_IFACE)
346
349
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
350
dbus_interface=client_interface,
348
351
ignore_reply=True)
350
353
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
354
dbus_interface=client_interface,
352
355
ignore_reply=True)
353
356
elif key == "R" or key == "_" or key == "ctrl k":
354
357
self.server_proxy_object.RemoveClient(self.proxy
356
359
ignore_reply=True)
358
361
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
362
dbus.Boolean(True), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
362
365
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
366
dbus.Boolean(False), ignore_reply=True,
367
dbus_interface=dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface = client_interface,
369
self.proxy.CheckedOK(dbus_interface=client_interface,
367
370
ignore_reply=True)
369
372
# elif key == "p" or key == "=":
393
def glib_safely(func, retval=True):
394
def safe_func(*args, **kwargs):
396
return func(*args, **kwargs)
390
403
class ConstrainedListBox(urwid.ListBox):
391
404
"""Like a normal urwid.ListBox, but will consume all "up" or
392
405
"down" key presses, thus not allowing any containing widgets to
393
406
use them as an excuse to shift focus away from this widget.
395
408
def keypress(self, *args, **kwargs):
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
409
ret = (super(ConstrainedListBox, self)
410
.keypress(*args, **kwargs))
397
411
if ret in ("up", "down"):
402
class UserInterface(object):
403
417
"""This is the entire user interface - the whole screen
404
418
with boxes, lists of client widgets, etc.
406
def __init__(self, max_log_length=1000, log_level=1):
420
def __init__(self, max_log_length=1000):
407
421
DBusGMainLoop(set_as_default=True)
409
423
self.screen = urwid.curses_display.Screen()
411
425
self.screen.register_palette((
413
427
"default", "default", None),
428
443
"bold,underline,blink,standout", "default",
429
444
"bold,underline,blink,standout"),
432
447
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
448
self.divider = "─" # \u2500
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
450
self.divider = "_" # \u005f
439
452
self.screen.start()
441
454
self.size = self.screen.get_cols_rows()
443
456
self.clients = urwid.SimpleListWalker([])
444
457
self.clients_dict = {}
446
459
# We will add Text widgets to this list
460
self.log = urwid.SimpleListWalker([])
448
461
self.max_log_length = max_log_length
450
self.log_level = log_level
452
463
# We keep a reference to the log widget so we can remove it
453
464
# from the ListWalker without it getting destroyed
454
465
self.logbox = ConstrainedListBox(self.log)
456
467
# This keeps track of whether self.uilist currently has
457
468
# self.logbox in it or not
458
469
self.log_visible = True
459
470
self.log_wrap = "any"
472
self.loghandler = UILogHandler(self)
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
467
self.busname = domain + '.Mandos'
468
self.main_loop = gobject.MainLoop()
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
473
.format(address, fingerprint))
475
self.add_log_line(("bold",
476
"Mandos Monitor version " + version))
477
self.add_log_line(("bold", "q: Quit ?: Help"))
479
self.busname = domain + ".Mandos"
480
self.main_loop = GLib.MainLoop()
482
def client_not_found(self, key_id, address):
483
log.info("Client with address %s and key ID %s could"
484
" not be found", address, key_id)
475
486
def rebuild(self):
476
487
"""This rebuilds the User Interface.
477
488
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
490
# self.uilist.append(urwid.ListBox(self.clients))
480
491
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
493
# header=urwid.Divider(),
485
urwid.Divider(div_char=
495
footer=urwid.Divider(
496
div_char=self.divider)))
487
497
if self.log_visible:
488
498
self.uilist.append(self.logbox)
489
499
self.topwidget = urwid.Pile(self.uilist)
491
def log_message(self, message, level=1):
492
"""Log message formatted with timestamp"""
493
if level < self.log_level:
495
timestamp = datetime.datetime.now().isoformat()
496
self.log_message_raw("{}: {}".format(timestamp, message),
499
def log_message_raw(self, markup, level=1):
500
"""Add a log message to the log buffer."""
501
if level < self.log_level:
501
def add_log_line(self, markup):
503
502
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
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]
507
self.logbox.set_focus(len(self.logbox.body.contents),
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)]
506
self.logbox.set_focus(len(self.logbox.body.contents)-1,
508
507
coming_from="above")
511
510
def toggle_log_display(self):
512
511
"""Toggle visibility of the log buffer."""
513
512
self.log_visible = not self.log_visible
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
514
log.debug("Log visibility changed to: %s", self.log_visible)
518
516
def change_log_display(self):
519
517
"""Change type of log display.
520
518
Currently, this toggles wrapping of text lines."""
576
565
self.clients_dict[path] = client
577
566
self.clients.sort(key=lambda c: c.properties["Name"])
580
569
def remove_client(self, client, path=None):
581
570
self.clients.remove(client)
583
572
path = client.proxy.object_path
584
573
del self.clients_dict[path]
587
576
def refresh(self):
588
577
"""Redraw the screen"""
589
578
canvas = self.topwidget.render(self.size, focus=True)
590
579
self.screen.draw_screen(self.size, canvas)
593
582
"""Start the main loop and exit when it's done."""
583
log.addHandler(self.loghandler)
584
self.orig_log_propagate = log.propagate
585
log.propagate = False
586
self.orig_log_level = log.level
594
588
self.bus = dbus.SystemBus()
595
589
mandos_dbus_objc = self.bus.get_object(
596
590
self.busname, "/", follow_name_owner_changes=True)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
591
self.mandos_serv = dbus.Interface(
592
mandos_dbus_objc, dbus_interface=server_interface)
601
594
mandos_clients = (self.mandos_serv
602
595
.GetAllClientsWithProperties())
603
596
if not mandos_clients:
604
self.log_message_raw(("bold", "Note: Server has no clients."))
597
log.warning("Note: Server has no clients.")
605
598
except dbus.exceptions.DBusException:
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
log.warning("Note: No Mandos server running.")
607
600
mandos_clients = dbus.Dictionary()
609
602
(self.mandos_serv
610
603
.connect_to_signal("InterfacesRemoved",
611
604
self.find_and_remove_client,
613
= dbus.OBJECT_MANAGER_IFACE,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
614
606
byte_arrays=True))
615
607
(self.mandos_serv
616
608
.connect_to_signal("InterfacesAdded",
617
609
self.add_new_client,
619
= dbus.OBJECT_MANAGER_IFACE,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
620
611
byte_arrays=True))
621
612
(self.mandos_serv
622
613
.connect_to_signal("ClientNotFound",
626
617
for path, client in mandos_clients.items():
627
618
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
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),
643
self._input_callback_tag = (gobject.io_add_watch
629
self._input_callback_tag = (
631
GLib.IOChannel.unix_new(sys.stdin.fileno()),
632
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
633
glib_safely(self.process_input)))
647
634
self.main_loop.run()
648
635
# Main loop has finished, we should close everything now
649
gobject.source_remove(self._input_callback_tag)
636
GLib.source_remove(self._input_callback_tag)
637
with warnings.catch_warnings():
638
warnings.simplefilter("ignore", BytesWarning)
653
642
self.main_loop.quit()
643
log.removeHandler(self.loghandler)
644
log.propagate = self.orig_log_propagate
655
646
def process_input(self, source, condition):
656
647
keys = self.screen.get_input()
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
648
translations = {"ctrl n": "down", # Emacs
649
"ctrl p": "up", # Emacs
650
"ctrl v": "page down", # Emacs
651
"meta v": "page up", # Emacs
652
" ": "page down", # less
653
"f": "page down", # less
654
"b": "page up", # less
669
660
key = translations[key]
670
661
except KeyError: # :-)
673
664
if key == "q" or key == "Q":
717
707
self.topwidget.set_focus(self.logbox)
720
if self.log_level == 0:
722
self.log_message("Verbose mode: Off")
710
if log.level < logging.INFO:
711
log.setLevel(logging.INFO)
712
log.info("Verbose mode: Off")
725
self.log_message("Verbose mode: On")
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
714
log.setLevel(logging.NOTSET)
715
log.info("Verbose mode: On")
716
# elif (key == "end" or key == "meta >" or key == "G"
718
# pass # xxx end-of-buffer
719
# elif (key == "home" or key == "meta <" or key == "g"
721
# pass # xxx beginning-of-buffer
722
# elif key == "ctrl e" or key == "$":
723
# pass # xxx move-end-of-line
724
# elif key == "ctrl a" or key == "^":
725
# pass # xxx move-beginning-of-line
726
# elif key == "ctrl b" or key == "meta (" or key == "h":
728
# elif key == "ctrl f" or key == "meta )" or key == "l":
731
# pass # scroll up log
733
# pass # scroll down log
744
734
elif self.topwidget.selectable():
745
735
self.topwidget.keypress(self.size, key)
740
class UILogHandler(logging.Handler):
741
def __init__(self, ui, *args, **kwargs):
743
super(UILogHandler, self).__init__(*args, **kwargs)
745
logging.Formatter("%(asctime)s: %(message)s"))
746
def emit(self, record):
747
msg = self.format(record)
748
if record.levelno > logging.INFO:
750
self.ui.add_log_line(msg)
749
753
ui = UserInterface()
752
756
except KeyboardInterrupt:
754
except Exception as e:
755
ui.log_message(str(e))
757
with warnings.catch_warnings():
758
warnings.filterwarnings("ignore", "", BytesWarning)
761
with warnings.catch_warnings():
762
warnings.filterwarnings("ignore", "", BytesWarning)