/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

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