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