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>.
27
26
from __future__ import (division, absolute_import, print_function,
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:
53
log = logging.getLogger(os.path.basename(sys.argv[0]))
54
logging.basicConfig(level="NOTSET", # Show all messages
55
format="%(message)s") # Show basic log messages
57
logging.captureWarnings(True) # Show warnings via the logging system
59
locale.setlocale(locale.LC_ALL, "")
61
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
63
59
# Some useful constants
64
domain = "se.recompile"
65
server_interface = domain + ".Mandos"
66
client_interface = domain + ".Mandos.Client"
70
dbus.OBJECT_MANAGER_IFACE
71
except AttributeError:
72
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
75
65
def isoformat_to_datetime(iso):
76
66
"Parse an ISO 8601 date string to a datetime.datetime()"
88
int(second), # Whole seconds
89
int(fraction*1000000)) # Microseconds
92
class MandosClientPropertyCache:
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
81
class MandosClientPropertyCache(object):
93
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
94
83
properties and calls a hook function when any of them are
97
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
98
self.proxy = proxy_object # Mandos Client proxy object
87
self.proxy = proxy_object # Mandos Client proxy object
99
88
self.properties = dict() if properties is None else properties
100
89
self.property_changed_match = (
101
90
self.proxy.connect_to_signal("PropertiesChanged",
102
91
self.properties_changed,
103
92
dbus.PROPERTIES_IFACE,
104
93
byte_arrays=True))
106
95
if properties is None:
107
self.properties.update(self.proxy.GetAll(
109
dbus_interface=dbus.PROPERTIES_IFACE))
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
111
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
113
103
def properties_changed(self, interface, properties, invalidated):
114
104
"""This is called whenever we get a PropertiesChanged signal
115
105
It updates the changed properties in the "properties" dict.
117
107
# Update properties dict with new value
118
if interface == client_interface:
119
self.properties.update(properties)
108
self.properties.update(properties)
121
110
def delete(self):
122
111
self.property_changed_match.remove()
167
158
client_interface,
168
159
byte_arrays=True))
169
log.debug("Created client %s", self.properties["Name"])
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
171
163
def using_timer(self, flag):
172
164
"""Call this method with True or False when timer should be
173
165
activated or deactivated.
175
167
if flag and self._update_timer_callback_tag is None:
176
168
# Will update the shown timer value every second
177
self._update_timer_callback_tag = (
178
GLib.timeout_add(1000,
179
glib_safely(self.update_timer)))
169
self._update_timer_callback_tag = (gobject.timeout_add
180
172
elif not (flag or self._update_timer_callback_tag is None):
181
GLib.source_remove(self._update_timer_callback_tag)
173
gobject.source_remove(self._update_timer_callback_tag)
182
174
self._update_timer_callback_tag = None
184
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, command):
185
177
if exitstatus == 0:
186
log.debug('Checker for client %s (command "%s")'
187
" succeeded", self.properties["Name"], command)
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
191
if os.WIFEXITED(condition):
192
log.info('Checker for client %s (command "%s") failed'
193
" with exit code %d", self.properties["Name"],
194
command, os.WEXITSTATUS(condition))
195
elif os.WIFSIGNALED(condition):
196
log.info('Checker for client %s (command "%s") was'
197
" killed by signal %d", self.properties["Name"],
198
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"]))
201
200
def checker_started(self, command):
202
201
"""Server signals that a checker started."""
203
log.debug('Client %s started checker "%s"',
204
self.properties["Name"], command)
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
206
206
def got_secret(self):
207
log.info("Client %s received its secret",
208
self.properties["Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
210
210
def need_approval(self, timeout, default):
212
message = "Client %s needs approval within %f seconds"
212
message = 'Client {} needs approval within {} seconds'
214
message = "Client %s will get its secret in %f seconds"
215
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"],
217
218
def rejected(self, reason):
218
log.info("Client %s was rejected; reason: %s",
219
self.properties["Name"], reason)
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
221
222
def selectable(self):
222
223
"""Make this a "selectable" widget.
223
224
This overrides the method from urwid.FlowWidget."""
226
227
def rows(self, maxcolrow, focus=False):
227
228
"""How many rows this widget will occupy might depend on
228
229
whether we have focus or not.
229
230
This overrides the method from urwid.FlowWidget"""
230
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
232
233
def current_widget(self, focus=False):
233
234
if focus or self.opened:
234
235
return self._focus_widget
235
236
return self._widget
237
238
def update(self):
238
239
"Called when what is visible on the screen should be updated."
239
240
# How to add standout mode to a style
240
with_standout = {"normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"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",
248
249
# Rebuild focus and non-focus widgets using current properties
250
251
# Base part of a client. Name!
251
base = "{name}: ".format(name=self.properties["Name"])
252
base = '{name}: '.format(name=self.properties["Name"])
252
253
if not self.properties["Enabled"]:
253
254
message = "DISABLED"
254
255
self.using_timer(False)
255
256
elif self.properties["ApprovalPending"]:
256
timeout = datetime.timedelta(
257
milliseconds=self.properties["ApprovalDelay"])
257
timeout = datetime.timedelta(milliseconds
258
260
last_approval_request = isoformat_to_datetime(
259
261
self.properties["LastApprovalRequest"])
260
262
if last_approval_request is not None:
321
322
if self.delete_hook is not None:
322
323
self.delete_hook(self)
323
324
return super(MandosClientWidget, self).delete(**kwargs)
325
326
def render(self, maxcolrow, focus=False):
326
327
"""Render differently if we have focus.
327
328
This overrides the method from urwid.FlowWidget"""
328
329
return self.current_widget(focus).render(maxcolrow,
331
332
def keypress(self, maxcolrow, key):
333
334
This overrides the method from urwid.FlowWidget"""
335
self.proxy.Set(client_interface, "Enabled",
336
dbus.Boolean(True), ignore_reply=True,
337
dbus_interface=dbus.PROPERTIES_IFACE)
336
self.proxy.Enable(dbus_interface = client_interface,
339
self.proxy.Set(client_interface, "Enabled", False,
341
dbus_interface=dbus.PROPERTIES_IFACE)
339
self.proxy.Disable(dbus_interface = client_interface,
343
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
344
dbus_interface=client_interface,
343
dbus_interface = client_interface,
345
344
ignore_reply=True)
347
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
348
dbus_interface=client_interface,
347
dbus_interface = client_interface,
349
348
ignore_reply=True)
350
349
elif key == "R" or key == "_" or key == "ctrl k":
351
350
self.server_proxy_object.RemoveClient(self.proxy
353
352
ignore_reply=True)
355
self.proxy.Set(client_interface, "CheckerRunning",
356
dbus.Boolean(True), ignore_reply=True,
357
dbus_interface=dbus.PROPERTIES_IFACE)
354
self.proxy.StartChecker(dbus_interface = client_interface,
359
self.proxy.Set(client_interface, "CheckerRunning",
360
dbus.Boolean(False), ignore_reply=True,
361
dbus_interface=dbus.PROPERTIES_IFACE)
357
self.proxy.StopChecker(dbus_interface = client_interface,
363
self.proxy.CheckedOK(dbus_interface=client_interface,
360
self.proxy.CheckedOK(dbus_interface = client_interface,
364
361
ignore_reply=True)
366
363
# elif key == "p" or key == "=":
387
def glib_safely(func, retval=True):
388
def safe_func(*args, **kwargs):
390
return func(*args, **kwargs)
397
384
class ConstrainedListBox(urwid.ListBox):
398
385
"""Like a normal urwid.ListBox, but will consume all "up" or
399
386
"down" key presses, thus not allowing any containing widgets to
400
387
use them as an excuse to shift focus away from this widget.
402
389
def keypress(self, *args, **kwargs):
403
ret = (super(ConstrainedListBox, self)
404
.keypress(*args, **kwargs))
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
405
391
if ret in ("up", "down"):
396
class UserInterface(object):
411
397
"""This is the entire user interface - the whole screen
412
398
with boxes, lists of client widgets, etc.
414
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
415
401
DBusGMainLoop(set_as_default=True)
417
403
self.screen = urwid.curses_display.Screen()
419
405
self.screen.register_palette((
421
407
"default", "default", None),
437
422
"bold,underline,blink,standout", "default",
438
423
"bold,underline,blink,standout"),
441
426
if urwid.supports_unicode():
442
self.divider = "─" # \u2500
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
444
self.divider = "_" # \u005f
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
446
433
self.screen.start()
448
435
self.size = self.screen.get_cols_rows()
450
437
self.clients = urwid.SimpleListWalker([])
451
438
self.clients_dict = {}
453
440
# We will add Text widgets to this list
454
self.log = urwid.SimpleListWalker([])
455
442
self.max_log_length = max_log_length
444
self.log_level = log_level
457
446
# We keep a reference to the log widget so we can remove it
458
447
# from the ListWalker without it getting destroyed
459
448
self.logbox = ConstrainedListBox(self.log)
461
450
# This keeps track of whether self.uilist currently has
462
451
# self.logbox in it or not
463
452
self.log_visible = True
464
453
self.log_wrap = "any"
466
self.loghandler = UILogHandler(self)
469
self.add_log_line(("bold",
470
"Mandos Monitor version " + version))
471
self.add_log_line(("bold", "q: Quit ?: Help"))
473
self.busname = domain + ".Mandos"
474
self.main_loop = GLib.MainLoop()
476
def client_not_found(self, key_id, address):
477
log.info("Client with address %s and key ID %s could"
478
" 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))
480
469
def rebuild(self):
481
470
"""This rebuilds the User Interface.
482
471
Call this when the widget layout needs to change"""
484
# self.uilist.append(urwid.ListBox(self.clients))
473
#self.uilist.append(urwid.ListBox(self.clients))
485
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
487
# header=urwid.Divider(),
476
#header=urwid.Divider(),
489
footer=urwid.Divider(
490
div_char=self.divider)))
479
urwid.Divider(div_char=
491
481
if self.log_visible:
492
482
self.uilist.append(self.logbox)
493
483
self.topwidget = urwid.Pile(self.uilist)
495
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:
496
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
if self.max_log_length:
498
if len(self.log) > self.max_log_length:
499
del self.log[0:(len(self.log) - self.max_log_length)]
500
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),
501
502
coming_from="above")
504
505
def toggle_log_display(self):
505
506
"""Toggle visibility of the log buffer."""
506
507
self.log_visible = not self.log_visible
508
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)
510
512
def change_log_display(self):
511
513
"""Change type of log display.
512
514
Currently, this toggles wrapping of text lines."""
516
518
self.log_wrap = "clip"
517
519
for textwidget in self.log:
518
520
textwidget.set_wrap_mode(self.log_wrap)
519
log.debug("Wrap mode: %s", self.log_wrap)
521
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):
522
525
"""Find a client by its object path and remove it.
524
This is connected to the InterfacesRemoved signal from the
527
This is connected to the ClientRemoved signal from the
525
528
Mandos server object."""
526
if client_interface not in interfaces:
527
# Not a Mandos client object; ignore
530
530
client = self.clients_dict[path]
533
log.warning("Unknown client %s removed", path)
533
self.log_message("Unknown client {!r} ({!r}) removed"
537
def add_new_client(self, path, ifs_and_props):
538
"""Find a client by its object path and remove it.
540
This is connected to the InterfacesAdded signal from the
541
Mandos server object.
543
if client_interface not in ifs_and_props:
544
# Not a Mandos client object; ignore
538
def add_new_client(self, path):
546
539
client_proxy_object = self.bus.get_object(self.busname, path)
547
self.add_client(MandosClientWidget(
548
server_proxy_object=self.mandos_serv,
549
proxy_object=client_proxy_object,
550
update_hook=self.refresh,
551
delete_hook=self.remove_client,
552
properties=dict(ifs_and_props[client_interface])),
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
555
552
def add_client(self, client, path=None):
556
553
self.clients.append(client)
559
556
self.clients_dict[path] = client
560
557
self.clients.sort(key=lambda c: c.properties["Name"])
563
560
def remove_client(self, client, path=None):
564
561
self.clients.remove(client)
566
563
path = client.proxy.object_path
567
564
del self.clients_dict[path]
570
567
def refresh(self):
571
568
"""Redraw the screen"""
572
569
canvas = self.topwidget.render(self.size, focus=True)
573
570
self.screen.draw_screen(self.size, canvas)
576
573
"""Start the main loop and exit when it's done."""
577
log.addHandler(self.loghandler)
578
self.orig_log_propagate = log.propagate
579
log.propagate = False
580
self.orig_log_level = log.level
582
574
self.bus = dbus.SystemBus()
583
575
mandos_dbus_objc = self.bus.get_object(
584
576
self.busname, "/", follow_name_owner_changes=True)
585
self.mandos_serv = dbus.Interface(
586
mandos_dbus_objc, dbus_interface=server_interface)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
588
581
mandos_clients = (self.mandos_serv
589
582
.GetAllClientsWithProperties())
590
583
if not mandos_clients:
591
log.warning("Note: Server has no clients.")
584
self.log_message_raw(("bold", "Note: Server has no clients."))
592
585
except dbus.exceptions.DBusException:
593
log.warning("Note: No Mandos server running.")
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
594
587
mandos_clients = dbus.Dictionary()
596
589
(self.mandos_serv
597
.connect_to_signal("InterfacesRemoved",
590
.connect_to_signal("ClientRemoved",
598
591
self.find_and_remove_client,
599
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
592
dbus_interface=server_interface,
600
593
byte_arrays=True))
601
594
(self.mandos_serv
602
.connect_to_signal("InterfacesAdded",
595
.connect_to_signal("ClientAdded",
603
596
self.add_new_client,
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
dbus_interface=server_interface,
605
598
byte_arrays=True))
606
599
(self.mandos_serv
607
600
.connect_to_signal("ClientNotFound",
611
604
for path, client in mandos_clients.items():
612
605
client_proxy_object = self.bus.get_object(self.busname,
614
self.add_client(MandosClientWidget(
615
server_proxy_object=self.mandos_serv,
616
proxy_object=client_proxy_object,
618
update_hook=self.refresh,
619
delete_hook=self.remove_client),
607
self.add_client(MandosClientWidget(server_proxy_object
610
=client_proxy_object,
623
self._input_callback_tag = (
625
GLib.IOChannel.unix_new(sys.stdin.fileno()),
626
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
627
glib_safely(self.process_input)))
621
self._input_callback_tag = (gobject.io_add_watch
628
625
self.main_loop.run()
629
626
# Main loop has finished, we should close everything now
630
GLib.source_remove(self._input_callback_tag)
631
with warnings.catch_warnings():
632
warnings.simplefilter("ignore", BytesWarning)
627
gobject.source_remove(self._input_callback_tag)
636
631
self.main_loop.quit()
637
log.removeHandler(self.loghandler)
638
log.propagate = self.orig_log_propagate
640
633
def process_input(self, source, condition):
641
634
keys = self.screen.get_input()
642
translations = {"ctrl n": "down", # Emacs
643
"ctrl p": "up", # Emacs
644
"ctrl v": "page down", # Emacs
645
"meta v": "page up", # Emacs
646
" ": "page down", # less
647
"f": "page down", # less
648
"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
654
647
key = translations[key]
655
648
except KeyError: # :-)
658
651
if key == "q" or key == "Q":
701
695
self.topwidget.set_focus(self.logbox)
704
if log.level < logging.INFO:
705
log.setLevel(logging.INFO)
706
log.info("Verbose mode: Off")
698
if self.log_level == 0:
700
self.log_message("Verbose mode: Off")
708
log.setLevel(logging.NOTSET)
709
log.info("Verbose mode: On")
710
# elif (key == "end" or key == "meta >" or key == "G"
712
# pass # xxx end-of-buffer
713
# elif (key == "home" or key == "meta <" or key == "g"
715
# pass # xxx beginning-of-buffer
716
# elif key == "ctrl e" or key == "$":
717
# pass # xxx move-end-of-line
718
# elif key == "ctrl a" or key == "^":
719
# pass # xxx move-beginning-of-line
720
# elif key == "ctrl b" or key == "meta (" or key == "h":
722
# elif key == "ctrl f" or key == "meta )" or key == "l":
725
# pass # scroll up log
727
# 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
728
722
elif self.topwidget.selectable():
729
723
self.topwidget.keypress(self.size, key)
734
class UILogHandler(logging.Handler):
735
def __init__(self, ui, *args, **kwargs):
737
super(UILogHandler, self).__init__(*args, **kwargs)
739
logging.Formatter("%(asctime)s: %(message)s"))
740
def emit(self, record):
741
msg = self.format(record)
742
if record.levelno > logging.INFO:
744
self.ui.add_log_line(msg)
747
727
ui = UserInterface()
750
730
except KeyboardInterrupt:
751
with warnings.catch_warnings():
752
warnings.filterwarnings("ignore", "", BytesWarning)
755
with warnings.catch_warnings():
756
warnings.filterwarnings("ignore", "", BytesWarning)
732
except Exception as e:
733
ui.log_message(str(e))