To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-monitor
- browse files at revision 889
- compare with another revision
- download diff
- download tarball
- view history from revision 889
- Committer: Teddy Hogeborn
- Date: 2016-11-26 23:21:16 UTC
- Revision ID: teddy@recompile.se-20161126232116-nhqk9x1qij09b7cx
Add comment in documentation source with clarifying text.
* intro.xml (INTRODUCTION): Add comment with clarification.
* intro.xml (INTRODUCTION): Add comment with clarification.
- files added:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-monitor
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
#
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2009-2011 Teddy Hogeborn
7
# Copyright © 2009-2011 Björn Påhlsson
8
#
5
#
6
# Copyright © 2009-2016 Teddy Hogeborn
7
# Copyright © 2009-2016 Björn Påhlsson
8
#
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
11
11
# the Free Software Foundation, either version 3 of the License, or
15
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
17
# GNU General Public License for more details.
18
#
18
#
19
19
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
21
#
22
# Contact the authors at <mandos@fukt.bsnet.se>.
23
#
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
22
#
23
# Contact the authors at <mandos@recompile.se>.
24
#
24
25
25
26
from __future__ import (division, absolute_import, print_function,
26
27
unicode_literals)
28
try:
29
from future_builtins import *
30
except ImportError:
31
pass
27
32
28
33
import sys
29
34
import os
30
import signal
31
35
32
36
import datetime
33
37
35
39
import urwid
36
40
37
41
from dbus.mainloop.glib import DBusGMainLoop
38
import gobject
42
from gi.repository import GLib
39
43
40
44
import dbus
41
45
42
import UserList
43
44
46
import locale
45
47
48
import logging
49
50
if sys.version_info.major == 2:
51
str = unicode
52
46
53
locale.setlocale(locale.LC_ALL, '')
47
54
48
import logging
49
55
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
50
56
51
57
# Some useful constants
52
domain = 'se.bsnet.fukt'
58
domain = 'se.recompile'
53
59
server_interface = domain + '.Mandos'
54
60
client_interface = domain + '.Mandos.Client'
55
version = "1.3.1"
56
57
# Always run in monochrome mode
58
urwid.curses_display.curses.has_colors = lambda : False
59
60
# Urwid doesn't support blinking, but we want it. Since we have no
61
# use for underline on its own, we make underline also always blink.
62
urwid.curses_display.curses.A_UNDERLINE |= (
63
urwid.curses_display.curses.A_BLINK)
61
version = "1.7.13"
62
63
try:
64
dbus.OBJECT_MANAGER_IFACE
65
except AttributeError:
66
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
67
64
68
65
69
def isoformat_to_datetime(iso):
66
70
"Parse an ISO 8601 date string to a datetime.datetime()"
75
79
int(day),
76
80
int(hour),
77
81
int(minute),
78
int(second), # Whole seconds
79
int(fraction*1000000)) # Microseconds
82
int(second), # Whole seconds
83
int(fraction*1000000)) # Microseconds
84
80
85
81
86
class MandosClientPropertyCache(object):
82
87
"""This wraps a Mandos Client D-Bus proxy object, caches the
83
88
properties and calls a hook function when any of them are
84
89
changed.
85
90
"""
86
def __init__(self, proxy_object=None, *args, **kwargs):
87
self.proxy = proxy_object # Mandos Client proxy object
88
89
self.properties = dict()
91
def __init__(self, proxy_object=None, properties=None, **kwargs):
92
self.proxy = proxy_object # Mandos Client proxy object
93
self.properties = dict() if properties is None else properties
90
94
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
93
client_interface,
95
self.proxy.connect_to_signal("PropertiesChanged",
96
self.properties_changed,
97
dbus.PROPERTIES_IFACE,
94
98
byte_arrays=True))
95
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
99
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
102
# *args, **kwargs)
103
104
def property_changed(self, property=None, value=None):
105
"""This is called whenever we get a PropertyChanged signal
106
It updates the changed property in the "properties" dict.
99
100
if properties is None:
101
self.properties.update(self.proxy.GetAll(
102
client_interface,
103
dbus_interface=dbus.PROPERTIES_IFACE))
104
105
super(MandosClientPropertyCache, self).__init__(**kwargs)
106
107
def properties_changed(self, interface, properties, invalidated):
108
"""This is called whenever we get a PropertiesChanged signal
109
It updates the changed properties in the "properties" dict.
107
110
"""
108
111
# Update properties dict with new value
109
self.properties[property] = value
110
111
def delete(self, *args, **kwargs):
112
if interface == client_interface:
113
self.properties.update(properties)
114
115
def delete(self):
112
116
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
114
*args, **kwargs)
115
117
116
118
117
119
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
118
120
"""A Mandos Client which is visible on the screen.
119
121
"""
120
122
121
123
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, *args, **kwargs):
124
delete_hook=None, logger=None, **kwargs):
123
125
# Called on update
124
126
self.update_hook = update_hook
125
127
# Called on delete
128
130
self.server_proxy_object = server_proxy_object
129
131
# Logger
130
132
self.logger = logger
131
133
132
134
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
134
self.last_checker_failed = False
135
135
136
136
# The widget shown normally
137
137
self._text_widget = urwid.Text("")
138
138
# The widget shown when we have focus
139
139
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(
141
update_hook=update_hook, delete_hook=delete_hook,
142
*args, **kwargs)
140
super(MandosClientWidget, self).__init__(**kwargs)
143
141
self.update()
144
142
self.opened = False
145
146
last_checked_ok = isoformat_to_datetime(self.properties
147
["LastCheckedOK"])
148
if last_checked_ok is None:
149
self.last_checker_failed = True
150
else:
151
self.last_checker_failed = ((datetime.datetime.utcnow()
152
- last_checked_ok)
153
> datetime.timedelta
154
(milliseconds=
155
self.properties
156
["Interval"]))
157
158
if self.last_checker_failed:
159
self.using_timer(True)
160
161
if self.need_approval:
162
self.using_timer(True)
163
143
164
144
self.match_objects = (
165
145
self.proxy.connect_to_signal("CheckerCompleted",
166
146
self.checker_completed,
182
162
self.rejected,
183
163
client_interface,
184
164
byte_arrays=True))
185
#self.logger('Created client %s' % (self.properties["Name"]))
186
187
def property_changed(self, property=None, value=None):
188
super(self, MandosClientWidget).property_changed(property,
189
value)
190
if property == "ApprovalPending":
191
using_timer(bool(value))
192
165
self.logger('Created client {}'
166
.format(self.properties["Name"]), level=0)
167
193
168
def using_timer(self, flag):
194
169
"""Call this method with True or False when timer should be
195
170
activated or deactivated.
196
171
"""
197
old = self._update_timer_callback_lock
198
if flag:
199
self._update_timer_callback_lock += 1
200
else:
201
self._update_timer_callback_lock -= 1
202
if old == 0 and self._update_timer_callback_lock:
203
self._update_timer_callback_tag = (gobject.timeout_add
172
if flag and self._update_timer_callback_tag is None:
173
# Will update the shown timer value every second
174
self._update_timer_callback_tag = (GLib.timeout_add
204
175
(1000,
205
176
self.update_timer))
206
elif old and self._update_timer_callback_lock == 0:
207
gobject.source_remove(self._update_timer_callback_tag)
177
elif not (flag or self._update_timer_callback_tag is None):
178
GLib.source_remove(self._update_timer_callback_tag)
208
179
self._update_timer_callback_tag = None
209
180
210
181
def checker_completed(self, exitstatus, condition, command):
211
182
if exitstatus == 0:
212
if self.last_checker_failed:
213
self.last_checker_failed = False
214
self.using_timer(False)
215
#self.logger('Checker for client %s (command "%s")'
216
# ' was successful'
217
# % (self.properties["Name"], command))
183
self.logger('Checker for client {} (command "{}")'
184
' succeeded'.format(self.properties["Name"],
185
command), level=0)
218
186
self.update()
219
187
return
220
188
# Checker failed
221
if not self.last_checker_failed:
222
self.last_checker_failed = True
223
self.using_timer(True)
224
189
if os.WIFEXITED(condition):
225
self.logger('Checker for client %s (command "%s")'
226
' failed with exit code %s'
227
% (self.properties["Name"], command,
228
os.WEXITSTATUS(condition)))
190
self.logger('Checker for client {} (command "{}") failed'
191
' with exit code {}'
192
.format(self.properties["Name"], command,
193
os.WEXITSTATUS(condition)))
229
194
elif os.WIFSIGNALED(condition):
230
self.logger('Checker for client %s (command "%s")'
231
' was killed by signal %s'
232
% (self.properties["Name"], command,
233
os.WTERMSIG(condition)))
234
elif os.WCOREDUMP(condition):
235
self.logger('Checker for client %s (command "%s")'
236
' dumped core'
237
% (self.properties["Name"], command))
238
else:
239
self.logger('Checker for client %s completed'
240
' mysteriously')
195
self.logger('Checker for client {} (command "{}") was'
196
' killed by signal {}'
197
.format(self.properties["Name"], command,
198
os.WTERMSIG(condition)))
241
199
self.update()
242
200
243
201
def checker_started(self, command):
244
#self.logger('Client %s started checker "%s"'
245
# % (self.properties["Name"], unicode(command)))
246
pass
247
202
"""Server signals that a checker started."""
203
self.logger('Client {} started checker "{}"'
204
.format(self.properties["Name"],
205
command), level=0)
206
248
207
def got_secret(self):
249
self.last_checker_failed = False
250
self.logger('Client %s received its secret'
251
% self.properties["Name"])
252
208
self.logger('Client {} received its secret'
209
.format(self.properties["Name"]))
210
253
211
def need_approval(self, timeout, default):
254
212
if not default:
255
message = 'Client %s needs approval within %s seconds'
213
message = 'Client {} needs approval within {} seconds'
256
214
else:
257
message = 'Client %s will get its secret in %s seconds'
258
self.logger(message
259
% (self.properties["Name"], timeout/1000))
260
self.using_timer(True)
261
215
message = 'Client {} will get its secret in {} seconds'
216
self.logger(message.format(self.properties["Name"],
217
timeout/1000))
218
262
219
def rejected(self, reason):
263
self.logger('Client %s was rejected; reason: %s'
264
% (self.properties["Name"], reason))
265
220
self.logger('Client {} was rejected; reason: {}'
221
.format(self.properties["Name"], reason))
222
266
223
def selectable(self):
267
224
"""Make this a "selectable" widget.
268
225
This overrides the method from urwid.FlowWidget."""
269
226
return True
270
227
271
228
def rows(self, maxcolrow, focus=False):
272
229
"""How many rows this widget will occupy might depend on
273
230
whether we have focus or not.
274
231
This overrides the method from urwid.FlowWidget"""
275
232
return self.current_widget(focus).rows(maxcolrow, focus=focus)
276
233
277
234
def current_widget(self, focus=False):
278
235
if focus or self.opened:
279
236
return self._focus_widget
280
237
return self._widget
281
238
282
239
def update(self):
283
240
"Called when what is visible on the screen should be updated."
284
241
# How to add standout mode to a style
285
with_standout = { "normal": "standout",
286
"bold": "bold-standout",
287
"underline-blink":
288
"underline-blink-standout",
289
"bold-underline-blink":
290
"bold-underline-blink-standout",
291
}
242
with_standout = {"normal": "standout",
243
"bold": "bold-standout",
244
"underline-blink":
245
"underline-blink-standout",
246
"bold-underline-blink":
247
"bold-underline-blink-standout",
248
}
292
249
293
250
# Rebuild focus and non-focus widgets using current properties
294
251
295
252
# Base part of a client. Name!
296
base = ('%(name)s: '
297
% {"name": self.properties["Name"]})
253
base = '{name}: '.format(name=self.properties["Name"])
298
254
if not self.properties["Enabled"]:
299
255
message = "DISABLED"
256
self.using_timer(False)
300
257
elif self.properties["ApprovalPending"]:
301
timeout = datetime.timedelta(milliseconds
302
= self.properties
303
["ApprovalDelay"])
258
timeout = datetime.timedelta(
259
milliseconds=self.properties["ApprovalDelay"])
304
260
last_approval_request = isoformat_to_datetime(
305
261
self.properties["LastApprovalRequest"])
306
262
if last_approval_request is not None:
307
timer = timeout - (datetime.datetime.utcnow()
308
- last_approval_request)
263
timer = max(timeout - (datetime.datetime.utcnow()
264
- last_approval_request),
265
datetime.timedelta())
309
266
else:
310
267
timer = datetime.timedelta()
311
268
if self.properties["ApprovedByDefault"]:
312
message = "Approval in %s. (d)eny?"
313
else:
314
message = "Denial in %s. (a)pprove?"
315
message = message % unicode(timer).rsplit(".", 1)[0]
316
elif self.last_checker_failed:
317
timeout = datetime.timedelta(milliseconds
318
= self.properties
319
["Timeout"])
320
last_ok = isoformat_to_datetime(
321
max((self.properties["LastCheckedOK"]
322
or self.properties["Created"]),
323
self.properties["LastEnabled"]))
324
timer = timeout - (datetime.datetime.utcnow() - last_ok)
269
message = "Approval in {}. (d)eny?"
270
else:
271
message = "Denial in {}. (a)pprove?"
272
message = message.format(str(timer).rsplit(".", 1)[0])
273
self.using_timer(True)
274
elif self.properties["LastCheckerStatus"] != 0:
275
# When checker has failed, show timer until client expires
276
expires = self.properties["Expires"]
277
if expires == "":
278
timer = datetime.timedelta(0)
279
else:
280
expires = (datetime.datetime.strptime
281
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
282
timer = max(expires - datetime.datetime.utcnow(),
283
datetime.timedelta())
325
284
message = ('A checker has failed! Time until client'
326
' gets disabled: %s'
327
% unicode(timer).rsplit(".", 1)[0])
285
' gets disabled: {}'
286
.format(str(timer).rsplit(".", 1)[0]))
287
self.using_timer(True)
328
288
else:
329
289
message = "enabled"
330
self._text = "%s%s" % (base, message)
331
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
292
332
293
if not urwid.supports_unicode():
333
294
self._text = self._text.encode("ascii", "replace")
334
295
textlist = [("normal", self._text)]
344
305
# Run update hook, if any
345
306
if self.update_hook is not None:
346
307
self.update_hook()
347
308
348
309
def update_timer(self):
349
"called by gobject"
310
"""called by GLib. Will indefinitely loop until
311
GLib.source_remove() on tag is called
312
"""
350
313
self.update()
351
314
return True # Keep calling this
352
353
def delete(self, *args, **kwargs):
315
316
def delete(self, **kwargs):
354
317
if self._update_timer_callback_tag is not None:
355
gobject.source_remove(self._update_timer_callback_tag)
318
GLib.source_remove(self._update_timer_callback_tag)
356
319
self._update_timer_callback_tag = None
357
320
for match in self.match_objects:
358
321
match.remove()
359
322
self.match_objects = ()
360
323
if self.delete_hook is not None:
361
324
self.delete_hook(self)
362
return super(MandosClientWidget, self).delete(*args, **kwargs)
363
325
return super(MandosClientWidget, self).delete(**kwargs)
326
364
327
def render(self, maxcolrow, focus=False):
365
328
"""Render differently if we have focus.
366
329
This overrides the method from urwid.FlowWidget"""
367
330
return self.current_widget(focus).render(maxcolrow,
368
331
focus=focus)
369
332
370
333
def keypress(self, maxcolrow, key):
371
334
"""Handle keys.
372
335
This overrides the method from urwid.FlowWidget"""
373
336
if key == "+":
374
self.proxy.Enable(dbus_interface = client_interface,
375
ignore_reply=True)
337
self.proxy.Set(client_interface, "Enabled",
338
dbus.Boolean(True), ignore_reply=True,
339
dbus_interface=dbus.PROPERTIES_IFACE)
376
340
elif key == "-":
377
self.proxy.Disable(dbus_interface = client_interface,
378
ignore_reply=True)
341
self.proxy.Set(client_interface, "Enabled", False,
342
ignore_reply=True,
343
dbus_interface=dbus.PROPERTIES_IFACE)
379
344
elif key == "a":
380
345
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
381
dbus_interface = client_interface,
346
dbus_interface=client_interface,
382
347
ignore_reply=True)
383
348
elif key == "d":
384
349
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
385
dbus_interface = client_interface,
350
dbus_interface=client_interface,
386
351
ignore_reply=True)
387
352
elif key == "R" or key == "_" or key == "ctrl k":
388
353
self.server_proxy_object.RemoveClient(self.proxy
389
354
.object_path,
390
355
ignore_reply=True)
391
356
elif key == "s":
392
self.proxy.StartChecker(dbus_interface = client_interface,
393
ignore_reply=True)
357
self.proxy.Set(client_interface, "CheckerRunning",
358
dbus.Boolean(True), ignore_reply=True,
359
dbus_interface=dbus.PROPERTIES_IFACE)
394
360
elif key == "S":
395
self.proxy.StopChecker(dbus_interface = client_interface,
396
ignore_reply=True)
361
self.proxy.Set(client_interface, "CheckerRunning",
362
dbus.Boolean(False), ignore_reply=True,
363
dbus_interface=dbus.PROPERTIES_IFACE)
397
364
elif key == "C":
398
self.proxy.CheckedOK(dbus_interface = client_interface,
365
self.proxy.CheckedOK(dbus_interface=client_interface,
399
366
ignore_reply=True)
400
367
# xxx
401
368
# elif key == "p" or key == "=":
406
373
# self.open()
407
374
else:
408
375
return key
409
410
def property_changed(self, property=None, value=None,
411
*args, **kwargs):
412
"""Call self.update() if old value is not new value.
376
377
def properties_changed(self, interface, properties, invalidated):
378
"""Call self.update() if any properties changed.
413
379
This overrides the method from MandosClientPropertyCache"""
414
property_name = unicode(property)
415
old_value = self.properties.get(property_name)
416
super(MandosClientWidget, self).property_changed(
417
property=property, value=value, *args, **kwargs)
418
if self.properties.get(property_name) != old_value:
380
old_values = {key: self.properties.get(key)
381
for key in properties.keys()}
382
super(MandosClientWidget, self).properties_changed(
383
interface, properties, invalidated)
384
if any(old_values[key] != self.properties.get(key)
385
for key in old_values):
419
386
self.update()
420
387
421
388
424
391
"down" key presses, thus not allowing any containing widgets to
425
392
use them as an excuse to shift focus away from this widget.
426
393
"""
427
def keypress(self, maxcolrow, key):
428
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
394
def keypress(self, *args, **kwargs):
395
ret = (super(ConstrainedListBox, self)
396
.keypress(*args, **kwargs))
429
397
if ret in ("up", "down"):
430
398
return
431
399
return ret
435
403
"""This is the entire user interface - the whole screen
436
404
with boxes, lists of client widgets, etc.
437
405
"""
438
def __init__(self, max_log_length=1000):
406
def __init__(self, max_log_length=1000, log_level=1):
439
407
DBusGMainLoop(set_as_default=True)
440
408
441
409
self.screen = urwid.curses_display.Screen()
442
410
443
411
self.screen.register_palette((
444
412
("normal",
445
413
"default", "default", None),
446
414
("bold",
447
"default", "default", "bold"),
415
"bold", "default", "bold"),
448
416
("underline-blink",
449
"default", "default", "underline"),
417
"underline,blink", "default", "underline,blink"),
450
418
("standout",
451
"default", "default", "standout"),
419
"standout", "default", "standout"),
452
420
("bold-underline-blink",
453
"default", "default", ("bold", "underline")),
421
"bold,underline,blink", "default",
422
"bold,underline,blink"),
454
423
("bold-standout",
455
"default", "default", ("bold", "standout")),
424
"bold,standout", "default", "bold,standout"),
456
425
("underline-blink-standout",
457
"default", "default", ("underline", "standout")),
426
"underline,blink,standout", "default",
427
"underline,blink,standout"),
458
428
("bold-underline-blink-standout",
459
"default", "default", ("bold", "underline",
460
"standout")),
429
"bold,underline,blink,standout", "default",
430
"bold,underline,blink,standout"),
461
431
))
462
432
463
433
if urwid.supports_unicode():
464
self.divider = "─" # \u2500
465
#self.divider = "━" # \u2501
434
self.divider = "─" # \u2500
466
435
else:
467
#self.divider = "-" # \u002d
468
self.divider = "_" # \u005f
469
436
self.divider = "_" # \u005f
437
470
438
self.screen.start()
471
439
472
440
self.size = self.screen.get_cols_rows()
473
441
474
442
self.clients = urwid.SimpleListWalker([])
475
443
self.clients_dict = {}
476
444
477
445
# We will add Text widgets to this list
478
446
self.log = []
479
447
self.max_log_length = max_log_length
480
448
449
self.log_level = log_level
450
481
451
# We keep a reference to the log widget so we can remove it
482
452
# from the ListWalker without it getting destroyed
483
453
self.logbox = ConstrainedListBox(self.log)
484
454
485
455
# This keeps track of whether self.uilist currently has
486
456
# self.logbox in it or not
487
457
self.log_visible = True
488
458
self.log_wrap = "any"
489
459
490
460
self.rebuild()
491
461
self.log_message_raw(("bold",
492
462
"Mandos Monitor version " + version))
493
463
self.log_message_raw(("bold",
494
464
"q: Quit ?: Help"))
495
465
496
466
self.busname = domain + '.Mandos'
497
self.main_loop = gobject.MainLoop()
498
self.bus = dbus.SystemBus()
499
mandos_dbus_objc = self.bus.get_object(
500
self.busname, "/", follow_name_owner_changes=True)
501
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
502
dbus_interface
503
= server_interface)
504
try:
505
mandos_clients = (self.mandos_serv
506
.GetAllClientsWithProperties())
507
except dbus.exceptions.DBusException:
508
mandos_clients = dbus.Dictionary()
509
510
(self.mandos_serv
511
.connect_to_signal("ClientRemoved",
512
self.find_and_remove_client,
513
dbus_interface=server_interface,
514
byte_arrays=True))
515
(self.mandos_serv
516
.connect_to_signal("ClientAdded",
517
self.add_new_client,
518
dbus_interface=server_interface,
519
byte_arrays=True))
520
(self.mandos_serv
521
.connect_to_signal("ClientNotFound",
522
self.client_not_found,
523
dbus_interface=server_interface,
524
byte_arrays=True))
525
for path, client in mandos_clients.iteritems():
526
client_proxy_object = self.bus.get_object(self.busname,
527
path)
528
self.add_client(MandosClientWidget(server_proxy_object
529
=self.mandos_serv,
530
proxy_object
531
=client_proxy_object,
532
properties=client,
533
update_hook
534
=self.refresh,
535
delete_hook
536
=self.remove_client,
537
logger
538
=self.log_message),
539
path=path)
540
467
self.main_loop = GLib.MainLoop()
468
541
469
def client_not_found(self, fingerprint, address):
542
self.log_message(("Client with address %s and fingerprint %s"
543
" could not be found" % (address,
544
fingerprint)))
545
470
self.log_message("Client with address {} and fingerprint {}"
471
" could not be found"
472
.format(address, fingerprint))
473
546
474
def rebuild(self):
547
475
"""This rebuilds the User Interface.
548
476
Call this when the widget layout needs to change"""
549
477
self.uilist = []
550
#self.uilist.append(urwid.ListBox(self.clients))
478
# self.uilist.append(urwid.ListBox(self.clients))
551
479
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
552
480
clients),
553
#header=urwid.Divider(),
481
# header=urwid.Divider(),
554
482
header=None,
555
footer=
556
urwid.Divider(div_char=
557
self.divider)))
483
footer=urwid.Divider(
484
div_char=self.divider)))
558
485
if self.log_visible:
559
486
self.uilist.append(self.logbox)
560
pass
561
487
self.topwidget = urwid.Pile(self.uilist)
562
563
def log_message(self, message):
488
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
492
return
564
493
timestamp = datetime.datetime.now().isoformat()
565
self.log_message_raw(timestamp + ": " + message)
566
567
def log_message_raw(self, markup):
494
self.log_message_raw("{}: {}".format(timestamp, message),
495
level=level)
496
497
def log_message_raw(self, markup, level=1):
568
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
500
return
569
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
570
if (self.max_log_length
571
and len(self.log) > self.max_log_length):
572
del self.log[0:len(self.log)-self.max_log_length-1]
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]
573
505
self.logbox.set_focus(len(self.logbox.body.contents),
574
506
coming_from="above")
575
507
self.refresh()
576
508
577
509
def toggle_log_display(self):
578
510
"""Toggle visibility of the log buffer."""
579
511
self.log_visible = not self.log_visible
580
512
self.rebuild()
581
#self.log_message("Log visibility changed to: "
582
# + unicode(self.log_visible))
583
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
515
584
516
def change_log_display(self):
585
517
"""Change type of log display.
586
518
Currently, this toggles wrapping of text lines."""
590
522
self.log_wrap = "clip"
591
523
for textwidget in self.log:
592
524
textwidget.set_wrap_mode(self.log_wrap)
593
#self.log_message("Wrap mode: " + self.log_wrap)
594
595
def find_and_remove_client(self, path, name):
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
526
level=0)
527
528
def find_and_remove_client(self, path, interfaces):
596
529
"""Find a client by its object path and remove it.
597
598
This is connected to the ClientRemoved signal from the
530
531
This is connected to the InterfacesRemoved signal from the
599
532
Mandos server object."""
533
if client_interface not in interfaces:
534
# Not a Mandos client object; ignore
535
return
600
536
try:
601
537
client = self.clients_dict[path]
602
538
except KeyError:
603
539
# not found?
604
self.log_message("Unknown client %r (%r) removed", name,
605
path)
540
self.log_message("Unknown client {!r} removed"
541
.format(path))
606
542
return
607
543
client.delete()
608
609
def add_new_client(self, path):
544
545
def add_new_client(self, path, ifs_and_props):
546
"""Find a client by its object path and remove it.
547
548
This is connected to the InterfacesAdded signal from the
549
Mandos server object.
550
"""
551
if client_interface not in ifs_and_props:
552
# Not a Mandos client object; ignore
553
return
610
554
client_proxy_object = self.bus.get_object(self.busname, path)
611
self.add_client(MandosClientWidget(server_proxy_object
612
=self.mandos_serv,
613
proxy_object
614
=client_proxy_object,
615
update_hook
616
=self.refresh,
617
delete_hook
618
=self.remove_client,
619
logger
620
=self.log_message),
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])),
621
562
path=path)
622
563
623
564
def add_client(self, client, path=None):
624
565
self.clients.append(client)
625
566
if path is None:
626
567
path = client.proxy.object_path
627
568
self.clients_dict[path] = client
628
self.clients.sort(None, lambda c: c.properties["Name"])
569
self.clients.sort(key=lambda c: c.properties["Name"])
629
570
self.refresh()
630
571
631
572
def remove_client(self, client, path=None):
632
573
self.clients.remove(client)
633
574
if path is None:
634
575
path = client.proxy.object_path
635
576
del self.clients_dict[path]
636
if not self.clients_dict:
637
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
638
# is completely emptied, we need to recreate it.
639
self.clients = urwid.SimpleListWalker([])
640
self.rebuild()
641
577
self.refresh()
642
578
643
579
def refresh(self):
644
580
"""Redraw the screen"""
645
581
canvas = self.topwidget.render(self.size, focus=True)
646
582
self.screen.draw_screen(self.size, canvas)
647
583
648
584
def run(self):
649
585
"""Start the main loop and exit when it's done."""
586
self.bus = dbus.SystemBus()
587
mandos_dbus_objc = self.bus.get_object(
588
self.busname, "/", follow_name_owner_changes=True)
589
self.mandos_serv = dbus.Interface(
590
mandos_dbus_objc, dbus_interface=server_interface)
591
try:
592
mandos_clients = (self.mandos_serv
593
.GetAllClientsWithProperties())
594
if not mandos_clients:
595
self.log_message_raw(("bold",
596
"Note: Server has no clients."))
597
except dbus.exceptions.DBusException:
598
self.log_message_raw(("bold",
599
"Note: No Mandos server running."))
600
mandos_clients = dbus.Dictionary()
601
602
(self.mandos_serv
603
.connect_to_signal("InterfacesRemoved",
604
self.find_and_remove_client,
605
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
606
byte_arrays=True))
607
(self.mandos_serv
608
.connect_to_signal("InterfacesAdded",
609
self.add_new_client,
610
dbus_interface=dbus.OBJECT_MANAGER_IFACE,
611
byte_arrays=True))
612
(self.mandos_serv
613
.connect_to_signal("ClientNotFound",
614
self.client_not_found,
615
dbus_interface=server_interface,
616
byte_arrays=True))
617
for path, client in mandos_clients.items():
618
client_proxy_object = self.bus.get_object(self.busname,
619
path)
620
self.add_client(MandosClientWidget(
621
server_proxy_object=self.mandos_serv,
622
proxy_object=client_proxy_object,
623
properties=client,
624
update_hook=self.refresh,
625
delete_hook=self.remove_client,
626
logger=self.log_message),
627
path=path)
628
650
629
self.refresh()
651
self._input_callback_tag = (gobject.io_add_watch
630
self._input_callback_tag = (GLib.io_add_watch
652
631
(sys.stdin.fileno(),
653
gobject.IO_IN,
632
GLib.IO_IN,
654
633
self.process_input))
655
634
self.main_loop.run()
656
635
# Main loop has finished, we should close everything now
657
gobject.source_remove(self._input_callback_tag)
636
GLib.source_remove(self._input_callback_tag)
658
637
self.screen.stop()
659
638
660
639
def stop(self):
661
640
self.main_loop.quit()
662
641
663
642
def process_input(self, source, condition):
664
643
keys = self.screen.get_input()
665
translations = { "ctrl n": "down", # Emacs
666
"ctrl p": "up", # Emacs
667
"ctrl v": "page down", # Emacs
668
"meta v": "page up", # Emacs
669
" ": "page down", # less
670
"f": "page down", # less
671
"b": "page up", # less
672
"j": "down", # vi
673
"k": "up", # vi
674
}
644
translations = {"ctrl n": "down", # Emacs
645
"ctrl p": "up", # Emacs
646
"ctrl v": "page down", # Emacs
647
"meta v": "page up", # Emacs
648
" ": "page down", # less
649
"f": "page down", # less
650
"b": "page up", # less
651
"j": "down", # vi
652
"k": "up", # vi
653
}
675
654
for key in keys:
676
655
try:
677
656
key = translations[key]
678
657
except KeyError: # :-)
679
658
pass
680
659
681
660
if key == "q" or key == "Q":
682
661
self.stop()
683
662
break
684
663
elif key == "window resize":
685
664
self.size = self.screen.get_cols_rows()
686
665
self.refresh()
687
elif key == "\f": # Ctrl-L
666
elif key == "ctrl l":
667
self.screen.clear()
688
668
self.refresh()
689
669
elif key == "l" or key == "D":
690
670
self.toggle_log_display()
702
682
"?: Help",
703
683
"l: Log window toggle",
704
684
"TAB: Switch window",
705
"w: Wrap (log)"))))
685
"w: Wrap (log lines)",
686
"v: Toggle verbose log",
687
))))
706
688
self.log_message_raw(("bold",
707
689
" "
708
690
.join(("Clients:",
721
703
else:
722
704
self.topwidget.set_focus(self.logbox)
723
705
self.refresh()
724
#elif (key == "end" or key == "meta >" or key == "G"
725
# or key == ">"):
726
# pass # xxx end-of-buffer
727
#elif (key == "home" or key == "meta <" or key == "g"
728
# or key == "<"):
729
# pass # xxx beginning-of-buffer
730
#elif key == "ctrl e" or key == "$":
731
# pass # xxx move-end-of-line
732
#elif key == "ctrl a" or key == "^":
733
# pass # xxx move-beginning-of-line
734
#elif key == "ctrl b" or key == "meta (" or key == "h":
735
# pass # xxx left
736
#elif key == "ctrl f" or key == "meta )" or key == "l":
737
# pass # xxx right
738
#elif key == "a":
739
# pass # scroll up log
740
#elif key == "z":
741
# pass # scroll down log
706
elif key == "v":
707
if self.log_level == 0:
708
self.log_level = 1
709
self.log_message("Verbose mode: Off")
710
else:
711
self.log_level = 0
712
self.log_message("Verbose mode: On")
713
# elif (key == "end" or key == "meta >" or key == "G"
714
# or key == ">"):
715
# pass # xxx end-of-buffer
716
# elif (key == "home" or key == "meta <" or key == "g"
717
# or key == "<"):
718
# pass # xxx beginning-of-buffer
719
# elif key == "ctrl e" or key == "$":
720
# pass # xxx move-end-of-line
721
# elif key == "ctrl a" or key == "^":
722
# pass # xxx move-beginning-of-line
723
# elif key == "ctrl b" or key == "meta (" or key == "h":
724
# pass # xxx left
725
# elif key == "ctrl f" or key == "meta )" or key == "l":
726
# pass # xxx right
727
# elif key == "a":
728
# pass # scroll up log
729
# elif key == "z":
730
# pass # scroll down log
742
731
elif self.topwidget.selectable():
743
732
self.topwidget.keypress(self.size, key)
744
733
self.refresh()
745
734
return True
746
735
736
747
737
ui = UserInterface()
748
738
try:
749
739
ui.run()
750
740
except KeyboardInterrupt:
751
741
ui.screen.stop()
752
except Exception, e:
753
ui.log_message(unicode(e))
742
except Exception as e:
743
ui.log_message(str(e))
754
744
ui.screen.stop()
755
745
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0