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