/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

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-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
 
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
 
#
24
 
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
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
 
30
import signal
36
31
 
37
32
import datetime
38
33
 
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
 
domain = 'se.recompile'
 
52
domain = 'se.bsnet.fukt'
60
53
server_interface = domain + '.Mandos'
61
54
client_interface = domain + '.Mandos.Client'
62
 
version = "1.7.19"
63
 
 
64
 
try:
65
 
    dbus.OBJECT_MANAGER_IFACE
66
 
except AttributeError:
67
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
68
 
 
 
55
version = "1.3.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:
174
 
            # Will update the shown timer value every second
175
 
            self._update_timer_callback_tag = (GLib.timeout_add
 
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:
 
203
            self._update_timer_callback_tag = (gobject.timeout_add
176
204
                                               (1000,
177
205
                                                self.update_timer))
178
 
        elif not (flag or self._update_timer_callback_tag is None):
179
 
            GLib.source_remove(self._update_timer_callback_tag)
 
206
        elif old and self._update_timer_callback_lock == 0:
 
207
            gobject.source_remove(self._update_timer_callback_tag)
180
208
            self._update_timer_callback_tag = None
181
 
 
 
209
    
182
210
    def checker_completed(self, exitstatus, condition, command):
183
211
        if exitstatus == 0:
184
 
            self.logger('Checker for client {} (command "{}")'
185
 
                        ' succeeded'.format(self.properties["Name"],
186
 
                                            command), level=0)
 
212
            if self.last_checker_failed:
 
213
                self.last_checker_failed = False
 
214
                self.using_timer(False)
 
215
            #self.logger('Checker for client %s (command "%s")'
 
216
            #            ' was successful'
 
217
            #            % (self.properties["Name"], command))
187
218
            self.update()
188
219
            return
189
220
        # Checker failed
 
221
        if not self.last_checker_failed:
 
222
            self.last_checker_failed = True
 
223
            self.using_timer(True)
190
224
        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)))
 
225
            self.logger('Checker for client %s (command "%s")'
 
226
                        ' failed with exit code %s'
 
227
                        % (self.properties["Name"], command,
 
228
                           os.WEXITSTATUS(condition)))
195
229
        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)))
 
230
            self.logger('Checker for client %s (command "%s")'
 
231
                        ' was killed by signal %s'
 
232
                        % (self.properties["Name"], command,
 
233
                           os.WTERMSIG(condition)))
 
234
        elif os.WCOREDUMP(condition):
 
235
            self.logger('Checker for client %s (command "%s")'
 
236
                        ' dumped core'
 
237
                        % (self.properties["Name"], command))
 
238
        else:
 
239
            self.logger('Checker for client %s completed'
 
240
                        ' mysteriously')
200
241
        self.update()
201
 
 
 
242
    
202
243
    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
 
 
 
244
        #self.logger('Client %s started checker "%s"'
 
245
        #            % (self.properties["Name"], unicode(command)))
 
246
        pass
 
247
    
208
248
    def got_secret(self):
209
 
        self.logger('Client {} received its secret'
210
 
                    .format(self.properties["Name"]))
211
 
 
 
249
        self.last_checker_failed = False
 
250
        self.logger('Client %s received its secret'
 
251
                    % self.properties["Name"])
 
252
    
212
253
    def need_approval(self, timeout, default):
213
254
        if not default:
214
 
            message = 'Client {} needs approval within {} seconds'
 
255
            message = 'Client %s needs approval within %s seconds'
215
256
        else:
216
 
            message = 'Client {} will get its secret in {} seconds'
217
 
        self.logger(message.format(self.properties["Name"],
218
 
                                   timeout/1000))
219
 
 
 
257
            message = 'Client %s will get its secret in %s seconds'
 
258
        self.logger(message
 
259
                    % (self.properties["Name"], timeout/1000))
 
260
        self.using_timer(True)
 
261
    
220
262
    def rejected(self, reason):
221
 
        self.logger('Client {} was rejected; reason: {}'
222
 
                    .format(self.properties["Name"], reason))
223
 
 
 
263
        self.logger('Client %s was rejected; reason: %s'
 
264
                    % (self.properties["Name"], reason))
 
265
    
224
266
    def selectable(self):
225
267
        """Make this a "selectable" widget.
226
268
        This overrides the method from urwid.FlowWidget."""
227
269
        return True
228
 
 
 
270
    
229
271
    def rows(self, maxcolrow, focus=False):
230
272
        """How many rows this widget will occupy might depend on
231
273
        whether we have focus or not.
232
274
        This overrides the method from urwid.FlowWidget"""
233
275
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
234
 
 
 
276
    
235
277
    def current_widget(self, focus=False):
236
278
        if focus or self.opened:
237
279
            return self._focus_widget
238
280
        return self._widget
239
 
 
 
281
    
240
282
    def update(self):
241
283
        "Called when what is visible on the screen should be updated."
242
284
        # 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
 
                         }
 
285
        with_standout = { "normal": "standout",
 
286
                          "bold": "bold-standout",
 
287
                          "underline-blink":
 
288
                              "underline-blink-standout",
 
289
                          "bold-underline-blink":
 
290
                              "bold-underline-blink-standout",
 
291
                          }
250
292
 
251
293
        # Rebuild focus and non-focus widgets using current properties
252
294
 
253
295
        # Base part of a client. Name!
254
 
        base = '{name}: '.format(name=self.properties["Name"])
 
296
        base = ('%(name)s: '
 
297
                      % {"name": self.properties["Name"]})
255
298
        if not self.properties["Enabled"]:
256
299
            message = "DISABLED"
257
 
            self.using_timer(False)
258
300
        elif self.properties["ApprovalPending"]:
259
 
            timeout = datetime.timedelta(
260
 
                milliseconds=self.properties["ApprovalDelay"])
 
301
            timeout = datetime.timedelta(milliseconds
 
302
                                         = self.properties
 
303
                                         ["ApprovalDelay"])
261
304
            last_approval_request = isoformat_to_datetime(
262
305
                self.properties["LastApprovalRequest"])
263
306
            if last_approval_request is not None:
264
 
                timer = max(timeout - (datetime.datetime.utcnow()
265
 
                                       - last_approval_request),
266
 
                            datetime.timedelta())
 
307
                timer = timeout - (datetime.datetime.utcnow()
 
308
                                   - last_approval_request)
267
309
            else:
268
310
                timer = datetime.timedelta()
269
311
            if self.properties["ApprovedByDefault"]:
270
 
                message = "Approval in {}. (d)eny?"
271
 
            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
277
 
            expires = self.properties["Expires"]
278
 
            if expires == "":
279
 
                timer = datetime.timedelta(0)
280
 
            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())
 
312
                message = "Approval in %s. (d)eny?"
 
313
            else:
 
314
                message = "Denial in %s. (a)pprove?"
 
315
            message = message % unicode(timer).rsplit(".", 1)[0]
 
316
        elif self.last_checker_failed:
 
317
            timeout = datetime.timedelta(milliseconds
 
318
                                         = self.properties
 
319
                                         ["Timeout"])
 
320
            last_ok = isoformat_to_datetime(
 
321
                max((self.properties["LastCheckedOK"]
 
322
                     or self.properties["Created"]),
 
323
                    self.properties["LastEnabled"]))
 
324
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
285
325
            message = ('A checker has failed! Time until client'
286
 
                       ' gets disabled: {}'
287
 
                       .format(str(timer).rsplit(".", 1)[0]))
288
 
            self.using_timer(True)
 
326
                       ' gets disabled: %s'
 
327
                           % unicode(timer).rsplit(".", 1)[0])
289
328
        else:
290
329
            message = "enabled"
291
 
            self.using_timer(False)
292
 
        self._text = "{}{}".format(base, message)
293
 
 
 
330
        self._text = "%s%s" % (base, message)
 
331
            
294
332
        if not urwid.supports_unicode():
295
333
            self._text = self._text.encode("ascii", "replace")
296
334
        textlist = [("normal", self._text)]
306
344
        # Run update hook, if any
307
345
        if self.update_hook is not None:
308
346
            self.update_hook()
309
 
 
 
347
    
310
348
    def update_timer(self):
311
 
        """called by GLib. Will indefinitely loop until
312
 
        GLib.source_remove() on tag is called
313
 
        """
 
349
        "called by gobject"
314
350
        self.update()
315
351
        return True             # Keep calling this
316
 
 
317
 
    def delete(self, **kwargs):
 
352
    
 
353
    def delete(self, *args, **kwargs):
318
354
        if self._update_timer_callback_tag is not None:
319
 
            GLib.source_remove(self._update_timer_callback_tag)
 
355
            gobject.source_remove(self._update_timer_callback_tag)
320
356
            self._update_timer_callback_tag = None
321
357
        for match in self.match_objects:
322
358
            match.remove()
323
359
        self.match_objects = ()
324
360
        if self.delete_hook is not None:
325
361
            self.delete_hook(self)
326
 
        return super(MandosClientWidget, self).delete(**kwargs)
327
 
 
 
362
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
363
    
328
364
    def render(self, maxcolrow, focus=False):
329
365
        """Render differently if we have focus.
330
366
        This overrides the method from urwid.FlowWidget"""
331
367
        return self.current_widget(focus).render(maxcolrow,
332
368
                                                 focus=focus)
333
 
 
 
369
    
334
370
    def keypress(self, maxcolrow, key):
335
371
        """Handle keys.
336
372
        This overrides the method from urwid.FlowWidget"""
337
373
        if key == "+":
338
 
            self.proxy.Set(client_interface, "Enabled",
339
 
                           dbus.Boolean(True), ignore_reply=True,
340
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
374
            self.proxy.Enable(dbus_interface = client_interface,
 
375
                              ignore_reply=True)
341
376
        elif key == "-":
342
 
            self.proxy.Set(client_interface, "Enabled", False,
343
 
                           ignore_reply=True,
344
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
377
            self.proxy.Disable(dbus_interface = client_interface,
 
378
                               ignore_reply=True)
345
379
        elif key == "a":
346
380
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
 
                               dbus_interface=client_interface,
 
381
                               dbus_interface = client_interface,
348
382
                               ignore_reply=True)
349
383
        elif key == "d":
350
384
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
 
                               dbus_interface=client_interface,
 
385
                                  dbus_interface = client_interface,
352
386
                               ignore_reply=True)
353
387
        elif key == "R" or key == "_" or key == "ctrl k":
354
388
            self.server_proxy_object.RemoveClient(self.proxy
355
389
                                                  .object_path,
356
390
                                                  ignore_reply=True)
357
391
        elif key == "s":
358
 
            self.proxy.Set(client_interface, "CheckerRunning",
359
 
                           dbus.Boolean(True), ignore_reply=True,
360
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
392
            self.proxy.StartChecker(dbus_interface = client_interface,
 
393
                                    ignore_reply=True)
361
394
        elif key == "S":
362
 
            self.proxy.Set(client_interface, "CheckerRunning",
363
 
                           dbus.Boolean(False), ignore_reply=True,
364
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
395
            self.proxy.StopChecker(dbus_interface = client_interface,
 
396
                                   ignore_reply=True)
365
397
        elif key == "C":
366
 
            self.proxy.CheckedOK(dbus_interface=client_interface,
 
398
            self.proxy.CheckedOK(dbus_interface = client_interface,
367
399
                                 ignore_reply=True)
368
400
        # xxx
369
401
#         elif key == "p" or key == "=":
374
406
#             self.open()
375
407
        else:
376
408
            return key
377
 
 
378
 
    def properties_changed(self, interface, properties, invalidated):
379
 
        """Call self.update() if any properties changed.
 
409
    
 
410
    def property_changed(self, property=None, value=None,
 
411
                         *args, **kwargs):
 
412
        """Call self.update() if old value is not new value.
380
413
        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):
 
414
        property_name = unicode(property)
 
415
        old_value = self.properties.get(property_name)
 
416
        super(MandosClientWidget, self).property_changed(
 
417
            property=property, value=value, *args, **kwargs)
 
418
        if self.properties.get(property_name) != old_value:
387
419
            self.update()
388
420
 
389
421
 
392
424
    "down" key presses, thus not allowing any containing widgets to
393
425
    use them as an excuse to shift focus away from this widget.
394
426
    """
395
 
    def keypress(self, *args, **kwargs):
396
 
        ret = (super(ConstrainedListBox, self)
397
 
               .keypress(*args, **kwargs))
 
427
    def keypress(self, maxcolrow, key):
 
428
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
398
429
        if ret in ("up", "down"):
399
430
            return
400
431
        return ret
404
435
    """This is the entire user interface - the whole screen
405
436
    with boxes, lists of client widgets, etc.
406
437
    """
407
 
    def __init__(self, max_log_length=1000, log_level=1):
 
438
    def __init__(self, max_log_length=1000):
408
439
        DBusGMainLoop(set_as_default=True)
409
 
 
 
440
        
410
441
        self.screen = urwid.curses_display.Screen()
411
 
 
 
442
        
412
443
        self.screen.register_palette((
413
444
                ("normal",
414
445
                 "default", "default", None),
415
446
                ("bold",
416
 
                 "bold", "default", "bold"),
 
447
                 "default", "default", "bold"),
417
448
                ("underline-blink",
418
 
                 "underline,blink", "default", "underline,blink"),
 
449
                 "default", "default", "underline"),
419
450
                ("standout",
420
 
                 "standout", "default", "standout"),
 
451
                 "default", "default", "standout"),
421
452
                ("bold-underline-blink",
422
 
                 "bold,underline,blink", "default",
423
 
                 "bold,underline,blink"),
 
453
                 "default", "default", ("bold", "underline")),
424
454
                ("bold-standout",
425
 
                 "bold,standout", "default", "bold,standout"),
 
455
                 "default", "default", ("bold", "standout")),
426
456
                ("underline-blink-standout",
427
 
                 "underline,blink,standout", "default",
428
 
                 "underline,blink,standout"),
 
457
                 "default", "default", ("underline", "standout")),
429
458
                ("bold-underline-blink-standout",
430
 
                 "bold,underline,blink,standout", "default",
431
 
                 "bold,underline,blink,standout"),
 
459
                 "default", "default", ("bold", "underline",
 
460
                                          "standout")),
432
461
                ))
433
 
 
 
462
        
434
463
        if urwid.supports_unicode():
435
 
            self.divider = "─"  # \u2500
 
464
            self.divider = "─" # \u2500
 
465
            #self.divider = "━" # \u2501
436
466
        else:
437
 
            self.divider = "_"  # \u005f
438
 
 
 
467
            #self.divider = "-" # \u002d
 
468
            self.divider = "_" # \u005f
 
469
        
439
470
        self.screen.start()
440
 
 
 
471
        
441
472
        self.size = self.screen.get_cols_rows()
442
 
 
 
473
        
443
474
        self.clients = urwid.SimpleListWalker([])
444
475
        self.clients_dict = {}
445
 
 
 
476
        
446
477
        # We will add Text widgets to this list
447
478
        self.log = []
448
479
        self.max_log_length = max_log_length
449
 
 
450
 
        self.log_level = log_level
451
 
 
 
480
        
452
481
        # We keep a reference to the log widget so we can remove it
453
482
        # from the ListWalker without it getting destroyed
454
483
        self.logbox = ConstrainedListBox(self.log)
455
 
 
 
484
        
456
485
        # This keeps track of whether self.uilist currently has
457
486
        # self.logbox in it or not
458
487
        self.log_visible = True
459
488
        self.log_wrap = "any"
460
 
 
 
489
        
461
490
        self.rebuild()
462
491
        self.log_message_raw(("bold",
463
492
                              "Mandos Monitor version " + version))
464
493
        self.log_message_raw(("bold",
465
494
                              "q: Quit  ?: Help"))
466
 
 
 
495
        
467
496
        self.busname = domain + '.Mandos'
468
 
        self.main_loop = GLib.MainLoop()
469
 
 
 
497
        self.main_loop = gobject.MainLoop()
 
498
        self.bus = dbus.SystemBus()
 
499
        mandos_dbus_objc = self.bus.get_object(
 
500
            self.busname, "/", follow_name_owner_changes=True)
 
501
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
502
                                          dbus_interface
 
503
                                          = server_interface)
 
504
        try:
 
505
            mandos_clients = (self.mandos_serv
 
506
                              .GetAllClientsWithProperties())
 
507
        except dbus.exceptions.DBusException:
 
508
            mandos_clients = dbus.Dictionary()
 
509
        
 
510
        (self.mandos_serv
 
511
         .connect_to_signal("ClientRemoved",
 
512
                            self.find_and_remove_client,
 
513
                            dbus_interface=server_interface,
 
514
                            byte_arrays=True))
 
515
        (self.mandos_serv
 
516
         .connect_to_signal("ClientAdded",
 
517
                            self.add_new_client,
 
518
                            dbus_interface=server_interface,
 
519
                            byte_arrays=True))
 
520
        (self.mandos_serv
 
521
         .connect_to_signal("ClientNotFound",
 
522
                            self.client_not_found,
 
523
                            dbus_interface=server_interface,
 
524
                            byte_arrays=True))
 
525
        for path, client in mandos_clients.iteritems():
 
526
            client_proxy_object = self.bus.get_object(self.busname,
 
527
                                                      path)
 
528
            self.add_client(MandosClientWidget(server_proxy_object
 
529
                                               =self.mandos_serv,
 
530
                                               proxy_object
 
531
                                               =client_proxy_object,
 
532
                                               properties=client,
 
533
                                               update_hook
 
534
                                               =self.refresh,
 
535
                                               delete_hook
 
536
                                               =self.remove_client,
 
537
                                               logger
 
538
                                               =self.log_message),
 
539
                            path=path)
 
540
    
470
541
    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
 
 
 
542
        self.log_message(("Client with address %s and fingerprint %s"
 
543
                          " could not be found" % (address,
 
544
                                                    fingerprint)))
 
545
    
475
546
    def rebuild(self):
476
547
        """This rebuilds the User Interface.
477
548
        Call this when the widget layout needs to change"""
478
549
        self.uilist = []
479
 
        # self.uilist.append(urwid.ListBox(self.clients))
 
550
        #self.uilist.append(urwid.ListBox(self.clients))
480
551
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
552
                                                          clients),
482
 
                                       # header=urwid.Divider(),
 
553
                                       #header=urwid.Divider(),
483
554
                                       header=None,
484
 
                                       footer=urwid.Divider(
485
 
                                           div_char=self.divider)))
 
555
                                       footer=
 
556
                                       urwid.Divider(div_char=
 
557
                                                     self.divider)))
486
558
        if self.log_visible:
487
559
            self.uilist.append(self.logbox)
 
560
            pass
488
561
        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
 
562
    
 
563
    def log_message(self, message):
494
564
        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):
 
565
        self.log_message_raw(timestamp + ": " + message)
 
566
    
 
567
    def log_message_raw(self, markup):
499
568
        """Add a log message to the log buffer."""
500
 
        if level < self.log_level:
501
 
            return
502
569
        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]
 
570
        if (self.max_log_length
 
571
            and len(self.log) > self.max_log_length):
 
572
            del self.log[0:len(self.log)-self.max_log_length-1]
506
573
        self.logbox.set_focus(len(self.logbox.body.contents),
507
574
                              coming_from="above")
508
575
        self.refresh()
509
 
 
 
576
    
510
577
    def toggle_log_display(self):
511
578
        """Toggle visibility of the log buffer."""
512
579
        self.log_visible = not self.log_visible
513
580
        self.rebuild()
514
 
        self.log_message("Log visibility changed to: {}"
515
 
                         .format(self.log_visible), level=0)
516
 
 
 
581
        #self.log_message("Log visibility changed to: "
 
582
        #                 + unicode(self.log_visible))
 
583
    
517
584
    def change_log_display(self):
518
585
        """Change type of log display.
519
586
        Currently, this toggles wrapping of text lines."""
523
590
            self.log_wrap = "clip"
524
591
        for textwidget in self.log:
525
592
            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):
 
593
        #self.log_message("Wrap mode: " + self.log_wrap)
 
594
    
 
595
    def find_and_remove_client(self, path, name):
530
596
        """Find a client by its object path and remove it.
531
 
 
532
 
        This is connected to the InterfacesRemoved signal from the
 
597
        
 
598
        This is connected to the ClientRemoved signal from the
533
599
        Mandos server object."""
534
 
        if client_interface not in interfaces:
535
 
            # Not a Mandos client object; ignore
536
 
            return
537
600
        try:
538
601
            client = self.clients_dict[path]
539
602
        except KeyError:
540
603
            # not found?
541
 
            self.log_message("Unknown client {!r} removed"
542
 
                             .format(path))
 
604
            self.log_message("Unknown client %r (%r) removed", name,
 
605
                             path)
543
606
            return
544
607
        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
 
608
    
 
609
    def add_new_client(self, path):
555
610
        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])),
 
611
        self.add_client(MandosClientWidget(server_proxy_object
 
612
                                           =self.mandos_serv,
 
613
                                           proxy_object
 
614
                                           =client_proxy_object,
 
615
                                           update_hook
 
616
                                           =self.refresh,
 
617
                                           delete_hook
 
618
                                           =self.remove_client,
 
619
                                           logger
 
620
                                           =self.log_message),
563
621
                        path=path)
564
 
 
 
622
    
565
623
    def add_client(self, client, path=None):
566
624
        self.clients.append(client)
567
625
        if path is None:
568
626
            path = client.proxy.object_path
569
627
        self.clients_dict[path] = client
570
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
628
        self.clients.sort(None, lambda c: c.properties["Name"])
571
629
        self.refresh()
572
 
 
 
630
    
573
631
    def remove_client(self, client, path=None):
574
632
        self.clients.remove(client)
575
633
        if path is None:
576
634
            path = client.proxy.object_path
577
635
        del self.clients_dict[path]
 
636
        if not self.clients_dict:
 
637
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
638
            # is completely emptied, we need to recreate it.
 
639
            self.clients = urwid.SimpleListWalker([])
 
640
            self.rebuild()
578
641
        self.refresh()
579
 
 
 
642
    
580
643
    def refresh(self):
581
644
        """Redraw the screen"""
582
645
        canvas = self.topwidget.render(self.size, focus=True)
583
646
        self.screen.draw_screen(self.size, canvas)
584
 
 
 
647
    
585
648
    def run(self):
586
649
        """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
650
        self.refresh()
631
 
        self._input_callback_tag = (GLib.io_add_watch
 
651
        self._input_callback_tag = (gobject.io_add_watch
632
652
                                    (sys.stdin.fileno(),
633
 
                                     GLib.IO_IN,
 
653
                                     gobject.IO_IN,
634
654
                                     self.process_input))
635
655
        self.main_loop.run()
636
656
        # Main loop has finished, we should close everything now
637
 
        GLib.source_remove(self._input_callback_tag)
 
657
        gobject.source_remove(self._input_callback_tag)
638
658
        self.screen.stop()
639
 
 
 
659
    
640
660
    def stop(self):
641
661
        self.main_loop.quit()
642
 
 
 
662
    
643
663
    def process_input(self, source, condition):
644
664
        keys = self.screen.get_input()
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
 
                        }
 
665
        translations = { "ctrl n": "down",      # Emacs
 
666
                         "ctrl p": "up",        # Emacs
 
667
                         "ctrl v": "page down", # Emacs
 
668
                         "meta v": "page up",   # Emacs
 
669
                         " ": "page down",      # less
 
670
                         "f": "page down",      # less
 
671
                         "b": "page up",        # less
 
672
                         "j": "down",           # vi
 
673
                         "k": "up",             # vi
 
674
                         }
655
675
        for key in keys:
656
676
            try:
657
677
                key = translations[key]
658
678
            except KeyError:    # :-)
659
679
                pass
660
 
 
 
680
            
661
681
            if key == "q" or key == "Q":
662
682
                self.stop()
663
683
                break
664
684
            elif key == "window resize":
665
685
                self.size = self.screen.get_cols_rows()
666
686
                self.refresh()
667
 
            elif key == "ctrl l":
668
 
                self.screen.clear()
 
687
            elif key == "\f":  # Ctrl-L
669
688
                self.refresh()
670
689
            elif key == "l" or key == "D":
671
690
                self.toggle_log_display()
683
702
                                            "?: Help",
684
703
                                            "l: Log window toggle",
685
704
                                            "TAB: Switch window",
686
 
                                            "w: Wrap (log lines)",
687
 
                                            "v: Toggle verbose log",
688
 
                                            ))))
 
705
                                            "w: Wrap (log)"))))
689
706
                self.log_message_raw(("bold",
690
707
                                      "  "
691
708
                                      .join(("Clients:",
704
721
                else:
705
722
                    self.topwidget.set_focus(self.logbox)
706
723
                self.refresh()
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
 
724
            #elif (key == "end" or key == "meta >" or key == "G"
 
725
            #      or key == ">"):
 
726
            #    pass            # xxx end-of-buffer
 
727
            #elif (key == "home" or key == "meta <" or key == "g"
 
728
            #      or key == "<"):
 
729
            #    pass            # xxx beginning-of-buffer
 
730
            #elif key == "ctrl e" or key == "$":
 
731
            #    pass            # xxx move-end-of-line
 
732
            #elif key == "ctrl a" or key == "^":
 
733
            #    pass            # xxx move-beginning-of-line
 
734
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
735
            #    pass            # xxx left
 
736
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
737
            #    pass            # xxx right
 
738
            #elif key == "a":
 
739
            #    pass            # scroll up log
 
740
            #elif key == "z":
 
741
            #    pass            # scroll down log
732
742
            elif self.topwidget.selectable():
733
743
                self.topwidget.keypress(self.size, key)
734
744
                self.refresh()
735
745
        return True
736
746
 
737
 
 
738
747
ui = UserInterface()
739
748
try:
740
749
    ui.run()
741
750
except KeyboardInterrupt:
742
751
    ui.screen.stop()
743
 
except Exception as e:
744
 
    ui.log_message(str(e))
 
752
except Exception, e:
 
753
    ui.log_message(unicode(e))
745
754
    ui.screen.stop()
746
755
    raise