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
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,
29
from future_builtins import *
30
from future_builtins import *
89
92
def __init__(self, proxy_object=None, properties=None, **kwargs):
90
self.proxy = proxy_object # Mandos Client proxy object
93
self.proxy = proxy_object # Mandos Client proxy object
91
94
self.properties = dict() if properties is None else properties
92
95
self.property_changed_match = (
93
self.proxy.connect_to_signal("PropertyChanged",
94
self._property_changed,
96
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
98
dbus.PROPERTIES_IFACE,
98
101
if properties is None:
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
102
= dbus.PROPERTIES_IFACE))
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
104
106
super(MandosClientPropertyCache, self).__init__(**kwargs)
106
def _property_changed(self, property, value):
107
"""Helper which takes positional arguments"""
108
return self.property_changed(property=property, value=value)
110
def property_changed(self, property=None, value=None):
111
"""This is called whenever we get a PropertyChanged signal
112
It updates the changed property in the "properties" dict.
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.
114
112
# Update properties dict with new value
115
self.properties[property] = value
113
if interface == client_interface:
114
self.properties.update(properties)
117
116
def delete(self):
118
117
self.property_changed_match.remove()
165
164
client_interface,
166
165
byte_arrays=True))
167
#self.logger('Created client {0}'
168
# .format(self.properties["Name"]))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
170
169
def using_timer(self, flag):
171
170
"""Call this method with True or False when timer should be
172
171
activated or deactivated.
174
173
if flag and self._update_timer_callback_tag is None:
175
174
# Will update the shown timer value every second
176
self._update_timer_callback_tag = (gobject.timeout_add
175
self._update_timer_callback_tag = (GLib.timeout_add
178
177
self.update_timer))
179
178
elif not (flag or self._update_timer_callback_tag is None):
180
gobject.source_remove(self._update_timer_callback_tag)
179
GLib.source_remove(self._update_timer_callback_tag)
181
180
self._update_timer_callback_tag = None
183
182
def checker_completed(self, exitstatus, condition, command):
184
183
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
188
190
if os.WIFEXITED(condition):
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
191
self.logger('Checker for client {} (command "{}") failed'
191
193
.format(self.properties["Name"], command,
192
194
os.WEXITSTATUS(condition)))
193
195
elif os.WIFSIGNALED(condition):
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
196
198
.format(self.properties["Name"], command,
197
199
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
201
.format(self.properties["Name"], command))
203
self.logger('Checker for client {0} completed'
205
.format(self.properties["Name"]))
208
202
def checker_started(self, command):
209
"""Server signals that a checker started. This could be useful
210
to log in the future. """
211
#self.logger('Client {0} started checker "{1}"'
212
# .format(self.properties["Name"],
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
216
208
def got_secret(self):
217
self.logger('Client {0} received its secret'
209
self.logger('Client {} received its secret'
218
210
.format(self.properties["Name"]))
220
212
def need_approval(self, timeout, default):
222
message = 'Client {0} needs approval within {1} seconds'
214
message = 'Client {} needs approval within {} seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
216
message = 'Client {} will get its secret in {} seconds'
225
217
self.logger(message.format(self.properties["Name"],
228
220
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
221
self.logger('Client {} was rejected; reason: {}'
230
222
.format(self.properties["Name"], reason))
232
224
def selectable(self):
233
225
"""Make this a "selectable" widget.
234
226
This overrides the method from urwid.FlowWidget."""
237
229
def rows(self, maxcolrow, focus=False):
238
230
"""How many rows this widget will occupy might depend on
239
231
whether we have focus or not.
240
232
This overrides the method from urwid.FlowWidget"""
241
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
243
235
def current_widget(self, focus=False):
244
236
if focus or self.opened:
245
237
return self._focus_widget
246
238
return self._widget
248
240
def update(self):
249
241
"Called when what is visible on the screen should be updated."
250
242
# How to add standout mode to a style
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"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",
259
251
# Rebuild focus and non-focus widgets using current properties
261
253
# Base part of a client. Name!
262
254
base = '{name}: '.format(name=self.properties["Name"])
263
255
if not self.properties["Enabled"]:
264
256
message = "DISABLED"
265
257
self.using_timer(False)
266
258
elif self.properties["ApprovalPending"]:
267
timeout = datetime.timedelta(milliseconds
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
270
261
last_approval_request = isoformat_to_datetime(
271
262
self.properties["LastApprovalRequest"])
272
263
if last_approval_request is not None:
332
324
if self.delete_hook is not None:
333
325
self.delete_hook(self)
334
326
return super(MandosClientWidget, self).delete(**kwargs)
336
328
def render(self, maxcolrow, focus=False):
337
329
"""Render differently if we have focus.
338
330
This overrides the method from urwid.FlowWidget"""
339
331
return self.current_widget(focus).render(maxcolrow,
342
334
def keypress(self, maxcolrow, key):
344
336
This overrides the method from urwid.FlowWidget"""
346
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)
349
self.proxy.Disable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
352
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
347
dbus_interface=client_interface,
354
348
ignore_reply=True)
356
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
351
dbus_interface=client_interface,
358
352
ignore_reply=True)
359
353
elif key == "R" or key == "_" or key == "ctrl k":
360
354
self.server_proxy_object.RemoveClient(self.proxy
362
356
ignore_reply=True)
364
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)
367
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)
370
self.proxy.CheckedOK(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
371
367
ignore_reply=True)
373
369
# elif key == "p" or key == "=":
406
404
"""This is the entire user interface - the whole screen
407
405
with boxes, lists of client widgets, etc.
409
def __init__(self, max_log_length=1000):
407
def __init__(self, max_log_length=1000, log_level=1):
410
408
DBusGMainLoop(set_as_default=True)
412
410
self.screen = urwid.curses_display.Screen()
414
412
self.screen.register_palette((
416
414
"default", "default", None),
418
"default", "default", "bold"),
416
"bold", "default", "bold"),
419
417
("underline-blink",
420
"default", "default", "underline"),
418
"underline,blink", "default", "underline,blink"),
422
"default", "default", "standout"),
420
"standout", "default", "standout"),
423
421
("bold-underline-blink",
424
"default", "default", ("bold", "underline")),
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
425
424
("bold-standout",
426
"default", "default", ("bold", "standout")),
425
"bold,standout", "default", "bold,standout"),
427
426
("underline-blink-standout",
428
"default", "default", ("underline", "standout")),
427
"underline,blink,standout", "default",
428
"underline,blink,standout"),
429
429
("bold-underline-blink-standout",
430
"default", "default", ("bold", "underline",
430
"bold,underline,blink,standout", "default",
431
"bold,underline,blink,standout"),
434
434
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
435
self.divider = "─" # \u2500
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
437
self.divider = "_" # \u005f
441
439
self.screen.start()
443
441
self.size = self.screen.get_cols_rows()
445
443
self.clients = urwid.SimpleListWalker([])
446
444
self.clients_dict = {}
448
446
# We will add Text widgets to this list
450
448
self.max_log_length = max_log_length
450
self.log_level = log_level
452
452
# We keep a reference to the log widget so we can remove it
453
453
# from the ListWalker without it getting destroyed
454
454
self.logbox = ConstrainedListBox(self.log)
456
456
# This keeps track of whether self.uilist currently has
457
457
# self.logbox in it or not
458
458
self.log_visible = True
459
459
self.log_wrap = "any"
462
462
self.log_message_raw(("bold",
463
463
"Mandos Monitor version " + version))
464
464
self.log_message_raw(("bold",
465
465
"q: Quit ?: Help"))
467
467
self.busname = domain + '.Mandos'
468
self.main_loop = gobject.MainLoop()
468
self.main_loop = GLib.MainLoop()
470
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} could not be found"
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
473
473
.format(address, fingerprint))
475
475
def rebuild(self):
476
476
"""This rebuilds the User Interface.
477
477
Call this when the widget layout needs to change"""
479
#self.uilist.append(urwid.ListBox(self.clients))
479
# self.uilist.append(urwid.ListBox(self.clients))
480
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
#header=urwid.Divider(),
482
# header=urwid.Divider(),
485
urwid.Divider(div_char=
484
footer=urwid.Divider(
485
div_char=self.divider)))
487
486
if self.log_visible:
488
487
self.uilist.append(self.logbox)
489
488
self.topwidget = urwid.Pile(self.uilist)
491
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:
492
494
timestamp = datetime.datetime.now().isoformat()
493
self.log_message_raw(timestamp + ": " + message)
495
def log_message_raw(self, markup):
495
self.log_message_raw("{}: {}".format(timestamp, message),
498
def log_message_raw(self, markup, level=1):
496
499
"""Add a log message to the log buffer."""
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]
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]
501
506
self.logbox.set_focus(len(self.logbox.body.contents),
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
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
514
self.log_message("Log visibility changed to: {}"
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."""
518
523
self.log_wrap = "clip"
519
524
for textwidget in self.log:
520
525
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
523
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):
524
530
"""Find a client by its object path and remove it.
526
This is connected to the ClientRemoved signal from the
532
This is connected to the InterfacesRemoved signal from the
527
533
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
529
538
client = self.clients_dict[path]
532
self.log_message("Unknown client {0!r} ({1!r}) removed"
541
self.log_message("Unknown client {!r} removed"
537
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
538
555
client_proxy_object = self.bus.get_object(self.busname, path)
539
self.add_client(MandosClientWidget(server_proxy_object
542
=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])),
551
565
def add_client(self, client, path=None):
552
566
self.clients.append(client)
554
568
path = client.proxy.object_path
555
569
self.clients_dict[path] = client
556
self.clients.sort(None, lambda c: c.properties["Name"])
570
self.clients.sort(key=lambda c: c.properties["Name"])
559
573
def remove_client(self, client, path=None):
560
574
self.clients.remove(client)
562
576
path = client.proxy.object_path
563
577
del self.clients_dict[path]
564
if not self.clients_dict:
565
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
566
# is completely emptied, we need to recreate it.
567
self.clients = urwid.SimpleListWalker([])
571
580
def refresh(self):
572
581
"""Redraw the screen"""
573
582
canvas = self.topwidget.render(self.size, focus=True)
574
583
self.screen.draw_screen(self.size, canvas)
577
586
"""Start the main loop and exit when it's done."""
578
587
self.bus = dbus.SystemBus()
579
588
mandos_dbus_objc = self.bus.get_object(
580
589
self.busname, "/", follow_name_owner_changes=True)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
585
593
mandos_clients = (self.mandos_serv
586
594
.GetAllClientsWithProperties())
595
if not mandos_clients:
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
587
598
except dbus.exceptions.DBusException:
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
588
601
mandos_clients = dbus.Dictionary()
590
603
(self.mandos_serv
591
.connect_to_signal("ClientRemoved",
604
.connect_to_signal("InterfacesRemoved",
592
605
self.find_and_remove_client,
593
dbus_interface=server_interface,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
594
607
byte_arrays=True))
595
608
(self.mandos_serv
596
.connect_to_signal("ClientAdded",
609
.connect_to_signal("InterfacesAdded",
597
610
self.add_new_client,
598
dbus_interface=server_interface,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
599
612
byte_arrays=True))
600
613
(self.mandos_serv
601
614
.connect_to_signal("ClientNotFound",
602
615
self.client_not_found,
603
616
dbus_interface=server_interface,
604
617
byte_arrays=True))
605
for path, client in mandos_clients.iteritems():
618
for path, client in mandos_clients.items():
606
619
client_proxy_object = self.bus.get_object(self.busname,
608
self.add_client(MandosClientWidget(server_proxy_object
611
=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),
622
self._input_callback_tag = (gobject.io_add_watch
631
self._input_callback_tag = (GLib.io_add_watch
623
632
(sys.stdin.fileno(),
625
634
self.process_input))
626
635
self.main_loop.run()
627
636
# Main loop has finished, we should close everything now
628
gobject.source_remove(self._input_callback_tag)
637
GLib.source_remove(self._input_callback_tag)
629
638
self.screen.stop()
632
641
self.main_loop.quit()
634
643
def process_input(self, source, condition):
635
644
keys = self.screen.get_input()
636
translations = { "ctrl n": "down", # Emacs
637
"ctrl p": "up", # Emacs
638
"ctrl v": "page down", # Emacs
639
"meta v": "page up", # Emacs
640
" ": "page down", # less
641
"f": "page down", # less
642
"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
648
657
key = translations[key]
649
658
except KeyError: # :-)
652
661
if key == "q" or key == "Q":
655
664
elif key == "window resize":
656
665
self.size = self.screen.get_cols_rows()
658
elif key == "\f": # Ctrl-L
667
elif key == "ctrl l":
660
670
elif key == "l" or key == "D":
661
671
self.toggle_log_display()
693
705
self.topwidget.set_focus(self.logbox)
695
#elif (key == "end" or key == "meta >" or key == "G"
697
# pass # xxx end-of-buffer
698
#elif (key == "home" or key == "meta <" or key == "g"
700
# pass # xxx beginning-of-buffer
701
#elif key == "ctrl e" or key == "$":
702
# pass # xxx move-end-of-line
703
#elif key == "ctrl a" or key == "^":
704
# pass # xxx move-beginning-of-line
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
710
# pass # scroll up log
712
# pass # scroll down log
708
if self.log_level == 0:
710
self.log_message("Verbose mode: Off")
713
self.log_message("Verbose mode: On")
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
713
732
elif self.topwidget.selectable():
714
733
self.topwidget.keypress(self.size, key)
718
738
ui = UserInterface()
721
741
except KeyboardInterrupt:
724
ui.log_message(unicode(e))
743
except Exception as e:
744
ui.log_message(str(e))