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)
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
68
56
# Some useful constants
69
domain = "se.recompile"
70
server_interface = domain + ".Mandos"
71
client_interface = domain + ".Mandos.Client"
57
domain = 'se.recompile'
58
server_interface = domain + '.Mandos'
59
client_interface = domain + '.Mandos.Client'
75
63
dbus.OBJECT_MANAGER_IFACE
76
64
except AttributeError:
77
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
67
def isoformat_to_datetime(iso):
81
68
"Parse an ISO 8601 date string to a datetime.datetime()"
93
int(second), # Whole seconds
94
int(fraction*1000000)) # Microseconds
97
class MandosClientPropertyCache:
80
int(second), # Whole seconds
81
int(fraction*1000000)) # Microseconds
83
class MandosClientPropertyCache(object):
98
84
"""This wraps a Mandos Client D-Bus proxy object, caches the
99
85
properties and calls a hook function when any of them are
102
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
103
self.proxy = proxy_object # Mandos Client proxy object
89
self.proxy = proxy_object # Mandos Client proxy object
104
90
self.properties = dict() if properties is None else properties
105
91
self.property_changed_match = (
106
92
self.proxy.connect_to_signal("PropertiesChanged",
107
93
self.properties_changed,
108
94
dbus.PROPERTIES_IFACE,
109
95
byte_arrays=True))
111
97
if properties is None:
112
self.properties.update(self.proxy.GetAll(
114
dbus_interface=dbus.PROPERTIES_IFACE))
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
116
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
118
105
def properties_changed(self, interface, properties, invalidated):
119
106
"""This is called whenever we get a PropertiesChanged signal
120
107
It updates the changed properties in the "properties" dict.
172
161
client_interface,
173
162
byte_arrays=True))
174
log.debug("Created client %s", self.properties["Name"])
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
176
166
def using_timer(self, flag):
177
167
"""Call this method with True or False when timer should be
178
168
activated or deactivated.
180
170
if flag and self._update_timer_callback_tag is None:
181
171
# Will update the shown timer value every second
182
self._update_timer_callback_tag = (
183
GLib.timeout_add(1000,
184
glib_safely(self.update_timer)))
172
self._update_timer_callback_tag = (GLib.timeout_add
185
175
elif not (flag or self._update_timer_callback_tag is None):
186
176
GLib.source_remove(self._update_timer_callback_tag)
187
177
self._update_timer_callback_tag = None
189
179
def checker_completed(self, exitstatus, condition, command):
190
180
if exitstatus == 0:
191
log.debug('Checker for client %s (command "%s")'
192
" succeeded", self.properties["Name"], command)
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
196
187
if os.WIFEXITED(condition):
197
log.info('Checker for client %s (command "%s") failed'
198
" with exit code %d", self.properties["Name"],
199
command, os.WEXITSTATUS(condition))
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
200
192
elif os.WIFSIGNALED(condition):
201
log.info('Checker for client %s (command "%s") was'
202
" killed by signal %d", self.properties["Name"],
203
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)))
206
199
def checker_started(self, command):
207
200
"""Server signals that a checker started."""
208
log.debug('Client %s started checker "%s"',
209
self.properties["Name"], command)
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
211
205
def got_secret(self):
212
log.info("Client %s received its secret",
213
self.properties["Name"])
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
215
209
def need_approval(self, timeout, default):
217
message = "Client %s needs approval within %f seconds"
211
message = 'Client {} needs approval within {} seconds'
219
message = "Client %s will get its secret in %f seconds"
220
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"],
222
217
def rejected(self, reason):
223
log.info("Client %s was rejected; reason: %s",
224
self.properties["Name"], reason)
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
226
221
def selectable(self):
227
222
"""Make this a "selectable" widget.
228
223
This overrides the method from urwid.FlowWidget."""
231
226
def rows(self, maxcolrow, focus=False):
232
227
"""How many rows this widget will occupy might depend on
233
228
whether we have focus or not.
234
229
This overrides the method from urwid.FlowWidget"""
235
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
237
232
def current_widget(self, focus=False):
238
233
if focus or self.opened:
239
234
return self._focus_widget
240
235
return self._widget
242
237
def update(self):
243
238
"Called when what is visible on the screen should be updated."
244
239
# How to add standout mode to a style
245
with_standout = {"normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"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",
253
248
# Rebuild focus and non-focus widgets using current properties
255
250
# Base part of a client. Name!
256
base = "{name}: ".format(name=self.properties["Name"])
251
base = '{name}: '.format(name=self.properties["Name"])
257
252
if not self.properties["Enabled"]:
258
253
message = "DISABLED"
259
254
self.using_timer(False)
260
255
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(
262
milliseconds=self.properties["ApprovalDelay"])
256
timeout = datetime.timedelta(milliseconds
263
259
last_approval_request = isoformat_to_datetime(
264
260
self.properties["LastApprovalRequest"])
265
261
if last_approval_request is not None:
326
322
if self.delete_hook is not None:
327
323
self.delete_hook(self)
328
324
return super(MandosClientWidget, self).delete(**kwargs)
330
326
def render(self, maxcolrow, focus=False):
331
327
"""Render differently if we have focus.
332
328
This overrides the method from urwid.FlowWidget"""
333
329
return self.current_widget(focus).render(maxcolrow,
336
332
def keypress(self, maxcolrow, key):
338
334
This overrides the method from urwid.FlowWidget"""
340
336
self.proxy.Set(client_interface, "Enabled",
341
dbus.Boolean(True), ignore_reply=True,
342
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
344
340
self.proxy.Set(client_interface, "Enabled", False,
346
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
348
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
349
dbus_interface=client_interface,
345
dbus_interface = client_interface,
350
346
ignore_reply=True)
352
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
353
dbus_interface=client_interface,
349
dbus_interface = client_interface,
354
350
ignore_reply=True)
355
351
elif key == "R" or key == "_" or key == "ctrl k":
356
352
self.server_proxy_object.RemoveClient(self.proxy
358
354
ignore_reply=True)
360
356
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(True), ignore_reply=True,
362
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
364
360
self.proxy.Set(client_interface, "CheckerRunning",
365
dbus.Boolean(False), ignore_reply=True,
366
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
368
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
369
365
ignore_reply=True)
371
367
# elif key == "p" or key == "=":
392
def glib_safely(func, retval=True):
393
def safe_func(*args, **kwargs):
395
return func(*args, **kwargs)
402
388
class ConstrainedListBox(urwid.ListBox):
403
389
"""Like a normal urwid.ListBox, but will consume all "up" or
404
390
"down" key presses, thus not allowing any containing widgets to
405
391
use them as an excuse to shift focus away from this widget.
407
393
def keypress(self, *args, **kwargs):
408
ret = (super(ConstrainedListBox, self)
409
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
410
395
if ret in ("up", "down"):
400
class UserInterface(object):
416
401
"""This is the entire user interface - the whole screen
417
402
with boxes, lists of client widgets, etc.
419
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
420
405
DBusGMainLoop(set_as_default=True)
422
407
self.screen = urwid.curses_display.Screen()
424
409
self.screen.register_palette((
426
411
"default", "default", None),
442
426
"bold,underline,blink,standout", "default",
443
427
"bold,underline,blink,standout"),
446
430
if urwid.supports_unicode():
447
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
449
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
451
437
self.screen.start()
453
439
self.size = self.screen.get_cols_rows()
455
441
self.clients = urwid.SimpleListWalker([])
456
442
self.clients_dict = {}
458
444
# We will add Text widgets to this list
459
self.log = urwid.SimpleListWalker([])
460
446
self.max_log_length = max_log_length
448
self.log_level = log_level
462
450
# We keep a reference to the log widget so we can remove it
463
451
# from the ListWalker without it getting destroyed
464
452
self.logbox = ConstrainedListBox(self.log)
466
454
# This keeps track of whether self.uilist currently has
467
455
# self.logbox in it or not
468
456
self.log_visible = True
469
457
self.log_wrap = "any"
471
self.loghandler = UILogHandler(self)
474
self.add_log_line(("bold",
475
"Mandos Monitor version " + version))
476
self.add_log_line(("bold", "q: Quit ?: Help"))
478
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'
479
466
self.main_loop = GLib.MainLoop()
481
def client_not_found(self, key_id, address):
482
log.info("Client with address %s and key ID %s could"
483
" 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))
485
473
def rebuild(self):
486
474
"""This rebuilds the User Interface.
487
475
Call this when the widget layout needs to change"""
489
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
490
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
492
# header=urwid.Divider(),
480
#header=urwid.Divider(),
494
footer=urwid.Divider(
495
div_char=self.divider)))
483
urwid.Divider(div_char=
496
485
if self.log_visible:
497
486
self.uilist.append(self.logbox)
498
487
self.topwidget = urwid.Pile(self.uilist)
500
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:
501
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if self.max_log_length:
503
if len(self.log) > self.max_log_length:
504
del self.log[0:(len(self.log) - self.max_log_length)]
505
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),
506
506
coming_from="above")
509
509
def toggle_log_display(self):
510
510
"""Toggle visibility of the log buffer."""
511
511
self.log_visible = not self.log_visible
513
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)
515
516
def change_log_display(self):
516
517
"""Change type of log display.
517
518
Currently, this toggles wrapping of text lines."""
564
574
self.clients_dict[path] = client
565
575
self.clients.sort(key=lambda c: c.properties["Name"])
568
578
def remove_client(self, client, path=None):
569
579
self.clients.remove(client)
571
581
path = client.proxy.object_path
572
582
del self.clients_dict[path]
575
585
def refresh(self):
576
586
"""Redraw the screen"""
577
587
canvas = self.topwidget.render(self.size, focus=True)
578
588
self.screen.draw_screen(self.size, canvas)
581
591
"""Start the main loop and exit when it's done."""
582
log.addHandler(self.loghandler)
583
self.orig_log_propagate = log.propagate
584
log.propagate = False
585
self.orig_log_level = log.level
587
592
self.bus = dbus.SystemBus()
588
593
mandos_dbus_objc = self.bus.get_object(
589
594
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
599
mandos_clients = (self.mandos_serv
594
600
.GetAllClientsWithProperties())
595
601
if not mandos_clients:
596
log.warning("Note: Server has no clients.")
602
self.log_message_raw(("bold", "Note: Server has no clients."))
597
603
except dbus.exceptions.DBusException:
598
log.warning("Note: No Mandos server running.")
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
605
mandos_clients = dbus.Dictionary()
601
607
(self.mandos_serv
602
608
.connect_to_signal("InterfacesRemoved",
603
609
self.find_and_remove_client,
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
= dbus.OBJECT_MANAGER_IFACE,
605
612
byte_arrays=True))
606
613
(self.mandos_serv
607
614
.connect_to_signal("InterfacesAdded",
608
615
self.add_new_client,
609
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
617
= dbus.OBJECT_MANAGER_IFACE,
610
618
byte_arrays=True))
611
619
(self.mandos_serv
612
620
.connect_to_signal("ClientNotFound",
616
624
for path, client in mandos_clients.items():
617
625
client_proxy_object = self.bus.get_object(self.busname,
619
self.add_client(MandosClientWidget(
620
server_proxy_object=self.mandos_serv,
621
proxy_object=client_proxy_object,
623
update_hook=self.refresh,
624
delete_hook=self.remove_client),
627
self.add_client(MandosClientWidget(server_proxy_object
630
=client_proxy_object,
628
self._input_callback_tag = (
630
GLib.IOChannel.unix_new(sys.stdin.fileno()),
631
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
632
glib_safely(self.process_input)))
641
self._input_callback_tag = (GLib.io_add_watch
633
645
self.main_loop.run()
634
646
# Main loop has finished, we should close everything now
635
647
GLib.source_remove(self._input_callback_tag)
636
with warnings.catch_warnings():
637
warnings.simplefilter("ignore", BytesWarning)
641
651
self.main_loop.quit()
642
log.removeHandler(self.loghandler)
643
log.propagate = self.orig_log_propagate
645
653
def process_input(self, source, condition):
646
654
keys = self.screen.get_input()
647
translations = {"ctrl n": "down", # Emacs
648
"ctrl p": "up", # Emacs
649
"ctrl v": "page down", # Emacs
650
"meta v": "page up", # Emacs
651
" ": "page down", # less
652
"f": "page down", # less
653
"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
659
667
key = translations[key]
660
668
except KeyError: # :-)
663
671
if key == "q" or key == "Q":
706
715
self.topwidget.set_focus(self.logbox)
709
if log.level < logging.INFO:
710
log.setLevel(logging.INFO)
711
log.info("Verbose mode: Off")
718
if self.log_level == 0:
720
self.log_message("Verbose mode: Off")
713
log.setLevel(logging.NOTSET)
714
log.info("Verbose mode: On")
715
# elif (key == "end" or key == "meta >" or key == "G"
717
# pass # xxx end-of-buffer
718
# elif (key == "home" or key == "meta <" or key == "g"
720
# pass # xxx beginning-of-buffer
721
# elif key == "ctrl e" or key == "$":
722
# pass # xxx move-end-of-line
723
# elif key == "ctrl a" or key == "^":
724
# pass # xxx move-beginning-of-line
725
# elif key == "ctrl b" or key == "meta (" or key == "h":
727
# elif key == "ctrl f" or key == "meta )" or key == "l":
730
# pass # scroll up log
732
# 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
733
742
elif self.topwidget.selectable():
734
743
self.topwidget.keypress(self.size, key)
739
class UILogHandler(logging.Handler):
740
def __init__(self, ui, *args, **kwargs):
742
super(UILogHandler, self).__init__(*args, **kwargs)
744
logging.Formatter("%(asctime)s: %(message)s"))
745
def emit(self, record):
746
msg = self.format(record)
747
if record.levelno > logging.INFO:
749
self.ui.add_log_line(msg)
752
747
ui = UserInterface()
755
750
except KeyboardInterrupt:
756
with warnings.catch_warnings():
757
warnings.filterwarnings("ignore", "", BytesWarning)
760
with warnings.catch_warnings():
761
warnings.filterwarnings("ignore", "", BytesWarning)
752
except Exception as e:
753
ui.log_message(str(e))