/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2014-06-14 23:43:07 UTC
  • Revision ID: teddy@recompile.se-20140614234307-i0mh9r2n4orkqtki
plugin-runner: Release memory and close FD's correctly in all cases.

* plugins.d/mandos-client.c (main): Init "direntries" to NULL.  Close
                                    "dir_fd" at fallback label.  Do
                                    not free "direntries" if
                                    scandirat() or scandir() failed.
                                    Do free(direntries) at fallback
                                    label.

Show diffs side-by-side

added added

removed removed

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