/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-11-21 19:50:51 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20191121195051-jq57g07ybacsjw3r
Makefile: Declare phoniness of targets at each target

Instead of having one global list of .PHONY targets, with its
associated risk of that list becoming out-of-date, declare a target to
be phony at each target declaration.

* Makefile (.PHONY): Remove global list.  Spread out .PHONY
  declarations to be located before the declaration of each target.

Show diffs side-by-side

added added

removed removed

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