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-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
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
27
from __future__ import (division, absolute_import, print_function,
48
49
if sys.version_info.major == 2:
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
52
log = logging.getLogger(os.path.basename(sys.argv[0]))
53
logging.basicConfig(level="NOTSET", # Show all messages
54
format="%(message)s") # Show basic log messages
56
logging.captureWarnings(True) # Show warnings via the logging system
58
locale.setlocale(locale.LC_ALL, "")
60
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
56
62
# Some useful constants
57
domain = 'se.recompile'
58
server_interface = domain + '.Mandos'
59
client_interface = domain + '.Mandos.Client'
63
domain = "se.recompile"
64
server_interface = domain + ".Mandos"
65
client_interface = domain + ".Mandos.Client"
63
69
dbus.OBJECT_MANAGER_IFACE
64
70
except AttributeError:
65
71
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
74
def isoformat_to_datetime(iso):
68
75
"Parse an ISO 8601 date string to a datetime.datetime()"
88
96
def __init__(self, proxy_object=None, properties=None, **kwargs):
89
self.proxy = proxy_object # Mandos Client proxy object
97
self.proxy = proxy_object # Mandos Client proxy object
90
98
self.properties = dict() if properties is None else properties
91
99
self.property_changed_match = (
92
100
self.proxy.connect_to_signal("PropertiesChanged",
93
101
self.properties_changed,
94
102
dbus.PROPERTIES_IFACE,
95
103
byte_arrays=True))
97
105
if properties is None:
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
106
self.properties.update(self.proxy.GetAll(
108
dbus_interface=dbus.PROPERTIES_IFACE))
103
110
super(MandosClientPropertyCache, self).__init__(**kwargs)
105
112
def properties_changed(self, interface, properties, invalidated):
106
113
"""This is called whenever we get a PropertiesChanged signal
107
114
It updates the changed properties in the "properties" dict.
161
166
client_interface,
162
167
byte_arrays=True))
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
168
log.debug("Created client %s", self.properties["Name"])
166
170
def using_timer(self, flag):
167
171
"""Call this method with True or False when timer should be
168
172
activated or deactivated.
170
174
if flag and self._update_timer_callback_tag is None:
171
175
# Will update the shown timer value every second
172
self._update_timer_callback_tag = (GLib.timeout_add
176
self._update_timer_callback_tag = (
177
GLib.timeout_add(1000,
178
glib_safely(self.update_timer)))
175
179
elif not (flag or self._update_timer_callback_tag is None):
176
180
GLib.source_remove(self._update_timer_callback_tag)
177
181
self._update_timer_callback_tag = None
179
183
def checker_completed(self, exitstatus, condition, command):
180
184
if exitstatus == 0:
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
187
190
if os.WIFEXITED(condition):
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
191
log.info('Checker for client %s (command "%s") failed'
192
" with exit code %d", self.properties["Name"],
193
command, os.WEXITSTATUS(condition))
192
194
elif os.WIFSIGNALED(condition):
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
195
log.info('Checker for client %s (command "%s") was'
196
" killed by signal %d", self.properties["Name"],
197
command, os.WTERMSIG(condition))
199
200
def checker_started(self, command):
200
201
"""Server signals that a checker started."""
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
205
205
def got_secret(self):
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
206
log.info("Client %s received its secret",
207
self.properties["Name"])
209
209
def need_approval(self, timeout, default):
211
message = 'Client {} needs approval within {} seconds'
211
message = "Client %s needs approval within %f seconds"
213
message = 'Client {} will get its secret in {} seconds'
214
self.logger(message.format(self.properties["Name"],
213
message = "Client %s will get its secret in %f seconds"
214
log.info(message, self.properties["Name"], timeout/1000)
217
216
def rejected(self, reason):
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
221
220
def selectable(self):
222
221
"""Make this a "selectable" widget.
223
222
This overrides the method from urwid.FlowWidget."""
226
225
def rows(self, maxcolrow, focus=False):
227
226
"""How many rows this widget will occupy might depend on
228
227
whether we have focus or not.
229
228
This overrides the method from urwid.FlowWidget"""
230
229
return self.current_widget(focus).rows(maxcolrow, focus=focus)
232
231
def current_widget(self, focus=False):
233
232
if focus or self.opened:
234
233
return self._focus_widget
235
234
return self._widget
237
236
def update(self):
238
237
"Called when what is visible on the screen should be updated."
239
238
# 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",
239
with_standout = {"normal": "standout",
240
"bold": "bold-standout",
242
"underline-blink-standout",
243
"bold-underline-blink":
244
"bold-underline-blink-standout",
248
247
# Rebuild focus and non-focus widgets using current properties
250
249
# Base part of a client. Name!
251
base = '{name}: '.format(name=self.properties["Name"])
250
base = "{name}: ".format(name=self.properties["Name"])
252
251
if not self.properties["Enabled"]:
253
252
message = "DISABLED"
254
253
self.using_timer(False)
255
254
elif self.properties["ApprovalPending"]:
256
timeout = datetime.timedelta(milliseconds
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
259
257
last_approval_request = isoformat_to_datetime(
260
258
self.properties["LastApprovalRequest"])
261
259
if last_approval_request is not None:
322
320
if self.delete_hook is not None:
323
321
self.delete_hook(self)
324
322
return super(MandosClientWidget, self).delete(**kwargs)
326
324
def render(self, maxcolrow, focus=False):
327
325
"""Render differently if we have focus.
328
326
This overrides the method from urwid.FlowWidget"""
329
327
return self.current_widget(focus).render(maxcolrow,
332
330
def keypress(self, maxcolrow, key):
334
332
This overrides the method from urwid.FlowWidget"""
336
334
self.proxy.Set(client_interface, "Enabled",
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
340
338
self.proxy.Set(client_interface, "Enabled", False,
342
dbus_interface = dbus.PROPERTIES_IFACE)
340
dbus_interface=dbus.PROPERTIES_IFACE)
344
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
dbus_interface = client_interface,
343
dbus_interface=client_interface,
346
344
ignore_reply=True)
348
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
dbus_interface = client_interface,
347
dbus_interface=client_interface,
350
348
ignore_reply=True)
351
349
elif key == "R" or key == "_" or key == "ctrl k":
352
350
self.server_proxy_object.RemoveClient(self.proxy
354
352
ignore_reply=True)
356
354
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
360
358
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
364
self.proxy.CheckedOK(dbus_interface = client_interface,
362
self.proxy.CheckedOK(dbus_interface=client_interface,
365
363
ignore_reply=True)
367
365
# elif key == "p" or key == "=":
386
def glib_safely(func, retval=True):
387
def safe_func(*args, **kwargs):
389
return func(*args, **kwargs)
388
396
class ConstrainedListBox(urwid.ListBox):
389
397
"""Like a normal urwid.ListBox, but will consume all "up" or
390
398
"down" key presses, thus not allowing any containing widgets to
391
399
use them as an excuse to shift focus away from this widget.
393
401
def keypress(self, *args, **kwargs):
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
402
ret = (super(ConstrainedListBox, self)
403
.keypress(*args, **kwargs))
395
404
if ret in ("up", "down"):
426
436
"bold,underline,blink,standout", "default",
427
437
"bold,underline,blink,standout"),
430
440
if urwid.supports_unicode():
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
441
self.divider = "─" # \u2500
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
443
self.divider = "_" # \u005f
437
445
self.screen.start()
439
447
self.size = self.screen.get_cols_rows()
441
449
self.clients = urwid.SimpleListWalker([])
442
450
self.clients_dict = {}
444
452
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
446
454
self.max_log_length = max_log_length
448
self.log_level = log_level
450
456
# We keep a reference to the log widget so we can remove it
451
457
# from the ListWalker without it getting destroyed
452
458
self.logbox = ConstrainedListBox(self.log)
454
460
# This keeps track of whether self.uilist currently has
455
461
# self.logbox in it or not
456
462
self.log_visible = True
457
463
self.log_wrap = "any"
465
self.loghandler = UILogHandler(self)
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
465
self.busname = domain + '.Mandos'
468
self.add_log_line(("bold",
469
"Mandos Monitor version " + version))
470
self.add_log_line(("bold", "q: Quit ?: Help"))
472
self.busname = domain + ".Mandos"
466
473
self.main_loop = GLib.MainLoop()
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))
475
def client_not_found(self, key_id, address):
476
log.info("Client with address %s and key ID %s could"
477
" not be found", address, key_id)
473
479
def rebuild(self):
474
480
"""This rebuilds the User Interface.
475
481
Call this when the widget layout needs to change"""
477
#self.uilist.append(urwid.ListBox(self.clients))
483
# self.uilist.append(urwid.ListBox(self.clients))
478
484
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
480
#header=urwid.Divider(),
486
# header=urwid.Divider(),
483
urwid.Divider(div_char=
488
footer=urwid.Divider(
489
div_char=self.divider)))
485
490
if self.log_visible:
486
491
self.uilist.append(self.logbox)
487
492
self.topwidget = urwid.Pile(self.uilist)
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:
494
def add_log_line(self, markup):
501
495
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
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),
496
if self.max_log_length:
497
if len(self.log) > self.max_log_length:
498
del self.log[0:(len(self.log) - self.max_log_length)]
499
self.logbox.set_focus(len(self.logbox.body.contents)-1,
506
500
coming_from="above")
509
503
def toggle_log_display(self):
510
504
"""Toggle visibility of the log buffer."""
511
505
self.log_visible = not self.log_visible
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
507
log.debug("Log visibility changed to: %s", self.log_visible)
516
509
def change_log_display(self):
517
510
"""Change type of log display.
518
511
Currently, this toggles wrapping of text lines."""
574
558
self.clients_dict[path] = client
575
559
self.clients.sort(key=lambda c: c.properties["Name"])
578
562
def remove_client(self, client, path=None):
579
563
self.clients.remove(client)
581
565
path = client.proxy.object_path
582
566
del self.clients_dict[path]
585
569
def refresh(self):
586
570
"""Redraw the screen"""
587
571
canvas = self.topwidget.render(self.size, focus=True)
588
572
self.screen.draw_screen(self.size, canvas)
591
575
"""Start the main loop and exit when it's done."""
576
log.addHandler(self.loghandler)
577
self.orig_log_propagate = log.propagate
578
log.propagate = False
579
self.orig_log_level = log.level
592
581
self.bus = dbus.SystemBus()
593
582
mandos_dbus_objc = self.bus.get_object(
594
583
self.busname, "/", follow_name_owner_changes=True)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
599
587
mandos_clients = (self.mandos_serv
600
588
.GetAllClientsWithProperties())
601
589
if not mandos_clients:
602
self.log_message_raw(("bold", "Note: Server has no clients."))
590
log.warning("Note: Server has no clients.")
603
591
except dbus.exceptions.DBusException:
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
592
log.warning("Note: No Mandos server running.")
605
593
mandos_clients = dbus.Dictionary()
607
595
(self.mandos_serv
608
596
.connect_to_signal("InterfacesRemoved",
609
597
self.find_and_remove_client,
611
= dbus.OBJECT_MANAGER_IFACE,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
612
599
byte_arrays=True))
613
600
(self.mandos_serv
614
601
.connect_to_signal("InterfacesAdded",
615
602
self.add_new_client,
617
= dbus.OBJECT_MANAGER_IFACE,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
618
604
byte_arrays=True))
619
605
(self.mandos_serv
620
606
.connect_to_signal("ClientNotFound",
624
610
for path, client in mandos_clients.items():
625
611
client_proxy_object = self.bus.get_object(self.busname,
627
self.add_client(MandosClientWidget(server_proxy_object
630
=client_proxy_object,
613
self.add_client(MandosClientWidget(
614
server_proxy_object=self.mandos_serv,
615
proxy_object=client_proxy_object,
617
update_hook=self.refresh,
618
delete_hook=self.remove_client),
641
self._input_callback_tag = (GLib.io_add_watch
622
self._input_callback_tag = (
624
GLib.IOChannel.unix_new(sys.stdin.fileno()),
625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
626
glib_safely(self.process_input)))
645
627
self.main_loop.run()
646
628
# Main loop has finished, we should close everything now
647
629
GLib.source_remove(self._input_callback_tag)
630
with warnings.catch_warnings():
631
warnings.simplefilter("ignore", BytesWarning)
651
635
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
653
639
def process_input(self, source, condition):
654
640
keys = self.screen.get_input()
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
641
translations = {"ctrl n": "down", # Emacs
642
"ctrl p": "up", # Emacs
643
"ctrl v": "page down", # Emacs
644
"meta v": "page up", # Emacs
645
" ": "page down", # less
646
"f": "page down", # less
647
"b": "page up", # less
667
653
key = translations[key]
668
654
except KeyError: # :-)
671
657
if key == "q" or key == "Q":
715
700
self.topwidget.set_focus(self.logbox)
718
if self.log_level == 0:
720
self.log_message("Verbose mode: Off")
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
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
707
log.setLevel(logging.NOTSET)
708
log.info("Verbose mode: On")
709
# elif (key == "end" or key == "meta >" or key == "G"
711
# pass # xxx end-of-buffer
712
# elif (key == "home" or key == "meta <" or key == "g"
714
# pass # xxx beginning-of-buffer
715
# elif key == "ctrl e" or key == "$":
716
# pass # xxx move-end-of-line
717
# elif key == "ctrl a" or key == "^":
718
# pass # xxx move-beginning-of-line
719
# elif key == "ctrl b" or key == "meta (" or key == "h":
721
# elif key == "ctrl f" or key == "meta )" or key == "l":
724
# pass # scroll up log
726
# pass # scroll down log
742
727
elif self.topwidget.selectable():
743
728
self.topwidget.keypress(self.size, key)
733
class UILogHandler(logging.Handler):
734
def __init__(self, ui, *args, **kwargs):
736
super(UILogHandler, self).__init__(*args, **kwargs)
738
logging.Formatter("%(asctime)s: %(message)s"))
739
def emit(self, record):
740
msg = self.format(record)
741
if record.levelno > logging.INFO:
743
self.ui.add_log_line(msg)
747
746
ui = UserInterface()
750
749
except KeyboardInterrupt:
752
except Exception as e:
753
ui.log_message(str(e))
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)