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
49
48
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)
51
locale.setlocale(locale.LC_ALL, '')
54
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
69
56
# Some useful constants
70
domain = "se.recompile"
71
server_interface = domain + ".Mandos"
72
client_interface = domain + ".Mandos.Client"
57
domain = 'se.recompile'
58
server_interface = domain + '.Mandos'
59
client_interface = domain + '.Mandos.Client'
76
63
dbus.OBJECT_MANAGER_IFACE
77
64
except AttributeError:
78
65
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
81
67
def isoformat_to_datetime(iso):
82
68
"Parse an ISO 8601 date string to a datetime.datetime()"
94
int(second), # Whole seconds
95
int(fraction*1000000)) # Microseconds
98
class MandosClientPropertyCache:
80
int(second), # Whole seconds
81
int(fraction*1000000)) # Microseconds
83
class MandosClientPropertyCache(object):
99
84
"""This wraps a Mandos Client D-Bus proxy object, caches the
100
85
properties and calls a hook function when any of them are
103
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
104
self.proxy = proxy_object # Mandos Client proxy object
89
self.proxy = proxy_object # Mandos Client proxy object
105
90
self.properties = dict() if properties is None else properties
106
91
self.property_changed_match = (
107
92
self.proxy.connect_to_signal("PropertiesChanged",
108
93
self.properties_changed,
109
94
dbus.PROPERTIES_IFACE,
110
95
byte_arrays=True))
112
97
if properties is None:
113
self.properties.update(self.proxy.GetAll(
115
dbus_interface=dbus.PROPERTIES_IFACE))
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
117
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
119
105
def properties_changed(self, interface, properties, invalidated):
120
106
"""This is called whenever we get a PropertiesChanged signal
121
107
It updates the changed properties in the "properties" dict.
123
109
# Update properties dict with new value
124
110
if interface == client_interface:
125
111
self.properties.update(properties)
127
113
def delete(self):
128
114
self.property_changed_match.remove()
131
class MandosClientWidget(MandosClientPropertyCache, urwid.Widget):
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
132
118
"""A Mandos Client which is visible on the screen.
135
_sizing = frozenset(["flow"])
137
121
def __init__(self, server_proxy_object=None, update_hook=None,
138
delete_hook=None, **kwargs):
122
delete_hook=None, logger=None, **kwargs):
139
123
# Called on update
140
124
self.update_hook = update_hook
141
125
# Called on delete
142
126
self.delete_hook = delete_hook
143
127
# Mandos Server proxy object
144
128
self.server_proxy_object = server_proxy_object
146
132
self._update_timer_callback_tag = None
148
134
# The widget shown normally
149
135
self._text_widget = urwid.Text("")
150
136
# The widget shown when we have focus
175
161
client_interface,
176
162
byte_arrays=True))
177
log.debug("Created client %s", self.properties["Name"])
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
179
166
def using_timer(self, flag):
180
167
"""Call this method with True or False when timer should be
181
168
activated or deactivated.
183
170
if flag and self._update_timer_callback_tag is None:
184
171
# 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)))
172
self._update_timer_callback_tag = (GLib.timeout_add
188
175
elif not (flag or self._update_timer_callback_tag is None):
189
176
GLib.source_remove(self._update_timer_callback_tag)
190
177
self._update_timer_callback_tag = None
192
179
def checker_completed(self, exitstatus, condition, command):
193
180
if exitstatus == 0:
194
log.debug('Checker for client %s (command "%s")'
195
" succeeded", self.properties["Name"], command)
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
199
187
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))
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
203
192
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))
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
209
199
def checker_started(self, command):
210
200
"""Server signals that a checker started."""
211
log.debug('Client %s started checker "%s"',
212
self.properties["Name"], command)
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
214
205
def got_secret(self):
215
log.info("Client %s received its secret",
216
self.properties["Name"])
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
218
209
def need_approval(self, timeout, default):
220
message = "Client %s needs approval within %f seconds"
211
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)
213
message = 'Client {} will get its secret in {} seconds'
214
self.logger(message.format(self.properties["Name"],
225
217
def rejected(self, reason):
226
log.info("Client %s was rejected; reason: %s",
227
self.properties["Name"], reason)
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
229
221
def selectable(self):
230
222
"""Make this a "selectable" widget.
231
This overrides the method from urwid.Widget."""
223
This overrides the method from urwid.FlowWidget."""
234
226
def rows(self, maxcolrow, focus=False):
235
227
"""How many rows this widget will occupy might depend on
236
228
whether we have focus or not.
237
This overrides the method from urwid.Widget"""
229
This overrides the method from urwid.FlowWidget"""
238
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
240
232
def current_widget(self, focus=False):
241
233
if focus or self.opened:
242
234
return self._focus_widget
243
235
return self._widget
245
237
def update(self):
246
238
"Called when what is visible on the screen should be updated."
247
239
# 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",
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
256
248
# Rebuild focus and non-focus widgets using current properties
258
250
# Base part of a client. Name!
259
base = "{name}: ".format(name=self.properties["Name"])
251
base = '{name}: '.format(name=self.properties["Name"])
260
252
if not self.properties["Enabled"]:
261
253
message = "DISABLED"
262
254
self.using_timer(False)
263
255
elif self.properties["ApprovalPending"]:
264
timeout = datetime.timedelta(
265
milliseconds=self.properties["ApprovalDelay"])
256
timeout = datetime.timedelta(milliseconds
266
259
last_approval_request = isoformat_to_datetime(
267
260
self.properties["LastApprovalRequest"])
268
261
if last_approval_request is not None:
329
322
if self.delete_hook is not None:
330
323
self.delete_hook(self)
331
324
return super(MandosClientWidget, self).delete(**kwargs)
333
326
def render(self, maxcolrow, focus=False):
334
327
"""Render differently if we have focus.
335
This overrides the method from urwid.Widget"""
328
This overrides the method from urwid.FlowWidget"""
336
329
return self.current_widget(focus).render(maxcolrow,
339
332
def keypress(self, maxcolrow, key):
341
This overrides the method from urwid.Widget"""
334
This overrides the method from urwid.FlowWidget"""
343
336
self.proxy.Set(client_interface, "Enabled",
344
dbus.Boolean(True), ignore_reply=True,
345
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
347
340
self.proxy.Set(client_interface, "Enabled", False,
349
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
351
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
352
dbus_interface=client_interface,
345
dbus_interface = client_interface,
353
346
ignore_reply=True)
355
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
356
dbus_interface=client_interface,
349
dbus_interface = client_interface,
357
350
ignore_reply=True)
358
351
elif key == "R" or key == "_" or key == "ctrl k":
359
352
self.server_proxy_object.RemoveClient(self.proxy
361
354
ignore_reply=True)
363
356
self.proxy.Set(client_interface, "CheckerRunning",
364
dbus.Boolean(True), ignore_reply=True,
365
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
367
360
self.proxy.Set(client_interface, "CheckerRunning",
368
dbus.Boolean(False), ignore_reply=True,
369
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
371
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
372
365
ignore_reply=True)
374
367
# elif key == "p" or key == "=":
395
def glib_safely(func, retval=True):
396
def safe_func(*args, **kwargs):
398
return func(*args, **kwargs)
405
388
class ConstrainedListBox(urwid.ListBox):
406
389
"""Like a normal urwid.ListBox, but will consume all "up" or
407
390
"down" key presses, thus not allowing any containing widgets to
408
391
use them as an excuse to shift focus away from this widget.
410
393
def keypress(self, *args, **kwargs):
411
ret = (super(ConstrainedListBox, self)
412
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
413
395
if ret in ("up", "down"):
400
class UserInterface(object):
419
401
"""This is the entire user interface - the whole screen
420
402
with boxes, lists of client widgets, etc.
422
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
423
405
DBusGMainLoop(set_as_default=True)
425
407
self.screen = urwid.curses_display.Screen()
427
409
self.screen.register_palette((
429
411
"default", "default", None),
445
426
"bold,underline,blink,standout", "default",
446
427
"bold,underline,blink,standout"),
449
430
if urwid.supports_unicode():
450
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
452
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
454
437
self.screen.start()
456
439
self.size = self.screen.get_cols_rows()
458
441
self.clients = urwid.SimpleListWalker([])
459
442
self.clients_dict = {}
461
444
# We will add Text widgets to this list
462
self.log = urwid.SimpleListWalker([])
463
446
self.max_log_length = max_log_length
448
self.log_level = log_level
465
450
# We keep a reference to the log widget so we can remove it
466
451
# from the ListWalker without it getting destroyed
467
452
self.logbox = ConstrainedListBox(self.log)
469
454
# This keeps track of whether self.uilist currently has
470
455
# self.logbox in it or not
471
456
self.log_visible = True
472
457
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"
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
465
self.busname = domain + '.Mandos'
482
466
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)
468
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
488
473
def rebuild(self):
489
474
"""This rebuilds the User Interface.
490
475
Call this when the widget layout needs to change"""
492
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
493
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
495
# header=urwid.Divider(),
480
#header=urwid.Divider(),
497
footer=urwid.Divider(
498
div_char=self.divider)))
483
urwid.Divider(div_char=
499
485
if self.log_visible:
500
486
self.uilist.append(self.logbox)
501
487
self.topwidget = urwid.Pile(self.uilist)
503
def add_log_line(self, markup):
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
504
501
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,
502
if (self.max_log_length
503
and len(self.log) > self.max_log_length):
504
del self.log[0:len(self.log)-self.max_log_length-1]
505
self.logbox.set_focus(len(self.logbox.body.contents),
509
506
coming_from="above")
512
509
def toggle_log_display(self):
513
510
"""Toggle visibility of the log buffer."""
514
511
self.log_visible = not self.log_visible
516
log.debug("Log visibility changed to: %s", self.log_visible)
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
518
516
def change_log_display(self):
519
517
"""Change type of log display.
520
518
Currently, this toggles wrapping of text lines."""
567
574
self.clients_dict[path] = client
568
575
self.clients.sort(key=lambda c: c.properties["Name"])
571
578
def remove_client(self, client, path=None):
572
579
self.clients.remove(client)
574
581
path = client.proxy.object_path
575
582
del self.clients_dict[path]
578
585
def refresh(self):
579
586
"""Redraw the screen"""
580
587
canvas = self.topwidget.render(self.size, focus=True)
581
588
self.screen.draw_screen(self.size, canvas)
584
591
"""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
592
self.bus = dbus.SystemBus()
591
593
mandos_dbus_objc = self.bus.get_object(
592
594
self.busname, "/", follow_name_owner_changes=True)
593
self.mandos_serv = dbus.Interface(
594
mandos_dbus_objc, dbus_interface=server_interface)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
596
599
mandos_clients = (self.mandos_serv
597
600
.GetAllClientsWithProperties())
598
601
if not mandos_clients:
599
log.warning("Note: Server has no clients.")
602
self.log_message_raw(("bold", "Note: Server has no clients."))
600
603
except dbus.exceptions.DBusException:
601
log.warning("Note: No Mandos server running.")
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
602
605
mandos_clients = dbus.Dictionary()
604
607
(self.mandos_serv
605
608
.connect_to_signal("InterfacesRemoved",
606
609
self.find_and_remove_client,
607
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
= dbus.OBJECT_MANAGER_IFACE,
608
612
byte_arrays=True))
609
613
(self.mandos_serv
610
614
.connect_to_signal("InterfacesAdded",
611
615
self.add_new_client,
612
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
617
= dbus.OBJECT_MANAGER_IFACE,
613
618
byte_arrays=True))
614
619
(self.mandos_serv
615
620
.connect_to_signal("ClientNotFound",
619
624
for path, client in mandos_clients.items():
620
625
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),
627
self.add_client(MandosClientWidget(server_proxy_object
630
=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)))
641
self._input_callback_tag = (GLib.io_add_watch
636
645
self.main_loop.run()
637
646
# Main loop has finished, we should close everything now
638
647
GLib.source_remove(self._input_callback_tag)
639
with warnings.catch_warnings():
640
warnings.simplefilter("ignore", BytesWarning)
644
651
self.main_loop.quit()
645
log.removeHandler(self.loghandler)
646
log.propagate = self.orig_log_propagate
648
653
def process_input(self, source, condition):
649
654
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
655
translations = { "ctrl n": "down", # Emacs
656
"ctrl p": "up", # Emacs
657
"ctrl v": "page down", # Emacs
658
"meta v": "page up", # Emacs
659
" ": "page down", # less
660
"f": "page down", # less
661
"b": "page up", # less
662
667
key = translations[key]
663
668
except KeyError: # :-)
666
671
if key == "q" or key == "Q":
709
715
self.topwidget.set_focus(self.logbox)
712
if log.level < logging.INFO:
713
log.setLevel(logging.INFO)
714
log.info("Verbose mode: Off")
718
if self.log_level == 0:
720
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
723
self.log_message("Verbose mode: On")
724
#elif (key == "end" or key == "meta >" or key == "G"
726
# pass # xxx end-of-buffer
727
#elif (key == "home" or key == "meta <" or key == "g"
729
# pass # xxx beginning-of-buffer
730
#elif key == "ctrl e" or key == "$":
731
# pass # xxx move-end-of-line
732
#elif key == "ctrl a" or key == "^":
733
# pass # xxx move-beginning-of-line
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
739
# pass # scroll up log
741
# pass # scroll down log
736
742
elif self.topwidget.selectable():
737
743
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
747
ui = UserInterface()
758
750
except KeyboardInterrupt:
759
with warnings.catch_warnings():
760
warnings.filterwarnings("ignore", "", BytesWarning)
763
with warnings.catch_warnings():
764
warnings.filterwarnings("ignore", "", BytesWarning)
752
except Exception as e:
753
ui.log_message(str(e))