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