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,
38
41
import urwid.curses_display
41
44
from dbus.mainloop.glib import DBusGMainLoop
45
from gi.repository import GObject as gobject
45
from gi.repository import GLib
51
49
if sys.version_info.major == 2:
54
locale.setlocale(locale.LC_ALL, '')
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
52
log = logging.getLogger(os.path.basename(sys.argv[0]))
53
logging.basicConfig(level="NOTSET", # Show all messages
54
format="%(message)s") # Show basic log messages
56
logging.captureWarnings(True) # Show warnings via the logging system
58
locale.setlocale(locale.LC_ALL, "")
60
logging.getLogger("dbus.proxies").setLevel(logging.CRITICAL)
59
62
# Some useful constants
60
domain = 'se.recompile'
61
server_interface = domain + '.Mandos'
62
client_interface = domain + '.Mandos.Client'
63
domain = "se.recompile"
64
server_interface = domain + ".Mandos"
65
client_interface = domain + ".Mandos.Client"
69
dbus.OBJECT_MANAGER_IFACE
70
except AttributeError:
71
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
65
74
def isoformat_to_datetime(iso):
66
75
"Parse an ISO 8601 date string to a datetime.datetime()"
86
96
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
97
self.proxy = proxy_object # Mandos Client proxy object
88
98
self.properties = dict() if properties is None else properties
89
99
self.property_changed_match = (
90
100
self.proxy.connect_to_signal("PropertiesChanged",
91
101
self.properties_changed,
92
102
dbus.PROPERTIES_IFACE,
93
103
byte_arrays=True))
95
105
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
99
= dbus.PROPERTIES_IFACE))
106
self.properties.update(self.proxy.GetAll(
108
dbus_interface=dbus.PROPERTIES_IFACE))
101
110
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
112
def properties_changed(self, interface, properties, invalidated):
104
113
"""This is called whenever we get a PropertiesChanged signal
105
114
It updates the changed properties in the "properties" dict.
107
116
# Update properties dict with new value
108
self.properties.update(properties)
117
if interface == client_interface:
118
self.properties.update(properties)
110
120
def delete(self):
111
121
self.property_changed_match.remove()
158
166
client_interface,
159
167
byte_arrays=True))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
168
log.debug("Created client %s", self.properties["Name"])
163
170
def using_timer(self, flag):
164
171
"""Call this method with True or False when timer should be
165
172
activated or deactivated.
167
174
if flag and self._update_timer_callback_tag is None:
168
175
# Will update the shown timer value every second
169
self._update_timer_callback_tag = (gobject.timeout_add
176
self._update_timer_callback_tag = (
177
GLib.timeout_add(1000,
178
glib_safely(self.update_timer)))
172
179
elif not (flag or self._update_timer_callback_tag is None):
173
gobject.source_remove(self._update_timer_callback_tag)
180
GLib.source_remove(self._update_timer_callback_tag)
174
181
self._update_timer_callback_tag = None
176
183
def checker_completed(self, exitstatus, condition, command):
177
184
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
185
log.debug('Checker for client %s (command "%s")'
186
" succeeded", self.properties["Name"], command)
184
190
if os.WIFEXITED(condition):
185
self.logger('Checker for client {} (command "{}") failed'
187
.format(self.properties["Name"], command,
188
os.WEXITSTATUS(condition)))
191
log.info('Checker for client %s (command "%s") failed'
192
" with exit code %d", self.properties["Name"],
193
command, os.WEXITSTATUS(condition))
189
194
elif os.WIFSIGNALED(condition):
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
os.WTERMSIG(condition)))
194
elif os.WCOREDUMP(condition):
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
199
self.logger('Checker for client {} completed'
201
.format(self.properties["Name"]))
195
log.info('Checker for client %s (command "%s") was'
196
" killed by signal %d", self.properties["Name"],
197
command, os.WTERMSIG(condition))
204
200
def checker_started(self, command):
205
201
"""Server signals that a checker started."""
206
self.logger('Client {} started checker "{}"'
207
.format(self.properties["Name"],
202
log.debug('Client %s started checker "%s"',
203
self.properties["Name"], command)
210
205
def got_secret(self):
211
self.logger('Client {} received its secret'
212
.format(self.properties["Name"]))
206
log.info("Client %s received its secret",
207
self.properties["Name"])
214
209
def need_approval(self, timeout, default):
216
message = 'Client {} needs approval within {} seconds'
211
message = "Client %s needs approval within %f seconds"
218
message = 'Client {} will get its secret in {} seconds'
219
self.logger(message.format(self.properties["Name"],
213
message = "Client %s will get its secret in %f seconds"
214
log.info(message, self.properties["Name"], timeout/1000)
222
216
def rejected(self, reason):
223
self.logger('Client {} was rejected; reason: {}'
224
.format(self.properties["Name"], reason))
217
log.info("Client %s was rejected; reason: %s",
218
self.properties["Name"], reason)
226
220
def selectable(self):
227
221
"""Make this a "selectable" widget.
228
222
This overrides the method from urwid.FlowWidget."""
231
225
def rows(self, maxcolrow, focus=False):
232
226
"""How many rows this widget will occupy might depend on
233
227
whether we have focus or not.
234
228
This overrides the method from urwid.FlowWidget"""
235
229
return self.current_widget(focus).rows(maxcolrow, focus=focus)
237
231
def current_widget(self, focus=False):
238
232
if focus or self.opened:
239
233
return self._focus_widget
240
234
return self._widget
242
236
def update(self):
243
237
"Called when what is visible on the screen should be updated."
244
238
# How to add standout mode to a style
245
with_standout = { "normal": "standout",
246
"bold": "bold-standout",
248
"underline-blink-standout",
249
"bold-underline-blink":
250
"bold-underline-blink-standout",
239
with_standout = {"normal": "standout",
240
"bold": "bold-standout",
242
"underline-blink-standout",
243
"bold-underline-blink":
244
"bold-underline-blink-standout",
253
247
# Rebuild focus and non-focus widgets using current properties
255
249
# Base part of a client. Name!
256
base = '{name}: '.format(name=self.properties["Name"])
250
base = "{name}: ".format(name=self.properties["Name"])
257
251
if not self.properties["Enabled"]:
258
252
message = "DISABLED"
259
253
self.using_timer(False)
260
254
elif self.properties["ApprovalPending"]:
261
timeout = datetime.timedelta(milliseconds
255
timeout = datetime.timedelta(
256
milliseconds=self.properties["ApprovalDelay"])
264
257
last_approval_request = isoformat_to_datetime(
265
258
self.properties["LastApprovalRequest"])
266
259
if last_approval_request is not None:
326
320
if self.delete_hook is not None:
327
321
self.delete_hook(self)
328
322
return super(MandosClientWidget, self).delete(**kwargs)
330
324
def render(self, maxcolrow, focus=False):
331
325
"""Render differently if we have focus.
332
326
This overrides the method from urwid.FlowWidget"""
333
327
return self.current_widget(focus).render(maxcolrow,
336
330
def keypress(self, maxcolrow, key):
338
332
This overrides the method from urwid.FlowWidget"""
340
self.proxy.Enable(dbus_interface = client_interface,
334
self.proxy.Set(client_interface, "Enabled",
335
dbus.Boolean(True), ignore_reply=True,
336
dbus_interface=dbus.PROPERTIES_IFACE)
343
self.proxy.Disable(dbus_interface = client_interface,
338
self.proxy.Set(client_interface, "Enabled", False,
340
dbus_interface=dbus.PROPERTIES_IFACE)
346
342
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface = client_interface,
343
dbus_interface=client_interface,
348
344
ignore_reply=True)
350
346
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface = client_interface,
347
dbus_interface=client_interface,
352
348
ignore_reply=True)
353
349
elif key == "R" or key == "_" or key == "ctrl k":
354
350
self.server_proxy_object.RemoveClient(self.proxy
356
352
ignore_reply=True)
358
self.proxy.StartChecker(dbus_interface = client_interface,
354
self.proxy.Set(client_interface, "CheckerRunning",
355
dbus.Boolean(True), ignore_reply=True,
356
dbus_interface=dbus.PROPERTIES_IFACE)
361
self.proxy.StopChecker(dbus_interface = client_interface,
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(False), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
364
self.proxy.CheckedOK(dbus_interface = client_interface,
362
self.proxy.CheckedOK(dbus_interface=client_interface,
365
363
ignore_reply=True)
367
365
# elif key == "p" or key == "=":
426
436
"bold,underline,blink,standout", "default",
427
437
"bold,underline,blink,standout"),
430
440
if urwid.supports_unicode():
431
self.divider = "─" # \u2500
432
#self.divider = "━" # \u2501
441
self.divider = "─" # \u2500
434
#self.divider = "-" # \u002d
435
self.divider = "_" # \u005f
443
self.divider = "_" # \u005f
437
445
self.screen.start()
439
447
self.size = self.screen.get_cols_rows()
441
449
self.clients = urwid.SimpleListWalker([])
442
450
self.clients_dict = {}
444
452
# We will add Text widgets to this list
453
self.log = urwid.SimpleListWalker([])
446
454
self.max_log_length = max_log_length
448
self.log_level = log_level
450
456
# We keep a reference to the log widget so we can remove it
451
457
# from the ListWalker without it getting destroyed
452
458
self.logbox = ConstrainedListBox(self.log)
454
460
# This keeps track of whether self.uilist currently has
455
461
# self.logbox in it or not
456
462
self.log_visible = True
457
463
self.log_wrap = "any"
465
self.loghandler = UILogHandler(self)
460
self.log_message_raw(("bold",
461
"Mandos Monitor version " + version))
462
self.log_message_raw(("bold",
465
self.busname = domain + '.Mandos'
466
self.main_loop = gobject.MainLoop()
468
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
468
self.add_log_line(("bold",
469
"Mandos Monitor version " + version))
470
self.add_log_line(("bold", "q: Quit ?: Help"))
472
self.busname = domain + ".Mandos"
473
self.main_loop = GLib.MainLoop()
475
def client_not_found(self, key_id, address):
476
log.info("Client with address %s and key ID %s could"
477
" not be found", address, key_id)
473
479
def rebuild(self):
474
480
"""This rebuilds the User Interface.
475
481
Call this when the widget layout needs to change"""
477
#self.uilist.append(urwid.ListBox(self.clients))
483
# self.uilist.append(urwid.ListBox(self.clients))
478
484
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
480
#header=urwid.Divider(),
486
# header=urwid.Divider(),
483
urwid.Divider(div_char=
488
footer=urwid.Divider(
489
div_char=self.divider)))
485
490
if self.log_visible:
486
491
self.uilist.append(self.logbox)
487
492
self.topwidget = urwid.Pile(self.uilist)
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
493
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
497
def log_message_raw(self, markup, level=1):
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
494
def add_log_line(self, markup):
501
495
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
if (self.max_log_length
503
and 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),
496
if self.max_log_length:
497
if len(self.log) > self.max_log_length:
498
del self.log[0:(len(self.log) - self.max_log_length)]
499
self.logbox.set_focus(len(self.logbox.body.contents)-1,
506
500
coming_from="above")
509
503
def toggle_log_display(self):
510
504
"""Toggle visibility of the log buffer."""
511
505
self.log_visible = not self.log_visible
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
507
log.debug("Log visibility changed to: %s", self.log_visible)
516
509
def change_log_display(self):
517
510
"""Change type of log display.
518
511
Currently, this toggles wrapping of text lines."""
522
515
self.log_wrap = "clip"
523
516
for textwidget in self.log:
524
517
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, name):
518
log.debug("Wrap mode: %s", self.log_wrap)
520
def find_and_remove_client(self, path, interfaces):
529
521
"""Find a client by its object path and remove it.
531
This is connected to the ClientRemoved signal from the
523
This is connected to the InterfacesRemoved signal from the
532
524
Mandos server object."""
525
if client_interface not in interfaces:
526
# Not a Mandos client object; ignore
534
529
client = self.clients_dict[path]
537
self.log_message("Unknown client {!r} ({!r}) removed"
532
log.warning("Unknown client %s removed", path)
542
def add_new_client(self, path):
536
def add_new_client(self, path, ifs_and_props):
537
"""Find a client by its object path and remove it.
539
This is connected to the InterfacesAdded signal from the
540
Mandos server object.
542
if client_interface not in ifs_and_props:
543
# Not a Mandos client object; ignore
543
545
client_proxy_object = self.bus.get_object(self.busname, path)
544
self.add_client(MandosClientWidget(server_proxy_object
547
=client_proxy_object,
546
self.add_client(MandosClientWidget(
547
server_proxy_object=self.mandos_serv,
548
proxy_object=client_proxy_object,
549
update_hook=self.refresh,
550
delete_hook=self.remove_client,
551
properties=dict(ifs_and_props[client_interface])),
556
554
def add_client(self, client, path=None):
557
555
self.clients.append(client)
560
558
self.clients_dict[path] = client
561
559
self.clients.sort(key=lambda c: c.properties["Name"])
564
562
def remove_client(self, client, path=None):
565
563
self.clients.remove(client)
567
565
path = client.proxy.object_path
568
566
del self.clients_dict[path]
571
569
def refresh(self):
572
570
"""Redraw the screen"""
573
571
canvas = self.topwidget.render(self.size, focus=True)
574
572
self.screen.draw_screen(self.size, canvas)
577
575
"""Start the main loop and exit when it's done."""
576
log.addHandler(self.loghandler)
577
self.orig_log_propagate = log.propagate
578
log.propagate = False
579
self.orig_log_level = log.level
578
581
self.bus = dbus.SystemBus()
579
582
mandos_dbus_objc = self.bus.get_object(
580
583
self.busname, "/", follow_name_owner_changes=True)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
584
self.mandos_serv = dbus.Interface(
585
mandos_dbus_objc, dbus_interface=server_interface)
585
587
mandos_clients = (self.mandos_serv
586
588
.GetAllClientsWithProperties())
587
589
if not mandos_clients:
588
self.log_message_raw(("bold", "Note: Server has no clients."))
590
log.warning("Note: Server has no clients.")
589
591
except dbus.exceptions.DBusException:
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
592
log.warning("Note: No Mandos server running.")
591
593
mandos_clients = dbus.Dictionary()
593
595
(self.mandos_serv
594
.connect_to_signal("ClientRemoved",
596
.connect_to_signal("InterfacesRemoved",
595
597
self.find_and_remove_client,
596
dbus_interface=server_interface,
598
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
599
byte_arrays=True))
598
600
(self.mandos_serv
599
.connect_to_signal("ClientAdded",
601
.connect_to_signal("InterfacesAdded",
600
602
self.add_new_client,
601
dbus_interface=server_interface,
603
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
602
604
byte_arrays=True))
603
605
(self.mandos_serv
604
606
.connect_to_signal("ClientNotFound",
608
610
for path, client in mandos_clients.items():
609
611
client_proxy_object = self.bus.get_object(self.busname,
611
self.add_client(MandosClientWidget(server_proxy_object
614
=client_proxy_object,
613
self.add_client(MandosClientWidget(
614
server_proxy_object=self.mandos_serv,
615
proxy_object=client_proxy_object,
617
update_hook=self.refresh,
618
delete_hook=self.remove_client),
625
self._input_callback_tag = (gobject.io_add_watch
622
self._input_callback_tag = (
624
GLib.IOChannel.unix_new(sys.stdin.fileno()),
625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
626
glib_safely(self.process_input)))
629
627
self.main_loop.run()
630
628
# Main loop has finished, we should close everything now
631
gobject.source_remove(self._input_callback_tag)
629
GLib.source_remove(self._input_callback_tag)
630
with warnings.catch_warnings():
631
warnings.simplefilter("ignore", BytesWarning)
635
635
self.main_loop.quit()
636
log.removeHandler(self.loghandler)
637
log.propagate = self.orig_log_propagate
637
639
def process_input(self, source, condition):
638
640
keys = self.screen.get_input()
639
translations = { "ctrl n": "down", # Emacs
640
"ctrl p": "up", # Emacs
641
"ctrl v": "page down", # Emacs
642
"meta v": "page up", # Emacs
643
" ": "page down", # less
644
"f": "page down", # less
645
"b": "page up", # less
641
translations = {"ctrl n": "down", # Emacs
642
"ctrl p": "up", # Emacs
643
"ctrl v": "page down", # Emacs
644
"meta v": "page up", # Emacs
645
" ": "page down", # less
646
"f": "page down", # less
647
"b": "page up", # less
651
653
key = translations[key]
652
654
except KeyError: # :-)
655
657
if key == "q" or key == "Q":
699
700
self.topwidget.set_focus(self.logbox)
702
if self.log_level == 0:
704
self.log_message("Verbose mode: Off")
703
if log.level < logging.INFO:
704
log.setLevel(logging.INFO)
705
log.info("Verbose mode: Off")
707
self.log_message("Verbose mode: On")
708
#elif (key == "end" or key == "meta >" or key == "G"
710
# pass # xxx end-of-buffer
711
#elif (key == "home" or key == "meta <" or key == "g"
713
# pass # xxx beginning-of-buffer
714
#elif key == "ctrl e" or key == "$":
715
# pass # xxx move-end-of-line
716
#elif key == "ctrl a" or key == "^":
717
# pass # xxx move-beginning-of-line
718
#elif key == "ctrl b" or key == "meta (" or key == "h":
720
#elif key == "ctrl f" or key == "meta )" or key == "l":
723
# pass # scroll up log
725
# pass # scroll down log
707
log.setLevel(logging.NOTSET)
708
log.info("Verbose mode: On")
709
# elif (key == "end" or key == "meta >" or key == "G"
711
# pass # xxx end-of-buffer
712
# elif (key == "home" or key == "meta <" or key == "g"
714
# pass # xxx beginning-of-buffer
715
# elif key == "ctrl e" or key == "$":
716
# pass # xxx move-end-of-line
717
# elif key == "ctrl a" or key == "^":
718
# pass # xxx move-beginning-of-line
719
# elif key == "ctrl b" or key == "meta (" or key == "h":
721
# elif key == "ctrl f" or key == "meta )" or key == "l":
724
# pass # scroll up log
726
# pass # scroll down log
726
727
elif self.topwidget.selectable():
727
728
self.topwidget.keypress(self.size, key)
733
class UILogHandler(logging.Handler):
734
def __init__(self, ui, *args, **kwargs):
736
super(UILogHandler, self).__init__(*args, **kwargs)
738
logging.Formatter("%(asctime)s: %(message)s"))
739
def emit(self, record):
740
msg = self.format(record)
741
if record.levelno > logging.INFO:
743
self.ui.add_log_line(msg)
731
746
ui = UserInterface()
734
749
except KeyboardInterrupt:
736
except Exception as e:
737
ui.log_message(str(e))
750
with warnings.catch_warnings():
751
warnings.filterwarnings("ignore", "", BytesWarning)
754
with warnings.catch_warnings():
755
warnings.filterwarnings("ignore", "", BytesWarning)