/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 at recompile
  • Date: 2011-12-27 03:56:39 UTC
  • mto: This revision was merged to the branch mainline in revision 541.
  • Revision ID: teddy@recompile.se-20111227035639-hvvgrqchckawlg02
Add wireless network hook

* network-hooks.s/bridge: Use canonical syntax for "ip" command.
* network-hooks.s/wireless: New.
* network-hooks.s/wireless.conf: - '' -
* plugins.d/mandos-client.c (run_network_hooks): Add new "CONNECT"
                                                 environment variable.
* plugins.d/mandos-client.xml (NETWORK HOOKS/REQUIREMENTS): Document
                                                            "CONNECT"
                                                            environment
                                                            variable.

Show diffs side-by-side

added added

removed removed

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