/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: 2009-12-25 23:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091225231347-gg9u9ru0wj0f24hh
More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

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