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