2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
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
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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
16
# Mandos is distributed in the hope that it will be useful, but
17
# WITHOUT ANY WARRANTY; without even the implied warranty of
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19
17
# GNU General Public License for more details.
21
19
# You should have received a copy of the GNU General Public License
22
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
24
23
# Contact the authors at <mandos@recompile.se>.
27
26
from __future__ import (division, absolute_import, print_function,
30
from future_builtins import *
29
from future_builtins import *
92
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
93
self.proxy = proxy_object # Mandos Client proxy object
90
self.proxy = proxy_object # Mandos Client proxy object
94
91
self.properties = dict() if properties is None else properties
95
92
self.property_changed_match = (
96
self.proxy.connect_to_signal("PropertiesChanged",
97
self.properties_changed,
98
dbus.PROPERTIES_IFACE,
93
self.proxy.connect_to_signal("PropertyChanged",
94
self._property_changed,
101
98
if properties is None:
102
self.properties.update(self.proxy.GetAll(
104
dbus_interface=dbus.PROPERTIES_IFACE))
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
102
= dbus.PROPERTIES_IFACE))
106
104
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.
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.
112
114
# Update properties dict with new value
113
if interface == client_interface:
114
self.properties.update(properties)
115
self.properties[property] = value
116
117
def delete(self):
117
118
self.property_changed_match.remove()
164
165
client_interface,
165
166
byte_arrays=True))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
167
#self.logger('Created client {0}'
168
# .format(self.properties["Name"]))
169
170
def using_timer(self, flag):
170
171
"""Call this method with True or False when timer should be
171
172
activated or deactivated.
173
174
if flag and self._update_timer_callback_tag is None:
174
175
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GLib.timeout_add
176
self._update_timer_callback_tag = (gobject.timeout_add
177
178
self.update_timer))
178
179
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
180
gobject.source_remove(self._update_timer_callback_tag)
180
181
self._update_timer_callback_tag = None
182
183
def checker_completed(self, exitstatus, condition, command):
183
184
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
188
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
193
191
.format(self.properties["Name"], command,
194
192
os.WEXITSTATUS(condition)))
195
193
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
198
196
.format(self.properties["Name"], command,
199
197
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"]))
202
208
def checker_started(self, command):
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
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"],
208
216
def got_secret(self):
209
self.logger('Client {} received its secret'
217
self.logger('Client {0} received its secret'
210
218
.format(self.properties["Name"]))
212
220
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
222
message = 'Client {0} needs approval within {1} seconds'
216
message = 'Client {} will get its secret in {} seconds'
224
message = 'Client {0} will get its secret in {1} seconds'
217
225
self.logger(message.format(self.properties["Name"],
220
228
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
229
self.logger('Client {0} was rejected; reason: {1}'
222
230
.format(self.properties["Name"], reason))
224
232
def selectable(self):
225
233
"""Make this a "selectable" widget.
226
234
This overrides the method from urwid.FlowWidget."""
229
237
def rows(self, maxcolrow, focus=False):
230
238
"""How many rows this widget will occupy might depend on
231
239
whether we have focus or not.
232
240
This overrides the method from urwid.FlowWidget"""
233
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
243
def current_widget(self, focus=False):
236
244
if focus or self.opened:
237
245
return self._focus_widget
238
246
return self._widget
240
248
def update(self):
241
249
"Called when what is visible on the screen should be updated."
242
250
# How to add standout mode to a style
243
with_standout = {"normal": "standout",
244
"bold": "bold-standout",
246
"underline-blink-standout",
247
"bold-underline-blink":
248
"bold-underline-blink-standout",
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"bold-underline-blink-standout",
251
259
# Rebuild focus and non-focus widgets using current properties
253
261
# Base part of a client. Name!
254
262
base = '{name}: '.format(name=self.properties["Name"])
255
263
if not self.properties["Enabled"]:
256
264
message = "DISABLED"
257
265
self.using_timer(False)
258
266
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
267
timeout = datetime.timedelta(milliseconds
261
270
last_approval_request = isoformat_to_datetime(
262
271
self.properties["LastApprovalRequest"])
263
272
if last_approval_request is not None:
324
332
if self.delete_hook is not None:
325
333
self.delete_hook(self)
326
334
return super(MandosClientWidget, self).delete(**kwargs)
328
336
def render(self, maxcolrow, focus=False):
329
337
"""Render differently if we have focus.
330
338
This overrides the method from urwid.FlowWidget"""
331
339
return self.current_widget(focus).render(maxcolrow,
334
342
def keypress(self, maxcolrow, key):
336
344
This overrides the method from urwid.FlowWidget"""
338
self.proxy.Set(client_interface, "Enabled",
339
dbus.Boolean(True), ignore_reply=True,
340
dbus_interface=dbus.PROPERTIES_IFACE)
346
self.proxy.Enable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
349
self.proxy.Disable(dbus_interface = client_interface,
346
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
353
dbus_interface = client_interface,
348
354
ignore_reply=True)
350
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
357
dbus_interface = client_interface,
352
358
ignore_reply=True)
353
359
elif key == "R" or key == "_" or key == "ctrl k":
354
360
self.server_proxy_object.RemoveClient(self.proxy
356
362
ignore_reply=True)
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
364
self.proxy.StartChecker(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.StopChecker(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
370
self.proxy.CheckedOK(dbus_interface = client_interface,
367
371
ignore_reply=True)
369
373
# elif key == "p" or key == "=":
404
406
"""This is the entire user interface - the whole screen
405
407
with boxes, lists of client widgets, etc.
407
def __init__(self, max_log_length=1000, log_level=1):
409
def __init__(self, max_log_length=1000):
408
410
DBusGMainLoop(set_as_default=True)
410
412
self.screen = urwid.curses_display.Screen()
412
414
self.screen.register_palette((
414
416
"default", "default", None),
416
"bold", "default", "bold"),
418
"default", "default", "bold"),
417
419
("underline-blink",
418
"underline,blink", "default", "underline,blink"),
420
"default", "default", "underline"),
420
"standout", "default", "standout"),
422
"default", "default", "standout"),
421
423
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
424
"default", "default", ("bold", "underline")),
424
425
("bold-standout",
425
"bold,standout", "default", "bold,standout"),
426
"default", "default", ("bold", "standout")),
426
427
("underline-blink-standout",
427
"underline,blink,standout", "default",
428
"underline,blink,standout"),
428
"default", "default", ("underline", "standout")),
429
429
("bold-underline-blink-standout",
430
"bold,underline,blink,standout", "default",
431
"bold,underline,blink,standout"),
430
"default", "default", ("bold", "underline",
434
434
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
437
self.divider = "_" # \u005f
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
439
441
self.screen.start()
441
443
self.size = self.screen.get_cols_rows()
443
445
self.clients = urwid.SimpleListWalker([])
444
446
self.clients_dict = {}
446
448
# We will add Text widgets to this list
447
self.log = urwid.SimpleListWalker([])
448
450
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 = GLib.MainLoop()
468
self.main_loop = gobject.MainLoop()
470
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} 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(),
484
footer=urwid.Divider(
485
div_char=self.divider)))
485
urwid.Divider(div_char=
486
487
if self.log_visible:
487
488
self.uilist.append(self.logbox)
488
489
self.topwidget = urwid.Pile(self.uilist)
490
def log_message(self, message, level=1):
491
def log_message(self, message):
491
492
"""Log message formatted with timestamp"""
492
if level < self.log_level:
494
493
timestamp = datetime.datetime.now().isoformat()
495
self.log_message_raw("{}: {}".format(timestamp, message),
498
def log_message_raw(self, markup, level=1):
494
self.log_message_raw(timestamp + ": " + message)
496
def log_message_raw(self, markup):
499
497
"""Add a log message to the log buffer."""
500
if level < self.log_level:
502
498
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
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,
499
if (self.max_log_length
500
and len(self.log) > self.max_log_length):
501
del self.log[0:len(self.log)-self.max_log_length-1]
502
self.logbox.set_focus(len(self.logbox.body.contents),
507
503
coming_from="above")
510
506
def toggle_log_display(self):
511
507
"""Toggle visibility of the log buffer."""
512
508
self.log_visible = not self.log_visible
514
self.log_message("Log visibility changed to: {}"
515
.format(self.log_visible), level=0)
510
#self.log_message("Log visibility changed to: "
511
# + unicode(self.log_visible))
517
513
def change_log_display(self):
518
514
"""Change type of log display.
519
515
Currently, this toggles wrapping of text lines."""
523
519
self.log_wrap = "clip"
524
520
for textwidget in self.log:
525
521
textwidget.set_wrap_mode(self.log_wrap)
526
self.log_message("Wrap mode: {}".format(self.log_wrap),
529
def find_and_remove_client(self, path, interfaces):
522
#self.log_message("Wrap mode: " + self.log_wrap)
524
def find_and_remove_client(self, path, name):
530
525
"""Find a client by its object path and remove it.
532
This is connected to the InterfacesRemoved signal from the
527
This is connected to the ClientRemoved signal from the
533
528
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
538
530
client = self.clients_dict[path]
541
self.log_message("Unknown client {!r} removed"
533
self.log_message("Unknown client {0!r} ({1!r}) removed"
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
def add_new_client(self, path):
555
539
client_proxy_object = self.bus.get_object(self.busname, path)
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])),
540
self.add_client(MandosClientWidget(server_proxy_object
543
=client_proxy_object,
565
552
def add_client(self, client, path=None):
566
553
self.clients.append(client)
568
555
path = client.proxy.object_path
569
556
self.clients_dict[path] = client
570
self.clients.sort(key=lambda c: c.properties["Name"])
557
self.clients.sort(None, lambda c: c.properties["Name"])
573
560
def remove_client(self, client, path=None):
574
561
self.clients.remove(client)
576
563
path = client.proxy.object_path
577
564
del self.clients_dict[path]
565
if not self.clients_dict:
566
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
567
# is completely emptied, we need to recreate it.
568
self.clients = urwid.SimpleListWalker([])
580
572
def refresh(self):
581
573
"""Redraw the screen"""
582
574
canvas = self.topwidget.render(self.size, focus=True)
583
575
self.screen.draw_screen(self.size, canvas)
586
578
"""Start the main loop and exit when it's done."""
587
579
self.bus = dbus.SystemBus()
588
580
mandos_dbus_objc = self.bus.get_object(
589
581
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
582
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
586
mandos_clients = (self.mandos_serv
594
587
.GetAllClientsWithProperties())
595
588
if not mandos_clients:
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
589
self.log_message_raw(("bold", "Note: Server has no clients."))
598
590
except dbus.exceptions.DBusException:
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
591
self.log_message_raw(("bold", "Note: No Mandos server running."))
601
592
mandos_clients = dbus.Dictionary()
603
594
(self.mandos_serv
604
.connect_to_signal("InterfacesRemoved",
595
.connect_to_signal("ClientRemoved",
605
596
self.find_and_remove_client,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
dbus_interface=server_interface,
607
598
byte_arrays=True))
608
599
(self.mandos_serv
609
.connect_to_signal("InterfacesAdded",
600
.connect_to_signal("ClientAdded",
610
601
self.add_new_client,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
602
dbus_interface=server_interface,
612
603
byte_arrays=True))
613
604
(self.mandos_serv
614
605
.connect_to_signal("ClientNotFound",
615
606
self.client_not_found,
616
607
dbus_interface=server_interface,
617
608
byte_arrays=True))
618
for path, client in mandos_clients.items():
609
for path, client in mandos_clients.iteritems():
619
610
client_proxy_object = self.bus.get_object(self.busname,
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),
612
self.add_client(MandosClientWidget(server_proxy_object
615
=client_proxy_object,
631
self._input_callback_tag = (
633
GLib.IOChannel.unix_new(sys.stdin.fileno()),
634
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
626
self._input_callback_tag = (gobject.io_add_watch
636
630
self.main_loop.run()
637
631
# Main loop has finished, we should close everything now
638
GLib.source_remove(self._input_callback_tag)
632
gobject.source_remove(self._input_callback_tag)
639
633
self.screen.stop()
642
636
self.main_loop.quit()
644
638
def process_input(self, source, condition):
645
639
keys = self.screen.get_input()
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
640
translations = { "ctrl n": "down", # Emacs
641
"ctrl p": "up", # Emacs
642
"ctrl v": "page down", # Emacs
643
"meta v": "page up", # Emacs
644
" ": "page down", # less
645
"f": "page down", # less
646
"b": "page up", # less
658
652
key = translations[key]
659
653
except KeyError: # :-)
662
656
if key == "q" or key == "Q":
665
659
elif key == "window resize":
666
660
self.size = self.screen.get_cols_rows()
668
elif key == "ctrl l":
662
elif key == "\f": # Ctrl-L
671
664
elif key == "l" or key == "D":
672
665
self.toggle_log_display()
706
697
self.topwidget.set_focus(self.logbox)
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
699
#elif (key == "end" or key == "meta >" or key == "G"
701
# pass # xxx end-of-buffer
702
#elif (key == "home" or key == "meta <" or key == "g"
704
# pass # xxx beginning-of-buffer
705
#elif key == "ctrl e" or key == "$":
706
# pass # xxx move-end-of-line
707
#elif key == "ctrl a" or key == "^":
708
# pass # xxx move-beginning-of-line
709
#elif key == "ctrl b" or key == "meta (" or key == "h":
711
#elif key == "ctrl f" or key == "meta )" or key == "l":
714
# pass # scroll up log
716
# pass # scroll down log
733
717
elif self.topwidget.selectable():
734
718
self.topwidget.keypress(self.size, key)
739
722
ui = UserInterface()
742
725
except KeyboardInterrupt:
744
except Exception as e:
745
ui.log_message(str(e))
728
ui.log_message(unicode(e))