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,
98
88
def __init__(self, proxy_object=None, properties=None, **kwargs):
99
self.proxy = proxy_object # Mandos Client proxy object
89
self.proxy = proxy_object # Mandos Client proxy object
100
90
self.properties = dict() if properties is None else properties
101
91
self.property_changed_match = (
102
92
self.proxy.connect_to_signal("PropertiesChanged",
103
93
self.properties_changed,
104
94
dbus.PROPERTIES_IFACE,
105
95
byte_arrays=True))
107
97
if properties is None:
108
self.properties.update(self.proxy.GetAll(
110
dbus_interface=dbus.PROPERTIES_IFACE))
98
self.properties.update(
99
self.proxy.GetAll(client_interface,
101
= dbus.PROPERTIES_IFACE))
112
103
super(MandosClientPropertyCache, self).__init__(**kwargs)
114
105
def properties_changed(self, interface, properties, invalidated):
115
106
"""This is called whenever we get a PropertiesChanged signal
116
107
It updates the changed properties in the "properties" dict.
168
161
client_interface,
169
162
byte_arrays=True))
170
log.debug('Created client %s', self.properties["Name"])
163
self.logger('Created client {}'
164
.format(self.properties["Name"]), level=0)
172
166
def using_timer(self, flag):
173
167
"""Call this method with True or False when timer should be
174
168
activated or deactivated.
176
170
if flag and self._update_timer_callback_tag is None:
177
171
# 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)))
172
self._update_timer_callback_tag = (GLib.timeout_add
181
175
elif not (flag or self._update_timer_callback_tag is None):
182
176
GLib.source_remove(self._update_timer_callback_tag)
183
177
self._update_timer_callback_tag = None
185
179
def checker_completed(self, exitstatus, condition, command):
186
180
if exitstatus == 0:
187
log.debug('Checker for client %s (command "%s")'
188
' succeeded', self.properties["Name"], command)
181
self.logger('Checker for client {} (command "{}")'
182
' succeeded'.format(self.properties["Name"],
192
187
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))
188
self.logger('Checker for client {} (command "{}") failed'
190
.format(self.properties["Name"], command,
191
os.WEXITSTATUS(condition)))
196
192
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))
193
self.logger('Checker for client {} (command "{}") was'
194
' killed by signal {}'
195
.format(self.properties["Name"], command,
196
os.WTERMSIG(condition)))
202
199
def checker_started(self, command):
203
200
"""Server signals that a checker started."""
204
log.debug('Client %s started checker "%s"',
205
self.properties["Name"], command)
201
self.logger('Client {} started checker "{}"'
202
.format(self.properties["Name"],
207
205
def got_secret(self):
208
log.info("Client %s received its secret",
209
self.properties["Name"])
206
self.logger('Client {} received its secret'
207
.format(self.properties["Name"]))
211
209
def need_approval(self, timeout, default):
213
message = "Client %s needs approval within %f seconds"
211
message = 'Client {} needs approval within {} seconds'
215
message = "Client %s will get its secret in %f seconds"
216
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"],
218
217
def rejected(self, reason):
219
log.info("Client %s was rejected; reason: %s",
220
self.properties["Name"], reason)
218
self.logger('Client {} was rejected; reason: {}'
219
.format(self.properties["Name"], reason))
222
221
def selectable(self):
223
222
"""Make this a "selectable" widget.
224
223
This overrides the method from urwid.FlowWidget."""
227
226
def rows(self, maxcolrow, focus=False):
228
227
"""How many rows this widget will occupy might depend on
229
228
whether we have focus or not.
230
229
This overrides the method from urwid.FlowWidget"""
231
230
return self.current_widget(focus).rows(maxcolrow, focus=focus)
233
232
def current_widget(self, focus=False):
234
233
if focus or self.opened:
235
234
return self._focus_widget
236
235
return self._widget
238
237
def update(self):
239
238
"Called when what is visible on the screen should be updated."
240
239
# 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",
240
with_standout = { "normal": "standout",
241
"bold": "bold-standout",
243
"underline-blink-standout",
244
"bold-underline-blink":
245
"bold-underline-blink-standout",
249
248
# Rebuild focus and non-focus widgets using current properties
251
250
# Base part of a client. Name!
252
251
base = '{name}: '.format(name=self.properties["Name"])
253
252
if not self.properties["Enabled"]:
254
253
message = "DISABLED"
255
254
self.using_timer(False)
256
255
elif self.properties["ApprovalPending"]:
257
timeout = datetime.timedelta(
258
milliseconds=self.properties["ApprovalDelay"])
256
timeout = datetime.timedelta(milliseconds
259
259
last_approval_request = isoformat_to_datetime(
260
260
self.properties["LastApprovalRequest"])
261
261
if last_approval_request is not None:
322
322
if self.delete_hook is not None:
323
323
self.delete_hook(self)
324
324
return super(MandosClientWidget, self).delete(**kwargs)
326
326
def render(self, maxcolrow, focus=False):
327
327
"""Render differently if we have focus.
328
328
This overrides the method from urwid.FlowWidget"""
329
329
return self.current_widget(focus).render(maxcolrow,
332
332
def keypress(self, maxcolrow, key):
334
334
This overrides the method from urwid.FlowWidget"""
336
336
self.proxy.Set(client_interface, "Enabled",
337
dbus.Boolean(True), ignore_reply=True,
338
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
340
340
self.proxy.Set(client_interface, "Enabled", False,
342
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
344
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
dbus_interface=client_interface,
345
dbus_interface = client_interface,
346
346
ignore_reply=True)
348
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
dbus_interface=client_interface,
349
dbus_interface = client_interface,
350
350
ignore_reply=True)
351
351
elif key == "R" or key == "_" or key == "ctrl k":
352
352
self.server_proxy_object.RemoveClient(self.proxy
354
354
ignore_reply=True)
356
356
self.proxy.Set(client_interface, "CheckerRunning",
357
dbus.Boolean(True), ignore_reply=True,
358
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
360
360
self.proxy.Set(client_interface, "CheckerRunning",
361
dbus.Boolean(False), ignore_reply=True,
362
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
364
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
365
365
ignore_reply=True)
367
367
# elif key == "p" or key == "=":
388
def glib_safely(func, retval=True):
389
def safe_func(*args, **kwargs):
391
return func(*args, **kwargs)
398
388
class ConstrainedListBox(urwid.ListBox):
399
389
"""Like a normal urwid.ListBox, but will consume all "up" or
400
390
"down" key presses, thus not allowing any containing widgets to
401
391
use them as an excuse to shift focus away from this widget.
403
393
def keypress(self, *args, **kwargs):
404
ret = (super(ConstrainedListBox, self)
405
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
406
395
if ret in ("up", "down"):
438
426
"bold,underline,blink,standout", "default",
439
427
"bold,underline,blink,standout"),
442
430
if urwid.supports_unicode():
443
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
445
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
447
437
self.screen.start()
449
439
self.size = self.screen.get_cols_rows()
451
441
self.clients = urwid.SimpleListWalker([])
452
442
self.clients_dict = {}
454
444
# We will add Text widgets to this list
455
self.log = urwid.SimpleListWalker([])
456
446
self.max_log_length = max_log_length
448
self.log_level = log_level
458
450
# We keep a reference to the log widget so we can remove it
459
451
# from the ListWalker without it getting destroyed
460
452
self.logbox = ConstrainedListBox(self.log)
462
454
# This keeps track of whether self.uilist currently has
463
455
# self.logbox in it or not
464
456
self.log_visible = True
465
457
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"))
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
474
465
self.busname = domain + '.Mandos'
475
466
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)
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))
481
473
def rebuild(self):
482
474
"""This rebuilds the User Interface.
483
475
Call this when the widget layout needs to change"""
485
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
486
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
488
# header=urwid.Divider(),
480
#header=urwid.Divider(),
490
footer=urwid.Divider(
491
div_char=self.divider)))
483
urwid.Divider(div_char=
492
485
if self.log_visible:
493
486
self.uilist.append(self.logbox)
494
487
self.topwidget = urwid.Pile(self.uilist)
496
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:
497
501
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,
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),
502
506
coming_from="above")
505
509
def toggle_log_display(self):
506
510
"""Toggle visibility of the log buffer."""
507
511
self.log_visible = not self.log_visible
509
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)
511
516
def change_log_display(self):
512
517
"""Change type of log display.
513
518
Currently, this toggles wrapping of text lines."""
560
574
self.clients_dict[path] = client
561
575
self.clients.sort(key=lambda c: c.properties["Name"])
564
578
def remove_client(self, client, path=None):
565
579
self.clients.remove(client)
567
581
path = client.proxy.object_path
568
582
del self.clients_dict[path]
571
585
def refresh(self):
572
586
"""Redraw the screen"""
573
587
canvas = self.topwidget.render(self.size, focus=True)
574
588
self.screen.draw_screen(self.size, canvas)
577
591
"""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
592
self.bus = dbus.SystemBus()
584
593
mandos_dbus_objc = self.bus.get_object(
585
594
self.busname, "/", follow_name_owner_changes=True)
586
self.mandos_serv = dbus.Interface(
587
mandos_dbus_objc, dbus_interface=server_interface)
595
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
589
599
mandos_clients = (self.mandos_serv
590
600
.GetAllClientsWithProperties())
591
601
if not mandos_clients:
592
log.warning("Note: Server has no clients.")
602
self.log_message_raw(("bold", "Note: Server has no clients."))
593
603
except dbus.exceptions.DBusException:
594
log.warning("Note: No Mandos server running.")
604
self.log_message_raw(("bold", "Note: No Mandos server running."))
595
605
mandos_clients = dbus.Dictionary()
597
607
(self.mandos_serv
598
608
.connect_to_signal("InterfacesRemoved",
599
609
self.find_and_remove_client,
600
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
= dbus.OBJECT_MANAGER_IFACE,
601
612
byte_arrays=True))
602
613
(self.mandos_serv
603
614
.connect_to_signal("InterfacesAdded",
604
615
self.add_new_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
617
= dbus.OBJECT_MANAGER_IFACE,
606
618
byte_arrays=True))
607
619
(self.mandos_serv
608
620
.connect_to_signal("ClientNotFound",
612
624
for path, client in mandos_clients.items():
613
625
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),
627
self.add_client(MandosClientWidget(server_proxy_object
630
=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)))
641
self._input_callback_tag = (GLib.io_add_watch
629
645
self.main_loop.run()
630
646
# Main loop has finished, we should close everything now
631
647
GLib.source_remove(self._input_callback_tag)
632
with warnings.catch_warnings():
633
warnings.simplefilter("ignore", BytesWarning)
637
651
self.main_loop.quit()
638
log.removeHandler(self.loghandler)
639
log.propagate = self.orig_log_propagate
641
653
def process_input(self, source, condition):
642
654
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
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
655
667
key = translations[key]
656
668
except KeyError: # :-)
659
671
if key == "q" or key == "Q":
702
715
self.topwidget.set_focus(self.logbox)
705
if log.level < logging.INFO:
706
log.setLevel(logging.INFO)
707
log.info("Verbose mode: Off")
718
if self.log_level == 0:
720
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
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
729
742
elif self.topwidget.selectable():
730
743
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
747
ui = UserInterface()
751
750
except KeyboardInterrupt:
752
with warnings.catch_warnings():
753
warnings.filterwarnings("ignore", "", BytesWarning)
756
with warnings.catch_warnings():
757
warnings.filterwarnings("ignore", "", BytesWarning)
752
except Exception as e:
753
ui.log_message(str(e))