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-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 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
90
self.proxy.connect_to_signal("PropertiesChanged",
101
91
self.properties_changed,
102
92
dbus.PROPERTIES_IFACE,
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
103
def properties_changed(self, interface, properties, invalidated):
113
104
"""This is called whenever we get a PropertiesChanged signal
114
105
It updates the changed properties in the "properties" dict.
116
107
# Update properties dict with new value
117
if interface == client_interface:
118
self.properties.update(properties)
108
self.properties.update(properties)
120
110
def delete(self):
121
111
self.property_changed_match.remove()
166
158
client_interface,
167
159
byte_arrays=True))
168
log.debug("Created client %s", self.properties["Name"])
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
170
163
def using_timer(self, flag):
171
164
"""Call this method with True or False when timer should be
172
165
activated or deactivated.
174
167
if flag and self._update_timer_callback_tag is None:
175
168
# 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)))
169
self._update_timer_callback_tag = (gobject.timeout_add
179
172
elif not (flag or self._update_timer_callback_tag is None):
180
GLib.source_remove(self._update_timer_callback_tag)
173
gobject.source_remove(self._update_timer_callback_tag)
181
174
self._update_timer_callback_tag = None
183
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, command):
184
177
if exitstatus == 0:
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
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))
194
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))
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
195
self.logger('Checker for client {} completed'
197
.format(self.properties["Name"]))
200
200
def checker_started(self, command):
201
201
"""Server signals that a checker started."""
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
205
206
def got_secret(self):
206
log.info("Client %s received its secret",
207
self.properties["Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
209
210
def need_approval(self, timeout, default):
211
message = "Client %s needs approval within %f seconds"
212
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)
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
216
218
def rejected(self, reason):
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
220
222
def selectable(self):
221
223
"""Make this a "selectable" widget.
222
224
This overrides the method from urwid.FlowWidget."""
225
227
def rows(self, maxcolrow, focus=False):
226
228
"""How many rows this widget will occupy might depend on
227
229
whether we have focus or not.
228
230
This overrides the method from urwid.FlowWidget"""
229
231
return self.current_widget(focus).rows(maxcolrow, focus=focus)
231
233
def current_widget(self, focus=False):
232
234
if focus or self.opened:
233
235
return self._focus_widget
234
236
return self._widget
236
238
def update(self):
237
239
"Called when what is visible on the screen should be updated."
238
240
# 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",
241
with_standout = { "normal": "standout",
242
"bold": "bold-standout",
244
"underline-blink-standout",
245
"bold-underline-blink":
246
"bold-underline-blink-standout",
247
249
# Rebuild focus and non-focus widgets using current properties
249
251
# Base part of a client. Name!
250
base = "{name}: ".format(name=self.properties["Name"])
252
base = '{name}: '.format(name=self.properties["Name"])
251
253
if not self.properties["Enabled"]:
252
254
message = "DISABLED"
253
255
self.using_timer(False)
254
256
elif self.properties["ApprovalPending"]:
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
257
timeout = datetime.timedelta(milliseconds
257
260
last_approval_request = isoformat_to_datetime(
258
261
self.properties["LastApprovalRequest"])
259
262
if last_approval_request is not None:
320
322
if self.delete_hook is not None:
321
323
self.delete_hook(self)
322
324
return super(MandosClientWidget, self).delete(**kwargs)
324
326
def render(self, maxcolrow, focus=False):
325
327
"""Render differently if we have focus.
326
328
This overrides the method from urwid.FlowWidget"""
327
329
return self.current_widget(focus).render(maxcolrow,
330
332
def keypress(self, maxcolrow, key):
332
334
This overrides the method from urwid.FlowWidget"""
334
336
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
337
dbus.Boolean(True), ignore_reply = True,
338
dbus_interface = dbus.PROPERTIES_IFACE)
338
340
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
342
dbus_interface = dbus.PROPERTIES_IFACE)
342
344
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface=client_interface,
345
dbus_interface = client_interface,
344
346
ignore_reply=True)
346
348
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface=client_interface,
349
dbus_interface = client_interface,
348
350
ignore_reply=True)
349
351
elif key == "R" or key == "_" or key == "ctrl k":
350
352
self.server_proxy_object.RemoveClient(self.proxy
352
354
ignore_reply=True)
354
356
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
357
dbus.Boolean(True), ignore_reply = True,
358
dbus_interface = dbus.PROPERTIES_IFACE)
358
360
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
361
dbus.Boolean(False), ignore_reply = True,
362
dbus_interface = dbus.PROPERTIES_IFACE)
362
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
363
365
ignore_reply=True)
365
367
# elif key == "p" or key == "=":
436
426
"bold,underline,blink,standout", "default",
437
427
"bold,underline,blink,standout"),
440
430
if urwid.supports_unicode():
441
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
443
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
445
437
self.screen.start()
447
439
self.size = self.screen.get_cols_rows()
449
441
self.clients = urwid.SimpleListWalker([])
450
442
self.clients_dict = {}
452
444
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
454
446
self.max_log_length = max_log_length
448
self.log_level = log_level
456
450
# We keep a reference to the log widget so we can remove it
457
451
# from the ListWalker without it getting destroyed
458
452
self.logbox = ConstrainedListBox(self.log)
460
454
# This keeps track of whether self.uilist currently has
461
455
# self.logbox in it or not
462
456
self.log_visible = True
463
457
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)
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
465
self.busname = domain + '.Mandos'
466
self.main_loop = gobject.MainLoop()
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))
479
473
def rebuild(self):
480
474
"""This rebuilds the User Interface.
481
475
Call this when the widget layout needs to change"""
483
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
484
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
486
# header=urwid.Divider(),
480
#header=urwid.Divider(),
488
footer=urwid.Divider(
489
div_char=self.divider)))
483
urwid.Divider(div_char=
490
485
if self.log_visible:
491
486
self.uilist.append(self.logbox)
492
487
self.topwidget = urwid.Pile(self.uilist)
494
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:
495
501
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,
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),
500
506
coming_from="above")
503
509
def toggle_log_display(self):
504
510
"""Toggle visibility of the log buffer."""
505
511
self.log_visible = not self.log_visible
507
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)
509
516
def change_log_display(self):
510
517
"""Change type of log display.
511
518
Currently, this toggles wrapping of text lines."""
515
522
self.log_wrap = "clip"
516
523
for textwidget in self.log:
517
524
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):
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, name):
521
529
"""Find a client by its object path and remove it.
523
This is connected to the InterfacesRemoved signal from the
531
This is connected to the ClientRemoved signal from the
524
532
Mandos server object."""
525
if client_interface not in interfaces:
526
# Not a Mandos client object; ignore
529
534
client = self.clients_dict[path]
532
log.warning("Unknown client %s removed", path)
537
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
542
def add_new_client(self, path):
545
543
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])),
544
self.add_client(MandosClientWidget(server_proxy_object
547
=client_proxy_object,
554
556
def add_client(self, client, path=None):
555
557
self.clients.append(client)
558
560
self.clients_dict[path] = client
559
561
self.clients.sort(key=lambda c: c.properties["Name"])
562
564
def remove_client(self, client, path=None):
563
565
self.clients.remove(client)
565
567
path = client.proxy.object_path
566
568
del self.clients_dict[path]
569
571
def refresh(self):
570
572
"""Redraw the screen"""
571
573
canvas = self.topwidget.render(self.size, focus=True)
572
574
self.screen.draw_screen(self.size, canvas)
575
577
"""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
578
self.bus = dbus.SystemBus()
582
579
mandos_dbus_objc = self.bus.get_object(
583
580
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
587
585
mandos_clients = (self.mandos_serv
588
586
.GetAllClientsWithProperties())
589
587
if not mandos_clients:
590
log.warning("Note: Server has no clients.")
588
self.log_message_raw(("bold", "Note: Server has no clients."))
591
589
except dbus.exceptions.DBusException:
592
log.warning("Note: No Mandos server running.")
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
593
591
mandos_clients = dbus.Dictionary()
595
593
(self.mandos_serv
596
.connect_to_signal("InterfacesRemoved",
594
.connect_to_signal("ClientRemoved",
597
595
self.find_and_remove_client,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
dbus_interface=server_interface,
599
597
byte_arrays=True))
600
598
(self.mandos_serv
601
.connect_to_signal("InterfacesAdded",
599
.connect_to_signal("ClientAdded",
602
600
self.add_new_client,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
601
dbus_interface=server_interface,
604
602
byte_arrays=True))
605
603
(self.mandos_serv
606
604
.connect_to_signal("ClientNotFound",
610
608
for path, client in mandos_clients.items():
611
609
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),
611
self.add_client(MandosClientWidget(server_proxy_object
614
=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)))
625
self._input_callback_tag = (gobject.io_add_watch
627
629
self.main_loop.run()
628
630
# 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)
631
gobject.source_remove(self._input_callback_tag)
635
635
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
639
637
def process_input(self, source, condition):
640
638
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
639
translations = { "ctrl n": "down", # Emacs
640
"ctrl p": "up", # Emacs
641
"ctrl v": "page down", # Emacs
642
"meta v": "page up", # Emacs
643
" ": "page down", # less
644
"f": "page down", # less
645
"b": "page up", # less
653
651
key = translations[key]
654
652
except KeyError: # :-)
657
655
if key == "q" or key == "Q":
700
699
self.topwidget.set_focus(self.logbox)
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
702
if self.log_level == 0:
704
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
707
self.log_message("Verbose mode: On")
708
#elif (key == "end" or key == "meta >" or key == "G"
710
# pass # xxx end-of-buffer
711
#elif (key == "home" or key == "meta <" or key == "g"
713
# pass # xxx beginning-of-buffer
714
#elif key == "ctrl e" or key == "$":
715
# pass # xxx move-end-of-line
716
#elif key == "ctrl a" or key == "^":
717
# pass # xxx move-beginning-of-line
718
#elif key == "ctrl b" or key == "meta (" or key == "h":
720
#elif key == "ctrl f" or key == "meta )" or key == "l":
723
# pass # scroll up log
725
# pass # scroll down log
727
726
elif self.topwidget.selectable():
728
727
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
731
ui = UserInterface()
749
734
except KeyboardInterrupt:
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)
736
except Exception as e:
737
ui.log_message(str(e))