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
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
336
self.proxy.Enable(dbus_interface = client_interface,
338
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
339
self.proxy.Disable(dbus_interface = client_interface,
342
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface=client_interface,
343
dbus_interface = client_interface,
344
344
ignore_reply=True)
346
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface=client_interface,
347
dbus_interface = client_interface,
348
348
ignore_reply=True)
349
349
elif key == "R" or key == "_" or key == "ctrl k":
350
350
self.server_proxy_object.RemoveClient(self.proxy
352
352
ignore_reply=True)
354
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
354
self.proxy.StartChecker(dbus_interface = client_interface,
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
357
self.proxy.StopChecker(dbus_interface = client_interface,
362
self.proxy.CheckedOK(dbus_interface=client_interface,
360
self.proxy.CheckedOK(dbus_interface = client_interface,
363
361
ignore_reply=True)
365
363
# elif key == "p" or key == "=":
436
422
"bold,underline,blink,standout", "default",
437
423
"bold,underline,blink,standout"),
440
426
if urwid.supports_unicode():
441
self.divider = "─" # \u2500
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
443
self.divider = "_" # \u005f
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
445
433
self.screen.start()
447
435
self.size = self.screen.get_cols_rows()
449
437
self.clients = urwid.SimpleListWalker([])
450
438
self.clients_dict = {}
452
440
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
454
442
self.max_log_length = max_log_length
444
self.log_level = log_level
456
446
# We keep a reference to the log widget so we can remove it
457
447
# from the ListWalker without it getting destroyed
458
448
self.logbox = ConstrainedListBox(self.log)
460
450
# This keeps track of whether self.uilist currently has
461
451
# self.logbox in it or not
462
452
self.log_visible = True
463
453
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)
456
self.log_message_raw(("bold",
457
"Mandos Monitor version " + version))
458
self.log_message_raw(("bold",
461
self.busname = domain + '.Mandos'
462
self.main_loop = gobject.MainLoop()
464
def client_not_found(self, fingerprint, address):
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
479
469
def rebuild(self):
480
470
"""This rebuilds the User Interface.
481
471
Call this when the widget layout needs to change"""
483
# self.uilist.append(urwid.ListBox(self.clients))
473
#self.uilist.append(urwid.ListBox(self.clients))
484
474
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
486
# header=urwid.Divider(),
476
#header=urwid.Divider(),
488
footer=urwid.Divider(
489
div_char=self.divider)))
479
urwid.Divider(div_char=
490
481
if self.log_visible:
491
482
self.uilist.append(self.logbox)
492
483
self.topwidget = urwid.Pile(self.uilist)
494
def add_log_line(self, markup):
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
489
timestamp = datetime.datetime.now().isoformat()
490
self.log_message_raw("{}: {}".format(timestamp, message),
493
def log_message_raw(self, markup, level=1):
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
495
497
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,
498
if (self.max_log_length
499
and len(self.log) > self.max_log_length):
500
del self.log[0:len(self.log)-self.max_log_length-1]
501
self.logbox.set_focus(len(self.logbox.body.contents),
500
502
coming_from="above")
503
505
def toggle_log_display(self):
504
506
"""Toggle visibility of the log buffer."""
505
507
self.log_visible = not self.log_visible
507
log.debug("Log visibility changed to: %s", self.log_visible)
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
509
512
def change_log_display(self):
510
513
"""Change type of log display.
511
514
Currently, this toggles wrapping of text lines."""
515
518
self.log_wrap = "clip"
516
519
for textwidget in self.log:
517
520
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):
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
524
def find_and_remove_client(self, path, name):
521
525
"""Find a client by its object path and remove it.
523
This is connected to the InterfacesRemoved signal from the
527
This is connected to the ClientRemoved signal from the
524
528
Mandos server object."""
525
if client_interface not in interfaces:
526
# Not a Mandos client object; ignore
529
530
client = self.clients_dict[path]
532
log.warning("Unknown client %s removed", path)
533
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
538
def add_new_client(self, path):
545
539
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])),
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
554
552
def add_client(self, client, path=None):
555
553
self.clients.append(client)
558
556
self.clients_dict[path] = client
559
557
self.clients.sort(key=lambda c: c.properties["Name"])
562
560
def remove_client(self, client, path=None):
563
561
self.clients.remove(client)
565
563
path = client.proxy.object_path
566
564
del self.clients_dict[path]
569
567
def refresh(self):
570
568
"""Redraw the screen"""
571
569
canvas = self.topwidget.render(self.size, focus=True)
572
570
self.screen.draw_screen(self.size, canvas)
575
573
"""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
574
self.bus = dbus.SystemBus()
582
575
mandos_dbus_objc = self.bus.get_object(
583
576
self.busname, "/", follow_name_owner_changes=True)
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
587
581
mandos_clients = (self.mandos_serv
588
582
.GetAllClientsWithProperties())
589
583
if not mandos_clients:
590
log.warning("Note: Server has no clients.")
584
self.log_message_raw(("bold", "Note: Server has no clients."))
591
585
except dbus.exceptions.DBusException:
592
log.warning("Note: No Mandos server running.")
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
593
587
mandos_clients = dbus.Dictionary()
595
589
(self.mandos_serv
596
.connect_to_signal("InterfacesRemoved",
590
.connect_to_signal("ClientRemoved",
597
591
self.find_and_remove_client,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
592
dbus_interface=server_interface,
599
593
byte_arrays=True))
600
594
(self.mandos_serv
601
.connect_to_signal("InterfacesAdded",
595
.connect_to_signal("ClientAdded",
602
596
self.add_new_client,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
dbus_interface=server_interface,
604
598
byte_arrays=True))
605
599
(self.mandos_serv
606
600
.connect_to_signal("ClientNotFound",
610
604
for path, client in mandos_clients.items():
611
605
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),
607
self.add_client(MandosClientWidget(server_proxy_object
610
=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)))
621
self._input_callback_tag = (gobject.io_add_watch
627
625
self.main_loop.run()
628
626
# 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)
627
gobject.source_remove(self._input_callback_tag)
635
631
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
639
633
def process_input(self, source, condition):
640
634
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
635
translations = { "ctrl n": "down", # Emacs
636
"ctrl p": "up", # Emacs
637
"ctrl v": "page down", # Emacs
638
"meta v": "page up", # Emacs
639
" ": "page down", # less
640
"f": "page down", # less
641
"b": "page up", # less
653
647
key = translations[key]
654
648
except KeyError: # :-)
657
651
if key == "q" or key == "Q":
700
695
self.topwidget.set_focus(self.logbox)
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
698
if self.log_level == 0:
700
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
703
self.log_message("Verbose mode: On")
704
#elif (key == "end" or key == "meta >" or key == "G"
706
# pass # xxx end-of-buffer
707
#elif (key == "home" or key == "meta <" or key == "g"
709
# pass # xxx beginning-of-buffer
710
#elif key == "ctrl e" or key == "$":
711
# pass # xxx move-end-of-line
712
#elif key == "ctrl a" or key == "^":
713
# pass # xxx move-beginning-of-line
714
#elif key == "ctrl b" or key == "meta (" or key == "h":
716
#elif key == "ctrl f" or key == "meta )" or key == "l":
719
# pass # scroll up log
721
# pass # scroll down log
727
722
elif self.topwidget.selectable():
728
723
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
727
ui = UserInterface()
749
730
except KeyboardInterrupt:
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)
732
except Exception as e:
733
ui.log_message(str(e))