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