/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: 2015-08-10 08:25:01 UTC
  • Revision ID: teddy@recompile.se-20150810082501-rb7w2dre1flqiqe2
Refactor D-Bus annotation class out from D-Bus properties class.

* mandos (DBusObjectWithAnnotations): New; factored out D-Bus
                                      annotations code from
                                      DBusObjectWithProperties class.
  (DBusObjectWithProperties): Inherit from DBusObjectWithAnnotations.
  (main/MandosDBusService): - '' -
  (main/MandosDBusService._foo): Removed interface annotation for
                                 "o.f.D.Property.EmitsChangedSignal";
                                 this object has no properties.

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