/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

* mandos-monitor.xml: New.
* Makefile (PROGS): Add "mandos-monitor".
  (DOCS): Add "mandos-monitor.xml".
  (mandos-monitor.8, mandos-monitor.8.xhtml, mandos-monitor): New.
  (install-server): Install "mandos-ctl" and "mandos-monitor" too.
  (uninstall-server): Remove "mandos-ctl" and "mandos-monitor" too.
* mandos-monitor: Don't log uninteresting messages.

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