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-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 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
27
from __future__ import (division, absolute_import, print_function,
38
41
import urwid.curses_display
41
44
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
45
from gi.repository import GLib
51
if sys.version_info[0] == 2:
49
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
52
log = logging.getLogger(os.path.basename(sys.argv[0]))
53
logging.basicConfig(level="NOTSET", # Show all messages
54
format="%(message)s") # Show basic log messages
56
logging.captureWarnings(True) # Show warnings via the logging system
58
locale.setlocale(locale.LC_ALL, "")
60
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
59
62
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
63
domain = "se.recompile"
64
server_interface = domain + ".Mandos"
65
client_interface = domain + ".Mandos.Client"
69
dbus.OBJECT_MANAGER_IFACE
70
except AttributeError:
71
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
65
74
def isoformat_to_datetime(iso):
66
75
"Parse an ISO 8601 date string to a datetime.datetime()"
86
96
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
97
self.proxy = proxy_object # Mandos Client proxy object
88
98
self.properties = dict() if properties is None else properties
89
99
self.property_changed_match = (
90
self.proxy.connect_to_signal("PropertyChanged",
91
self._property_changed,
100
self.proxy.connect_to_signal("PropertiesChanged",
101
self.properties_changed,
102
dbus.PROPERTIES_IFACE,
93
103
byte_arrays=True))
95
105
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
106
self.properties.update(self.proxy.GetAll(
108
dbus_interface=dbus.PROPERTIES_IFACE))
101
110
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
def _property_changed(self, property, value):
104
"""Helper which takes positional arguments"""
105
return self.property_changed(property=property, value=value)
107
def property_changed(self, property=None, value=None):
108
"""This is called whenever we get a PropertyChanged signal
109
It updates the changed property in the "properties" dict.
112
def properties_changed(self, interface, properties, invalidated):
113
"""This is called whenever we get a PropertiesChanged signal
114
It updates the changed properties in the "properties" dict.
111
116
# Update properties dict with new value
112
self.properties[property] = value
117
if interface == client_interface:
118
self.properties.update(properties)
114
120
def delete(self):
115
121
self.property_changed_match.remove()
162
166
client_interface,
163
167
byte_arrays=True))
164
self.logger('Created client {0}'
165
.format(self.properties["Name"]), level=0)
168
log.debug("Created client %s", self.properties["Name"])
167
170
def using_timer(self, flag):
168
171
"""Call this method with True or False when timer should be
169
172
activated or deactivated.
171
174
if flag and self._update_timer_callback_tag is None:
172
175
# Will update the shown timer value every second
173
self._update_timer_callback_tag = (gobject.timeout_add
176
self._update_timer_callback_tag = (
177
GLib.timeout_add(1000,
178
glib_safely(self.update_timer)))
176
179
elif not (flag or self._update_timer_callback_tag is None):
177
gobject.source_remove(self._update_timer_callback_tag)
180
GLib.source_remove(self._update_timer_callback_tag)
178
181
self._update_timer_callback_tag = None
180
183
def checker_completed(self, exitstatus, condition, command):
181
184
if exitstatus == 0:
182
self.logger('Checker for client {0} (command "{1}")'
183
' succeeded'.format(self.properties["Name"],
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
188
190
if os.WIFEXITED(condition):
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
191
.format(self.properties["Name"], command,
192
os.WEXITSTATUS(condition)))
191
log.info('Checker for client %s (command "%s") failed'
192
" with exit code %d", self.properties["Name"],
193
command, os.WEXITSTATUS(condition))
193
194
elif os.WIFSIGNALED(condition):
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
196
.format(self.properties["Name"], command,
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
195
log.info('Checker for client %s (command "%s") was'
196
" killed by signal %d", self.properties["Name"],
197
command, os.WTERMSIG(condition))
208
200
def checker_started(self, command):
209
201
"""Server signals that a checker started."""
210
self.logger('Client {0} started checker "{1}"'
211
.format(self.properties["Name"],
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
214
205
def got_secret(self):
215
self.logger('Client {0} received its secret'
216
.format(self.properties["Name"]))
206
log.info("Client %s received its secret",
207
self.properties["Name"])
218
209
def need_approval(self, timeout, default):
220
message = 'Client {0} needs approval within {1} seconds'
211
message = "Client %s needs approval within %f seconds"
222
message = 'Client {0} will get its secret in {1} seconds'
223
self.logger(message.format(self.properties["Name"],
213
message = "Client %s will get its secret in %f seconds"
214
log.info(message, self.properties["Name"], timeout/1000)
226
216
def rejected(self, reason):
227
self.logger('Client {0} was rejected; reason: {1}'
228
.format(self.properties["Name"], reason))
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
230
220
def selectable(self):
231
221
"""Make this a "selectable" widget.
232
222
This overrides the method from urwid.FlowWidget."""
235
225
def rows(self, maxcolrow, focus=False):
236
226
"""How many rows this widget will occupy might depend on
237
227
whether we have focus or not.
238
228
This overrides the method from urwid.FlowWidget"""
239
229
return self.current_widget(focus).rows(maxcolrow, focus=focus)
241
231
def current_widget(self, focus=False):
242
232
if focus or self.opened:
243
233
return self._focus_widget
244
234
return self._widget
246
236
def update(self):
247
237
"Called when what is visible on the screen should be updated."
248
238
# How to add standout mode to a style
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"bold-underline-blink-standout",
239
with_standout = {"normal": "standout",
240
"bold": "bold-standout",
242
"underline-blink-standout",
243
"bold-underline-blink":
244
"bold-underline-blink-standout",
257
247
# Rebuild focus and non-focus widgets using current properties
259
249
# Base part of a client. Name!
260
base = '{name}: '.format(name=self.properties["Name"])
250
base = "{name}: ".format(name=self.properties["Name"])
261
251
if not self.properties["Enabled"]:
262
252
message = "DISABLED"
263
253
self.using_timer(False)
264
254
elif self.properties["ApprovalPending"]:
265
timeout = datetime.timedelta(milliseconds
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
268
257
last_approval_request = isoformat_to_datetime(
269
258
self.properties["LastApprovalRequest"])
270
259
if last_approval_request is not None:
330
320
if self.delete_hook is not None:
331
321
self.delete_hook(self)
332
322
return super(MandosClientWidget, self).delete(**kwargs)
334
324
def render(self, maxcolrow, focus=False):
335
325
"""Render differently if we have focus.
336
326
This overrides the method from urwid.FlowWidget"""
337
327
return self.current_widget(focus).render(maxcolrow,
340
330
def keypress(self, maxcolrow, key):
342
332
This overrides the method from urwid.FlowWidget"""
344
self.proxy.Enable(dbus_interface = client_interface,
334
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
347
self.proxy.Disable(dbus_interface = client_interface,
338
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
350
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
351
dbus_interface = client_interface,
343
dbus_interface=client_interface,
352
344
ignore_reply=True)
354
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
355
dbus_interface = client_interface,
347
dbus_interface=client_interface,
356
348
ignore_reply=True)
357
349
elif key == "R" or key == "_" or key == "ctrl k":
358
350
self.server_proxy_object.RemoveClient(self.proxy
360
352
ignore_reply=True)
362
self.proxy.StartChecker(dbus_interface = client_interface,
354
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
365
self.proxy.StopChecker(dbus_interface = client_interface,
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
368
self.proxy.CheckedOK(dbus_interface = client_interface,
362
self.proxy.CheckedOK(dbus_interface=client_interface,
369
363
ignore_reply=True)
371
365
# elif key == "p" or key == "=":
380
def property_changed(self, property=None, **kwargs):
381
"""Call self.update() if old value is not new value.
374
def properties_changed(self, interface, properties, invalidated):
375
"""Call self.update() if any properties changed.
382
376
This overrides the method from MandosClientPropertyCache"""
383
property_name = str(property)
384
old_value = self.properties.get(property_name)
385
super(MandosClientWidget, self).property_changed(
386
property=property, **kwargs)
387
if self.properties.get(property_name) != old_value:
377
old_values = {key: self.properties.get(key)
378
for key in properties.keys()}
379
super(MandosClientWidget, self).properties_changed(
380
interface, properties, invalidated)
381
if any(old_values[key] != self.properties.get(key)
382
for key in old_values):
386
def glib_safely(func, retval=True):
387
def safe_func(*args, **kwargs):
389
return func(*args, **kwargs)
391
396
class ConstrainedListBox(urwid.ListBox):
392
397
"""Like a normal urwid.ListBox, but will consume all "up" or
393
398
"down" key presses, thus not allowing any containing widgets to
394
399
use them as an excuse to shift focus away from this widget.
396
401
def keypress(self, *args, **kwargs):
397
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
402
ret = (super(ConstrainedListBox, self)
403
.keypress(*args, **kwargs))
398
404
if ret in ("up", "down"):
429
436
"bold,underline,blink,standout", "default",
430
437
"bold,underline,blink,standout"),
433
440
if urwid.supports_unicode():
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
441
self.divider = "─" # \u2500
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
443
self.divider = "_" # \u005f
440
445
self.screen.start()
442
447
self.size = self.screen.get_cols_rows()
444
449
self.clients = urwid.SimpleListWalker([])
445
450
self.clients_dict = {}
447
452
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
449
454
self.max_log_length = max_log_length
451
self.log_level = log_level
453
456
# We keep a reference to the log widget so we can remove it
454
457
# from the ListWalker without it getting destroyed
455
458
self.logbox = ConstrainedListBox(self.log)
457
460
# This keeps track of whether self.uilist currently has
458
461
# self.logbox in it or not
459
462
self.log_visible = True
460
463
self.log_wrap = "any"
465
self.loghandler = UILogHandler(self)
463
self.log_message_raw(("bold",
464
"Mandos Monitor version " + version))
465
self.log_message_raw(("bold",
468
self.busname = domain + '.Mandos'
469
self.main_loop = gobject.MainLoop()
471
def client_not_found(self, fingerprint, address):
472
self.log_message("Client with address {0} and fingerprint"
473
" {1} could not be found"
474
.format(address, fingerprint))
468
self.add_log_line(("bold",
469
"Mandos Monitor version " + version))
470
self.add_log_line(("bold", "q: Quit ?: Help"))
472
self.busname = domain + ".Mandos"
473
self.main_loop = GLib.MainLoop()
475
def client_not_found(self, key_id, address):
476
log.info("Client with address %s and key ID %s could"
477
" not be found", address, key_id)
476
479
def rebuild(self):
477
480
"""This rebuilds the User Interface.
478
481
Call this when the widget layout needs to change"""
480
#self.uilist.append(urwid.ListBox(self.clients))
483
# self.uilist.append(urwid.ListBox(self.clients))
481
484
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
483
#header=urwid.Divider(),
486
# header=urwid.Divider(),
486
urwid.Divider(div_char=
488
footer=urwid.Divider(
489
div_char=self.divider)))
488
490
if self.log_visible:
489
491
self.uilist.append(self.logbox)
490
492
self.topwidget = urwid.Pile(self.uilist)
492
def log_message(self, message, level=1):
493
"""Log message formatted with timestamp"""
494
if level < self.log_level:
496
timestamp = datetime.datetime.now().isoformat()
497
self.log_message_raw("{0}: {1}".format(timestamp, message),
500
def log_message_raw(self, markup, level=1):
501
"""Add a log message to the log buffer."""
502
if level < self.log_level:
494
def add_log_line(self, markup):
504
495
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
if (self.max_log_length
506
and len(self.log) > self.max_log_length):
507
del self.log[0:len(self.log)-self.max_log_length-1]
508
self.logbox.set_focus(len(self.logbox.body.contents),
496
if self.max_log_length:
497
if len(self.log) > self.max_log_length:
498
del self.log[0:(len(self.log) - self.max_log_length)]
499
self.logbox.set_focus(len(self.logbox.body.contents)-1,
509
500
coming_from="above")
512
503
def toggle_log_display(self):
513
504
"""Toggle visibility of the log buffer."""
514
505
self.log_visible = not self.log_visible
516
self.log_message("Log visibility changed to: {0}"
517
.format(self.log_visible), level=0)
507
log.debug("Log visibility changed to: %s", self.log_visible)
519
509
def change_log_display(self):
520
510
"""Change type of log display.
521
511
Currently, this toggles wrapping of text lines."""
525
515
self.log_wrap = "clip"
526
516
for textwidget in self.log:
527
517
textwidget.set_wrap_mode(self.log_wrap)
528
self.log_message("Wrap mode: {0}".format(self.log_wrap),
531
def find_and_remove_client(self, path, name):
518
log.debug("Wrap mode: %s", self.log_wrap)
520
def find_and_remove_client(self, path, interfaces):
532
521
"""Find a client by its object path and remove it.
534
This is connected to the ClientRemoved signal from the
523
This is connected to the InterfacesRemoved signal from the
535
524
Mandos server object."""
525
if client_interface not in interfaces:
526
# Not a Mandos client object; ignore
537
529
client = self.clients_dict[path]
540
self.log_message("Unknown client {0!r} ({1!r}) removed"
532
log.warning("Unknown client %s removed", path)
545
def add_new_client(self, path):
536
def add_new_client(self, path, ifs_and_props):
537
"""Find a client by its object path and remove it.
539
This is connected to the InterfacesAdded signal from the
540
Mandos server object.
542
if client_interface not in ifs_and_props:
543
# Not a Mandos client object; ignore
546
545
client_proxy_object = self.bus.get_object(self.busname, path)
547
self.add_client(MandosClientWidget(server_proxy_object
550
=client_proxy_object,
546
self.add_client(MandosClientWidget(
547
server_proxy_object=self.mandos_serv,
548
proxy_object=client_proxy_object,
549
update_hook=self.refresh,
550
delete_hook=self.remove_client,
551
properties=dict(ifs_and_props[client_interface])),
559
554
def add_client(self, client, path=None):
560
555
self.clients.append(client)
563
558
self.clients_dict[path] = client
564
559
self.clients.sort(key=lambda c: c.properties["Name"])
567
562
def remove_client(self, client, path=None):
568
563
self.clients.remove(client)
570
565
path = client.proxy.object_path
571
566
del self.clients_dict[path]
574
569
def refresh(self):
575
570
"""Redraw the screen"""
576
571
canvas = self.topwidget.render(self.size, focus=True)
577
572
self.screen.draw_screen(self.size, canvas)
580
575
"""Start the main loop and exit when it's done."""
576
log.addHandler(self.loghandler)
577
self.orig_log_propagate = log.propagate
578
log.propagate = False
579
self.orig_log_level = log.level
581
581
self.bus = dbus.SystemBus()
582
582
mandos_dbus_objc = self.bus.get_object(
583
583
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
588
587
mandos_clients = (self.mandos_serv
589
588
.GetAllClientsWithProperties())
590
589
if not mandos_clients:
591
self.log_message_raw(("bold", "Note: Server has no clients."))
590
log.warning("Note: Server has no clients.")
592
591
except dbus.exceptions.DBusException:
593
self.log_message_raw(("bold", "Note: No Mandos server running."))
592
log.warning("Note: No Mandos server running.")
594
593
mandos_clients = dbus.Dictionary()
596
595
(self.mandos_serv
597
.connect_to_signal("ClientRemoved",
596
.connect_to_signal("InterfacesRemoved",
598
597
self.find_and_remove_client,
599
dbus_interface=server_interface,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
600
599
byte_arrays=True))
601
600
(self.mandos_serv
602
.connect_to_signal("ClientAdded",
601
.connect_to_signal("InterfacesAdded",
603
602
self.add_new_client,
604
dbus_interface=server_interface,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
605
604
byte_arrays=True))
606
605
(self.mandos_serv
607
606
.connect_to_signal("ClientNotFound",
611
610
for path, client in mandos_clients.items():
612
611
client_proxy_object = self.bus.get_object(self.busname,
614
self.add_client(MandosClientWidget(server_proxy_object
617
=client_proxy_object,
613
self.add_client(MandosClientWidget(
614
server_proxy_object=self.mandos_serv,
615
proxy_object=client_proxy_object,
617
update_hook=self.refresh,
618
delete_hook=self.remove_client),
628
self._input_callback_tag = (gobject.io_add_watch
622
self._input_callback_tag = (
624
GLib.IOChannel.unix_new(sys.stdin.fileno()),
625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
626
glib_safely(self.process_input)))
632
627
self.main_loop.run()
633
628
# Main loop has finished, we should close everything now
634
gobject.source_remove(self._input_callback_tag)
629
GLib.source_remove(self._input_callback_tag)
630
with warnings.catch_warnings():
631
warnings.simplefilter("ignore", BytesWarning)
638
635
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
640
639
def process_input(self, source, condition):
641
640
keys = self.screen.get_input()
642
translations = { "ctrl n": "down", # Emacs
643
"ctrl p": "up", # Emacs
644
"ctrl v": "page down", # Emacs
645
"meta v": "page up", # Emacs
646
" ": "page down", # less
647
"f": "page down", # less
648
"b": "page up", # less
641
translations = {"ctrl n": "down", # Emacs
642
"ctrl p": "up", # Emacs
643
"ctrl v": "page down", # Emacs
644
"meta v": "page up", # Emacs
645
" ": "page down", # less
646
"f": "page down", # less
647
"b": "page up", # less
654
653
key = translations[key]
655
654
except KeyError: # :-)
658
657
if key == "q" or key == "Q":
661
660
elif key == "window resize":
662
661
self.size = self.screen.get_cols_rows()
664
elif key == "\f": # Ctrl-L
663
elif key == "ctrl l":
666
666
elif key == "l" or key == "D":
667
667
self.toggle_log_display()
701
700
self.topwidget.set_focus(self.logbox)
704
if self.log_level == 0:
706
self.log_message("Verbose mode: Off")
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
709
self.log_message("Verbose mode: On")
710
#elif (key == "end" or key == "meta >" or key == "G"
712
# pass # xxx end-of-buffer
713
#elif (key == "home" or key == "meta <" or key == "g"
715
# pass # xxx beginning-of-buffer
716
#elif key == "ctrl e" or key == "$":
717
# pass # xxx move-end-of-line
718
#elif key == "ctrl a" or key == "^":
719
# pass # xxx move-beginning-of-line
720
#elif key == "ctrl b" or key == "meta (" or key == "h":
722
#elif key == "ctrl f" or key == "meta )" or key == "l":
725
# pass # scroll up log
727
# pass # scroll down log
707
log.setLevel(logging.NOTSET)
708
log.info("Verbose mode: On")
709
# elif (key == "end" or key == "meta >" or key == "G"
711
# pass # xxx end-of-buffer
712
# elif (key == "home" or key == "meta <" or key == "g"
714
# pass # xxx beginning-of-buffer
715
# elif key == "ctrl e" or key == "$":
716
# pass # xxx move-end-of-line
717
# elif key == "ctrl a" or key == "^":
718
# pass # xxx move-beginning-of-line
719
# elif key == "ctrl b" or key == "meta (" or key == "h":
721
# elif key == "ctrl f" or key == "meta )" or key == "l":
724
# pass # scroll up log
726
# pass # scroll down log
728
727
elif self.topwidget.selectable():
729
728
self.topwidget.keypress(self.size, key)
733
class UILogHandler(logging.Handler):
734
def __init__(self, ui, *args, **kwargs):
736
super(UILogHandler, self).__init__(*args, **kwargs)
738
logging.Formatter("%(asctime)s: %(message)s"))
739
def emit(self, record):
740
msg = self.format(record)
741
if record.levelno > logging.INFO:
743
self.ui.add_log_line(msg)
733
746
ui = UserInterface()
736
749
except KeyboardInterrupt:
738
except Exception as e:
739
ui.log_message(str(e))
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)