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
49
48
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)
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
69
56
# Some useful constants
70
domain = "se.recompile"
71
server_interface = domain + ".Mandos"
72
client_interface = domain + ".Mandos.Client"
57
domain = 'se.recompile'
58
server_interface = domain + '.Mandos'
59
client_interface = domain + '.Mandos.Client'
76
63
dbus.OBJECT_MANAGER_IFACE
77
64
except AttributeError:
78
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
81
67
def isoformat_to_datetime(iso):
82
68
"Parse an ISO 8601 date string to a datetime.datetime()"
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
80
int(second), # Whole seconds
81
int(fraction*1000000)) # Microseconds
83
class MandosClientPropertyCache(object):
99
84
"""This wraps a Mandos Client D-Bus proxy object, caches the
100
85
properties and calls a hook function when any of them are
103
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
104
self.proxy = proxy_object # Mandos Client proxy object
89
self.proxy = proxy_object # Mandos Client proxy object
105
90
self.properties = dict() if properties is None else properties
106
91
self.property_changed_match = (
107
92
self.proxy.connect_to_signal("PropertiesChanged",
108
93
self.properties_changed,
109
94
dbus.PROPERTIES_IFACE,
110
95
byte_arrays=True))
112
97
if properties is None:
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
117
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
119
105
def properties_changed(self, interface, properties, invalidated):
120
106
"""This is called whenever we get a PropertiesChanged signal
121
107
It updates the changed properties in the "properties" dict.
173
161
client_interface,
174
162
byte_arrays=True))
175
log.debug("Created client %s", self.properties["Name"])
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
177
166
def using_timer(self, flag):
178
167
"""Call this method with True or False when timer should be
179
168
activated or deactivated.
181
170
if flag and self._update_timer_callback_tag is None:
182
171
# 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)))
172
self._update_timer_callback_tag = (GLib.timeout_add
186
175
elif not (flag or self._update_timer_callback_tag is None):
187
176
GLib.source_remove(self._update_timer_callback_tag)
188
177
self._update_timer_callback_tag = None
190
179
def checker_completed(self, exitstatus, condition, command):
191
180
if exitstatus == 0:
192
log.debug('Checker for client %s (command "%s")'
193
" succeeded", self.properties["Name"], command)
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
197
187
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))
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
201
192
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))
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
207
199
def checker_started(self, command):
208
200
"""Server signals that a checker started."""
209
log.debug('Client %s started checker "%s"',
210
self.properties["Name"], command)
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
212
205
def got_secret(self):
213
log.info("Client %s received its secret",
214
self.properties["Name"])
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
216
209
def need_approval(self, timeout, default):
218
message = "Client %s needs approval within %f seconds"
211
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)
213
message = 'Client {} will get its secret in {} seconds'
214
self.logger(message.format(self.properties["Name"],
223
217
def rejected(self, reason):
224
log.info("Client %s was rejected; reason: %s",
225
self.properties["Name"], reason)
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
227
221
def selectable(self):
228
222
"""Make this a "selectable" widget.
229
223
This overrides the method from urwid.FlowWidget."""
232
226
def rows(self, maxcolrow, focus=False):
233
227
"""How many rows this widget will occupy might depend on
234
228
whether we have focus or not.
235
229
This overrides the method from urwid.FlowWidget"""
236
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
238
232
def current_widget(self, focus=False):
239
233
if focus or self.opened:
240
234
return self._focus_widget
241
235
return self._widget
243
237
def update(self):
244
238
"Called when what is visible on the screen should be updated."
245
239
# 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",
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
254
248
# Rebuild focus and non-focus widgets using current properties
256
250
# Base part of a client. Name!
257
base = "{name}: ".format(name=self.properties["Name"])
251
base = '{name}: '.format(name=self.properties["Name"])
258
252
if not self.properties["Enabled"]:
259
253
message = "DISABLED"
260
254
self.using_timer(False)
261
255
elif self.properties["ApprovalPending"]:
262
timeout = datetime.timedelta(
263
milliseconds=self.properties["ApprovalDelay"])
256
timeout = datetime.timedelta(milliseconds
264
259
last_approval_request = isoformat_to_datetime(
265
260
self.properties["LastApprovalRequest"])
266
261
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
336
self.proxy.Set(client_interface, "Enabled",
342
dbus.Boolean(True), ignore_reply=True,
343
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
345
340
self.proxy.Set(client_interface, "Enabled", False,
347
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
349
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface=client_interface,
345
dbus_interface = client_interface,
351
346
ignore_reply=True)
353
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface=client_interface,
349
dbus_interface = client_interface,
355
350
ignore_reply=True)
356
351
elif key == "R" or key == "_" or key == "ctrl k":
357
352
self.server_proxy_object.RemoveClient(self.proxy
359
354
ignore_reply=True)
361
356
self.proxy.Set(client_interface, "CheckerRunning",
362
dbus.Boolean(True), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
365
360
self.proxy.Set(client_interface, "CheckerRunning",
366
dbus.Boolean(False), ignore_reply=True,
367
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
369
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
370
365
ignore_reply=True)
372
367
# elif key == "p" or key == "=":
393
def glib_safely(func, retval=True):
394
def safe_func(*args, **kwargs):
396
return func(*args, **kwargs)
403
388
class ConstrainedListBox(urwid.ListBox):
404
389
"""Like a normal urwid.ListBox, but will consume all "up" or
405
390
"down" key presses, thus not allowing any containing widgets to
406
391
use them as an excuse to shift focus away from this widget.
408
393
def keypress(self, *args, **kwargs):
409
ret = (super(ConstrainedListBox, self)
410
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
411
395
if ret in ("up", "down"):
400
class UserInterface(object):
417
401
"""This is the entire user interface - the whole screen
418
402
with boxes, lists of client widgets, etc.
420
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
421
405
DBusGMainLoop(set_as_default=True)
423
407
self.screen = urwid.curses_display.Screen()
425
409
self.screen.register_palette((
427
411
"default", "default", None),
443
426
"bold,underline,blink,standout", "default",
444
427
"bold,underline,blink,standout"),
447
430
if urwid.supports_unicode():
448
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
450
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
452
437
self.screen.start()
454
439
self.size = self.screen.get_cols_rows()
456
441
self.clients = urwid.SimpleListWalker([])
457
442
self.clients_dict = {}
459
444
# We will add Text widgets to this list
460
self.log = urwid.SimpleListWalker([])
461
446
self.max_log_length = max_log_length
448
self.log_level = log_level
463
450
# We keep a reference to the log widget so we can remove it
464
451
# from the ListWalker without it getting destroyed
465
452
self.logbox = ConstrainedListBox(self.log)
467
454
# This keeps track of whether self.uilist currently has
468
455
# self.logbox in it or not
469
456
self.log_visible = True
470
457
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"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
465
self.busname = domain + '.Mandos'
480
466
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)
468
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
486
473
def rebuild(self):
487
474
"""This rebuilds the User Interface.
488
475
Call this when the widget layout needs to change"""
490
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
491
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
493
# header=urwid.Divider(),
480
#header=urwid.Divider(),
495
footer=urwid.Divider(
496
div_char=self.divider)))
483
urwid.Divider(div_char=
497
485
if self.log_visible:
498
486
self.uilist.append(self.logbox)
499
487
self.topwidget = urwid.Pile(self.uilist)
501
def add_log_line(self, markup):
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
502
501
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,
502
if (self.max_log_length
503
and len(self.log) > self.max_log_length):
504
del self.log[0:len(self.log)-self.max_log_length-1]
505
self.logbox.set_focus(len(self.logbox.body.contents),
507
506
coming_from="above")
510
509
def toggle_log_display(self):
511
510
"""Toggle visibility of the log buffer."""
512
511
self.log_visible = not self.log_visible
514
log.debug("Log visibility changed to: %s", self.log_visible)
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
516
516
def change_log_display(self):
517
517
"""Change type of log display.
518
518
Currently, this toggles wrapping of text lines."""
565
574
self.clients_dict[path] = client
566
575
self.clients.sort(key=lambda c: c.properties["Name"])
569
578
def remove_client(self, client, path=None):
570
579
self.clients.remove(client)
572
581
path = client.proxy.object_path
573
582
del self.clients_dict[path]
576
585
def refresh(self):
577
586
"""Redraw the screen"""
578
587
canvas = self.topwidget.render(self.size, focus=True)
579
588
self.screen.draw_screen(self.size, canvas)
582
591
"""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
592
self.bus = dbus.SystemBus()
589
593
mandos_dbus_objc = self.bus.get_object(
590
594
self.busname, "/", follow_name_owner_changes=True)
591
self.mandos_serv = dbus.Interface(
592
mandos_dbus_objc, dbus_interface=server_interface)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
594
599
mandos_clients = (self.mandos_serv
595
600
.GetAllClientsWithProperties())
596
601
if not mandos_clients:
597
log.warning("Note: Server has no clients.")
602
self.log_message_raw(("bold", "Note: Server has no clients."))
598
603
except dbus.exceptions.DBusException:
599
log.warning("Note: No Mandos server running.")
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
605
mandos_clients = dbus.Dictionary()
602
607
(self.mandos_serv
603
608
.connect_to_signal("InterfacesRemoved",
604
609
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
= dbus.OBJECT_MANAGER_IFACE,
606
612
byte_arrays=True))
607
613
(self.mandos_serv
608
614
.connect_to_signal("InterfacesAdded",
609
615
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
617
= dbus.OBJECT_MANAGER_IFACE,
611
618
byte_arrays=True))
612
619
(self.mandos_serv
613
620
.connect_to_signal("ClientNotFound",
617
624
for path, client in mandos_clients.items():
618
625
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),
627
self.add_client(MandosClientWidget(server_proxy_object
630
=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)))
641
self._input_callback_tag = (GLib.io_add_watch
634
645
self.main_loop.run()
635
646
# Main loop has finished, we should close everything now
636
647
GLib.source_remove(self._input_callback_tag)
637
with warnings.catch_warnings():
638
warnings.simplefilter("ignore", BytesWarning)
642
651
self.main_loop.quit()
643
log.removeHandler(self.loghandler)
644
log.propagate = self.orig_log_propagate
646
653
def process_input(self, source, condition):
647
654
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
655
translations = { "ctrl n": "down", # Emacs
656
"ctrl p": "up", # Emacs
657
"ctrl v": "page down", # Emacs
658
"meta v": "page up", # Emacs
659
" ": "page down", # less
660
"f": "page down", # less
661
"b": "page up", # less
660
667
key = translations[key]
661
668
except KeyError: # :-)
664
671
if key == "q" or key == "Q":
707
715
self.topwidget.set_focus(self.logbox)
710
if log.level < logging.INFO:
711
log.setLevel(logging.INFO)
712
log.info("Verbose mode: Off")
718
if self.log_level == 0:
720
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
723
self.log_message("Verbose mode: On")
724
#elif (key == "end" or key == "meta >" or key == "G"
726
# pass # xxx end-of-buffer
727
#elif (key == "home" or key == "meta <" or key == "g"
729
# pass # xxx beginning-of-buffer
730
#elif key == "ctrl e" or key == "$":
731
# pass # xxx move-end-of-line
732
#elif key == "ctrl a" or key == "^":
733
# pass # xxx move-beginning-of-line
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
739
# pass # scroll up log
741
# pass # scroll down log
734
742
elif self.topwidget.selectable():
735
743
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
747
ui = UserInterface()
756
750
except KeyboardInterrupt:
757
with warnings.catch_warnings():
758
warnings.filterwarnings("ignore", "", BytesWarning)
761
with warnings.catch_warnings():
762
warnings.filterwarnings("ignore", "", BytesWarning)
752
except Exception as e:
753
ui.log_message(str(e))