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-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 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"
76
dbus.OBJECT_MANAGER_IFACE
77
except AttributeError:
78
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
65
81
def isoformat_to_datetime(iso):
66
82
"Parse an ISO 8601 date string to a datetime.datetime()"
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
81
class MandosClientPropertyCache(object):
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
82
99
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
100
properties and calls a hook function when any of them are
86
103
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
104
self.proxy = proxy_object # Mandos Client proxy object
88
105
self.properties = dict() if properties is None else properties
89
106
self.property_changed_match = (
90
107
self.proxy.connect_to_signal("PropertiesChanged",
91
108
self.properties_changed,
92
109
dbus.PROPERTIES_IFACE,
93
110
byte_arrays=True))
95
112
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
101
117
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
119
def properties_changed(self, interface, properties, invalidated):
104
120
"""This is called whenever we get a PropertiesChanged signal
105
121
It updates the changed properties in the "properties" dict.
107
123
# Update properties dict with new value
108
self.properties.update(properties)
124
if interface == client_interface:
125
self.properties.update(properties)
110
127
def delete(self):
111
128
self.property_changed_match.remove()
158
173
client_interface,
159
174
byte_arrays=True))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
175
log.debug("Created client %s", self.properties["Name"])
163
177
def using_timer(self, flag):
164
178
"""Call this method with True or False when timer should be
165
179
activated or deactivated.
167
181
if flag and self._update_timer_callback_tag is None:
168
182
# Will update the shown timer value every second
169
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)))
172
186
elif not (flag or self._update_timer_callback_tag is None):
173
gobject.source_remove(self._update_timer_callback_tag)
187
GLib.source_remove(self._update_timer_callback_tag)
174
188
self._update_timer_callback_tag = None
176
190
def checker_completed(self, exitstatus, condition, command):
177
191
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
192
log.debug('Checker for client %s (command "%s")'
193
" succeeded", self.properties["Name"], command)
184
197
if os.WIFEXITED(condition):
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
188
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))
189
201
elif os.WIFSIGNALED(condition):
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
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))
196
207
def checker_started(self, command):
197
208
"""Server signals that a checker started."""
198
self.logger('Client {} started checker "{}"'
199
.format(self.properties["Name"],
209
log.debug('Client %s started checker "%s"',
210
self.properties["Name"], command)
202
212
def got_secret(self):
203
self.logger('Client {} received its secret'
204
.format(self.properties["Name"]))
213
log.info("Client %s received its secret",
214
self.properties["Name"])
206
216
def need_approval(self, timeout, default):
208
message = 'Client {} needs approval within {} seconds'
218
message = "Client %s needs approval within %f seconds"
210
message = 'Client {} will get its secret in {} seconds'
211
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)
214
223
def rejected(self, reason):
215
self.logger('Client {} was rejected; reason: {}'
216
.format(self.properties["Name"], reason))
224
log.info("Client %s was rejected; reason: %s",
225
self.properties["Name"], reason)
218
227
def selectable(self):
219
228
"""Make this a "selectable" widget.
220
229
This overrides the method from urwid.FlowWidget."""
223
232
def rows(self, maxcolrow, focus=False):
224
233
"""How many rows this widget will occupy might depend on
225
234
whether we have focus or not.
226
235
This overrides the method from urwid.FlowWidget"""
227
236
return self.current_widget(focus).rows(maxcolrow, focus=focus)
229
238
def current_widget(self, focus=False):
230
239
if focus or self.opened:
231
240
return self._focus_widget
232
241
return self._widget
234
243
def update(self):
235
244
"Called when what is visible on the screen should be updated."
236
245
# How to add standout mode to a style
237
with_standout = { "normal": "standout",
238
"bold": "bold-standout",
240
"underline-blink-standout",
241
"bold-underline-blink":
242
"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",
245
254
# Rebuild focus and non-focus widgets using current properties
247
256
# Base part of a client. Name!
248
base = '{name}: '.format(name=self.properties["Name"])
257
base = "{name}: ".format(name=self.properties["Name"])
249
258
if not self.properties["Enabled"]:
250
259
message = "DISABLED"
251
260
self.using_timer(False)
252
261
elif self.properties["ApprovalPending"]:
253
timeout = datetime.timedelta(milliseconds
262
timeout = datetime.timedelta(
263
milliseconds=self.properties["ApprovalDelay"])
256
264
last_approval_request = isoformat_to_datetime(
257
265
self.properties["LastApprovalRequest"])
258
266
if last_approval_request is not None:
318
327
if self.delete_hook is not None:
319
328
self.delete_hook(self)
320
329
return super(MandosClientWidget, self).delete(**kwargs)
322
331
def render(self, maxcolrow, focus=False):
323
332
"""Render differently if we have focus.
324
333
This overrides the method from urwid.FlowWidget"""
325
334
return self.current_widget(focus).render(maxcolrow,
328
337
def keypress(self, maxcolrow, key):
330
339
This overrides the method from urwid.FlowWidget"""
332
341
self.proxy.Set(client_interface, "Enabled",
333
dbus.Boolean(True), ignore_reply = True,
334
dbus_interface = dbus.PROPERTIES_IFACE)
342
dbus.Boolean(True), ignore_reply=True,
343
dbus_interface=dbus.PROPERTIES_IFACE)
336
345
self.proxy.Set(client_interface, "Enabled", False,
338
dbus_interface = dbus.PROPERTIES_IFACE)
347
dbus_interface=dbus.PROPERTIES_IFACE)
340
349
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
341
dbus_interface = client_interface,
350
dbus_interface=client_interface,
342
351
ignore_reply=True)
344
353
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
345
dbus_interface = client_interface,
354
dbus_interface=client_interface,
346
355
ignore_reply=True)
347
356
elif key == "R" or key == "_" or key == "ctrl k":
348
357
self.server_proxy_object.RemoveClient(self.proxy
350
359
ignore_reply=True)
352
361
self.proxy.Set(client_interface, "CheckerRunning",
353
dbus.Boolean(True), ignore_reply = True,
354
dbus_interface = dbus.PROPERTIES_IFACE)
362
dbus.Boolean(True), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
356
365
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(False), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
366
dbus.Boolean(False), ignore_reply=True,
367
dbus_interface=dbus.PROPERTIES_IFACE)
360
self.proxy.CheckedOK(dbus_interface = client_interface,
369
self.proxy.CheckedOK(dbus_interface=client_interface,
361
370
ignore_reply=True)
363
372
# elif key == "p" or key == "=":
393
def glib_safely(func, retval=True):
394
def safe_func(*args, **kwargs):
396
return func(*args, **kwargs)
384
403
class ConstrainedListBox(urwid.ListBox):
385
404
"""Like a normal urwid.ListBox, but will consume all "up" or
386
405
"down" key presses, thus not allowing any containing widgets to
387
406
use them as an excuse to shift focus away from this widget.
389
408
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
409
ret = (super(ConstrainedListBox, self)
410
.keypress(*args, **kwargs))
391
411
if ret in ("up", "down"):
396
class UserInterface(object):
397
417
"""This is the entire user interface - the whole screen
398
418
with boxes, lists of client widgets, etc.
400
def __init__(self, max_log_length=1000, log_level=1):
420
def __init__(self, max_log_length=1000):
401
421
DBusGMainLoop(set_as_default=True)
403
423
self.screen = urwid.curses_display.Screen()
405
425
self.screen.register_palette((
407
427
"default", "default", None),
422
443
"bold,underline,blink,standout", "default",
423
444
"bold,underline,blink,standout"),
426
447
if urwid.supports_unicode():
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
448
self.divider = "─" # \u2500
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
450
self.divider = "_" # \u005f
433
452
self.screen.start()
435
454
self.size = self.screen.get_cols_rows()
437
456
self.clients = urwid.SimpleListWalker([])
438
457
self.clients_dict = {}
440
459
# We will add Text widgets to this list
460
self.log = urwid.SimpleListWalker([])
442
461
self.max_log_length = max_log_length
444
self.log_level = log_level
446
463
# We keep a reference to the log widget so we can remove it
447
464
# from the ListWalker without it getting destroyed
448
465
self.logbox = ConstrainedListBox(self.log)
450
467
# This keeps track of whether self.uilist currently has
451
468
# self.logbox in it or not
452
469
self.log_visible = True
453
470
self.log_wrap = "any"
472
self.loghandler = UILogHandler(self)
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
461
self.busname = domain + '.Mandos'
462
self.main_loop = gobject.MainLoop()
464
def client_not_found(self, fingerprint, address):
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.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)
469
486
def rebuild(self):
470
487
"""This rebuilds the User Interface.
471
488
Call this when the widget layout needs to change"""
473
#self.uilist.append(urwid.ListBox(self.clients))
490
# self.uilist.append(urwid.ListBox(self.clients))
474
491
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
476
#header=urwid.Divider(),
493
# header=urwid.Divider(),
479
urwid.Divider(div_char=
495
footer=urwid.Divider(
496
div_char=self.divider)))
481
497
if self.log_visible:
482
498
self.uilist.append(self.logbox)
483
499
self.topwidget = urwid.Pile(self.uilist)
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
489
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
493
def log_message_raw(self, markup, level=1):
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
501
def add_log_line(self, markup):
497
502
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
if (self.max_log_length
499
and len(self.log) > self.max_log_length):
500
del self.log[0:len(self.log)-self.max_log_length-1]
501
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,
502
507
coming_from="above")
505
510
def toggle_log_display(self):
506
511
"""Toggle visibility of the log buffer."""
507
512
self.log_visible = not self.log_visible
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
514
log.debug("Log visibility changed to: %s", self.log_visible)
512
516
def change_log_display(self):
513
517
"""Change type of log display.
514
518
Currently, this toggles wrapping of text lines."""
518
522
self.log_wrap = "clip"
519
523
for textwidget in self.log:
520
524
textwidget.set_wrap_mode(self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
524
def find_and_remove_client(self, path, name):
525
log.debug("Wrap mode: %s", self.log_wrap)
527
def find_and_remove_client(self, path, interfaces):
525
528
"""Find a client by its object path and remove it.
527
This is connected to the ClientRemoved signal from the
530
This is connected to the InterfacesRemoved signal from the
528
531
Mandos server object."""
532
if client_interface not in interfaces:
533
# Not a Mandos client object; ignore
530
536
client = self.clients_dict[path]
533
self.log_message("Unknown client {!r} ({!r}) removed"
539
log.warning("Unknown client %s removed", path)
538
def add_new_client(self, path):
543
def add_new_client(self, path, ifs_and_props):
544
"""Find a client by its object path and remove it.
546
This is connected to the InterfacesAdded signal from the
547
Mandos server object.
549
if client_interface not in ifs_and_props:
550
# Not a Mandos client object; ignore
539
552
client_proxy_object = self.bus.get_object(self.busname, path)
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
553
self.add_client(MandosClientWidget(
554
server_proxy_object=self.mandos_serv,
555
proxy_object=client_proxy_object,
556
update_hook=self.refresh,
557
delete_hook=self.remove_client,
558
properties=dict(ifs_and_props[client_interface])),
552
561
def add_client(self, client, path=None):
553
562
self.clients.append(client)
556
565
self.clients_dict[path] = client
557
566
self.clients.sort(key=lambda c: c.properties["Name"])
560
569
def remove_client(self, client, path=None):
561
570
self.clients.remove(client)
563
572
path = client.proxy.object_path
564
573
del self.clients_dict[path]
567
576
def refresh(self):
568
577
"""Redraw the screen"""
569
578
canvas = self.topwidget.render(self.size, focus=True)
570
579
self.screen.draw_screen(self.size, canvas)
573
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
574
588
self.bus = dbus.SystemBus()
575
589
mandos_dbus_objc = self.bus.get_object(
576
590
self.busname, "/", follow_name_owner_changes=True)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
591
self.mandos_serv = dbus.Interface(
592
mandos_dbus_objc, dbus_interface=server_interface)
581
594
mandos_clients = (self.mandos_serv
582
595
.GetAllClientsWithProperties())
583
596
if not mandos_clients:
584
self.log_message_raw(("bold", "Note: Server has no clients."))
597
log.warning("Note: Server has no clients.")
585
598
except dbus.exceptions.DBusException:
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
log.warning("Note: No Mandos server running.")
587
600
mandos_clients = dbus.Dictionary()
589
602
(self.mandos_serv
590
.connect_to_signal("ClientRemoved",
603
.connect_to_signal("InterfacesRemoved",
591
604
self.find_and_remove_client,
592
dbus_interface=server_interface,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
593
606
byte_arrays=True))
594
607
(self.mandos_serv
595
.connect_to_signal("ClientAdded",
608
.connect_to_signal("InterfacesAdded",
596
609
self.add_new_client,
597
dbus_interface=server_interface,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
598
611
byte_arrays=True))
599
612
(self.mandos_serv
600
613
.connect_to_signal("ClientNotFound",
604
617
for path, client in mandos_clients.items():
605
618
client_proxy_object = self.bus.get_object(self.busname,
607
self.add_client(MandosClientWidget(server_proxy_object
610
=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),
621
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)))
625
634
self.main_loop.run()
626
635
# Main loop has finished, we should close everything now
627
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)
631
642
self.main_loop.quit()
643
log.removeHandler(self.loghandler)
644
log.propagate = self.orig_log_propagate
633
646
def process_input(self, source, condition):
634
647
keys = self.screen.get_input()
635
translations = { "ctrl n": "down", # Emacs
636
"ctrl p": "up", # Emacs
637
"ctrl v": "page down", # Emacs
638
"meta v": "page up", # Emacs
639
" ": "page down", # less
640
"f": "page down", # less
641
"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
647
660
key = translations[key]
648
661
except KeyError: # :-)
651
664
if key == "q" or key == "Q":
695
707
self.topwidget.set_focus(self.logbox)
698
if self.log_level == 0:
700
self.log_message("Verbose mode: Off")
710
if log.level < logging.INFO:
711
log.setLevel(logging.INFO)
712
log.info("Verbose mode: Off")
703
self.log_message("Verbose mode: On")
704
#elif (key == "end" or key == "meta >" or key == "G"
706
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
709
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
711
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
713
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
719
# pass # scroll up log
721
# 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
722
734
elif self.topwidget.selectable():
723
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)
727
753
ui = UserInterface()
730
756
except KeyboardInterrupt:
732
except Exception as e:
733
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)