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