/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

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