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