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-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
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"
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
76
66
dbus.OBJECT_MANAGER_IFACE
77
67
except AttributeError:
78
68
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
81
70
def isoformat_to_datetime(iso):
82
71
"Parse an ISO 8601 date string to a datetime.datetime()"
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
class MandosClientPropertyCache(object):
99
87
"""This wraps a Mandos Client D-Bus proxy object, caches the
100
88
properties and calls a hook function when any of them are
103
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
104
self.proxy = proxy_object # Mandos Client proxy object
92
self.proxy = proxy_object # Mandos Client proxy object
105
93
self.properties = dict() if properties is None else properties
106
94
self.property_changed_match = (
107
95
self.proxy.connect_to_signal("PropertiesChanged",
108
96
self.properties_changed,
109
97
dbus.PROPERTIES_IFACE,
110
98
byte_arrays=True))
112
100
if properties is None:
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
117
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
119
108
def properties_changed(self, interface, properties, invalidated):
120
109
"""This is called whenever we get a PropertiesChanged signal
121
110
It updates the changed properties in the "properties" dict.
173
164
client_interface,
174
165
byte_arrays=True))
175
log.debug("Created client %s", self.properties["Name"])
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
177
169
def using_timer(self, flag):
178
170
"""Call this method with True or False when timer should be
179
171
activated or deactivated.
181
173
if flag and self._update_timer_callback_tag is None:
182
174
# 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)))
175
self._update_timer_callback_tag = (gobject.timeout_add
186
178
elif not (flag or self._update_timer_callback_tag is None):
187
GLib.source_remove(self._update_timer_callback_tag)
179
gobject.source_remove(self._update_timer_callback_tag)
188
180
self._update_timer_callback_tag = None
190
182
def checker_completed(self, exitstatus, condition, command):
191
183
if exitstatus == 0:
192
log.debug('Checker for client %s (command "%s")'
193
" succeeded", self.properties["Name"], command)
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
197
190
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))
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
201
195
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))
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
207
202
def checker_started(self, command):
208
203
"""Server signals that a checker started."""
209
log.debug('Client %s started checker "%s"',
210
self.properties["Name"], command)
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
212
208
def got_secret(self):
213
log.info("Client %s received its secret",
214
self.properties["Name"])
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
216
212
def need_approval(self, timeout, default):
218
message = "Client %s needs approval within %f seconds"
214
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)
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
223
220
def rejected(self, reason):
224
log.info("Client %s was rejected; reason: %s",
225
self.properties["Name"], reason)
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
227
224
def selectable(self):
228
225
"""Make this a "selectable" widget.
229
226
This overrides the method from urwid.FlowWidget."""
232
229
def rows(self, maxcolrow, focus=False):
233
230
"""How many rows this widget will occupy might depend on
234
231
whether we have focus or not.
235
232
This overrides the method from urwid.FlowWidget"""
236
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
238
235
def current_widget(self, focus=False):
239
236
if focus or self.opened:
240
237
return self._focus_widget
241
238
return self._widget
243
240
def update(self):
244
241
"Called when what is visible on the screen should be updated."
245
242
# 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",
243
with_standout = { "normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
254
251
# Rebuild focus and non-focus widgets using current properties
256
253
# Base part of a client. Name!
257
base = "{name}: ".format(name=self.properties["Name"])
254
base = '{name}: '.format(name=self.properties["Name"])
258
255
if not self.properties["Enabled"]:
259
256
message = "DISABLED"
260
257
self.using_timer(False)
261
258
elif self.properties["ApprovalPending"]:
262
timeout = datetime.timedelta(
263
milliseconds=self.properties["ApprovalDelay"])
259
timeout = datetime.timedelta(milliseconds
264
262
last_approval_request = isoformat_to_datetime(
265
263
self.properties["LastApprovalRequest"])
266
264
if last_approval_request is not None:
327
324
if self.delete_hook is not None:
328
325
self.delete_hook(self)
329
326
return super(MandosClientWidget, self).delete(**kwargs)
331
328
def render(self, maxcolrow, focus=False):
332
329
"""Render differently if we have focus.
333
330
This overrides the method from urwid.FlowWidget"""
334
331
return self.current_widget(focus).render(maxcolrow,
337
334
def keypress(self, maxcolrow, key):
339
336
This overrides the method from urwid.FlowWidget"""
341
338
self.proxy.Set(client_interface, "Enabled",
342
dbus.Boolean(True), ignore_reply=True,
343
dbus_interface=dbus.PROPERTIES_IFACE)
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
345
342
self.proxy.Set(client_interface, "Enabled", False,
347
dbus_interface=dbus.PROPERTIES_IFACE)
344
dbus_interface = dbus.PROPERTIES_IFACE)
349
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface=client_interface,
347
dbus_interface = client_interface,
351
348
ignore_reply=True)
353
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface=client_interface,
351
dbus_interface = client_interface,
355
352
ignore_reply=True)
356
353
elif key == "R" or key == "_" or key == "ctrl k":
357
354
self.server_proxy_object.RemoveClient(self.proxy
359
356
ignore_reply=True)
361
358
self.proxy.Set(client_interface, "CheckerRunning",
362
dbus.Boolean(True), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
365
362
self.proxy.Set(client_interface, "CheckerRunning",
366
dbus.Boolean(False), ignore_reply=True,
367
dbus_interface=dbus.PROPERTIES_IFACE)
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
369
self.proxy.CheckedOK(dbus_interface=client_interface,
366
self.proxy.CheckedOK(dbus_interface = client_interface,
370
367
ignore_reply=True)
372
369
# elif key == "p" or key == "=":
393
def glib_safely(func, retval=True):
394
def safe_func(*args, **kwargs):
396
return func(*args, **kwargs)
403
390
class ConstrainedListBox(urwid.ListBox):
404
391
"""Like a normal urwid.ListBox, but will consume all "up" or
405
392
"down" key presses, thus not allowing any containing widgets to
406
393
use them as an excuse to shift focus away from this widget.
408
395
def keypress(self, *args, **kwargs):
409
ret = (super(ConstrainedListBox, self)
410
.keypress(*args, **kwargs))
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
411
397
if ret in ("up", "down"):
402
class UserInterface(object):
417
403
"""This is the entire user interface - the whole screen
418
404
with boxes, lists of client widgets, etc.
420
def __init__(self, max_log_length=1000):
406
def __init__(self, max_log_length=1000, log_level=1):
421
407
DBusGMainLoop(set_as_default=True)
423
409
self.screen = urwid.curses_display.Screen()
425
411
self.screen.register_palette((
427
413
"default", "default", None),
443
428
"bold,underline,blink,standout", "default",
444
429
"bold,underline,blink,standout"),
447
432
if urwid.supports_unicode():
448
self.divider = "─" # \u2500
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
450
self.divider = "_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
452
439
self.screen.start()
454
441
self.size = self.screen.get_cols_rows()
456
443
self.clients = urwid.SimpleListWalker([])
457
444
self.clients_dict = {}
459
446
# We will add Text widgets to this list
460
self.log = urwid.SimpleListWalker([])
461
448
self.max_log_length = max_log_length
450
self.log_level = log_level
463
452
# We keep a reference to the log widget so we can remove it
464
453
# from the ListWalker without it getting destroyed
465
454
self.logbox = ConstrainedListBox(self.log)
467
456
# This keeps track of whether self.uilist currently has
468
457
# self.logbox in it or not
469
458
self.log_visible = True
470
459
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)
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))
486
475
def rebuild(self):
487
476
"""This rebuilds the User Interface.
488
477
Call this when the widget layout needs to change"""
490
# self.uilist.append(urwid.ListBox(self.clients))
479
#self.uilist.append(urwid.ListBox(self.clients))
491
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
493
# header=urwid.Divider(),
482
#header=urwid.Divider(),
495
footer=urwid.Divider(
496
div_char=self.divider)))
485
urwid.Divider(div_char=
497
487
if self.log_visible:
498
488
self.uilist.append(self.logbox)
499
489
self.topwidget = urwid.Pile(self.uilist)
501
def add_log_line(self, markup):
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:
502
503
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,
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),
507
508
coming_from="above")
510
511
def toggle_log_display(self):
511
512
"""Toggle visibility of the log buffer."""
512
513
self.log_visible = not self.log_visible
514
log.debug("Log visibility changed to: %s", self.log_visible)
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
516
518
def change_log_display(self):
517
519
"""Change type of log display.
518
520
Currently, this toggles wrapping of text lines."""
565
576
self.clients_dict[path] = client
566
577
self.clients.sort(key=lambda c: c.properties["Name"])
569
580
def remove_client(self, client, path=None):
570
581
self.clients.remove(client)
572
583
path = client.proxy.object_path
573
584
del self.clients_dict[path]
576
587
def refresh(self):
577
588
"""Redraw the screen"""
578
589
canvas = self.topwidget.render(self.size, focus=True)
579
590
self.screen.draw_screen(self.size, canvas)
582
593
"""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
594
self.bus = dbus.SystemBus()
589
595
mandos_dbus_objc = self.bus.get_object(
590
596
self.busname, "/", follow_name_owner_changes=True)
591
self.mandos_serv = dbus.Interface(
592
mandos_dbus_objc, dbus_interface=server_interface)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
594
601
mandos_clients = (self.mandos_serv
595
602
.GetAllClientsWithProperties())
596
603
if not mandos_clients:
597
log.warning("Note: Server has no clients.")
604
self.log_message_raw(("bold", "Note: Server has no clients."))
598
605
except dbus.exceptions.DBusException:
599
log.warning("Note: No Mandos server running.")
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
607
mandos_clients = dbus.Dictionary()
602
609
(self.mandos_serv
603
610
.connect_to_signal("InterfacesRemoved",
604
611
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
613
= dbus.OBJECT_MANAGER_IFACE,
606
614
byte_arrays=True))
607
615
(self.mandos_serv
608
616
.connect_to_signal("InterfacesAdded",
609
617
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
619
= dbus.OBJECT_MANAGER_IFACE,
611
620
byte_arrays=True))
612
621
(self.mandos_serv
613
622
.connect_to_signal("ClientNotFound",
617
626
for path, client in mandos_clients.items():
618
627
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),
629
self.add_client(MandosClientWidget(server_proxy_object
632
=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)))
643
self._input_callback_tag = (gobject.io_add_watch
634
647
self.main_loop.run()
635
648
# 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)
649
gobject.source_remove(self._input_callback_tag)
642
653
self.main_loop.quit()
643
log.removeHandler(self.loghandler)
644
log.propagate = self.orig_log_propagate
646
655
def process_input(self, source, condition):
647
656
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
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
660
669
key = translations[key]
661
670
except KeyError: # :-)
664
673
if key == "q" or key == "Q":
707
717
self.topwidget.set_focus(self.logbox)
710
if log.level < logging.INFO:
711
log.setLevel(logging.INFO)
712
log.info("Verbose mode: Off")
720
if self.log_level == 0:
722
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
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
734
744
elif self.topwidget.selectable():
735
745
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
749
ui = UserInterface()
756
752
except KeyboardInterrupt:
757
with warnings.catch_warnings():
758
warnings.filterwarnings("ignore", "", BytesWarning)
761
with warnings.catch_warnings():
762
warnings.filterwarnings("ignore", "", BytesWarning)
754
except Exception as e:
755
ui.log_message(str(e))