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
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
98
dbus.PROPERTIES_IFACE,
90
self.proxy.connect_to_signal("PropertyChanged",
91
self._property_changed,
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
def properties_changed(self, interface, properties, invalidated):
109
"""This is called whenever we get a PropertiesChanged signal
110
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.
112
111
# Update properties dict with new value
113
if interface == client_interface:
114
self.properties.update(properties)
112
self.properties[property] = value
116
114
def delete(self):
117
115
self.property_changed_match.remove()
165
163
byte_arrays=True))
166
164
self.logger('Created client {}'
167
165
.format(self.properties["Name"]), level=0)
169
167
def using_timer(self, flag):
170
168
"""Call this method with True or False when timer should be
171
169
activated or deactivated.
173
171
if flag and self._update_timer_callback_tag is None:
174
172
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GLib.timeout_add
173
self._update_timer_callback_tag = (gobject.timeout_add
177
175
self.update_timer))
178
176
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
177
gobject.source_remove(self._update_timer_callback_tag)
180
178
self._update_timer_callback_tag = None
182
180
def checker_completed(self, exitstatus, condition, command):
183
181
if exitstatus == 0:
184
182
self.logger('Checker for client {} (command "{}")'
197
195
' killed by signal {}'
198
196
.format(self.properties["Name"], command,
199
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {} (command "{}") dumped'
200
' core'.format(self.properties["Name"],
203
self.logger('Checker for client {} completed'
205
.format(self.properties["Name"]))
202
208
def checker_started(self, command):
203
209
"""Server signals that a checker started."""
204
210
self.logger('Client {} started checker "{}"'
205
211
.format(self.properties["Name"],
206
212
command), level=0)
208
214
def got_secret(self):
209
215
self.logger('Client {} received its secret'
210
216
.format(self.properties["Name"]))
212
218
def need_approval(self, timeout, default):
214
220
message = 'Client {} needs approval within {} seconds'
216
222
message = 'Client {} will get its secret in {} seconds'
217
223
self.logger(message.format(self.properties["Name"],
220
226
def rejected(self, reason):
221
227
self.logger('Client {} was rejected; reason: {}'
222
228
.format(self.properties["Name"], reason))
224
230
def selectable(self):
225
231
"""Make this a "selectable" widget.
226
232
This overrides the method from urwid.FlowWidget."""
229
235
def rows(self, maxcolrow, focus=False):
230
236
"""How many rows this widget will occupy might depend on
231
237
whether we have focus or not.
232
238
This overrides the method from urwid.FlowWidget"""
233
239
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
241
def current_widget(self, focus=False):
236
242
if focus or self.opened:
237
243
return self._focus_widget
238
244
return self._widget
240
246
def update(self):
241
247
"Called when what is visible on the screen should be updated."
242
248
# 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",
249
with_standout = { "normal": "standout",
250
"bold": "bold-standout",
252
"underline-blink-standout",
253
"bold-underline-blink":
254
"bold-underline-blink-standout",
251
257
# Rebuild focus and non-focus widgets using current properties
253
259
# Base part of a client. Name!
254
260
base = '{name}: '.format(name=self.properties["Name"])
255
261
if not self.properties["Enabled"]:
256
262
message = "DISABLED"
257
263
self.using_timer(False)
258
264
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
265
timeout = datetime.timedelta(milliseconds
261
268
last_approval_request = isoformat_to_datetime(
262
269
self.properties["LastApprovalRequest"])
263
270
if last_approval_request is not None:
306
313
# Run update hook, if any
307
314
if self.update_hook is not None:
308
315
self.update_hook()
310
317
def update_timer(self):
311
"""called by GLib. Will indefinitely loop until
312
GLib.source_remove() on tag is called
318
"""called by gobject. Will indefinitely loop until
319
gobject.source_remove() on tag is called"""
315
321
return True # Keep calling this
317
323
def delete(self, **kwargs):
318
324
if self._update_timer_callback_tag is not None:
319
GLib.source_remove(self._update_timer_callback_tag)
325
gobject.source_remove(self._update_timer_callback_tag)
320
326
self._update_timer_callback_tag = None
321
327
for match in self.match_objects:
324
330
if self.delete_hook is not None:
325
331
self.delete_hook(self)
326
332
return super(MandosClientWidget, self).delete(**kwargs)
328
334
def render(self, maxcolrow, focus=False):
329
335
"""Render differently if we have focus.
330
336
This overrides the method from urwid.FlowWidget"""
331
337
return self.current_widget(focus).render(maxcolrow,
334
340
def keypress(self, maxcolrow, key):
336
342
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)
344
self.proxy.Enable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
347
self.proxy.Disable(dbus_interface = client_interface,
346
350
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
351
dbus_interface = client_interface,
348
352
ignore_reply=True)
350
354
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
355
dbus_interface = client_interface,
352
356
ignore_reply=True)
353
357
elif key == "R" or key == "_" or key == "ctrl k":
354
358
self.server_proxy_object.RemoveClient(self.proxy
356
360
ignore_reply=True)
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
362
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)
365
self.proxy.StopChecker(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
368
self.proxy.CheckedOK(dbus_interface = client_interface,
367
369
ignore_reply=True)
369
371
# elif key == "p" or key == "=":
378
def properties_changed(self, interface, properties, invalidated):
379
"""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.
380
382
This overrides the method from MandosClientPropertyCache"""
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
383
super(MandosClientWidget, self).properties_changed(
384
interface, properties, invalidated)
385
if any(old_values[key] != self.properties.get(key)
386
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:
393
394
use them as an excuse to shift focus away from this widget.
395
396
def keypress(self, *args, **kwargs):
396
ret = (super(ConstrainedListBox, self)
397
.keypress(*args, **kwargs))
397
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
398
398
if ret in ("up", "down"):
407
407
def __init__(self, max_log_length=1000, log_level=1):
408
408
DBusGMainLoop(set_as_default=True)
410
410
self.screen = urwid.curses_display.Screen()
412
412
self.screen.register_palette((
414
414
"default", "default", None),
420
420
"standout", "default", "standout"),
421
421
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
422
"bold,underline,blink", "default", "bold,underline,blink"),
424
423
("bold-standout",
425
424
"bold,standout", "default", "bold,standout"),
426
425
("underline-blink-standout",
430
429
"bold,underline,blink,standout", "default",
431
430
"bold,underline,blink,standout"),
434
433
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
434
self.divider = "─" # \u2500
435
#self.divider = "━" # \u2501
437
self.divider = "_" # \u005f
437
#self.divider = "-" # \u002d
438
self.divider = "_" # \u005f
439
440
self.screen.start()
441
442
self.size = self.screen.get_cols_rows()
443
444
self.clients = urwid.SimpleListWalker([])
444
445
self.clients_dict = {}
446
447
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
449
self.max_log_length = max_log_length
450
451
self.log_level = log_level
452
453
# We keep a reference to the log widget so we can remove it
453
454
# from the ListWalker without it getting destroyed
454
455
self.logbox = ConstrainedListBox(self.log)
456
457
# This keeps track of whether self.uilist currently has
457
458
# self.logbox in it or not
458
459
self.log_visible = True
459
460
self.log_wrap = "any"
462
463
self.log_message_raw(("bold",
463
464
"Mandos Monitor version " + version))
464
465
self.log_message_raw(("bold",
465
466
"q: Quit ?: Help"))
467
468
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))
469
self.main_loop = gobject.MainLoop()
471
def client_not_found(self, fingerprint, address):
472
self.log_message("Client with address {} and fingerprint {}"
473
" could not be found"
474
.format(address, fingerprint))
474
476
def rebuild(self):
475
477
"""This rebuilds the User Interface.
476
478
Call this when the widget layout needs to change"""
478
# self.uilist.append(urwid.ListBox(self.clients))
480
#self.uilist.append(urwid.ListBox(self.clients))
479
481
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
# header=urwid.Divider(),
483
#header=urwid.Divider(),
483
footer=urwid.Divider(
484
div_char=self.divider)))
486
urwid.Divider(div_char=
485
488
if self.log_visible:
486
489
self.uilist.append(self.logbox)
487
490
self.topwidget = urwid.Pile(self.uilist)
489
492
def log_message(self, message, level=1):
490
493
"""Log message formatted with timestamp"""
491
494
if level < self.log_level:
493
496
timestamp = datetime.datetime.now().isoformat()
494
497
self.log_message_raw("{}: {}".format(timestamp, message),
497
500
def log_message_raw(self, markup, level=1):
498
501
"""Add a log message to the log buffer."""
499
502
if level < self.log_level:
501
504
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,
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),
506
509
coming_from="above")
509
512
def toggle_log_display(self):
510
513
"""Toggle visibility of the log buffer."""
511
514
self.log_visible = not self.log_visible
513
516
self.log_message("Log visibility changed to: {}"
514
517
.format(self.log_visible), level=0)
516
519
def change_log_display(self):
517
520
"""Change type of log display.
518
521
Currently, this toggles wrapping of text lines."""
524
527
textwidget.set_wrap_mode(self.log_wrap)
525
528
self.log_message("Wrap mode: {}".format(self.log_wrap),
528
def find_and_remove_client(self, path, interfaces):
531
def find_and_remove_client(self, path, name):
529
532
"""Find a client by its object path and remove it.
531
This is connected to the InterfacesRemoved signal from the
534
This is connected to the ClientRemoved signal from the
532
535
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
537
537
client = self.clients_dict[path]
540
self.log_message("Unknown client {!r} removed"
540
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
545
def add_new_client(self, path):
554
546
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])),
547
self.add_client(MandosClientWidget(server_proxy_object
550
=client_proxy_object,
564
559
def add_client(self, client, path=None):
565
560
self.clients.append(client)
568
563
self.clients_dict[path] = client
569
564
self.clients.sort(key=lambda c: c.properties["Name"])
572
567
def remove_client(self, client, path=None):
573
568
self.clients.remove(client)
575
570
path = client.proxy.object_path
576
571
del self.clients_dict[path]
579
574
def refresh(self):
580
575
"""Redraw the screen"""
581
576
canvas = self.topwidget.render(self.size, focus=True)
582
577
self.screen.draw_screen(self.size, canvas)
585
580
"""Start the main loop and exit when it's done."""
586
581
self.bus = dbus.SystemBus()
587
582
mandos_dbus_objc = self.bus.get_object(
588
583
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
584
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
592
588
mandos_clients = (self.mandos_serv
593
589
.GetAllClientsWithProperties())
594
590
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
591
self.log_message_raw(("bold", "Note: Server has no clients."))
597
592
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
593
self.log_message_raw(("bold", "Note: No Mandos server running."))
600
594
mandos_clients = dbus.Dictionary()
602
596
(self.mandos_serv
603
.connect_to_signal("InterfacesRemoved",
597
.connect_to_signal("ClientRemoved",
604
598
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
599
dbus_interface=server_interface,
606
600
byte_arrays=True))
607
601
(self.mandos_serv
608
.connect_to_signal("InterfacesAdded",
602
.connect_to_signal("ClientAdded",
609
603
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
604
dbus_interface=server_interface,
611
605
byte_arrays=True))
612
606
(self.mandos_serv
613
607
.connect_to_signal("ClientNotFound",
617
611
for path, client in mandos_clients.items():
618
612
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),
614
self.add_client(MandosClientWidget(server_proxy_object
617
=client_proxy_object,
630
self._input_callback_tag = (
632
GLib.IOChannel.unix_new(sys.stdin.fileno()),
633
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
628
self._input_callback_tag = (gobject.io_add_watch
635
632
self.main_loop.run()
636
633
# 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)
634
gobject.source_remove(self._input_callback_tag)
643
638
self.main_loop.quit()
645
640
def process_input(self, source, condition):
646
641
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
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
659
654
key = translations[key]
660
655
except KeyError: # :-)
663
658
if key == "q" or key == "Q":
714
709
self.log_level = 0
715
710
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
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
734
729
elif self.topwidget.selectable():
735
730
self.topwidget.keypress(self.size, key)
740
734
ui = UserInterface()