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
51
if sys.version_info.major == 2:
54
54
locale.setlocale(locale.LC_ALL, '')
56
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
58
59
# Some useful constants
59
60
domain = 'se.recompile'
60
61
server_interface = domain + '.Mandos'
61
62
client_interface = domain + '.Mandos.Client'
65
dbus.OBJECT_MANAGER_IFACE
66
except AttributeError:
67
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
70
65
def isoformat_to_datetime(iso):
71
66
"Parse an ISO 8601 date string to a datetime.datetime()"
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
87
81
class MandosClientPropertyCache(object):
88
82
"""This wraps a Mandos Client D-Bus proxy object, caches the
92
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
93
self.proxy = proxy_object # Mandos Client proxy object
87
self.proxy = proxy_object # Mandos Client proxy object
94
88
self.properties = dict() if properties is None else properties
95
89
self.property_changed_match = (
96
90
self.proxy.connect_to_signal("PropertiesChanged",
97
91
self.properties_changed,
98
92
dbus.PROPERTIES_IFACE,
101
95
if properties is None:
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
106
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
108
103
def properties_changed(self, interface, properties, invalidated):
109
104
"""This is called whenever we get a PropertiesChanged signal
110
105
It updates the changed properties in the "properties" dict.
112
107
# Update properties dict with new value
113
if interface == client_interface:
114
self.properties.update(properties)
108
self.properties.update(properties)
116
110
def delete(self):
117
111
self.property_changed_match.remove()
165
159
byte_arrays=True))
166
160
self.logger('Created client {}'
167
161
.format(self.properties["Name"]), level=0)
169
163
def using_timer(self, flag):
170
164
"""Call this method with True or False when timer should be
171
165
activated or deactivated.
173
167
if flag and self._update_timer_callback_tag is None:
174
168
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GLib.timeout_add
169
self._update_timer_callback_tag = (gobject.timeout_add
177
171
self.update_timer))
178
172
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
173
gobject.source_remove(self._update_timer_callback_tag)
180
174
self._update_timer_callback_tag = None
182
176
def checker_completed(self, exitstatus, condition, command):
183
177
if exitstatus == 0:
184
178
self.logger('Checker for client {} (command "{}")'
197
191
' killed by signal {}'
198
192
.format(self.properties["Name"], command,
199
193
os.WTERMSIG(condition)))
194
elif os.WCOREDUMP(condition):
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
199
self.logger('Checker for client {} completed'
201
.format(self.properties["Name"]))
202
204
def checker_started(self, command):
203
205
"""Server signals that a checker started."""
204
206
self.logger('Client {} started checker "{}"'
205
207
.format(self.properties["Name"],
206
208
command), level=0)
208
210
def got_secret(self):
209
211
self.logger('Client {} received its secret'
210
212
.format(self.properties["Name"]))
212
214
def need_approval(self, timeout, default):
214
216
message = 'Client {} needs approval within {} seconds'
216
218
message = 'Client {} will get its secret in {} seconds'
217
219
self.logger(message.format(self.properties["Name"],
220
222
def rejected(self, reason):
221
223
self.logger('Client {} was rejected; reason: {}'
222
224
.format(self.properties["Name"], reason))
224
226
def selectable(self):
225
227
"""Make this a "selectable" widget.
226
228
This overrides the method from urwid.FlowWidget."""
229
231
def rows(self, maxcolrow, focus=False):
230
232
"""How many rows this widget will occupy might depend on
231
233
whether we have focus or not.
232
234
This overrides the method from urwid.FlowWidget"""
233
235
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
237
def current_widget(self, focus=False):
236
238
if focus or self.opened:
237
239
return self._focus_widget
238
240
return self._widget
240
242
def update(self):
241
243
"Called when what is visible on the screen should be updated."
242
244
# How to add standout mode to a style
243
with_standout = {"normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
245
with_standout = { "normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
251
253
# Rebuild focus and non-focus widgets using current properties
253
255
# Base part of a client. Name!
254
256
base = '{name}: '.format(name=self.properties["Name"])
255
257
if not self.properties["Enabled"]:
256
258
message = "DISABLED"
257
259
self.using_timer(False)
258
260
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
261
timeout = datetime.timedelta(milliseconds
261
264
last_approval_request = isoformat_to_datetime(
262
265
self.properties["LastApprovalRequest"])
263
266
if last_approval_request is not None:
306
309
# Run update hook, if any
307
310
if self.update_hook is not None:
308
311
self.update_hook()
310
313
def update_timer(self):
311
"""called by GLib. Will indefinitely loop until
312
GLib.source_remove() on tag is called
314
"""called by gobject. Will indefinitely loop until
315
gobject.source_remove() on tag is called"""
315
317
return True # Keep calling this
317
319
def delete(self, **kwargs):
318
320
if self._update_timer_callback_tag is not None:
319
GLib.source_remove(self._update_timer_callback_tag)
321
gobject.source_remove(self._update_timer_callback_tag)
320
322
self._update_timer_callback_tag = None
321
323
for match in self.match_objects:
324
326
if self.delete_hook is not None:
325
327
self.delete_hook(self)
326
328
return super(MandosClientWidget, self).delete(**kwargs)
328
330
def render(self, maxcolrow, focus=False):
329
331
"""Render differently if we have focus.
330
332
This overrides the method from urwid.FlowWidget"""
331
333
return self.current_widget(focus).render(maxcolrow,
334
336
def keypress(self, maxcolrow, key):
336
338
This overrides the method from urwid.FlowWidget"""
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply=True,
340
dbus_interface=dbus.PROPERTIES_IFACE)
340
self.proxy.Enable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
343
self.proxy.Disable(dbus_interface = client_interface,
346
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
347
dbus_interface = client_interface,
348
348
ignore_reply=True)
350
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
351
dbus_interface = client_interface,
352
352
ignore_reply=True)
353
353
elif key == "R" or key == "_" or key == "ctrl k":
354
354
self.server_proxy_object.RemoveClient(self.proxy
356
356
ignore_reply=True)
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
358
self.proxy.StartChecker(dbus_interface = client_interface,
362
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply=True,
364
dbus_interface=dbus.PROPERTIES_IFACE)
361
self.proxy.StopChecker(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
364
self.proxy.CheckedOK(dbus_interface = client_interface,
367
365
ignore_reply=True)
369
367
# elif key == "p" or key == "=":
378
376
def properties_changed(self, interface, properties, invalidated):
379
377
"""Call self.update() if any properties changed.
380
378
This overrides the method from MandosClientPropertyCache"""
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
383
381
super(MandosClientWidget, self).properties_changed(
384
382
interface, properties, invalidated)
385
383
if any(old_values[key] != self.properties.get(key)
393
391
use them as an excuse to shift focus away from this widget.
395
393
def keypress(self, *args, **kwargs):
396
ret = (super(ConstrainedListBox, self)
397
.keypress(*args, **kwargs))
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
398
395
if ret in ("up", "down"):
407
404
def __init__(self, max_log_length=1000, log_level=1):
408
405
DBusGMainLoop(set_as_default=True)
410
407
self.screen = urwid.curses_display.Screen()
412
409
self.screen.register_palette((
414
411
"default", "default", None),
420
417
"standout", "default", "standout"),
421
418
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
419
"bold,underline,blink", "default", "bold,underline,blink"),
424
420
("bold-standout",
425
421
"bold,standout", "default", "bold,standout"),
426
422
("underline-blink-standout",
430
426
"bold,underline,blink,standout", "default",
431
427
"bold,underline,blink,standout"),
434
430
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
437
self.divider = "_" # \u005f
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
439
437
self.screen.start()
441
439
self.size = self.screen.get_cols_rows()
443
441
self.clients = urwid.SimpleListWalker([])
444
442
self.clients_dict = {}
446
444
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
446
self.max_log_length = max_log_length
450
448
self.log_level = log_level
452
450
# We keep a reference to the log widget so we can remove it
453
451
# from the ListWalker without it getting destroyed
454
452
self.logbox = ConstrainedListBox(self.log)
456
454
# This keeps track of whether self.uilist currently has
457
455
# self.logbox in it or not
458
456
self.log_visible = True
459
457
self.log_wrap = "any"
462
460
self.log_message_raw(("bold",
463
461
"Mandos Monitor version " + version))
464
462
self.log_message_raw(("bold",
465
463
"q: Quit ?: Help"))
467
465
self.busname = domain + '.Mandos'
468
self.main_loop = GLib.MainLoop()
470
def client_not_found(self, key_id, address):
471
self.log_message("Client with address {} and key ID {} could"
472
" not be found".format(address, key_id))
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))
474
473
def rebuild(self):
475
474
"""This rebuilds the User Interface.
476
475
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
477
#self.uilist.append(urwid.ListBox(self.clients))
479
478
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
480
#header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
483
urwid.Divider(div_char=
485
485
if self.log_visible:
486
486
self.uilist.append(self.logbox)
487
487
self.topwidget = urwid.Pile(self.uilist)
489
489
def log_message(self, message, level=1):
490
490
"""Log message formatted with timestamp"""
491
491
if level < self.log_level:
493
493
timestamp = datetime.datetime.now().isoformat()
494
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
497
def log_message_raw(self, markup, level=1):
498
498
"""Add a log message to the log buffer."""
499
499
if level < self.log_level:
501
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if self.max_log_length:
503
if 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)-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),
506
506
coming_from="above")
509
509
def toggle_log_display(self):
510
510
"""Toggle visibility of the log buffer."""
511
511
self.log_visible = not self.log_visible
513
513
self.log_message("Log visibility changed to: {}"
514
514
.format(self.log_visible), level=0)
516
516
def change_log_display(self):
517
517
"""Change type of log display.
518
518
Currently, this toggles wrapping of text lines."""
524
524
textwidget.set_wrap_mode(self.log_wrap)
525
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
528
def find_and_remove_client(self, path, name):
529
529
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
531
This is connected to the ClientRemoved signal from the
532
532
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
534
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
537
self.log_message("Unknown client {!r} ({!r}) removed"
545
def add_new_client(self, path, ifs_and_props):
546
"""Find a client by its object path and remove it.
548
This is connected to the InterfacesAdded signal from the
549
Mandos server object.
551
if client_interface not in ifs_and_props:
552
# Not a Mandos client object; ignore
542
def add_new_client(self, path):
554
543
client_proxy_object = self.bus.get_object(self.busname, path)
555
self.add_client(MandosClientWidget(
556
server_proxy_object=self.mandos_serv,
557
proxy_object=client_proxy_object,
558
update_hook=self.refresh,
559
delete_hook=self.remove_client,
560
logger=self.log_message,
561
properties=dict(ifs_and_props[client_interface])),
544
self.add_client(MandosClientWidget(server_proxy_object
547
=client_proxy_object,
564
556
def add_client(self, client, path=None):
565
557
self.clients.append(client)
568
560
self.clients_dict[path] = client
569
561
self.clients.sort(key=lambda c: c.properties["Name"])
572
564
def remove_client(self, client, path=None):
573
565
self.clients.remove(client)
575
567
path = client.proxy.object_path
576
568
del self.clients_dict[path]
579
571
def refresh(self):
580
572
"""Redraw the screen"""
581
573
canvas = self.topwidget.render(self.size, focus=True)
582
574
self.screen.draw_screen(self.size, canvas)
585
577
"""Start the main loop and exit when it's done."""
586
578
self.bus = dbus.SystemBus()
587
579
mandos_dbus_objc = self.bus.get_object(
588
580
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
592
585
mandos_clients = (self.mandos_serv
593
586
.GetAllClientsWithProperties())
594
587
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
588
self.log_message_raw(("bold", "Note: Server has no clients."))
597
589
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
591
mandos_clients = dbus.Dictionary()
602
593
(self.mandos_serv
603
.connect_to_signal("InterfacesRemoved",
594
.connect_to_signal("ClientRemoved",
604
595
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
dbus_interface=server_interface,
606
597
byte_arrays=True))
607
598
(self.mandos_serv
608
.connect_to_signal("InterfacesAdded",
599
.connect_to_signal("ClientAdded",
609
600
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
601
dbus_interface=server_interface,
611
602
byte_arrays=True))
612
603
(self.mandos_serv
613
604
.connect_to_signal("ClientNotFound",
617
608
for path, client in mandos_clients.items():
618
609
client_proxy_object = self.bus.get_object(self.busname,
620
self.add_client(MandosClientWidget(
621
server_proxy_object=self.mandos_serv,
622
proxy_object=client_proxy_object,
624
update_hook=self.refresh,
625
delete_hook=self.remove_client,
626
logger=self.log_message),
611
self.add_client(MandosClientWidget(server_proxy_object
614
=client_proxy_object,
630
self._input_callback_tag = (
632
GLib.IOChannel.unix_new(sys.stdin.fileno()),
633
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
625
self._input_callback_tag = (gobject.io_add_watch
635
629
self.main_loop.run()
636
630
# Main loop has finished, we should close everything now
637
GLib.source_remove(self._input_callback_tag)
638
with warnings.catch_warnings():
639
warnings.simplefilter("ignore", BytesWarning)
631
gobject.source_remove(self._input_callback_tag)
643
635
self.main_loop.quit()
645
637
def process_input(self, source, condition):
646
638
keys = self.screen.get_input()
647
translations = {"ctrl n": "down", # Emacs
648
"ctrl p": "up", # Emacs
649
"ctrl v": "page down", # Emacs
650
"meta v": "page up", # Emacs
651
" ": "page down", # less
652
"f": "page down", # less
653
"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
659
651
key = translations[key]
660
652
except KeyError: # :-)
663
655
if key == "q" or key == "Q":
714
706
self.log_level = 0
715
707
self.log_message("Verbose mode: On")
716
# elif (key == "end" or key == "meta >" or key == "G"
718
# pass # xxx end-of-buffer
719
# elif (key == "home" or key == "meta <" or key == "g"
721
# pass # xxx beginning-of-buffer
722
# elif key == "ctrl e" or key == "$":
723
# pass # xxx move-end-of-line
724
# elif key == "ctrl a" or key == "^":
725
# pass # xxx move-beginning-of-line
726
# elif key == "ctrl b" or key == "meta (" or key == "h":
728
# elif key == "ctrl f" or key == "meta )" or key == "l":
731
# pass # scroll up log
733
# pass # scroll down log
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
734
726
elif self.topwidget.selectable():
735
727
self.topwidget.keypress(self.size, key)
740
731
ui = UserInterface()