2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
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
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
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
19
# GNU General Public License for more details.
19
21
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
24
# Contact the authors at <mandos@recompile.se>.
26
27
from __future__ import (division, absolute_import, print_function,
41
42
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
43
from gi.repository import GLib
51
51
if sys.version_info.major == 2:
54
54
locale.setlocale(locale.LC_ALL, '')
57
56
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
59
58
# Some useful constants
60
59
domain = 'se.recompile'
61
60
server_interface = domain + '.Mandos'
62
61
client_interface = domain + '.Mandos.Client'
65
dbus.OBJECT_MANAGER_IFACE
66
except AttributeError:
67
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
65
70
def isoformat_to_datetime(iso):
66
71
"Parse an ISO 8601 date string to a datetime.datetime()"
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
83
int(second), # Whole seconds
84
int(fraction*1000000)) # Microseconds
81
87
class MandosClientPropertyCache(object):
82
88
"""This wraps a Mandos Client D-Bus proxy object, caches the
86
92
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
93
self.proxy = proxy_object # Mandos Client proxy object
88
94
self.properties = dict() if properties is None else properties
89
95
self.property_changed_match = (
90
96
self.proxy.connect_to_signal("PropertiesChanged",
91
97
self.properties_changed,
92
98
dbus.PROPERTIES_IFACE,
95
101
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
101
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
108
def properties_changed(self, interface, properties, invalidated):
104
109
"""This is called whenever we get a PropertiesChanged signal
105
110
It updates the changed properties in the "properties" dict.
107
112
# Update properties dict with new value
108
self.properties.update(properties)
113
if interface == client_interface:
114
self.properties.update(properties)
110
116
def delete(self):
111
117
self.property_changed_match.remove()
114
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
115
121
"""A Mandos Client which is visible on the screen.
118
124
def __init__(self, server_proxy_object=None, update_hook=None,
119
125
delete_hook=None, logger=None, **kwargs):
120
126
# Called on update
159
165
byte_arrays=True))
160
166
self.logger('Created client {}'
161
167
.format(self.properties["Name"]), level=0)
163
169
def using_timer(self, flag):
164
170
"""Call this method with True or False when timer should be
165
171
activated or deactivated.
167
173
if flag and self._update_timer_callback_tag is None:
168
174
# Will update the shown timer value every second
169
self._update_timer_callback_tag = (gobject.timeout_add
175
self._update_timer_callback_tag = (GLib.timeout_add
171
177
self.update_timer))
172
178
elif not (flag or self._update_timer_callback_tag is None):
173
gobject.source_remove(self._update_timer_callback_tag)
179
GLib.source_remove(self._update_timer_callback_tag)
174
180
self._update_timer_callback_tag = None
176
def checker_completed(self, exitstatus, signal, command):
182
def checker_completed(self, exitstatus, condition, command):
177
183
if exitstatus == 0:
178
184
self.logger('Checker for client {} (command "{}")'
179
185
' succeeded'.format(self.properties["Name"],
190
if os.WIFEXITED(condition):
185
191
self.logger('Checker for client {} (command "{}") failed'
186
192
' with exit code {}'
187
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
195
elif os.WIFSIGNALED(condition):
190
196
self.logger('Checker for client {} (command "{}") was'
191
197
' killed by signal {}'
192
198
.format(self.properties["Name"], command,
195
self.logger('Checker for client {} completed'
197
.format(self.properties["Name"]))
199
os.WTERMSIG(condition)))
200
202
def checker_started(self, command):
201
203
"""Server signals that a checker started."""
202
204
self.logger('Client {} started checker "{}"'
203
205
.format(self.properties["Name"],
204
206
command), level=0)
206
208
def got_secret(self):
207
209
self.logger('Client {} received its secret'
208
210
.format(self.properties["Name"]))
210
212
def need_approval(self, timeout, default):
212
214
message = 'Client {} needs approval within {} seconds'
214
216
message = 'Client {} will get its secret in {} seconds'
215
217
self.logger(message.format(self.properties["Name"],
218
220
def rejected(self, reason):
219
221
self.logger('Client {} was rejected; reason: {}'
220
222
.format(self.properties["Name"], reason))
222
224
def selectable(self):
223
225
"""Make this a "selectable" widget.
224
226
This overrides the method from urwid.FlowWidget."""
227
229
def rows(self, maxcolrow, focus=False):
228
230
"""How many rows this widget will occupy might depend on
229
231
whether we have focus or not.
230
232
This overrides the method from urwid.FlowWidget"""
231
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
233
235
def current_widget(self, focus=False):
234
236
if focus or self.opened:
235
237
return self._focus_widget
236
238
return self._widget
238
240
def update(self):
239
241
"Called when what is visible on the screen should be updated."
240
242
# 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",
243
with_standout = {"normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
249
251
# Rebuild focus and non-focus widgets using current properties
251
253
# Base part of a client. Name!
252
254
base = '{name}: '.format(name=self.properties["Name"])
253
255
if not self.properties["Enabled"]:
254
256
message = "DISABLED"
255
257
self.using_timer(False)
256
258
elif self.properties["ApprovalPending"]:
257
timeout = datetime.timedelta(milliseconds
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
260
261
last_approval_request = isoformat_to_datetime(
261
262
self.properties["LastApprovalRequest"])
262
263
if last_approval_request is not None:
305
306
# Run update hook, if any
306
307
if self.update_hook is not None:
307
308
self.update_hook()
309
310
def update_timer(self):
310
"""called by gobject. Will indefinitely loop until
311
gobject.source_remove() on tag is called"""
311
"""called by GLib. Will indefinitely loop until
312
GLib.source_remove() on tag is called
313
315
return True # Keep calling this
315
317
def delete(self, **kwargs):
316
318
if self._update_timer_callback_tag is not None:
317
gobject.source_remove(self._update_timer_callback_tag)
319
GLib.source_remove(self._update_timer_callback_tag)
318
320
self._update_timer_callback_tag = None
319
321
for match in self.match_objects:
322
324
if self.delete_hook is not None:
323
325
self.delete_hook(self)
324
326
return super(MandosClientWidget, self).delete(**kwargs)
326
328
def render(self, maxcolrow, focus=False):
327
329
"""Render differently if we have focus.
328
330
This overrides the method from urwid.FlowWidget"""
329
331
return self.current_widget(focus).render(maxcolrow,
332
334
def keypress(self, maxcolrow, key):
334
336
This overrides the method from urwid.FlowWidget"""
336
self.proxy.Enable(dbus_interface = client_interface,
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply=True,
340
dbus_interface=dbus.PROPERTIES_IFACE)
339
self.proxy.Disable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
342
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
dbus_interface = client_interface,
347
dbus_interface=client_interface,
344
348
ignore_reply=True)
346
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
dbus_interface = client_interface,
351
dbus_interface=client_interface,
348
352
ignore_reply=True)
349
353
elif key == "R" or key == "_" or key == "ctrl k":
350
354
self.server_proxy_object.RemoveClient(self.proxy
352
356
ignore_reply=True)
354
self.proxy.StartChecker(dbus_interface = client_interface,
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
357
self.proxy.StopChecker(dbus_interface = client_interface,
362
self.proxy.Set(client_interface, "CheckerRunning",
363
dbus.Boolean(False), ignore_reply=True,
364
dbus_interface=dbus.PROPERTIES_IFACE)
360
self.proxy.CheckedOK(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
361
367
ignore_reply=True)
363
369
# elif key == "p" or key == "=":
372
378
def properties_changed(self, interface, properties, invalidated):
373
379
"""Call self.update() if any properties changed.
374
380
This overrides the method from MandosClientPropertyCache"""
375
old_values = { key: self.properties.get(key)
376
for key in properties.keys() }
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
377
383
super(MandosClientWidget, self).properties_changed(
378
384
interface, properties, invalidated)
379
385
if any(old_values[key] != self.properties.get(key)
387
393
use them as an excuse to shift focus away from this widget.
389
395
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
396
ret = (super(ConstrainedListBox, self)
397
.keypress(*args, **kwargs))
391
398
if ret in ("up", "down"):
400
407
def __init__(self, max_log_length=1000, log_level=1):
401
408
DBusGMainLoop(set_as_default=True)
403
410
self.screen = urwid.curses_display.Screen()
405
412
self.screen.register_palette((
407
414
"default", "default", None),
413
420
"standout", "default", "standout"),
414
421
("bold-underline-blink",
415
"bold,underline,blink", "default", "bold,underline,blink"),
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
416
424
("bold-standout",
417
425
"bold,standout", "default", "bold,standout"),
418
426
("underline-blink-standout",
422
430
"bold,underline,blink,standout", "default",
423
431
"bold,underline,blink,standout"),
426
434
if urwid.supports_unicode():
427
self.divider = "─" # \u2500
428
#self.divider = "━" # \u2501
435
self.divider = "─" # \u2500
430
#self.divider = "-" # \u002d
431
self.divider = "_" # \u005f
437
self.divider = "_" # \u005f
433
439
self.screen.start()
435
441
self.size = self.screen.get_cols_rows()
437
443
self.clients = urwid.SimpleListWalker([])
438
444
self.clients_dict = {}
440
446
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
442
448
self.max_log_length = max_log_length
444
450
self.log_level = log_level
446
452
# We keep a reference to the log widget so we can remove it
447
453
# from the ListWalker without it getting destroyed
448
454
self.logbox = ConstrainedListBox(self.log)
450
456
# This keeps track of whether self.uilist currently has
451
457
# self.logbox in it or not
452
458
self.log_visible = True
453
459
self.log_wrap = "any"
456
462
self.log_message_raw(("bold",
457
463
"Mandos Monitor version " + version))
458
464
self.log_message_raw(("bold",
459
465
"q: Quit ?: Help"))
461
467
self.busname = domain + '.Mandos'
462
self.main_loop = gobject.MainLoop()
468
self.main_loop = GLib.MainLoop()
464
470
def client_not_found(self, fingerprint, address):
465
471
self.log_message("Client with address {} and fingerprint {}"
466
472
" could not be found"
467
473
.format(address, fingerprint))
469
475
def rebuild(self):
470
476
"""This rebuilds the User Interface.
471
477
Call this when the widget layout needs to change"""
473
#self.uilist.append(urwid.ListBox(self.clients))
479
# self.uilist.append(urwid.ListBox(self.clients))
474
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
476
#header=urwid.Divider(),
482
# header=urwid.Divider(),
479
urwid.Divider(div_char=
484
footer=urwid.Divider(
485
div_char=self.divider)))
481
486
if self.log_visible:
482
487
self.uilist.append(self.logbox)
483
488
self.topwidget = urwid.Pile(self.uilist)
485
490
def log_message(self, message, level=1):
486
491
"""Log message formatted with timestamp"""
487
492
if level < self.log_level:
489
494
timestamp = datetime.datetime.now().isoformat()
490
495
self.log_message_raw("{}: {}".format(timestamp, message),
493
498
def log_message_raw(self, markup, level=1):
494
499
"""Add a log message to the log buffer."""
495
500
if level < self.log_level:
497
502
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
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),
503
if self.max_log_length:
504
if len(self.log) > self.max_log_length:
505
del self.log[0:len(self.log)-self.max_log_length-1]
506
self.logbox.set_focus(len(self.logbox.body.contents)-1,
502
507
coming_from="above")
505
510
def toggle_log_display(self):
506
511
"""Toggle visibility of the log buffer."""
507
512
self.log_visible = not self.log_visible
509
514
self.log_message("Log visibility changed to: {}"
510
515
.format(self.log_visible), level=0)
512
517
def change_log_display(self):
513
518
"""Change type of log display.
514
519
Currently, this toggles wrapping of text lines."""
520
525
textwidget.set_wrap_mode(self.log_wrap)
521
526
self.log_message("Wrap mode: {}".format(self.log_wrap),
524
def find_and_remove_client(self, path, name):
529
def find_and_remove_client(self, path, interfaces):
525
530
"""Find a client by its object path and remove it.
527
This is connected to the ClientRemoved signal from the
532
This is connected to the InterfacesRemoved signal from the
528
533
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
530
538
client = self.clients_dict[path]
533
self.log_message("Unknown client {!r} ({!r}) removed"
541
self.log_message("Unknown client {!r} removed"
538
def add_new_client(self, path):
546
def add_new_client(self, path, ifs_and_props):
547
"""Find a client by its object path and remove it.
549
This is connected to the InterfacesAdded signal from the
550
Mandos server object.
552
if client_interface not in ifs_and_props:
553
# Not a Mandos client object; ignore
539
555
client_proxy_object = self.bus.get_object(self.busname, path)
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
556
self.add_client(MandosClientWidget(
557
server_proxy_object=self.mandos_serv,
558
proxy_object=client_proxy_object,
559
update_hook=self.refresh,
560
delete_hook=self.remove_client,
561
logger=self.log_message,
562
properties=dict(ifs_and_props[client_interface])),
552
565
def add_client(self, client, path=None):
553
566
self.clients.append(client)
556
569
self.clients_dict[path] = client
557
570
self.clients.sort(key=lambda c: c.properties["Name"])
560
573
def remove_client(self, client, path=None):
561
574
self.clients.remove(client)
563
576
path = client.proxy.object_path
564
577
del self.clients_dict[path]
567
580
def refresh(self):
568
581
"""Redraw the screen"""
569
582
canvas = self.topwidget.render(self.size, focus=True)
570
583
self.screen.draw_screen(self.size, canvas)
573
586
"""Start the main loop and exit when it's done."""
574
587
self.bus = dbus.SystemBus()
575
588
mandos_dbus_objc = self.bus.get_object(
576
589
self.busname, "/", follow_name_owner_changes=True)
577
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
581
593
mandos_clients = (self.mandos_serv
582
594
.GetAllClientsWithProperties())
583
595
if not mandos_clients:
584
self.log_message_raw(("bold", "Note: Server has no clients."))
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
585
598
except dbus.exceptions.DBusException:
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
587
601
mandos_clients = dbus.Dictionary()
589
603
(self.mandos_serv
590
.connect_to_signal("ClientRemoved",
604
.connect_to_signal("InterfacesRemoved",
591
605
self.find_and_remove_client,
592
dbus_interface=server_interface,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
593
607
byte_arrays=True))
594
608
(self.mandos_serv
595
.connect_to_signal("ClientAdded",
609
.connect_to_signal("InterfacesAdded",
596
610
self.add_new_client,
597
dbus_interface=server_interface,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
598
612
byte_arrays=True))
599
613
(self.mandos_serv
600
614
.connect_to_signal("ClientNotFound",
604
618
for path, client in mandos_clients.items():
605
619
client_proxy_object = self.bus.get_object(self.busname,
607
self.add_client(MandosClientWidget(server_proxy_object
610
=client_proxy_object,
621
self.add_client(MandosClientWidget(
622
server_proxy_object=self.mandos_serv,
623
proxy_object=client_proxy_object,
625
update_hook=self.refresh,
626
delete_hook=self.remove_client,
627
logger=self.log_message),
621
self._input_callback_tag = (gobject.io_add_watch
631
self._input_callback_tag = (GLib.io_add_watch
622
632
(sys.stdin.fileno(),
624
634
self.process_input))
625
635
self.main_loop.run()
626
636
# Main loop has finished, we should close everything now
627
gobject.source_remove(self._input_callback_tag)
637
GLib.source_remove(self._input_callback_tag)
628
638
self.screen.stop()
631
641
self.main_loop.quit()
633
643
def process_input(self, source, condition):
634
644
keys = self.screen.get_input()
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
645
translations = {"ctrl n": "down", # Emacs
646
"ctrl p": "up", # Emacs
647
"ctrl v": "page down", # Emacs
648
"meta v": "page up", # Emacs
649
" ": "page down", # less
650
"f": "page down", # less
651
"b": "page up", # less
647
657
key = translations[key]
648
658
except KeyError: # :-)
651
661
if key == "q" or key == "Q":
702
712
self.log_level = 0
703
713
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
714
# elif (key == "end" or key == "meta >" or key == "G"
716
# pass # xxx end-of-buffer
717
# elif (key == "home" or key == "meta <" or key == "g"
719
# pass # xxx beginning-of-buffer
720
# elif key == "ctrl e" or key == "$":
721
# pass # xxx move-end-of-line
722
# elif key == "ctrl a" or key == "^":
723
# pass # xxx move-beginning-of-line
724
# elif key == "ctrl b" or key == "meta (" or key == "h":
726
# elif key == "ctrl f" or key == "meta )" or key == "l":
729
# pass # scroll up log
731
# pass # scroll down log
722
732
elif self.topwidget.selectable():
723
733
self.topwidget.keypress(self.size, key)
727
738
ui = UserInterface()
added
removed
mandos-monitor
