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