2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos Monitor - Control and monitor the Mandos server
6
# Copyright © 2009-2017 Teddy Hogeborn
7
# Copyright © 2009-2017 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
175
client_interface,
165
176
byte_arrays=True))
166
self.logger('Created client {}'
167
.format(self.properties["Name"]), level=0)
177
#self.logger('Created client {0}'
178
# .format(self.properties["Name"]))
180
def property_changed(self, property=None, value=None):
181
super(self, MandosClientWidget).property_changed(property,
183
if property == "ApprovalPending":
184
using_timer(bool(value))
185
if property == "LastCheckerStatus":
186
using_timer(value != 0)
187
#self.logger('Checker for client {0} (command "{1}") was '
188
# ' successful'.format(self.properties["Name"],
169
191
def using_timer(self, flag):
170
192
"""Call this method with True or False when timer should be
171
193
activated or deactivated.
173
if flag and self._update_timer_callback_tag is None:
195
old = self._update_timer_callback_lock
197
self._update_timer_callback_lock += 1
199
self._update_timer_callback_lock -= 1
200
if old == 0 and self._update_timer_callback_lock:
174
201
# Will update the shown timer value every second
175
self._update_timer_callback_tag = (GLib.timeout_add
202
self._update_timer_callback_tag = (gobject.timeout_add
177
204
self.update_timer))
178
elif not (flag or self._update_timer_callback_tag is None):
179
GLib.source_remove(self._update_timer_callback_tag)
205
elif old and self._update_timer_callback_lock == 0:
206
gobject.source_remove(self._update_timer_callback_tag)
180
207
self._update_timer_callback_tag = None
182
209
def checker_completed(self, exitstatus, condition, command):
183
210
if exitstatus == 0:
184
self.logger('Checker for client {} (command "{}")'
185
' succeeded'.format(self.properties["Name"],
190
214
if os.WIFEXITED(condition):
191
self.logger('Checker for client {} (command "{}") failed'
215
self.logger('Checker for client {0} (command "{1}")'
216
' failed with exit code {2}'
193
217
.format(self.properties["Name"], command,
194
218
os.WEXITSTATUS(condition)))
195
219
elif os.WIFSIGNALED(condition):
196
self.logger('Checker for client {} (command "{}") was'
197
' killed by signal {}'
220
self.logger('Checker for client {0} (command "{1}") was'
221
' killed by signal {2}'
198
222
.format(self.properties["Name"], command,
199
223
os.WTERMSIG(condition)))
224
elif os.WCOREDUMP(condition):
225
self.logger('Checker for client {0} (command "{1}")'
227
.format(self.properties["Name"], command))
229
self.logger('Checker for client {0} completed'
231
.format(self.properties["Name"]))
202
234
def checker_started(self, command):
203
"""Server signals that a checker started."""
204
self.logger('Client {} started checker "{}"'
205
.format(self.properties["Name"],
235
"""Server signals that a checker started. This could be useful
236
to log in the future. """
237
#self.logger('Client {0} started checker "{1}"'
238
# .format(self.properties["Name"],
208
242
def got_secret(self):
209
self.logger('Client {} received its secret'
243
self.logger('Client {0} received its secret'
210
244
.format(self.properties["Name"]))
212
246
def need_approval(self, timeout, default):
214
message = 'Client {} needs approval within {} seconds'
248
message = 'Client {0} needs approval within {1} seconds'
216
message = 'Client {} will get its secret in {} seconds'
250
message = 'Client {0} will get its secret in {1} seconds'
217
251
self.logger(message.format(self.properties["Name"],
253
self.using_timer(True)
220
255
def rejected(self, reason):
221
self.logger('Client {} was rejected; reason: {}'
256
self.logger('Client {0} was rejected; reason: {1}'
222
257
.format(self.properties["Name"], reason))
224
259
def selectable(self):
225
260
"""Make this a "selectable" widget.
226
261
This overrides the method from urwid.FlowWidget."""
229
264
def rows(self, maxcolrow, focus=False):
230
265
"""How many rows this widget will occupy might depend on
231
266
whether we have focus or not.
232
267
This overrides the method from urwid.FlowWidget"""
233
268
return self.current_widget(focus).rows(maxcolrow, focus=focus)
235
270
def current_widget(self, focus=False):
236
271
if focus or self.opened:
237
272
return self._focus_widget
238
273
return self._widget
240
275
def update(self):
241
276
"Called when what is visible on the screen should be updated."
242
277
# 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",
278
with_standout = { "normal": "standout",
279
"bold": "bold-standout",
281
"underline-blink-standout",
282
"bold-underline-blink":
283
"bold-underline-blink-standout",
251
286
# Rebuild focus and non-focus widgets using current properties
254
289
base = '{name}: '.format(name=self.properties["Name"])
255
290
if not self.properties["Enabled"]:
256
291
message = "DISABLED"
257
self.using_timer(False)
258
292
elif self.properties["ApprovalPending"]:
259
timeout = datetime.timedelta(
260
milliseconds=self.properties["ApprovalDelay"])
293
timeout = datetime.timedelta(milliseconds
261
296
last_approval_request = isoformat_to_datetime(
262
297
self.properties["LastApprovalRequest"])
263
298
if last_approval_request is not None:
264
timer = max(timeout - (datetime.datetime.utcnow()
265
- last_approval_request),
266
datetime.timedelta())
299
timer = timeout - (datetime.datetime.utcnow()
300
- last_approval_request)
268
302
timer = datetime.timedelta()
269
303
if self.properties["ApprovedByDefault"]:
270
message = "Approval in {}. (d)eny?"
304
message = "Approval in {0}. (d)eny?"
272
message = "Denial in {}. (a)pprove?"
273
message = message.format(str(timer).rsplit(".", 1)[0])
274
self.using_timer(True)
306
message = "Denial in {0}. (a)pprove?"
307
message = message.format(unicode(timer).rsplit(".", 1)[0])
275
308
elif self.properties["LastCheckerStatus"] != 0:
276
309
# When checker has failed, show timer until client expires
277
310
expires = self.properties["Expires"]
324
353
if self.delete_hook is not None:
325
354
self.delete_hook(self)
326
355
return super(MandosClientWidget, self).delete(**kwargs)
328
357
def render(self, maxcolrow, focus=False):
329
358
"""Render differently if we have focus.
330
359
This overrides the method from urwid.FlowWidget"""
331
360
return self.current_widget(focus).render(maxcolrow,
334
363
def keypress(self, maxcolrow, key):
336
365
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)
367
self.proxy.Enable(dbus_interface = client_interface,
342
self.proxy.Set(client_interface, "Enabled", False,
344
dbus_interface=dbus.PROPERTIES_IFACE)
370
self.proxy.Disable(dbus_interface = client_interface,
346
373
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
dbus_interface=client_interface,
374
dbus_interface = client_interface,
348
375
ignore_reply=True)
350
377
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
dbus_interface=client_interface,
378
dbus_interface = client_interface,
352
379
ignore_reply=True)
353
380
elif key == "R" or key == "_" or key == "ctrl k":
354
381
self.server_proxy_object.RemoveClient(self.proxy
356
383
ignore_reply=True)
358
self.proxy.Set(client_interface, "CheckerRunning",
359
dbus.Boolean(True), ignore_reply=True,
360
dbus_interface=dbus.PROPERTIES_IFACE)
385
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)
388
self.proxy.StopChecker(dbus_interface = client_interface,
366
self.proxy.CheckedOK(dbus_interface=client_interface,
391
self.proxy.CheckedOK(dbus_interface = client_interface,
367
392
ignore_reply=True)
369
394
# elif key == "p" or key == "=":
404
427
"""This is the entire user interface - the whole screen
405
428
with boxes, lists of client widgets, etc.
407
def __init__(self, max_log_length=1000, log_level=1):
430
def __init__(self, max_log_length=1000):
408
431
DBusGMainLoop(set_as_default=True)
410
433
self.screen = urwid.curses_display.Screen()
412
435
self.screen.register_palette((
414
437
"default", "default", None),
416
"bold", "default", "bold"),
439
"default", "default", "bold"),
417
440
("underline-blink",
418
"underline,blink", "default", "underline,blink"),
441
"default", "default", "underline"),
420
"standout", "default", "standout"),
443
"default", "default", "standout"),
421
444
("bold-underline-blink",
422
"bold,underline,blink", "default",
423
"bold,underline,blink"),
445
"default", "default", ("bold", "underline")),
424
446
("bold-standout",
425
"bold,standout", "default", "bold,standout"),
447
"default", "default", ("bold", "standout")),
426
448
("underline-blink-standout",
427
"underline,blink,standout", "default",
428
"underline,blink,standout"),
449
"default", "default", ("underline", "standout")),
429
450
("bold-underline-blink-standout",
430
"bold,underline,blink,standout", "default",
431
"bold,underline,blink,standout"),
451
"default", "default", ("bold", "underline",
434
455
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
456
self.divider = "─" # \u2500
457
#self.divider = "━" # \u2501
437
self.divider = "_" # \u005f
459
#self.divider = "-" # \u002d
460
self.divider = "_" # \u005f
439
462
self.screen.start()
441
464
self.size = self.screen.get_cols_rows()
443
466
self.clients = urwid.SimpleListWalker([])
444
467
self.clients_dict = {}
446
469
# We will add Text widgets to this list
448
471
self.max_log_length = max_log_length
450
self.log_level = log_level
452
473
# We keep a reference to the log widget so we can remove it
453
474
# from the ListWalker without it getting destroyed
454
475
self.logbox = ConstrainedListBox(self.log)
456
477
# This keeps track of whether self.uilist currently has
457
478
# self.logbox in it or not
458
479
self.log_visible = True
459
480
self.log_wrap = "any"
462
483
self.log_message_raw(("bold",
463
484
"Mandos Monitor version " + version))
464
485
self.log_message_raw(("bold",
465
486
"q: Quit ?: Help"))
467
488
self.busname = domain + '.Mandos'
468
self.main_loop = GLib.MainLoop()
489
self.main_loop = gobject.MainLoop()
470
491
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {} and fingerprint {}"
472
" could not be found"
492
self.log_message("Client with address {0} and fingerprint"
493
" {1} could not be found"
473
494
.format(address, fingerprint))
475
496
def rebuild(self):
476
497
"""This rebuilds the User Interface.
477
498
Call this when the widget layout needs to change"""
479
# self.uilist.append(urwid.ListBox(self.clients))
500
#self.uilist.append(urwid.ListBox(self.clients))
480
501
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
482
# header=urwid.Divider(),
503
#header=urwid.Divider(),
484
footer=urwid.Divider(
485
div_char=self.divider)))
506
urwid.Divider(div_char=
486
508
if self.log_visible:
487
509
self.uilist.append(self.logbox)
488
510
self.topwidget = urwid.Pile(self.uilist)
490
def log_message(self, message, level=1):
491
"""Log message formatted with timestamp"""
492
if level < self.log_level:
512
def log_message(self, message):
494
513
timestamp = datetime.datetime.now().isoformat()
495
self.log_message_raw("{}: {}".format(timestamp, message),
498
def log_message_raw(self, markup, level=1):
514
self.log_message_raw(timestamp + ": " + message)
516
def log_message_raw(self, markup):
499
517
"""Add a log message to the log buffer."""
500
if level < self.log_level:
502
518
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]
519
if (self.max_log_length
520
and len(self.log) > self.max_log_length):
521
del self.log[0:len(self.log)-self.max_log_length-1]
506
522
self.logbox.set_focus(len(self.logbox.body.contents),
507
523
coming_from="above")
510
526
def toggle_log_display(self):
511
527
"""Toggle visibility of the log buffer."""
512
528
self.log_visible = not self.log_visible
514
self.log_message("Log visibility changed to: {}"
515
.format(self.log_visible), level=0)
530
#self.log_message("Log visibility changed to: "
531
# + unicode(self.log_visible))
517
533
def change_log_display(self):
518
534
"""Change type of log display.
519
535
Currently, this toggles wrapping of text lines."""
523
539
self.log_wrap = "clip"
524
540
for textwidget in self.log:
525
541
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):
542
#self.log_message("Wrap mode: " + self.log_wrap)
544
def find_and_remove_client(self, path, name):
530
545
"""Find a client by its object path and remove it.
532
This is connected to the InterfacesRemoved signal from the
547
This is connected to the ClientRemoved signal from the
533
548
Mandos server object."""
534
if client_interface not in interfaces:
535
# Not a Mandos client object; ignore
538
550
client = self.clients_dict[path]
541
self.log_message("Unknown client {!r} removed"
553
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
558
def add_new_client(self, path):
555
559
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])),
560
self.add_client(MandosClientWidget(server_proxy_object
563
=client_proxy_object,
565
572
def add_client(self, client, path=None):
566
573
self.clients.append(client)
568
575
path = client.proxy.object_path
569
576
self.clients_dict[path] = client
570
self.clients.sort(key=lambda c: c.properties["Name"])
577
self.clients.sort(None, lambda c: c.properties["Name"])
573
580
def remove_client(self, client, path=None):
574
581
self.clients.remove(client)
576
583
path = client.proxy.object_path
577
584
del self.clients_dict[path]
585
if not self.clients_dict:
586
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
587
# is completely emptied, we need to recreate it.
588
self.clients = urwid.SimpleListWalker([])
580
592
def refresh(self):
581
593
"""Redraw the screen"""
582
594
canvas = self.topwidget.render(self.size, focus=True)
583
595
self.screen.draw_screen(self.size, canvas)
586
598
"""Start the main loop and exit when it's done."""
587
599
self.bus = dbus.SystemBus()
588
600
mandos_dbus_objc = self.bus.get_object(
589
601
self.busname, "/", follow_name_owner_changes=True)
590
self.mandos_serv = dbus.Interface(
591
mandos_dbus_objc, dbus_interface=server_interface)
602
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
593
606
mandos_clients = (self.mandos_serv
594
607
.GetAllClientsWithProperties())
595
if not mandos_clients:
596
self.log_message_raw(("bold",
597
"Note: Server has no clients."))
598
608
except dbus.exceptions.DBusException:
599
self.log_message_raw(("bold",
600
"Note: No Mandos server running."))
601
609
mandos_clients = dbus.Dictionary()
603
611
(self.mandos_serv
604
.connect_to_signal("InterfacesRemoved",
612
.connect_to_signal("ClientRemoved",
605
613
self.find_and_remove_client,
606
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
614
dbus_interface=server_interface,
607
615
byte_arrays=True))
608
616
(self.mandos_serv
609
.connect_to_signal("InterfacesAdded",
617
.connect_to_signal("ClientAdded",
610
618
self.add_new_client,
611
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
619
dbus_interface=server_interface,
612
620
byte_arrays=True))
613
621
(self.mandos_serv
614
622
.connect_to_signal("ClientNotFound",
615
623
self.client_not_found,
616
624
dbus_interface=server_interface,
617
625
byte_arrays=True))
618
for path, client in mandos_clients.items():
626
for path, client in mandos_clients.iteritems():
619
627
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),
629
self.add_client(MandosClientWidget(server_proxy_object
632
=client_proxy_object,
631
self._input_callback_tag = (GLib.io_add_watch
643
self._input_callback_tag = (gobject.io_add_watch
632
644
(sys.stdin.fileno(),
634
646
self.process_input))
635
647
self.main_loop.run()
636
648
# Main loop has finished, we should close everything now
637
GLib.source_remove(self._input_callback_tag)
649
gobject.source_remove(self._input_callback_tag)
638
650
self.screen.stop()
641
653
self.main_loop.quit()
643
655
def process_input(self, source, condition):
644
656
keys = self.screen.get_input()
645
translations = {"ctrl n": "down", # Emacs
646
"ctrl p": "up", # Emacs
647
"ctrl v": "page down", # Emacs
648
"meta v": "page up", # Emacs
649
" ": "page down", # less
650
"f": "page down", # less
651
"b": "page up", # less
657
translations = { "ctrl n": "down", # Emacs
658
"ctrl p": "up", # Emacs
659
"ctrl v": "page down", # Emacs
660
"meta v": "page up", # Emacs
661
" ": "page down", # less
662
"f": "page down", # less
663
"b": "page up", # less
657
669
key = translations[key]
658
670
except KeyError: # :-)
661
673
if key == "q" or key == "Q":
664
676
elif key == "window resize":
665
677
self.size = self.screen.get_cols_rows()
667
elif key == "ctrl l":
679
elif key == "\f": # Ctrl-L
670
681
elif key == "l" or key == "D":
671
682
self.toggle_log_display()
705
714
self.topwidget.set_focus(self.logbox)
708
if self.log_level == 0:
710
self.log_message("Verbose mode: Off")
713
self.log_message("Verbose mode: On")
714
# elif (key == "end" or key == "meta >" or key == "G"
716
# pass # xxx end-of-buffer
717
# elif (key == "home" or key == "meta <" or key == "g"
719
# pass # xxx beginning-of-buffer
720
# elif key == "ctrl e" or key == "$":
721
# pass # xxx move-end-of-line
722
# elif key == "ctrl a" or key == "^":
723
# pass # xxx move-beginning-of-line
724
# elif key == "ctrl b" or key == "meta (" or key == "h":
726
# elif key == "ctrl f" or key == "meta )" or key == "l":
729
# pass # scroll up log
731
# pass # scroll down log
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
732
734
elif self.topwidget.selectable():
733
735
self.topwidget.keypress(self.size, key)
738
739
ui = UserInterface()
741
742
except KeyboardInterrupt:
743
except Exception as e:
744
ui.log_message(str(e))
745
ui.log_message(unicode(e))