/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2018-02-08 10:23:55 UTC
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

Show diffs side-by-side

added added

removed removed

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