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)
59
68
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
69
domain = "se.recompile"
70
server_interface = domain + ".Mandos"
71
client_interface = domain + ".Mandos.Client"
66
75
dbus.OBJECT_MANAGER_IFACE
67
76
except AttributeError:
68
77
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
80
def isoformat_to_datetime(iso):
71
81
"Parse an ISO 8601 date string to a datetime.datetime()"
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
class MandosClientPropertyCache(object):
93
int(second), # Whole seconds
94
int(fraction*1000000)) # Microseconds
97
class MandosClientPropertyCache:
87
98
"""This wraps a Mandos Client D-Bus proxy object, caches the
88
99
properties and calls a hook function when any of them are
91
102
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
103
self.proxy = proxy_object # Mandos Client proxy object
93
104
self.properties = dict() if properties is None else properties
94
105
self.property_changed_match = (
95
106
self.proxy.connect_to_signal("PropertiesChanged",
96
107
self.properties_changed,
97
108
dbus.PROPERTIES_IFACE,
98
109
byte_arrays=True))
100
111
if properties is None:
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
112
self.properties.update(self.proxy.GetAll(
114
dbus_interface=dbus.PROPERTIES_IFACE))
106
116
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
118
def properties_changed(self, interface, properties, invalidated):
109
119
"""This is called whenever we get a PropertiesChanged signal
110
120
It updates the changed properties in the "properties" dict.
164
172
client_interface,
165
173
byte_arrays=True))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
174
log.debug("Created client %s", self.properties["Name"])
169
176
def using_timer(self, flag):
170
177
"""Call this method with True or False when timer should be
171
178
activated or deactivated.
173
180
if flag and self._update_timer_callback_tag is None:
174
181
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (gobject.timeout_add
182
self._update_timer_callback_tag = (
183
GLib.timeout_add(1000,
184
glib_safely(self.update_timer)))
178
185
elif not (flag or self._update_timer_callback_tag is None):
179
gobject.source_remove(self._update_timer_callback_tag)
186
GLib.source_remove(self._update_timer_callback_tag)
180
187
self._update_timer_callback_tag = None
182
189
def checker_completed(self, exitstatus, condition, command):
183
190
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
191
log.debug('Checker for client %s (command "%s")'
192
" succeeded", self.properties["Name"], command)
190
196
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
197
log.info('Checker for client %s (command "%s") failed'
198
" with exit code %d", self.properties["Name"],
199
command, os.WEXITSTATUS(condition))
195
200
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)))
201
log.info('Checker for client %s (command "%s") was'
202
" killed by signal %d", self.properties["Name"],
203
command, os.WTERMSIG(condition))
202
206
def checker_started(self, command):
203
207
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
208
log.debug('Client %s started checker "%s"',
209
self.properties["Name"], command)
208
211
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
212
log.info("Client %s received its secret",
213
self.properties["Name"])
212
215
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
217
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"],
219
message = "Client %s will get its secret in %f seconds"
220
log.info(message, self.properties["Name"], timeout/1000)
220
222
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
223
log.info("Client %s was rejected; reason: %s",
224
self.properties["Name"], reason)
224
226
def selectable(self):
225
227
"""Make this a "selectable" widget.
226
228
This overrides the method from urwid.FlowWidget."""
229
231
def rows(self, maxcolrow, focus=False):
230
232
"""How many rows this widget will occupy might depend on
231
233
whether we have focus or not.
232
234
This overrides the method from urwid.FlowWidget"""
233
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
237
def current_widget(self, focus=False):
236
238
if focus or self.opened:
237
239
return self._focus_widget
238
240
return self._widget
240
242
def update(self):
241
243
"Called when what is visible on the screen should be updated."
242
244
# 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",
245
with_standout = {"normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
251
253
# Rebuild focus and non-focus widgets using current properties
253
255
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
256
base = "{name}: ".format(name=self.properties["Name"])
255
257
if not self.properties["Enabled"]:
256
258
message = "DISABLED"
257
259
self.using_timer(False)
258
260
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(milliseconds
261
timeout = datetime.timedelta(
262
milliseconds=self.properties["ApprovalDelay"])
262
263
last_approval_request = isoformat_to_datetime(
263
264
self.properties["LastApprovalRequest"])
264
265
if last_approval_request is not None:
324
326
if self.delete_hook is not None:
325
327
self.delete_hook(self)
326
328
return super(MandosClientWidget, self).delete(**kwargs)
328
330
def render(self, maxcolrow, focus=False):
329
331
"""Render differently if we have focus.
330
332
This overrides the method from urwid.FlowWidget"""
331
333
return self.current_widget(focus).render(maxcolrow,
334
336
def keypress(self, maxcolrow, key):
336
338
This overrides the method from urwid.FlowWidget"""
338
340
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
341
dbus.Boolean(True), ignore_reply=True,
342
dbus_interface=dbus.PROPERTIES_IFACE)
342
344
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface = dbus.PROPERTIES_IFACE)
346
dbus_interface=dbus.PROPERTIES_IFACE)
346
348
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
349
dbus_interface=client_interface,
348
350
ignore_reply=True)
350
352
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
353
dbus_interface=client_interface,
352
354
ignore_reply=True)
353
355
elif key == "R" or key == "_" or key == "ctrl k":
354
356
self.server_proxy_object.RemoveClient(self.proxy
356
358
ignore_reply=True)
358
360
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
361
dbus.Boolean(True), ignore_reply=True,
362
dbus_interface=dbus.PROPERTIES_IFACE)
362
364
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
365
dbus.Boolean(False), ignore_reply=True,
366
dbus_interface=dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface = client_interface,
368
self.proxy.CheckedOK(dbus_interface=client_interface,
367
369
ignore_reply=True)
369
371
# elif key == "p" or key == "=":
392
def glib_safely(func, retval=True):
393
def safe_func(*args, **kwargs):
395
return func(*args, **kwargs)
390
402
class ConstrainedListBox(urwid.ListBox):
391
403
"""Like a normal urwid.ListBox, but will consume all "up" or
392
404
"down" key presses, thus not allowing any containing widgets to
393
405
use them as an excuse to shift focus away from this widget.
395
407
def keypress(self, *args, **kwargs):
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
408
ret = (super(ConstrainedListBox, self)
409
.keypress(*args, **kwargs))
397
410
if ret in ("up", "down"):
402
class UserInterface(object):
403
416
"""This is the entire user interface - the whole screen
404
417
with boxes, lists of client widgets, etc.
406
def __init__(self, max_log_length=1000, log_level=1):
419
def __init__(self, max_log_length=1000):
407
420
DBusGMainLoop(set_as_default=True)
409
422
self.screen = urwid.curses_display.Screen()
411
424
self.screen.register_palette((
413
426
"default", "default", None),
428
442
"bold,underline,blink,standout", "default",
429
443
"bold,underline,blink,standout"),
432
446
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
447
self.divider = "─" # \u2500
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
449
self.divider = "_" # \u005f
439
451
self.screen.start()
441
453
self.size = self.screen.get_cols_rows()
443
455
self.clients = urwid.SimpleListWalker([])
444
456
self.clients_dict = {}
446
458
# We will add Text widgets to this list
459
self.log = urwid.SimpleListWalker([])
448
460
self.max_log_length = max_log_length
450
self.log_level = log_level
452
462
# We keep a reference to the log widget so we can remove it
453
463
# from the ListWalker without it getting destroyed
454
464
self.logbox = ConstrainedListBox(self.log)
456
466
# This keeps track of whether self.uilist currently has
457
467
# self.logbox in it or not
458
468
self.log_visible = True
459
469
self.log_wrap = "any"
471
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))
474
self.add_log_line(("bold",
475
"Mandos Monitor version " + version))
476
self.add_log_line(("bold", "q: Quit ?: Help"))
478
self.busname = domain + ".Mandos"
479
self.main_loop = GLib.MainLoop()
481
def client_not_found(self, key_id, address):
482
log.info("Client with address %s and key ID %s could"
483
" not be found", address, key_id)
475
485
def rebuild(self):
476
486
"""This rebuilds the User Interface.
477
487
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
489
# self.uilist.append(urwid.ListBox(self.clients))
480
490
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
492
# header=urwid.Divider(),
485
urwid.Divider(div_char=
494
footer=urwid.Divider(
495
div_char=self.divider)))
487
496
if self.log_visible:
488
497
self.uilist.append(self.logbox)
489
498
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:
500
def add_log_line(self, markup):
503
501
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),
502
if self.max_log_length:
503
if len(self.log) > self.max_log_length:
504
del self.log[0:(len(self.log) - self.max_log_length)]
505
self.logbox.set_focus(len(self.logbox.body.contents)-1,
508
506
coming_from="above")
511
509
def toggle_log_display(self):
512
510
"""Toggle visibility of the log buffer."""
513
511
self.log_visible = not self.log_visible
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
513
log.debug("Log visibility changed to: %s", self.log_visible)
518
515
def change_log_display(self):
519
516
"""Change type of log display.
520
517
Currently, this toggles wrapping of text lines."""
576
564
self.clients_dict[path] = client
577
565
self.clients.sort(key=lambda c: c.properties["Name"])
580
568
def remove_client(self, client, path=None):
581
569
self.clients.remove(client)
583
571
path = client.proxy.object_path
584
572
del self.clients_dict[path]
587
575
def refresh(self):
588
576
"""Redraw the screen"""
589
577
canvas = self.topwidget.render(self.size, focus=True)
590
578
self.screen.draw_screen(self.size, canvas)
593
581
"""Start the main loop and exit when it's done."""
582
log.addHandler(self.loghandler)
583
self.orig_log_propagate = log.propagate
584
log.propagate = False
585
self.orig_log_level = log.level
594
587
self.bus = dbus.SystemBus()
595
588
mandos_dbus_objc = self.bus.get_object(
596
589
self.busname, "/", follow_name_owner_changes=True)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
601
593
mandos_clients = (self.mandos_serv
602
594
.GetAllClientsWithProperties())
603
595
if not mandos_clients:
604
self.log_message_raw(("bold", "Note: Server has no clients."))
596
log.warning("Note: Server has no clients.")
605
597
except dbus.exceptions.DBusException:
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
598
log.warning("Note: No Mandos server running.")
607
599
mandos_clients = dbus.Dictionary()
609
601
(self.mandos_serv
610
602
.connect_to_signal("InterfacesRemoved",
611
603
self.find_and_remove_client,
613
= dbus.OBJECT_MANAGER_IFACE,
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
614
605
byte_arrays=True))
615
606
(self.mandos_serv
616
607
.connect_to_signal("InterfacesAdded",
617
608
self.add_new_client,
619
= dbus.OBJECT_MANAGER_IFACE,
609
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
620
610
byte_arrays=True))
621
611
(self.mandos_serv
622
612
.connect_to_signal("ClientNotFound",
626
616
for path, client in mandos_clients.items():
627
617
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
619
self.add_client(MandosClientWidget(
620
server_proxy_object=self.mandos_serv,
621
proxy_object=client_proxy_object,
623
update_hook=self.refresh,
624
delete_hook=self.remove_client),
643
self._input_callback_tag = (gobject.io_add_watch
628
self._input_callback_tag = (
630
GLib.IOChannel.unix_new(sys.stdin.fileno()),
631
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
632
glib_safely(self.process_input)))
647
633
self.main_loop.run()
648
634
# Main loop has finished, we should close everything now
649
gobject.source_remove(self._input_callback_tag)
635
GLib.source_remove(self._input_callback_tag)
636
with warnings.catch_warnings():
637
warnings.simplefilter("ignore", BytesWarning)
653
641
self.main_loop.quit()
642
log.removeHandler(self.loghandler)
643
log.propagate = self.orig_log_propagate
655
645
def process_input(self, source, condition):
656
646
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
647
translations = {"ctrl n": "down", # Emacs
648
"ctrl p": "up", # Emacs
649
"ctrl v": "page down", # Emacs
650
"meta v": "page up", # Emacs
651
" ": "page down", # less
652
"f": "page down", # less
653
"b": "page up", # less
669
659
key = translations[key]
670
660
except KeyError: # :-)
673
663
if key == "q" or key == "Q":
717
706
self.topwidget.set_focus(self.logbox)
720
if self.log_level == 0:
722
self.log_message("Verbose mode: Off")
709
if log.level < logging.INFO:
710
log.setLevel(logging.INFO)
711
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
713
log.setLevel(logging.NOTSET)
714
log.info("Verbose mode: On")
715
# elif (key == "end" or key == "meta >" or key == "G"
717
# pass # xxx end-of-buffer
718
# elif (key == "home" or key == "meta <" or key == "g"
720
# pass # xxx beginning-of-buffer
721
# elif key == "ctrl e" or key == "$":
722
# pass # xxx move-end-of-line
723
# elif key == "ctrl a" or key == "^":
724
# pass # xxx move-beginning-of-line
725
# elif key == "ctrl b" or key == "meta (" or key == "h":
727
# elif key == "ctrl f" or key == "meta )" or key == "l":
730
# pass # scroll up log
732
# pass # scroll down log
744
733
elif self.topwidget.selectable():
745
734
self.topwidget.keypress(self.size, key)
739
class UILogHandler(logging.Handler):
740
def __init__(self, ui, *args, **kwargs):
742
super(UILogHandler, self).__init__(*args, **kwargs)
744
logging.Formatter("%(asctime)s: %(message)s"))
745
def emit(self, record):
746
msg = self.format(record)
747
if record.levelno > logging.INFO:
749
self.ui.add_log_line(msg)
749
752
ui = UserInterface()
752
755
except KeyboardInterrupt:
754
except Exception as e:
755
ui.log_message(str(e))
756
with warnings.catch_warnings():
757
warnings.filterwarnings("ignore", "", BytesWarning)
760
with warnings.catch_warnings():
761
warnings.filterwarnings("ignore", "", BytesWarning)