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