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-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 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"
75
dbus.OBJECT_MANAGER_IFACE
76
except AttributeError:
77
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
80
65
def isoformat_to_datetime(iso):
81
66
"Parse an ISO 8601 date string to a datetime.datetime()"
93
int(second), # Whole seconds
94
int(fraction*1000000)) # Microseconds
97
class MandosClientPropertyCache:
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
81
class MandosClientPropertyCache(object):
98
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
99
83
properties and calls a hook function when any of them are
102
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
103
self.proxy = proxy_object # Mandos Client proxy object
87
self.proxy = proxy_object # Mandos Client proxy object
104
88
self.properties = dict() if properties is None else properties
105
89
self.property_changed_match = (
106
90
self.proxy.connect_to_signal("PropertiesChanged",
107
91
self.properties_changed,
108
92
dbus.PROPERTIES_IFACE,
109
93
byte_arrays=True))
111
95
if properties is None:
112
self.properties.update(self.proxy.GetAll(
114
dbus_interface=dbus.PROPERTIES_IFACE))
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
116
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
118
103
def properties_changed(self, interface, properties, invalidated):
119
104
"""This is called whenever we get a PropertiesChanged signal
120
105
It updates the changed properties in the "properties" dict.
122
107
# Update properties dict with new value
123
if interface == client_interface:
124
self.properties.update(properties)
108
self.properties.update(properties)
126
110
def delete(self):
127
111
self.property_changed_match.remove()
172
158
client_interface,
173
159
byte_arrays=True))
174
log.debug("Created client %s", self.properties["Name"])
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
176
163
def using_timer(self, flag):
177
164
"""Call this method with True or False when timer should be
178
165
activated or deactivated.
180
167
if flag and self._update_timer_callback_tag is None:
181
168
# 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)))
169
self._update_timer_callback_tag = (gobject.timeout_add
185
172
elif not (flag or self._update_timer_callback_tag is None):
186
GLib.source_remove(self._update_timer_callback_tag)
173
gobject.source_remove(self._update_timer_callback_tag)
187
174
self._update_timer_callback_tag = None
189
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, command):
190
177
if exitstatus == 0:
191
log.debug('Checker for client %s (command "%s")'
192
" succeeded", self.properties["Name"], command)
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
196
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))
200
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))
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
195
self.logger('Checker for client {} completed'
197
.format(self.properties["Name"]))
206
200
def checker_started(self, command):
207
201
"""Server signals that a checker started."""
208
log.debug('Client %s started checker "%s"',
209
self.properties["Name"], command)
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
211
206
def got_secret(self):
212
log.info("Client %s received its secret",
213
self.properties["Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
215
210
def need_approval(self, timeout, default):
217
message = "Client %s needs approval within %f seconds"
212
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)
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
222
218
def rejected(self, reason):
223
log.info("Client %s was rejected; reason: %s",
224
self.properties["Name"], reason)
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
226
222
def selectable(self):
227
223
"""Make this a "selectable" widget.
228
224
This overrides the method from urwid.FlowWidget."""
231
227
def rows(self, maxcolrow, focus=False):
232
228
"""How many rows this widget will occupy might depend on
233
229
whether we have focus or not.
234
230
This overrides the method from urwid.FlowWidget"""
235
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
237
233
def current_widget(self, focus=False):
238
234
if focus or self.opened:
239
235
return self._focus_widget
240
236
return self._widget
242
238
def update(self):
243
239
"Called when what is visible on the screen should be updated."
244
240
# 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",
241
with_standout = { "normal": "standout",
242
"bold": "bold-standout",
244
"underline-blink-standout",
245
"bold-underline-blink":
246
"bold-underline-blink-standout",
253
249
# Rebuild focus and non-focus widgets using current properties
255
251
# Base part of a client. Name!
256
base = "{name}: ".format(name=self.properties["Name"])
252
base = '{name}: '.format(name=self.properties["Name"])
257
253
if not self.properties["Enabled"]:
258
254
message = "DISABLED"
259
255
self.using_timer(False)
260
256
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(
262
milliseconds=self.properties["ApprovalDelay"])
257
timeout = datetime.timedelta(milliseconds
263
260
last_approval_request = isoformat_to_datetime(
264
261
self.properties["LastApprovalRequest"])
265
262
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
self.proxy.Set(client_interface, "Enabled",
341
dbus.Boolean(True), ignore_reply=True,
342
dbus_interface=dbus.PROPERTIES_IFACE)
336
self.proxy.Enable(dbus_interface = client_interface,
344
self.proxy.Set(client_interface, "Enabled", False,
346
dbus_interface=dbus.PROPERTIES_IFACE)
339
self.proxy.Disable(dbus_interface = client_interface,
348
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
349
dbus_interface=client_interface,
343
dbus_interface = client_interface,
350
344
ignore_reply=True)
352
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
353
dbus_interface=client_interface,
347
dbus_interface = client_interface,
354
348
ignore_reply=True)
355
349
elif key == "R" or key == "_" or key == "ctrl k":
356
350
self.server_proxy_object.RemoveClient(self.proxy
358
352
ignore_reply=True)
360
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(True), ignore_reply=True,
362
dbus_interface=dbus.PROPERTIES_IFACE)
354
self.proxy.StartChecker(dbus_interface = client_interface,
364
self.proxy.Set(client_interface, "CheckerRunning",
365
dbus.Boolean(False), ignore_reply=True,
366
dbus_interface=dbus.PROPERTIES_IFACE)
357
self.proxy.StopChecker(dbus_interface = client_interface,
368
self.proxy.CheckedOK(dbus_interface=client_interface,
360
self.proxy.CheckedOK(dbus_interface = client_interface,
369
361
ignore_reply=True)
371
363
# elif key == "p" or key == "=":
392
def glib_safely(func, retval=True):
393
def safe_func(*args, **kwargs):
395
return func(*args, **kwargs)
402
384
class ConstrainedListBox(urwid.ListBox):
403
385
"""Like a normal urwid.ListBox, but will consume all "up" or
404
386
"down" key presses, thus not allowing any containing widgets to
405
387
use them as an excuse to shift focus away from this widget.
407
389
def keypress(self, *args, **kwargs):
408
ret = (super(ConstrainedListBox, self)
409
.keypress(*args, **kwargs))
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
410
391
if ret in ("up", "down"):
396
class UserInterface(object):
416
397
"""This is the entire user interface - the whole screen
417
398
with boxes, lists of client widgets, etc.
419
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
420
401
DBusGMainLoop(set_as_default=True)
422
403
self.screen = urwid.curses_display.Screen()
424
405
self.screen.register_palette((
426
407
"default", "default", None),
442
422
"bold,underline,blink,standout", "default",
443
423
"bold,underline,blink,standout"),
446
426
if urwid.supports_unicode():
447
self.divider = "─" # \u2500
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
449
self.divider = "_" # \u005f
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
451
433
self.screen.start()
453
435
self.size = self.screen.get_cols_rows()
455
437
self.clients = urwid.SimpleListWalker([])
456
438
self.clients_dict = {}
458
440
# We will add Text widgets to this list
459
self.log = urwid.SimpleListWalker([])
460
442
self.max_log_length = max_log_length
444
self.log_level = log_level
462
446
# We keep a reference to the log widget so we can remove it
463
447
# from the ListWalker without it getting destroyed
464
448
self.logbox = ConstrainedListBox(self.log)
466
450
# This keeps track of whether self.uilist currently has
467
451
# self.logbox in it or not
468
452
self.log_visible = True
469
453
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)
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
461
self.busname = domain + '.Mandos'
462
self.main_loop = gobject.MainLoop()
464
def client_not_found(self, fingerprint, address):
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
485
469
def rebuild(self):
486
470
"""This rebuilds the User Interface.
487
471
Call this when the widget layout needs to change"""
489
# self.uilist.append(urwid.ListBox(self.clients))
473
#self.uilist.append(urwid.ListBox(self.clients))
490
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
492
# header=urwid.Divider(),
476
#header=urwid.Divider(),
494
footer=urwid.Divider(
495
div_char=self.divider)))
479
urwid.Divider(div_char=
496
481
if self.log_visible:
497
482
self.uilist.append(self.logbox)
498
483
self.topwidget = urwid.Pile(self.uilist)
500
def add_log_line(self, markup):
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
489
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
493
def log_message_raw(self, markup, level=1):
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
501
497
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,
498
if (self.max_log_length
499
and len(self.log) > self.max_log_length):
500
del self.log[0:len(self.log)-self.max_log_length-1]
501
self.logbox.set_focus(len(self.logbox.body.contents),
506
502
coming_from="above")
509
505
def toggle_log_display(self):
510
506
"""Toggle visibility of the log buffer."""
511
507
self.log_visible = not self.log_visible
513
log.debug("Log visibility changed to: %s", self.log_visible)
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
515
512
def change_log_display(self):
516
513
"""Change type of log display.
517
514
Currently, this toggles wrapping of text lines."""
521
518
self.log_wrap = "clip"
522
519
for textwidget in self.log:
523
520
textwidget.set_wrap_mode(self.log_wrap)
524
log.debug("Wrap mode: %s", self.log_wrap)
526
def find_and_remove_client(self, path, interfaces):
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
524
def find_and_remove_client(self, path, name):
527
525
"""Find a client by its object path and remove it.
529
This is connected to the InterfacesRemoved signal from the
527
This is connected to the ClientRemoved signal from the
530
528
Mandos server object."""
531
if client_interface not in interfaces:
532
# Not a Mandos client object; ignore
535
530
client = self.clients_dict[path]
538
log.warning("Unknown client %s removed", path)
533
self.log_message("Unknown client {!r} ({!r}) removed"
542
def add_new_client(self, path, ifs_and_props):
543
"""Find a client by its object path and remove it.
545
This is connected to the InterfacesAdded signal from the
546
Mandos server object.
548
if client_interface not in ifs_and_props:
549
# Not a Mandos client object; ignore
538
def add_new_client(self, path):
551
539
client_proxy_object = self.bus.get_object(self.busname, path)
552
self.add_client(MandosClientWidget(
553
server_proxy_object=self.mandos_serv,
554
proxy_object=client_proxy_object,
555
update_hook=self.refresh,
556
delete_hook=self.remove_client,
557
properties=dict(ifs_and_props[client_interface])),
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
560
552
def add_client(self, client, path=None):
561
553
self.clients.append(client)
564
556
self.clients_dict[path] = client
565
557
self.clients.sort(key=lambda c: c.properties["Name"])
568
560
def remove_client(self, client, path=None):
569
561
self.clients.remove(client)
571
563
path = client.proxy.object_path
572
564
del self.clients_dict[path]
575
567
def refresh(self):
576
568
"""Redraw the screen"""
577
569
canvas = self.topwidget.render(self.size, focus=True)
578
570
self.screen.draw_screen(self.size, canvas)
581
573
"""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
574
self.bus = dbus.SystemBus()
588
575
mandos_dbus_objc = self.bus.get_object(
589
576
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
581
mandos_clients = (self.mandos_serv
594
582
.GetAllClientsWithProperties())
595
583
if not mandos_clients:
596
log.warning("Note: Server has no clients.")
584
self.log_message_raw(("bold", "Note: Server has no clients."))
597
585
except dbus.exceptions.DBusException:
598
log.warning("Note: No Mandos server running.")
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
587
mandos_clients = dbus.Dictionary()
601
589
(self.mandos_serv
602
.connect_to_signal("InterfacesRemoved",
590
.connect_to_signal("ClientRemoved",
603
591
self.find_and_remove_client,
604
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
592
dbus_interface=server_interface,
605
593
byte_arrays=True))
606
594
(self.mandos_serv
607
.connect_to_signal("InterfacesAdded",
595
.connect_to_signal("ClientAdded",
608
596
self.add_new_client,
609
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
dbus_interface=server_interface,
610
598
byte_arrays=True))
611
599
(self.mandos_serv
612
600
.connect_to_signal("ClientNotFound",
616
604
for path, client in mandos_clients.items():
617
605
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),
607
self.add_client(MandosClientWidget(server_proxy_object
610
=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)))
621
self._input_callback_tag = (gobject.io_add_watch
633
625
self.main_loop.run()
634
626
# 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)
627
gobject.source_remove(self._input_callback_tag)
641
631
self.main_loop.quit()
642
log.removeHandler(self.loghandler)
643
log.propagate = self.orig_log_propagate
645
633
def process_input(self, source, condition):
646
634
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
635
translations = { "ctrl n": "down", # Emacs
636
"ctrl p": "up", # Emacs
637
"ctrl v": "page down", # Emacs
638
"meta v": "page up", # Emacs
639
" ": "page down", # less
640
"f": "page down", # less
641
"b": "page up", # less
659
647
key = translations[key]
660
648
except KeyError: # :-)
663
651
if key == "q" or key == "Q":
706
695
self.topwidget.set_focus(self.logbox)
709
if log.level < logging.INFO:
710
log.setLevel(logging.INFO)
711
log.info("Verbose mode: Off")
698
if self.log_level == 0:
700
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
703
self.log_message("Verbose mode: On")
704
#elif (key == "end" or key == "meta >" or key == "G"
706
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
709
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
711
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
713
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
719
# pass # scroll up log
721
# pass # scroll down log
733
722
elif self.topwidget.selectable():
734
723
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
727
ui = UserInterface()
755
730
except KeyboardInterrupt:
756
with warnings.catch_warnings():
757
warnings.filterwarnings("ignore", "", BytesWarning)
760
with warnings.catch_warnings():
761
warnings.filterwarnings("ignore", "", BytesWarning)
732
except Exception as e:
733
ui.log_message(str(e))