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