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
26
from __future__ import (division, absolute_import, print_function,
29
30
from future_builtins import *
30
31
except ImportError:
38
41
import urwid.curses_display
41
44
from dbus.mainloop.glib import DBusGMainLoop
43
from gi.repository import GObject
45
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)
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)
59
69
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
70
domain = "se.recompile"
71
server_interface = domain + ".Mandos"
72
client_interface = domain + ".Mandos.Client"
66
76
dbus.OBJECT_MANAGER_IFACE
67
77
except AttributeError:
68
78
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
81
def isoformat_to_datetime(iso):
71
82
"Parse an ISO 8601 date string to a datetime.datetime()"
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
86
class MandosClientPropertyCache(object):
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
87
99
"""This wraps a Mandos Client D-Bus proxy object, caches the
88
100
properties and calls a hook function when any of them are
91
103
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
104
self.proxy = proxy_object # Mandos Client proxy object
93
105
self.properties = dict() if properties is None else properties
94
106
self.property_changed_match = (
95
107
self.proxy.connect_to_signal("PropertiesChanged",
96
108
self.properties_changed,
97
109
dbus.PROPERTIES_IFACE,
98
110
byte_arrays=True))
100
112
if properties is None:
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
106
117
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
119
def properties_changed(self, interface, properties, invalidated):
109
120
"""This is called whenever we get a PropertiesChanged signal
110
121
It updates the changed properties in the "properties" dict.
112
123
# Update properties dict with new value
113
124
if interface == client_interface:
114
125
self.properties.update(properties)
116
127
def delete(self):
117
128
self.property_changed_match.remove()
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
131
class MandosClientWidget(MandosClientPropertyCache, urwid.Widget):
121
132
"""A Mandos Client which is visible on the screen.
135
_sizing = frozenset(["flow"])
124
137
def __init__(self, server_proxy_object=None, update_hook=None,
125
delete_hook=None, logger=None, **kwargs):
138
delete_hook=None, **kwargs):
126
139
# Called on update
127
140
self.update_hook = update_hook
128
141
# Called on delete
129
142
self.delete_hook = delete_hook
130
143
# Mandos Server proxy object
131
144
self.server_proxy_object = server_proxy_object
135
146
self._update_timer_callback_tag = None
137
148
# The widget shown normally
138
149
self._text_widget = urwid.Text("")
139
150
# The widget shown when we have focus
164
175
client_interface,
165
176
byte_arrays=True))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
177
log.debug("Created client %s", self.properties["Name"])
169
179
def using_timer(self, flag):
170
180
"""Call this method with True or False when timer should be
171
181
activated or deactivated.
173
183
if flag and self._update_timer_callback_tag is None:
174
184
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GObject.timeout_add
185
self._update_timer_callback_tag = (
186
GLib.timeout_add(1000,
187
glib_safely(self.update_timer)))
178
188
elif not (flag or self._update_timer_callback_tag is None):
179
GObject.source_remove(self._update_timer_callback_tag)
189
GLib.source_remove(self._update_timer_callback_tag)
180
190
self._update_timer_callback_tag = None
182
192
def checker_completed(self, exitstatus, condition, command):
183
193
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
194
log.debug('Checker for client %s (command "%s")'
195
" succeeded", self.properties["Name"], command)
190
199
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
200
log.info('Checker for client %s (command "%s") failed'
201
" with exit code %d", self.properties["Name"],
202
command, os.WEXITSTATUS(condition))
195
203
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)))
204
log.info('Checker for client %s (command "%s") was'
205
" killed by signal %d", self.properties["Name"],
206
command, os.WTERMSIG(condition))
202
209
def checker_started(self, command):
203
210
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
211
log.debug('Client %s started checker "%s"',
212
self.properties["Name"], command)
208
214
def got_secret(self):
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
215
log.info("Client %s received its secret",
216
self.properties["Name"])
212
218
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
220
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"],
222
message = "Client %s will get its secret in %f seconds"
223
log.info(message, self.properties["Name"], timeout/1000)
220
225
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
226
log.info("Client %s was rejected; reason: %s",
227
self.properties["Name"], reason)
224
229
def selectable(self):
225
230
"""Make this a "selectable" widget.
226
This overrides the method from urwid.FlowWidget."""
231
This overrides the method from urwid.Widget."""
229
234
def rows(self, maxcolrow, focus=False):
230
235
"""How many rows this widget will occupy might depend on
231
236
whether we have focus or not.
232
This overrides the method from urwid.FlowWidget"""
237
This overrides the method from urwid.Widget"""
233
238
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
240
def current_widget(self, focus=False):
236
241
if focus or self.opened:
237
242
return self._focus_widget
238
243
return self._widget
240
245
def update(self):
241
246
"Called when what is visible on the screen should be updated."
242
247
# 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",
248
with_standout = {"normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"bold-underline-blink-standout",
251
256
# Rebuild focus and non-focus widgets using current properties
253
258
# Base part of a client. Name!
254
base = '{name}: '.format(name=self.properties["Name"])
259
base = "{name}: ".format(name=self.properties["Name"])
255
260
if not self.properties["Enabled"]:
256
261
message = "DISABLED"
257
262
self.using_timer(False)
258
263
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(milliseconds
264
timeout = datetime.timedelta(
265
milliseconds=self.properties["ApprovalDelay"])
262
266
last_approval_request = isoformat_to_datetime(
263
267
self.properties["LastApprovalRequest"])
264
268
if last_approval_request is not None:
324
329
if self.delete_hook is not None:
325
330
self.delete_hook(self)
326
331
return super(MandosClientWidget, self).delete(**kwargs)
328
333
def render(self, maxcolrow, focus=False):
329
334
"""Render differently if we have focus.
330
This overrides the method from urwid.FlowWidget"""
335
This overrides the method from urwid.Widget"""
331
336
return self.current_widget(focus).render(maxcolrow,
334
339
def keypress(self, maxcolrow, key):
336
This overrides the method from urwid.FlowWidget"""
341
This overrides the method from urwid.Widget"""
338
343
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
344
dbus.Boolean(True), ignore_reply=True,
345
dbus_interface=dbus.PROPERTIES_IFACE)
342
347
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface = dbus.PROPERTIES_IFACE)
349
dbus_interface=dbus.PROPERTIES_IFACE)
346
351
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
352
dbus_interface=client_interface,
348
353
ignore_reply=True)
350
355
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
356
dbus_interface=client_interface,
352
357
ignore_reply=True)
353
358
elif key == "R" or key == "_" or key == "ctrl k":
354
359
self.server_proxy_object.RemoveClient(self.proxy
356
361
ignore_reply=True)
358
363
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
364
dbus.Boolean(True), ignore_reply=True,
365
dbus_interface=dbus.PROPERTIES_IFACE)
362
367
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
368
dbus.Boolean(False), ignore_reply=True,
369
dbus_interface=dbus.PROPERTIES_IFACE)
366
self.proxy.CheckedOK(dbus_interface = client_interface,
371
self.proxy.CheckedOK(dbus_interface=client_interface,
367
372
ignore_reply=True)
369
374
# elif key == "p" or key == "=":
395
def glib_safely(func, retval=True):
396
def safe_func(*args, **kwargs):
398
return func(*args, **kwargs)
390
405
class ConstrainedListBox(urwid.ListBox):
391
406
"""Like a normal urwid.ListBox, but will consume all "up" or
392
407
"down" key presses, thus not allowing any containing widgets to
393
408
use them as an excuse to shift focus away from this widget.
395
410
def keypress(self, *args, **kwargs):
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
411
ret = (super(ConstrainedListBox, self)
412
.keypress(*args, **kwargs))
397
413
if ret in ("up", "down"):
402
class UserInterface(object):
403
419
"""This is the entire user interface - the whole screen
404
420
with boxes, lists of client widgets, etc.
406
def __init__(self, max_log_length=1000, log_level=1):
422
def __init__(self, max_log_length=1000):
407
423
DBusGMainLoop(set_as_default=True)
409
425
self.screen = urwid.curses_display.Screen()
411
427
self.screen.register_palette((
413
429
"default", "default", None),
428
445
"bold,underline,blink,standout", "default",
429
446
"bold,underline,blink,standout"),
432
449
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
450
self.divider = "─" # \u2500
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
452
self.divider = "_" # \u005f
439
454
self.screen.start()
441
456
self.size = self.screen.get_cols_rows()
443
458
self.clients = urwid.SimpleListWalker([])
444
459
self.clients_dict = {}
446
461
# We will add Text widgets to this list
462
self.log = urwid.SimpleListWalker([])
448
463
self.max_log_length = max_log_length
450
self.log_level = log_level
452
465
# We keep a reference to the log widget so we can remove it
453
466
# from the ListWalker without it getting destroyed
454
467
self.logbox = ConstrainedListBox(self.log)
456
469
# This keeps track of whether self.uilist currently has
457
470
# self.logbox in it or not
458
471
self.log_visible = True
459
472
self.log_wrap = "any"
474
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))
477
self.add_log_line(("bold",
478
"Mandos Monitor version " + version))
479
self.add_log_line(("bold", "q: Quit ?: Help"))
481
self.busname = domain + ".Mandos"
482
self.main_loop = GLib.MainLoop()
484
def client_not_found(self, key_id, address):
485
log.info("Client with address %s and key ID %s could"
486
" not be found", address, key_id)
475
488
def rebuild(self):
476
489
"""This rebuilds the User Interface.
477
490
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
492
# self.uilist.append(urwid.ListBox(self.clients))
480
493
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
495
# header=urwid.Divider(),
485
urwid.Divider(div_char=
497
footer=urwid.Divider(
498
div_char=self.divider)))
487
499
if self.log_visible:
488
500
self.uilist.append(self.logbox)
489
501
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:
503
def add_log_line(self, markup):
503
504
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),
505
if self.max_log_length:
506
if len(self.log) > self.max_log_length:
507
del self.log[0:(len(self.log) - self.max_log_length)]
508
self.logbox.set_focus(len(self.logbox.body.contents)-1,
508
509
coming_from="above")
511
512
def toggle_log_display(self):
512
513
"""Toggle visibility of the log buffer."""
513
514
self.log_visible = not self.log_visible
515
self.log_message("Log visibility changed to: {}"
516
.format(self.log_visible), level=0)
516
log.debug("Log visibility changed to: %s", self.log_visible)
518
518
def change_log_display(self):
519
519
"""Change type of log display.
520
520
Currently, this toggles wrapping of text lines."""
576
567
self.clients_dict[path] = client
577
568
self.clients.sort(key=lambda c: c.properties["Name"])
580
571
def remove_client(self, client, path=None):
581
572
self.clients.remove(client)
583
574
path = client.proxy.object_path
584
575
del self.clients_dict[path]
587
578
def refresh(self):
588
579
"""Redraw the screen"""
589
580
canvas = self.topwidget.render(self.size, focus=True)
590
581
self.screen.draw_screen(self.size, canvas)
593
584
"""Start the main loop and exit when it's done."""
585
log.addHandler(self.loghandler)
586
self.orig_log_propagate = log.propagate
587
log.propagate = False
588
self.orig_log_level = log.level
594
590
self.bus = dbus.SystemBus()
595
591
mandos_dbus_objc = self.bus.get_object(
596
592
self.busname, "/", follow_name_owner_changes=True)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
self.mandos_serv = dbus.Interface(
594
mandos_dbus_objc, dbus_interface=server_interface)
601
596
mandos_clients = (self.mandos_serv
602
597
.GetAllClientsWithProperties())
603
598
if not mandos_clients:
604
self.log_message_raw(("bold", "Note: Server has no clients."))
599
log.warning("Note: Server has no clients.")
605
600
except dbus.exceptions.DBusException:
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
601
log.warning("Note: No Mandos server running.")
607
602
mandos_clients = dbus.Dictionary()
609
604
(self.mandos_serv
610
605
.connect_to_signal("InterfacesRemoved",
611
606
self.find_and_remove_client,
613
= dbus.OBJECT_MANAGER_IFACE,
607
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
614
608
byte_arrays=True))
615
609
(self.mandos_serv
616
610
.connect_to_signal("InterfacesAdded",
617
611
self.add_new_client,
619
= dbus.OBJECT_MANAGER_IFACE,
612
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
620
613
byte_arrays=True))
621
614
(self.mandos_serv
622
615
.connect_to_signal("ClientNotFound",
626
619
for path, client in mandos_clients.items():
627
620
client_proxy_object = self.bus.get_object(self.busname,
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
622
self.add_client(MandosClientWidget(
623
server_proxy_object=self.mandos_serv,
624
proxy_object=client_proxy_object,
626
update_hook=self.refresh,
627
delete_hook=self.remove_client),
643
self._input_callback_tag = (GObject.io_add_watch
631
self._input_callback_tag = (
633
GLib.IOChannel.unix_new(sys.stdin.fileno()),
634
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
635
glib_safely(self.process_input)))
647
636
self.main_loop.run()
648
637
# Main loop has finished, we should close everything now
649
GObject.source_remove(self._input_callback_tag)
638
GLib.source_remove(self._input_callback_tag)
639
with warnings.catch_warnings():
640
warnings.simplefilter("ignore", BytesWarning)
653
644
self.main_loop.quit()
645
log.removeHandler(self.loghandler)
646
log.propagate = self.orig_log_propagate
655
648
def process_input(self, source, condition):
656
649
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
650
translations = {"ctrl n": "down", # Emacs
651
"ctrl p": "up", # Emacs
652
"ctrl v": "page down", # Emacs
653
"meta v": "page up", # Emacs
654
" ": "page down", # less
655
"f": "page down", # less
656
"b": "page up", # less
669
662
key = translations[key]
670
663
except KeyError: # :-)
673
666
if key == "q" or key == "Q":
717
709
self.topwidget.set_focus(self.logbox)
720
if self.log_level == 0:
722
self.log_message("Verbose mode: Off")
712
if log.level < logging.INFO:
713
log.setLevel(logging.INFO)
714
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
716
log.setLevel(logging.NOTSET)
717
log.info("Verbose mode: On")
718
# elif (key == "end" or key == "meta >" or key == "G"
720
# pass # xxx end-of-buffer
721
# elif (key == "home" or key == "meta <" or key == "g"
723
# pass # xxx beginning-of-buffer
724
# elif key == "ctrl e" or key == "$":
725
# pass # xxx move-end-of-line
726
# elif key == "ctrl a" or key == "^":
727
# pass # xxx move-beginning-of-line
728
# elif key == "ctrl b" or key == "meta (" or key == "h":
730
# elif key == "ctrl f" or key == "meta )" or key == "l":
733
# pass # scroll up log
735
# pass # scroll down log
744
736
elif self.topwidget.selectable():
745
737
self.topwidget.keypress(self.size, key)
742
class UILogHandler(logging.Handler):
743
def __init__(self, ui, *args, **kwargs):
745
super(UILogHandler, self).__init__(*args, **kwargs)
747
logging.Formatter("%(asctime)s: %(message)s"))
748
def emit(self, record):
749
msg = self.format(record)
750
if record.levelno > logging.INFO:
752
self.ui.add_log_line(msg)
749
755
ui = UserInterface()
752
758
except KeyboardInterrupt:
754
except Exception as e:
755
ui.log_message(str(e))
759
with warnings.catch_warnings():
760
warnings.filterwarnings("ignore", "", BytesWarning)
763
with warnings.catch_warnings():
764
warnings.filterwarnings("ignore", "", BytesWarning)