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