2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 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,
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
self.proxy.connect_to_signal("PropertyChanged",
91
self._property_changed,
96
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
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
def _property_changed(self, property, value):
104
"""Helper which takes positional arguments"""
105
return self.property_changed(property=property, value=value)
107
def property_changed(self, property=None, value=None):
108
"""This is called whenever we get a PropertyChanged signal
109
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.
111
112
# Update properties dict with new value
112
self.properties[property] = value
113
if interface == client_interface:
114
self.properties.update(properties)
114
116
def delete(self):
115
117
self.property_changed_match.remove()
162
164
client_interface,
163
165
byte_arrays=True))
164
#self.logger('Created client {0}'
165
# .format(self.properties["Name"]))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
167
169
def using_timer(self, flag):
168
170
"""Call this method with True or False when timer should be
169
171
activated or deactivated.
171
173
if flag and self._update_timer_callback_tag is None:
172
174
# Will update the shown timer value every second
173
self._update_timer_callback_tag = (gobject.timeout_add
175
self._update_timer_callback_tag = (GLib.timeout_add
175
177
self.update_timer))
176
178
elif not (flag or self._update_timer_callback_tag is None):
177
gobject.source_remove(self._update_timer_callback_tag)
179
GLib.source_remove(self._update_timer_callback_tag)
178
180
self._update_timer_callback_tag = None
180
182
def checker_completed(self, exitstatus, condition, command):
181
183
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
185
190
if os.WIFEXITED(condition):
186
self.logger('Checker for client {0} (command "{1}")'
187
' failed with exit code {2}'
191
self.logger('Checker for client {} (command "{}") failed'
188
193
.format(self.properties["Name"], command,
189
194
os.WEXITSTATUS(condition)))
190
195
elif os.WIFSIGNALED(condition):
191
self.logger('Checker for client {0} (command "{1}") was'
192
' killed by signal {2}'
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
193
198
.format(self.properties["Name"], command,
194
199
os.WTERMSIG(condition)))
195
elif os.WCOREDUMP(condition):
196
self.logger('Checker for client {0} (command "{1}")'
198
.format(self.properties["Name"], command))
200
self.logger('Checker for client {0} completed'
202
.format(self.properties["Name"]))
205
202
def checker_started(self, command):
206
"""Server signals that a checker started. This could be useful
207
to log in the future. """
208
#self.logger('Client {0} started checker "{1}"'
209
# .format(self.properties["Name"],
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
213
208
def got_secret(self):
214
self.logger('Client {0} received its secret'
209
self.logger('Client {} received its secret'
215
210
.format(self.properties["Name"]))
217
212
def need_approval(self, timeout, default):
219
message = 'Client {0} needs approval within {1} seconds'
214
message = 'Client {} needs approval within {} seconds'
221
message = 'Client {0} will get its secret in {1} seconds'
216
message = 'Client {} will get its secret in {} seconds'
222
217
self.logger(message.format(self.properties["Name"],
225
220
def rejected(self, reason):
226
self.logger('Client {0} was rejected; reason: {1}'
221
self.logger('Client {} was rejected; reason: {}'
227
222
.format(self.properties["Name"], reason))
229
224
def selectable(self):
230
225
"""Make this a "selectable" widget.
231
226
This overrides the method from urwid.FlowWidget."""
234
229
def rows(self, maxcolrow, focus=False):
235
230
"""How many rows this widget will occupy might depend on
236
231
whether we have focus or not.
237
232
This overrides the method from urwid.FlowWidget"""
238
233
return self.current_widget(focus).rows(maxcolrow, focus=focus)
240
235
def current_widget(self, focus=False):
241
236
if focus or self.opened:
242
237
return self._focus_widget
243
238
return self._widget
245
240
def update(self):
246
241
"Called when what is visible on the screen should be updated."
247
242
# How to add standout mode to a style
248
with_standout = { "normal": "standout",
249
"bold": "bold-standout",
251
"underline-blink-standout",
252
"bold-underline-blink":
253
"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",
256
251
# Rebuild focus and non-focus widgets using current properties
258
253
# Base part of a client. Name!
259
254
base = '{name}: '.format(name=self.properties["Name"])
260
255
if not self.properties["Enabled"]:
261
256
message = "DISABLED"
262
257
self.using_timer(False)
263
258
elif self.properties["ApprovalPending"]:
264
timeout = datetime.timedelta(milliseconds
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
267
261
last_approval_request = isoformat_to_datetime(
268
262
self.properties["LastApprovalRequest"])
269
263
if last_approval_request is not None:
329
324
if self.delete_hook is not None:
330
325
self.delete_hook(self)
331
326
return super(MandosClientWidget, self).delete(**kwargs)
333
328
def render(self, maxcolrow, focus=False):
334
329
"""Render differently if we have focus.
335
330
This overrides the method from urwid.FlowWidget"""
336
331
return self.current_widget(focus).render(maxcolrow,
339
334
def keypress(self, maxcolrow, key):
341
336
This overrides the method from urwid.FlowWidget"""
343
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)
346
self.proxy.Disable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
349
346
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
dbus_interface = client_interface,
347
dbus_interface=client_interface,
351
348
ignore_reply=True)
353
350
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
dbus_interface = client_interface,
351
dbus_interface=client_interface,
355
352
ignore_reply=True)
356
353
elif key == "R" or key == "_" or key == "ctrl k":
357
354
self.server_proxy_object.RemoveClient(self.proxy
359
356
ignore_reply=True)
361
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)
364
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)
367
self.proxy.CheckedOK(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
368
367
ignore_reply=True)
370
369
# elif key == "p" or key == "=":
379
def property_changed(self, property=None, **kwargs):
380
"""Call self.update() if old value is not new value.
378
def properties_changed(self, interface, properties, invalidated):
379
"""Call self.update() if any properties changed.
381
380
This overrides the method from MandosClientPropertyCache"""
382
property_name = str(property)
383
old_value = self.properties.get(property_name)
384
super(MandosClientWidget, self).property_changed(
385
property=property, **kwargs)
386
if self.properties.get(property_name) != old_value:
381
old_values = {key: self.properties.get(key)
382
for key in properties.keys()}
383
super(MandosClientWidget, self).properties_changed(
384
interface, properties, invalidated)
385
if any(old_values[key] != self.properties.get(key)
386
for key in old_values):
428
430
"bold,underline,blink,standout", "default",
429
431
"bold,underline,blink,standout"),
432
434
if urwid.supports_unicode():
433
self.divider = "─" # \u2500
434
#self.divider = "━" # \u2501
435
self.divider = "─" # \u2500
436
#self.divider = "-" # \u002d
437
self.divider = "_" # \u005f
437
self.divider = "_" # \u005f
439
439
self.screen.start()
441
441
self.size = self.screen.get_cols_rows()
443
443
self.clients = urwid.SimpleListWalker([])
444
444
self.clients_dict = {}
446
446
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
448
self.max_log_length = max_log_length
450
self.log_level = log_level
450
452
# We keep a reference to the log widget so we can remove it
451
453
# from the ListWalker without it getting destroyed
452
454
self.logbox = ConstrainedListBox(self.log)
454
456
# This keeps track of whether self.uilist currently has
455
457
# self.logbox in it or not
456
458
self.log_visible = True
457
459
self.log_wrap = "any"
460
462
self.log_message_raw(("bold",
461
463
"Mandos Monitor version " + version))
462
464
self.log_message_raw(("bold",
463
465
"q: Quit ?: Help"))
465
467
self.busname = domain + '.Mandos'
466
self.main_loop = gobject.MainLoop()
468
self.main_loop = GLib.MainLoop()
468
470
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {0} and fingerprint"
470
" {1} could not be found"
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
471
473
.format(address, fingerprint))
473
475
def rebuild(self):
474
476
"""This rebuilds the User Interface.
475
477
Call this when the widget layout needs to change"""
477
#self.uilist.append(urwid.ListBox(self.clients))
479
# self.uilist.append(urwid.ListBox(self.clients))
478
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
480
#header=urwid.Divider(),
482
# header=urwid.Divider(),
483
urwid.Divider(div_char=
484
footer=urwid.Divider(
485
div_char=self.divider)))
485
486
if self.log_visible:
486
487
self.uilist.append(self.logbox)
487
488
self.topwidget = urwid.Pile(self.uilist)
489
def log_message(self, message):
490
def log_message(self, message, level=1):
490
491
"""Log message formatted with timestamp"""
492
if level < self.log_level:
491
494
timestamp = datetime.datetime.now().isoformat()
492
self.log_message_raw(timestamp + ": " + message)
494
def log_message_raw(self, markup):
495
self.log_message_raw("{}: {}".format(timestamp, message),
498
def log_message_raw(self, markup, level=1):
495
499
"""Add a log message to the log buffer."""
500
if level < self.log_level:
496
502
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
if (self.max_log_length
498
and len(self.log) > self.max_log_length):
499
del self.log[0:len(self.log)-self.max_log_length-1]
500
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,
501
507
coming_from="above")
504
510
def toggle_log_display(self):
505
511
"""Toggle visibility of the log buffer."""
506
512
self.log_visible = not self.log_visible
508
#self.log_message("Log visibility changed to: "
509
# + str(self.log_visible))
514
self.log_message("Log visibility changed to: {}"
515
.format(self.log_visible), level=0)
511
517
def change_log_display(self):
512
518
"""Change type of log display.
513
519
Currently, this toggles wrapping of text lines."""
517
523
self.log_wrap = "clip"
518
524
for textwidget in self.log:
519
525
textwidget.set_wrap_mode(self.log_wrap)
520
#self.log_message("Wrap mode: " + self.log_wrap)
522
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):
523
530
"""Find a client by its object path and remove it.
525
This is connected to the ClientRemoved signal from the
532
This is connected to the InterfacesRemoved signal from the
526
533
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
528
538
client = self.clients_dict[path]
531
self.log_message("Unknown client {0!r} ({1!r}) removed"
541
self.log_message("Unknown client {!r} removed"
536
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
537
555
client_proxy_object = self.bus.get_object(self.busname, path)
538
self.add_client(MandosClientWidget(server_proxy_object
541
=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])),
550
565
def add_client(self, client, path=None):
551
566
self.clients.append(client)
554
569
self.clients_dict[path] = client
555
570
self.clients.sort(key=lambda c: c.properties["Name"])
558
573
def remove_client(self, client, path=None):
559
574
self.clients.remove(client)
561
576
path = client.proxy.object_path
562
577
del self.clients_dict[path]
565
580
def refresh(self):
566
581
"""Redraw the screen"""
567
582
canvas = self.topwidget.render(self.size, focus=True)
568
583
self.screen.draw_screen(self.size, canvas)
571
586
"""Start the main loop and exit when it's done."""
572
587
self.bus = dbus.SystemBus()
573
588
mandos_dbus_objc = self.bus.get_object(
574
589
self.busname, "/", follow_name_owner_changes=True)
575
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
579
593
mandos_clients = (self.mandos_serv
580
594
.GetAllClientsWithProperties())
581
595
if not mandos_clients:
582
self.log_message_raw(("bold", "Note: Server has no clients."))
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
583
598
except dbus.exceptions.DBusException:
584
self.log_message_raw(("bold", "Note: No Mandos server running."))
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
585
601
mandos_clients = dbus.Dictionary()
587
603
(self.mandos_serv
588
.connect_to_signal("ClientRemoved",
604
.connect_to_signal("InterfacesRemoved",
589
605
self.find_and_remove_client,
590
dbus_interface=server_interface,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
591
607
byte_arrays=True))
592
608
(self.mandos_serv
593
.connect_to_signal("ClientAdded",
609
.connect_to_signal("InterfacesAdded",
594
610
self.add_new_client,
595
dbus_interface=server_interface,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
612
byte_arrays=True))
597
613
(self.mandos_serv
598
614
.connect_to_signal("ClientNotFound",
602
618
for path, client in mandos_clients.items():
603
619
client_proxy_object = self.bus.get_object(self.busname,
605
self.add_client(MandosClientWidget(server_proxy_object
608
=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),
619
self._input_callback_tag = (gobject.io_add_watch
631
self._input_callback_tag = (
633
GLib.IOChannel.unix_new(sys.stdin.fileno()),
634
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
623
636
self.main_loop.run()
624
637
# Main loop has finished, we should close everything now
625
gobject.source_remove(self._input_callback_tag)
638
GLib.source_remove(self._input_callback_tag)
626
639
self.screen.stop()
629
642
self.main_loop.quit()
631
644
def process_input(self, source, condition):
632
645
keys = self.screen.get_input()
633
translations = { "ctrl n": "down", # Emacs
634
"ctrl p": "up", # Emacs
635
"ctrl v": "page down", # Emacs
636
"meta v": "page up", # Emacs
637
" ": "page down", # less
638
"f": "page down", # less
639
"b": "page up", # less
646
translations = {"ctrl n": "down", # Emacs
647
"ctrl p": "up", # Emacs
648
"ctrl v": "page down", # Emacs
649
"meta v": "page up", # Emacs
650
" ": "page down", # less
651
"f": "page down", # less
652
"b": "page up", # less
645
658
key = translations[key]
646
659
except KeyError: # :-)
649
662
if key == "q" or key == "Q":
652
665
elif key == "window resize":
653
666
self.size = self.screen.get_cols_rows()
655
elif key == "\f": # Ctrl-L
668
elif key == "ctrl l":
657
671
elif key == "l" or key == "D":
658
672
self.toggle_log_display()
690
706
self.topwidget.set_focus(self.logbox)
692
#elif (key == "end" or key == "meta >" or key == "G"
694
# pass # xxx end-of-buffer
695
#elif (key == "home" or key == "meta <" or key == "g"
697
# pass # xxx beginning-of-buffer
698
#elif key == "ctrl e" or key == "$":
699
# pass # xxx move-end-of-line
700
#elif key == "ctrl a" or key == "^":
701
# pass # xxx move-beginning-of-line
702
#elif key == "ctrl b" or key == "meta (" or key == "h":
704
#elif key == "ctrl f" or key == "meta )" or key == "l":
707
# pass # scroll up log
709
# pass # scroll down log
709
if self.log_level == 0:
711
self.log_message("Verbose mode: Off")
714
self.log_message("Verbose mode: On")
715
# elif (key == "end" or key == "meta >" or key == "G"
717
# pass # xxx end-of-buffer
718
# elif (key == "home" or key == "meta <" or key == "g"
720
# pass # xxx beginning-of-buffer
721
# elif key == "ctrl e" or key == "$":
722
# pass # xxx move-end-of-line
723
# elif key == "ctrl a" or key == "^":
724
# pass # xxx move-beginning-of-line
725
# elif key == "ctrl b" or key == "meta (" or key == "h":
727
# elif key == "ctrl f" or key == "meta )" or key == "l":
730
# pass # scroll up log
732
# pass # scroll down log
710
733
elif self.topwidget.selectable():
711
734
self.topwidget.keypress(self.size, key)
715
739
ui = UserInterface()