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>.
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"
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
69
66
dbus.OBJECT_MANAGER_IFACE
70
67
except AttributeError:
71
68
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
74
70
def isoformat_to_datetime(iso):
75
71
"Parse an ISO 8601 date string to a datetime.datetime()"
96
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
97
self.proxy = proxy_object # Mandos Client proxy object
92
self.proxy = proxy_object # Mandos Client proxy object
98
93
self.properties = dict() if properties is None else properties
99
94
self.property_changed_match = (
100
95
self.proxy.connect_to_signal("PropertiesChanged",
101
96
self.properties_changed,
102
97
dbus.PROPERTIES_IFACE,
103
98
byte_arrays=True))
105
100
if properties is None:
106
self.properties.update(self.proxy.GetAll(
108
dbus_interface=dbus.PROPERTIES_IFACE))
101
self.properties.update(
102
self.proxy.GetAll(client_interface,
104
= dbus.PROPERTIES_IFACE))
110
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
112
108
def properties_changed(self, interface, properties, invalidated):
113
109
"""This is called whenever we get a PropertiesChanged signal
114
110
It updates the changed properties in the "properties" dict.
166
164
client_interface,
167
165
byte_arrays=True))
168
log.debug("Created client %s", self.properties["Name"])
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
170
169
def using_timer(self, flag):
171
170
"""Call this method with True or False when timer should be
172
171
activated or deactivated.
174
173
if flag and self._update_timer_callback_tag is None:
175
174
# 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)))
175
self._update_timer_callback_tag = (gobject.timeout_add
179
178
elif not (flag or self._update_timer_callback_tag is None):
180
GLib.source_remove(self._update_timer_callback_tag)
179
gobject.source_remove(self._update_timer_callback_tag)
181
180
self._update_timer_callback_tag = None
183
182
def checker_completed(self, exitstatus, condition, command):
184
183
if exitstatus == 0:
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
190
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))
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
194
195
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))
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
200
202
def checker_started(self, command):
201
203
"""Server signals that a checker started."""
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
205
208
def got_secret(self):
206
log.info("Client %s received its secret",
207
self.properties["Name"])
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
209
212
def need_approval(self, timeout, default):
211
message = "Client %s needs approval within %f seconds"
214
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)
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
216
220
def rejected(self, reason):
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
220
224
def selectable(self):
221
225
"""Make this a "selectable" widget.
222
226
This overrides the method from urwid.FlowWidget."""
225
229
def rows(self, maxcolrow, focus=False):
226
230
"""How many rows this widget will occupy might depend on
227
231
whether we have focus or not.
228
232
This overrides the method from urwid.FlowWidget"""
229
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
231
235
def current_widget(self, focus=False):
232
236
if focus or self.opened:
233
237
return self._focus_widget
234
238
return self._widget
236
240
def update(self):
237
241
"Called when what is visible on the screen should be updated."
238
242
# 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",
243
with_standout = { "normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
247
251
# Rebuild focus and non-focus widgets using current properties
249
253
# Base part of a client. Name!
250
base = "{name}: ".format(name=self.properties["Name"])
254
base = '{name}: '.format(name=self.properties["Name"])
251
255
if not self.properties["Enabled"]:
252
256
message = "DISABLED"
253
257
self.using_timer(False)
254
258
elif self.properties["ApprovalPending"]:
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
259
timeout = datetime.timedelta(milliseconds
257
262
last_approval_request = isoformat_to_datetime(
258
263
self.properties["LastApprovalRequest"])
259
264
if last_approval_request is not None:
320
324
if self.delete_hook is not None:
321
325
self.delete_hook(self)
322
326
return super(MandosClientWidget, self).delete(**kwargs)
324
328
def render(self, maxcolrow, focus=False):
325
329
"""Render differently if we have focus.
326
330
This overrides the method from urwid.FlowWidget"""
327
331
return self.current_widget(focus).render(maxcolrow,
330
334
def keypress(self, maxcolrow, key):
332
336
This overrides the method from urwid.FlowWidget"""
334
338
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
339
dbus.Boolean(True), ignore_reply = True,
340
dbus_interface = dbus.PROPERTIES_IFACE)
338
342
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
344
dbus_interface = dbus.PROPERTIES_IFACE)
342
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface=client_interface,
347
dbus_interface = client_interface,
344
348
ignore_reply=True)
346
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface=client_interface,
351
dbus_interface = client_interface,
348
352
ignore_reply=True)
349
353
elif key == "R" or key == "_" or key == "ctrl k":
350
354
self.server_proxy_object.RemoveClient(self.proxy
352
356
ignore_reply=True)
354
358
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
359
dbus.Boolean(True), ignore_reply = True,
360
dbus_interface = dbus.PROPERTIES_IFACE)
358
362
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
363
dbus.Boolean(False), ignore_reply = True,
364
dbus_interface = dbus.PROPERTIES_IFACE)
362
self.proxy.CheckedOK(dbus_interface=client_interface,
366
self.proxy.CheckedOK(dbus_interface = client_interface,
363
367
ignore_reply=True)
365
369
# elif key == "p" or key == "=":
386
def glib_safely(func, retval=True):
387
def safe_func(*args, **kwargs):
389
return func(*args, **kwargs)
396
390
class ConstrainedListBox(urwid.ListBox):
397
391
"""Like a normal urwid.ListBox, but will consume all "up" or
398
392
"down" key presses, thus not allowing any containing widgets to
399
393
use them as an excuse to shift focus away from this widget.
401
395
def keypress(self, *args, **kwargs):
402
ret = (super(ConstrainedListBox, self)
403
.keypress(*args, **kwargs))
396
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
404
397
if ret in ("up", "down"):
436
428
"bold,underline,blink,standout", "default",
437
429
"bold,underline,blink,standout"),
440
432
if urwid.supports_unicode():
441
self.divider = "─" # \u2500
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
443
self.divider = "_" # \u005f
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
445
439
self.screen.start()
447
441
self.size = self.screen.get_cols_rows()
449
443
self.clients = urwid.SimpleListWalker([])
450
444
self.clients_dict = {}
452
446
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
454
448
self.max_log_length = max_log_length
450
self.log_level = log_level
456
452
# We keep a reference to the log widget so we can remove it
457
453
# from the ListWalker without it getting destroyed
458
454
self.logbox = ConstrainedListBox(self.log)
460
456
# This keeps track of whether self.uilist currently has
461
457
# self.logbox in it or not
462
458
self.log_visible = True
463
459
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)
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))
479
475
def rebuild(self):
480
476
"""This rebuilds the User Interface.
481
477
Call this when the widget layout needs to change"""
483
# self.uilist.append(urwid.ListBox(self.clients))
479
#self.uilist.append(urwid.ListBox(self.clients))
484
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
486
# header=urwid.Divider(),
482
#header=urwid.Divider(),
488
footer=urwid.Divider(
489
div_char=self.divider)))
485
urwid.Divider(div_char=
490
487
if self.log_visible:
491
488
self.uilist.append(self.logbox)
492
489
self.topwidget = urwid.Pile(self.uilist)
494
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:
495
503
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,
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),
500
508
coming_from="above")
503
511
def toggle_log_display(self):
504
512
"""Toggle visibility of the log buffer."""
505
513
self.log_visible = not self.log_visible
507
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)
509
518
def change_log_display(self):
510
519
"""Change type of log display.
511
520
Currently, this toggles wrapping of text lines."""
558
576
self.clients_dict[path] = client
559
577
self.clients.sort(key=lambda c: c.properties["Name"])
562
580
def remove_client(self, client, path=None):
563
581
self.clients.remove(client)
565
583
path = client.proxy.object_path
566
584
del self.clients_dict[path]
569
587
def refresh(self):
570
588
"""Redraw the screen"""
571
589
canvas = self.topwidget.render(self.size, focus=True)
572
590
self.screen.draw_screen(self.size, canvas)
575
593
"""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
594
self.bus = dbus.SystemBus()
582
595
mandos_dbus_objc = self.bus.get_object(
583
596
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
597
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
587
601
mandos_clients = (self.mandos_serv
588
602
.GetAllClientsWithProperties())
589
603
if not mandos_clients:
590
log.warning("Note: Server has no clients.")
604
self.log_message_raw(("bold", "Note: Server has no clients."))
591
605
except dbus.exceptions.DBusException:
592
log.warning("Note: No Mandos server running.")
606
self.log_message_raw(("bold", "Note: No Mandos server running."))
593
607
mandos_clients = dbus.Dictionary()
595
609
(self.mandos_serv
596
610
.connect_to_signal("InterfacesRemoved",
597
611
self.find_and_remove_client,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
613
= dbus.OBJECT_MANAGER_IFACE,
599
614
byte_arrays=True))
600
615
(self.mandos_serv
601
616
.connect_to_signal("InterfacesAdded",
602
617
self.add_new_client,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
619
= dbus.OBJECT_MANAGER_IFACE,
604
620
byte_arrays=True))
605
621
(self.mandos_serv
606
622
.connect_to_signal("ClientNotFound",
610
626
for path, client in mandos_clients.items():
611
627
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),
629
self.add_client(MandosClientWidget(server_proxy_object
632
=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)))
643
self._input_callback_tag = (gobject.io_add_watch
627
647
self.main_loop.run()
628
648
# 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)
649
gobject.source_remove(self._input_callback_tag)
635
653
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
639
655
def process_input(self, source, condition):
640
656
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
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
653
669
key = translations[key]
654
670
except KeyError: # :-)
657
673
if key == "q" or key == "Q":
700
717
self.topwidget.set_focus(self.logbox)
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
720
if self.log_level == 0:
722
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
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
727
744
elif self.topwidget.selectable():
728
745
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
749
ui = UserInterface()
749
752
except KeyboardInterrupt:
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)
754
except Exception as e:
755
ui.log_message(str(e))