2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 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-2018 Teddy Hogeborn
7
# Copyright © 2009-2018 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 <http://www.gnu.org/licenses/>.
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
22
24
# Contact the authors at <mandos@recompile.se>.
25
27
from __future__ import (division, absolute_import, print_function,
30
from future_builtins import *
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
83
89
properties and calls a hook function when any of them are
86
def __init__(self, proxy_object=None, *args, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
89
self.properties = dict()
92
def __init__(self, proxy_object=None, properties=None, **kwargs):
93
self.proxy = proxy_object # Mandos Client proxy object
94
self.properties = dict() if properties is None else properties
90
95
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
96
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
98
dbus.PROPERTIES_IFACE,
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
104
def property_changed(self, property=None, value=None):
105
"""This is called whenever we get a PropertyChanged signal
106
It updates the changed property in the "properties" dict.
101
if properties is None:
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
106
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.
108
112
# Update properties dict with new value
109
self.properties[property] = value
111
def delete(self, *args, **kwargs):
113
if interface == client_interface:
114
self.properties.update(properties)
112
117
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
117
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
118
121
"""A Mandos Client which is visible on the screen.
121
124
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, *args, **kwargs):
125
delete_hook=None, logger=None, **kwargs):
123
126
# Called on update
124
127
self.update_hook = update_hook
125
128
# Called on delete
183
164
client_interface,
184
165
byte_arrays=True))
185
#self.logger('Created client %s' % (self.properties["Name"]))
187
def property_changed(self, property=None, value=None):
188
super(self, MandosClientWidget).property_changed(property,
190
if property == "ApprovalPending":
191
using_timer(bool(value))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
193
169
def using_timer(self, flag):
194
170
"""Call this method with True or False when timer should be
195
171
activated or deactivated.
197
old = self._update_timer_callback_lock
199
self._update_timer_callback_lock += 1
201
self._update_timer_callback_lock -= 1
202
if old == 0 and self._update_timer_callback_lock:
173
if flag and self._update_timer_callback_tag is None:
203
174
# Will update the shown timer value every second
204
self._update_timer_callback_tag = (gobject.timeout_add
175
self._update_timer_callback_tag = (GLib.timeout_add
206
177
self.update_timer))
207
elif old and self._update_timer_callback_lock == 0:
208
gobject.source_remove(self._update_timer_callback_tag)
178
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
209
180
self._update_timer_callback_tag = None
211
182
def checker_completed(self, exitstatus, condition, command):
212
183
if exitstatus == 0:
213
if self.last_checker_failed:
214
self.last_checker_failed = False
215
self.using_timer(False)
216
#self.logger('Checker for client %s (command "%s")'
218
# % (self.properties["Name"], command))
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
222
if not self.last_checker_failed:
223
self.last_checker_failed = True
224
self.using_timer(True)
225
190
if os.WIFEXITED(condition):
226
self.logger('Checker for client %s (command "%s")'
227
' failed with exit code %s'
228
% (self.properties["Name"], command,
229
os.WEXITSTATUS(condition)))
191
self.logger('Checker for client {} (command "{}") failed'
193
.format(self.properties["Name"], command,
194
os.WEXITSTATUS(condition)))
230
195
elif os.WIFSIGNALED(condition):
231
self.logger('Checker for client %s (command "%s")'
232
' was killed by signal %s'
233
% (self.properties["Name"], command,
234
os.WTERMSIG(condition)))
235
elif os.WCOREDUMP(condition):
236
self.logger('Checker for client %s (command "%s")'
238
% (self.properties["Name"], command))
240
self.logger('Checker for client %s completed'
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
198
.format(self.properties["Name"], command,
199
os.WTERMSIG(condition)))
244
202
def checker_started(self, command):
245
"""Server signals that a checker started. This could be useful
246
to log in the future. """
247
#self.logger('Client %s started checker "%s"'
248
# % (self.properties["Name"], unicode(command)))
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
251
208
def got_secret(self):
252
self.last_checker_failed = False
253
self.logger('Client %s received its secret'
254
% self.properties["Name"])
209
self.logger('Client {} received its secret'
210
.format(self.properties["Name"]))
256
212
def need_approval(self, timeout, default):
258
message = 'Client %s needs approval within %s seconds'
214
message = 'Client {} needs approval within {} seconds'
260
message = 'Client %s will get its secret in %s seconds'
262
% (self.properties["Name"], timeout/1000))
263
self.using_timer(True)
216
message = 'Client {} will get its secret in {} seconds'
217
self.logger(message.format(self.properties["Name"],
265
220
def rejected(self, reason):
266
self.logger('Client %s was rejected; reason: %s'
267
% (self.properties["Name"], reason))
221
self.logger('Client {} was rejected; reason: {}'
222
.format(self.properties["Name"], reason))
269
224
def selectable(self):
270
225
"""Make this a "selectable" widget.
271
226
This overrides the method from urwid.FlowWidget."""
274
229
def rows(self, maxcolrow, focus=False):
275
230
"""How many rows this widget will occupy might depend on
276
231
whether we have focus or not.
277
232
This overrides the method from urwid.FlowWidget"""
278
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
280
235
def current_widget(self, focus=False):
281
236
if focus or self.opened:
282
237
return self._focus_widget
283
238
return self._widget
285
240
def update(self):
286
241
"Called when what is visible on the screen should be updated."
287
242
# How to add standout mode to a style
288
with_standout = { "normal": "standout",
289
"bold": "bold-standout",
291
"underline-blink-standout",
292
"bold-underline-blink":
293
"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",
296
251
# Rebuild focus and non-focus widgets using current properties
298
253
# Base part of a client. Name!
300
% {"name": self.properties["Name"]})
254
base = '{name}: '.format(name=self.properties["Name"])
301
255
if not self.properties["Enabled"]:
302
256
message = "DISABLED"
257
self.using_timer(False)
303
258
elif self.properties["ApprovalPending"]:
304
timeout = datetime.timedelta(milliseconds
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
307
261
last_approval_request = isoformat_to_datetime(
308
262
self.properties["LastApprovalRequest"])
309
263
if last_approval_request is not None:
310
timer = timeout - (datetime.datetime.utcnow()
311
- last_approval_request)
264
timer = max(timeout - (datetime.datetime.utcnow()
265
- last_approval_request),
266
datetime.timedelta())
313
268
timer = datetime.timedelta()
314
269
if self.properties["ApprovedByDefault"]:
315
message = "Approval in %s. (d)eny?"
270
message = "Approval in {}. (d)eny?"
317
message = "Denial in %s. (a)pprove?"
318
message = message % unicode(timer).rsplit(".", 1)[0]
319
elif self.last_checker_failed:
320
# When checker has failed, print a timer until client expires
272
message = "Denial in {}. (a)pprove?"
273
message = message.format(str(timer).rsplit(".", 1)[0])
274
self.using_timer(True)
275
elif self.properties["LastCheckerStatus"] != 0:
276
# When checker has failed, show timer until client expires
321
277
expires = self.properties["Expires"]
322
278
if expires == "":
323
279
timer = datetime.timedelta(0)
325
expires = datetime.datetime.strptime(expires,
326
'%Y-%m-%dT%H:%M:%S.%f')
327
timer = expires - datetime.datetime.utcnow()
281
expires = (datetime.datetime.strptime
282
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
283
timer = max(expires - datetime.datetime.utcnow(),
284
datetime.timedelta())
328
285
message = ('A checker has failed! Time until client'
330
% unicode(timer).rsplit(".", 1)[0])
287
.format(str(timer).rsplit(".", 1)[0]))
288
self.using_timer(True)
332
290
message = "enabled"
333
self._text = "%s%s" % (base, message)
291
self.using_timer(False)
292
self._text = "{}{}".format(base, message)
335
294
if not urwid.supports_unicode():
336
295
self._text = self._text.encode("ascii", "replace")
337
296
textlist = [("normal", self._text)]
347
306
# Run update hook, if any
348
307
if self.update_hook is not None:
349
308
self.update_hook()
351
310
def update_timer(self):
352
"""called by gobject. Will indefinitely loop until
353
gobject.source_remove() on tag is called"""
311
"""called by GLib. Will indefinitely loop until
312
GLib.source_remove() on tag is called
355
315
return True # Keep calling this
357
def delete(self, *args, **kwargs):
317
def delete(self, **kwargs):
358
318
if self._update_timer_callback_tag is not None:
359
gobject.source_remove(self._update_timer_callback_tag)
319
GLib.source_remove(self._update_timer_callback_tag)
360
320
self._update_timer_callback_tag = None
361
321
for match in self.match_objects:
363
323
self.match_objects = ()
364
324
if self.delete_hook is not None:
365
325
self.delete_hook(self)
366
return super(MandosClientWidget, self).delete(*args, **kwargs)
326
return super(MandosClientWidget, self).delete(**kwargs)
368
328
def render(self, maxcolrow, focus=False):
369
329
"""Render differently if we have focus.
370
330
This overrides the method from urwid.FlowWidget"""
371
331
return self.current_widget(focus).render(maxcolrow,
374
334
def keypress(self, maxcolrow, key):
376
336
This overrides the method from urwid.FlowWidget"""
378
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)
381
self.proxy.Disable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
384
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
385
dbus_interface = client_interface,
347
dbus_interface=client_interface,
386
348
ignore_reply=True)
388
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
389
dbus_interface = client_interface,
351
dbus_interface=client_interface,
390
352
ignore_reply=True)
391
353
elif key == "R" or key == "_" or key == "ctrl k":
392
354
self.server_proxy_object.RemoveClient(self.proxy
394
356
ignore_reply=True)
396
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)
399
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)
402
self.proxy.CheckedOK(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
403
367
ignore_reply=True)
405
369
# elif key == "p" or key == "=":
439
404
"""This is the entire user interface - the whole screen
440
405
with boxes, lists of client widgets, etc.
442
def __init__(self, max_log_length=1000):
407
def __init__(self, max_log_length=1000, log_level=1):
443
408
DBusGMainLoop(set_as_default=True)
445
410
self.screen = urwid.curses_display.Screen()
447
412
self.screen.register_palette((
449
414
"default", "default", None),
451
"default", "default", "bold"),
416
"bold", "default", "bold"),
452
417
("underline-blink",
453
"default", "default", "underline"),
418
"underline,blink", "default", "underline,blink"),
455
"default", "default", "standout"),
420
"standout", "default", "standout"),
456
421
("bold-underline-blink",
457
"default", "default", ("bold", "underline")),
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
458
424
("bold-standout",
459
"default", "default", ("bold", "standout")),
425
"bold,standout", "default", "bold,standout"),
460
426
("underline-blink-standout",
461
"default", "default", ("underline", "standout")),
427
"underline,blink,standout", "default",
428
"underline,blink,standout"),
462
429
("bold-underline-blink-standout",
463
"default", "default", ("bold", "underline",
430
"bold,underline,blink,standout", "default",
431
"bold,underline,blink,standout"),
467
434
if urwid.supports_unicode():
468
self.divider = "─" # \u2500
469
#self.divider = "━" # \u2501
435
self.divider = "─" # \u2500
471
#self.divider = "-" # \u002d
472
self.divider = "_" # \u005f
437
self.divider = "_" # \u005f
474
439
self.screen.start()
476
441
self.size = self.screen.get_cols_rows()
478
443
self.clients = urwid.SimpleListWalker([])
479
444
self.clients_dict = {}
481
446
# We will add Text widgets to this list
483
448
self.max_log_length = max_log_length
450
self.log_level = log_level
485
452
# We keep a reference to the log widget so we can remove it
486
453
# from the ListWalker without it getting destroyed
487
454
self.logbox = ConstrainedListBox(self.log)
489
456
# This keeps track of whether self.uilist currently has
490
457
# self.logbox in it or not
491
458
self.log_visible = True
492
459
self.log_wrap = "any"
495
462
self.log_message_raw(("bold",
496
463
"Mandos Monitor version " + version))
497
464
self.log_message_raw(("bold",
498
465
"q: Quit ?: Help"))
500
467
self.busname = domain + '.Mandos'
501
self.main_loop = gobject.MainLoop()
468
self.main_loop = GLib.MainLoop()
503
470
def client_not_found(self, fingerprint, address):
504
self.log_message(("Client with address %s and fingerprint %s"
505
" could not be found" % (address,
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
473
.format(address, fingerprint))
508
475
def rebuild(self):
509
476
"""This rebuilds the User Interface.
510
477
Call this when the widget layout needs to change"""
512
#self.uilist.append(urwid.ListBox(self.clients))
479
# self.uilist.append(urwid.ListBox(self.clients))
513
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
515
#header=urwid.Divider(),
482
# header=urwid.Divider(),
518
urwid.Divider(div_char=
484
footer=urwid.Divider(
485
div_char=self.divider)))
520
486
if self.log_visible:
521
487
self.uilist.append(self.logbox)
522
488
self.topwidget = urwid.Pile(self.uilist)
524
def log_message(self, message):
490
def log_message(self, message, level=1):
491
"""Log message formatted with timestamp"""
492
if level < self.log_level:
525
494
timestamp = datetime.datetime.now().isoformat()
526
self.log_message_raw(timestamp + ": " + message)
528
def log_message_raw(self, markup):
495
self.log_message_raw("{}: {}".format(timestamp, message),
498
def log_message_raw(self, markup, level=1):
529
499
"""Add a log message to the log buffer."""
500
if level < self.log_level:
530
502
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
531
if (self.max_log_length
532
and len(self.log) > self.max_log_length):
533
del self.log[0:len(self.log)-self.max_log_length-1]
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]
534
506
self.logbox.set_focus(len(self.logbox.body.contents),
535
507
coming_from="above")
538
510
def toggle_log_display(self):
539
511
"""Toggle visibility of the log buffer."""
540
512
self.log_visible = not self.log_visible
542
#self.log_message("Log visibility changed to: "
543
# + unicode(self.log_visible))
514
self.log_message("Log visibility changed to: {}"
515
.format(self.log_visible), level=0)
545
517
def change_log_display(self):
546
518
"""Change type of log display.
547
519
Currently, this toggles wrapping of text lines."""
551
523
self.log_wrap = "clip"
552
524
for textwidget in self.log:
553
525
textwidget.set_wrap_mode(self.log_wrap)
554
#self.log_message("Wrap mode: " + self.log_wrap)
556
def find_and_remove_client(self, path, name):
526
self.log_message("Wrap mode: {}".format(self.log_wrap),
529
def find_and_remove_client(self, path, interfaces):
557
530
"""Find a client by its object path and remove it.
559
This is connected to the ClientRemoved signal from the
532
This is connected to the InterfacesRemoved signal from the
560
533
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
562
538
client = self.clients_dict[path]
565
self.log_message("Unknown client %r (%r) removed", name,
541
self.log_message("Unknown client {!r} removed"
570
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
571
555
client_proxy_object = self.bus.get_object(self.busname, path)
572
self.add_client(MandosClientWidget(server_proxy_object
575
=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])),
584
565
def add_client(self, client, path=None):
585
566
self.clients.append(client)
587
568
path = client.proxy.object_path
588
569
self.clients_dict[path] = client
589
self.clients.sort(None, lambda c: c.properties["Name"])
570
self.clients.sort(key=lambda c: c.properties["Name"])
592
573
def remove_client(self, client, path=None):
593
574
self.clients.remove(client)
595
576
path = client.proxy.object_path
596
577
del self.clients_dict[path]
597
if not self.clients_dict:
598
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
599
# is completely emptied, we need to recreate it.
600
self.clients = urwid.SimpleListWalker([])
604
580
def refresh(self):
605
581
"""Redraw the screen"""
606
582
canvas = self.topwidget.render(self.size, focus=True)
607
583
self.screen.draw_screen(self.size, canvas)
610
586
"""Start the main loop and exit when it's done."""
611
587
self.bus = dbus.SystemBus()
612
588
mandos_dbus_objc = self.bus.get_object(
613
589
self.busname, "/", follow_name_owner_changes=True)
614
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
618
593
mandos_clients = (self.mandos_serv
619
594
.GetAllClientsWithProperties())
595
if not mandos_clients:
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
620
598
except dbus.exceptions.DBusException:
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
621
601
mandos_clients = dbus.Dictionary()
623
603
(self.mandos_serv
624
.connect_to_signal("ClientRemoved",
604
.connect_to_signal("InterfacesRemoved",
625
605
self.find_and_remove_client,
626
dbus_interface=server_interface,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
627
607
byte_arrays=True))
628
608
(self.mandos_serv
629
.connect_to_signal("ClientAdded",
609
.connect_to_signal("InterfacesAdded",
630
610
self.add_new_client,
631
dbus_interface=server_interface,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
632
612
byte_arrays=True))
633
613
(self.mandos_serv
634
614
.connect_to_signal("ClientNotFound",
635
615
self.client_not_found,
636
616
dbus_interface=server_interface,
637
617
byte_arrays=True))
638
for path, client in mandos_clients.iteritems():
618
for path, client in mandos_clients.items():
639
619
client_proxy_object = self.bus.get_object(self.busname,
641
self.add_client(MandosClientWidget(server_proxy_object
644
=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),
655
self._input_callback_tag = (gobject.io_add_watch
631
self._input_callback_tag = (GLib.io_add_watch
656
632
(sys.stdin.fileno(),
658
634
self.process_input))
659
635
self.main_loop.run()
660
636
# Main loop has finished, we should close everything now
661
gobject.source_remove(self._input_callback_tag)
637
GLib.source_remove(self._input_callback_tag)
662
638
self.screen.stop()
665
641
self.main_loop.quit()
667
643
def process_input(self, source, condition):
668
644
keys = self.screen.get_input()
669
translations = { "ctrl n": "down", # Emacs
670
"ctrl p": "up", # Emacs
671
"ctrl v": "page down", # Emacs
672
"meta v": "page up", # Emacs
673
" ": "page down", # less
674
"f": "page down", # less
675
"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
681
657
key = translations[key]
682
658
except KeyError: # :-)
685
661
if key == "q" or key == "Q":
688
664
elif key == "window resize":
689
665
self.size = self.screen.get_cols_rows()
691
elif key == "\f": # Ctrl-L
667
elif key == "ctrl l":
693
670
elif key == "l" or key == "D":
694
671
self.toggle_log_display()
added
removed
mandos-monitor
