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