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