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