/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:
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
 
3
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
5
 
6
# Copyright © 2009-2014 Teddy Hogeborn
 
7
# Copyright © 2009-2014 Björn Påhlsson
 
8
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
 
19
# You should have received a copy of the GNU General Public License
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
 
23
# Contact the authors at <mandos@recompile.se>.
 
24
3
25
 
4
 
from __future__ import division, absolute_import, with_statement
 
26
from __future__ import (division, absolute_import, print_function,
 
27
                        unicode_literals)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
5
32
 
6
33
import sys
7
34
import os
8
 
import signal
9
35
 
10
36
import datetime
11
37
 
13
39
import urwid
14
40
 
15
41
from dbus.mainloop.glib import DBusGMainLoop
16
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
17
46
 
18
47
import dbus
19
48
 
20
 
import UserList
21
 
 
22
49
import locale
23
50
 
24
 
locale.setlocale(locale.LC_ALL, u'')
 
51
if sys.version_info.major == 2:
 
52
    str = unicode
 
53
 
 
54
locale.setlocale(locale.LC_ALL, '')
 
55
 
 
56
import logging
 
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
25
58
 
26
59
# Some useful constants
27
 
domain = 'se.bsnet.fukt'
 
60
domain = 'se.recompile'
28
61
server_interface = domain + '.Mandos'
29
62
client_interface = domain + '.Mandos.Client'
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)
 
63
version = "1.6.9"
 
64
 
 
65
def isoformat_to_datetime(iso):
 
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
67
    if not iso:
 
68
        return None
 
69
    d, t = iso.split("T", 1)
 
70
    year, month, day = d.split("-", 2)
 
71
    hour, minute, second = t.split(":", 2)
 
72
    second, fraction = divmod(float(second), 1)
 
73
    return datetime.datetime(int(year),
 
74
                             int(month),
 
75
                             int(day),
 
76
                             int(hour),
 
77
                             int(minute),
 
78
                             int(second),           # Whole seconds
 
79
                             int(fraction*1000000)) # Microseconds
39
80
 
40
81
class MandosClientPropertyCache(object):
41
82
    """This wraps a Mandos Client D-Bus proxy object, caches the
42
83
    properties and calls a hook function when any of them are
43
84
    changed.
44
85
    """
45
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
46
87
        self.proxy = proxy_object # Mandos Client proxy object
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)
 
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)
59
102
    
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.
 
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.
63
106
        """
64
107
        # Update properties dict with new value
65
 
        self.properties[property] = value
 
108
        self.properties.update(properties)
 
109
    
 
110
    def delete(self):
 
111
        self.property_changed_match.remove()
66
112
 
67
113
 
68
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
70
116
    """
71
117
    
72
118
    def __init__(self, server_proxy_object=None, update_hook=None,
73
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
119
                 delete_hook=None, logger=None, **kwargs):
74
120
        # Called on update
75
121
        self.update_hook = update_hook
76
122
        # Called on delete
80
126
        # Logger
81
127
        self.logger = logger
82
128
        
 
129
        self._update_timer_callback_tag = None
 
130
        
83
131
        # The widget shown normally
84
 
        self._text_widget = urwid.Text(u"")
 
132
        self._text_widget = urwid.Text("")
85
133
        # The widget shown when we have focus
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)
 
134
        self._focus_text_widget = urwid.Text("")
 
135
        super(MandosClientWidget, self).__init__(**kwargs)
90
136
        self.update()
91
137
        self.opened = False
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)
 
138
        
 
139
        self.match_objects = (
 
140
            self.proxy.connect_to_signal("CheckerCompleted",
 
141
                                         self.checker_completed,
 
142
                                         client_interface,
 
143
                                         byte_arrays=True),
 
144
            self.proxy.connect_to_signal("CheckerStarted",
 
145
                                         self.checker_started,
 
146
                                         client_interface,
 
147
                                         byte_arrays=True),
 
148
            self.proxy.connect_to_signal("GotSecret",
 
149
                                         self.got_secret,
 
150
                                         client_interface,
 
151
                                         byte_arrays=True),
 
152
            self.proxy.connect_to_signal("NeedApproval",
 
153
                                         self.need_approval,
 
154
                                         client_interface,
 
155
                                         byte_arrays=True),
 
156
            self.proxy.connect_to_signal("Rejected",
 
157
                                         self.rejected,
 
158
                                         client_interface,
 
159
                                         byte_arrays=True))
 
160
        self.logger('Created client {}'
 
161
                    .format(self.properties["Name"]), level=0)
 
162
    
 
163
    def using_timer(self, flag):
 
164
        """Call this method with True or False when timer should be
 
165
        activated or deactivated.
 
166
        """
 
167
        if flag and self._update_timer_callback_tag is None:
 
168
            # Will update the shown timer value every second
 
169
            self._update_timer_callback_tag = (gobject.timeout_add
 
170
                                               (1000,
 
171
                                                self.update_timer))
 
172
        elif not (flag or self._update_timer_callback_tag is None):
 
173
            gobject.source_remove(self._update_timer_callback_tag)
 
174
            self._update_timer_callback_tag = None
108
175
    
109
176
    def checker_completed(self, exitstatus, condition, command):
110
177
        if exitstatus == 0:
111
 
            self.logger(u'Checker for client %s (command "%s")'
112
 
                        u' was successful'
113
 
                        % (self.properties[u"name"], command))
 
178
            self.logger('Checker for client {} (command "{}")'
 
179
                        ' succeeded'.format(self.properties["Name"],
 
180
                                            command), level=0)
 
181
            self.update()
114
182
            return
 
183
        # Checker failed
115
184
        if os.WIFEXITED(condition):
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')
 
185
            self.logger('Checker for client {} (command "{}") failed'
 
186
                        ' with exit code {}'
 
187
                        .format(self.properties["Name"], command,
 
188
                                os.WEXITSTATUS(condition)))
 
189
        elif os.WIFSIGNALED(condition):
 
190
            self.logger('Checker for client {} (command "{}") was'
 
191
                        ' killed by signal {}'
 
192
                        .format(self.properties["Name"], command,
 
193
                                os.WTERMSIG(condition)))
 
194
        elif os.WCOREDUMP(condition):
 
195
            self.logger('Checker for client {} (command "{}") dumped'
 
196
                        ' core'.format(self.properties["Name"],
 
197
                                       command))
 
198
        else:
 
199
            self.logger('Checker for client {} completed'
 
200
                        ' mysteriously'
 
201
                        .format(self.properties["Name"]))
 
202
        self.update()
132
203
    
133
204
    def checker_started(self, command):
134
 
        self.logger(u'Client %s started checker "%s"'
135
 
                    % (self.properties[u"name"], unicode(command)))
 
205
        """Server signals that a checker started."""
 
206
        self.logger('Client {} started checker "{}"'
 
207
                    .format(self.properties["Name"],
 
208
                            command), level=0)
136
209
    
137
210
    def got_secret(self):
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"])
 
211
        self.logger('Client {} received its secret'
 
212
                    .format(self.properties["Name"]))
 
213
    
 
214
    def need_approval(self, timeout, default):
 
215
        if not default:
 
216
            message = 'Client {} needs approval within {} seconds'
 
217
        else:
 
218
            message = 'Client {} will get its secret in {} seconds'
 
219
        self.logger(message.format(self.properties["Name"],
 
220
                                   timeout/1000))
 
221
    
 
222
    def rejected(self, reason):
 
223
        self.logger('Client {} was rejected; reason: {}'
 
224
                    .format(self.properties["Name"], reason))
144
225
    
145
226
    def selectable(self):
146
227
        """Make this a "selectable" widget.
147
228
        This overrides the method from urwid.FlowWidget."""
148
229
        return True
149
230
    
150
 
    def rows(self, (maxcol,), focus=False):
 
231
    def rows(self, maxcolrow, focus=False):
151
232
        """How many rows this widget will occupy might depend on
152
233
        whether we have focus or not.
153
234
        This overrides the method from urwid.FlowWidget"""
154
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
235
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
155
236
    
156
237
    def current_widget(self, focus=False):
157
238
        if focus or self.opened:
161
242
    def update(self):
162
243
        "Called when what is visible on the screen should be updated."
163
244
        # How to add standout mode to a style
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",
 
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",
170
251
                          }
171
252
        
172
253
        # Rebuild focus and non-focus widgets using current properties
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")})
 
254
        
 
255
        # Base part of a client. Name!
 
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"]:
 
261
            timeout = datetime.timedelta(milliseconds
 
262
                                         = self.properties
 
263
                                         ["ApprovalDelay"])
 
264
            last_approval_request = isoformat_to_datetime(
 
265
                self.properties["LastApprovalRequest"])
 
266
            if last_approval_request is not None:
 
267
                timer = max(timeout - (datetime.datetime.utcnow()
 
268
                                       - last_approval_request),
 
269
                            datetime.timedelta())
 
270
            else:
 
271
                timer = datetime.timedelta()
 
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)
 
292
        else:
 
293
            message = "enabled"
 
294
            self.using_timer(False)
 
295
        self._text = "{}{}".format(base, message)
 
296
        
179
297
        if not urwid.supports_unicode():
180
298
            self._text = self._text.encode("ascii", "replace")
181
 
        textlist = [(u"normal", self._text)]
 
299
        textlist = [("normal", self._text)]
182
300
        self._text_widget.set_text(textlist)
183
301
        self._focus_text_widget.set_text([(with_standout[text[0]],
184
302
                                           text[1])
192
310
        if self.update_hook is not None:
193
311
            self.update_hook()
194
312
    
195
 
    def delete(self):
 
313
    def update_timer(self):
 
314
        """called by gobject. Will indefinitely loop until
 
315
        gobject.source_remove() on tag is called"""
 
316
        self.update()
 
317
        return True             # Keep calling this
 
318
    
 
319
    def delete(self, **kwargs):
 
320
        if self._update_timer_callback_tag is not None:
 
321
            gobject.source_remove(self._update_timer_callback_tag)
 
322
            self._update_timer_callback_tag = None
 
323
        for match in self.match_objects:
 
324
            match.remove()
 
325
        self.match_objects = ()
196
326
        if self.delete_hook is not None:
197
327
            self.delete_hook(self)
 
328
        return super(MandosClientWidget, self).delete(**kwargs)
198
329
    
199
 
    def render(self, (maxcol,), focus=False):
 
330
    def render(self, maxcolrow, focus=False):
200
331
        """Render differently if we have focus.
201
332
        This overrides the method from urwid.FlowWidget"""
202
 
        return self.current_widget(focus).render((maxcol,),
 
333
        return self.current_widget(focus).render(maxcolrow,
203
334
                                                 focus=focus)
204
335
    
205
 
    def keypress(self, (maxcol,), key):
 
336
    def keypress(self, maxcolrow, key):
206
337
        """Handle keys.
207
338
        This overrides the method from urwid.FlowWidget"""
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":
 
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":
 
346
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
347
                               dbus_interface = client_interface,
 
348
                               ignore_reply=True)
 
349
        elif key == "d":
 
350
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
351
                                  dbus_interface = client_interface,
 
352
                               ignore_reply=True)
 
353
        elif key == "R" or key == "_" or key == "ctrl k":
213
354
            self.server_proxy_object.RemoveClient(self.proxy
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()
 
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)
221
366
        # xxx
222
 
#         elif key == u"p" or key == "=":
 
367
#         elif key == "p" or key == "=":
223
368
#             self.proxy.pause()
224
 
#         elif key == u"u" or key == ":":
 
369
#         elif key == "u" or key == ":":
225
370
#             self.proxy.unpause()
226
 
#         elif key == u"RET":
 
371
#         elif key == "RET":
227
372
#             self.open()
228
373
        else:
229
374
            return key
230
375
    
231
 
    def property_changed(self, property=None, value=None,
232
 
                         *args, **kwargs):
233
 
        """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.
234
378
        This overrides the method from MandosClientPropertyCache"""
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:
 
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):
240
385
            self.update()
241
386
 
242
387
 
245
390
    "down" key presses, thus not allowing any containing widgets to
246
391
    use them as an excuse to shift focus away from this widget.
247
392
    """
248
 
    def keypress(self, (maxcol, maxrow), key):
249
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
250
 
        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"):
251
396
            return
252
397
        return ret
253
398
 
256
401
    """This is the entire user interface - the whole screen
257
402
    with boxes, lists of client widgets, etc.
258
403
    """
259
 
    def __init__(self, max_log_length=1000):
 
404
    def __init__(self, max_log_length=1000, log_level=1):
260
405
        DBusGMainLoop(set_as_default=True)
261
406
        
262
407
        self.screen = urwid.curses_display.Screen()
263
408
        
264
409
        self.screen.register_palette((
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")),
 
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"),
282
428
                ))
283
429
        
284
430
        if urwid.supports_unicode():
285
 
            self.divider = u"─" # \u2500
286
 
            #self.divider = u"━" # \u2501
 
431
            self.divider = "─" # \u2500
 
432
            #self.divider = "━" # \u2501
287
433
        else:
288
 
            #self.divider = u"-" # \u002d
289
 
            self.divider = u"_" # \u005f
 
434
            #self.divider = "-" # \u002d
 
435
            self.divider = "_" # \u005f
290
436
        
291
437
        self.screen.start()
292
438
        
299
445
        self.log = []
300
446
        self.max_log_length = max_log_length
301
447
        
 
448
        self.log_level = log_level
 
449
        
302
450
        # We keep a reference to the log widget so we can remove it
303
451
        # from the ListWalker without it getting destroyed
304
452
        self.logbox = ConstrainedListBox(self.log)
306
454
        # This keeps track of whether self.uilist currently has
307
455
        # self.logbox in it or not
308
456
        self.log_visible = True
309
 
        self.log_wrap = u"any"
 
457
        self.log_wrap = "any"
310
458
        
311
459
        self.rebuild()
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"))
 
460
        self.log_message_raw(("bold",
 
461
                              "Mandos Monitor version " + version))
 
462
        self.log_message_raw(("bold",
 
463
                              "q: Quit  ?: Help"))
316
464
        
317
465
        self.busname = domain + '.Mandos'
318
466
        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)
361
467
    
362
468
    def client_not_found(self, fingerprint, address):
363
 
        self.log_message((u"Client with address %s and fingerprint %s"
364
 
                          u" could not be found" % (address,
365
 
                                                    fingerprint)))
 
469
        self.log_message("Client with address {} and fingerprint {}"
 
470
                         " could not be found"
 
471
                         .format(address, fingerprint))
366
472
    
367
473
    def rebuild(self):
368
474
        """This rebuilds the User Interface.
369
475
        Call this when the widget layout needs to change"""
370
476
        self.uilist = []
371
477
        #self.uilist.append(urwid.ListBox(self.clients))
372
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
478
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
479
                                                          clients),
373
480
                                       #header=urwid.Divider(),
374
481
                                       header=None,
375
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
482
                                       footer=
 
483
                                       urwid.Divider(div_char=
 
484
                                                     self.divider)))
376
485
        if self.log_visible:
377
486
            self.uilist.append(self.logbox)
378
 
            pass
379
487
        self.topwidget = urwid.Pile(self.uilist)
380
488
    
381
 
    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
382
493
        timestamp = datetime.datetime.now().isoformat()
383
 
        self.log_message_raw(timestamp + u": " + message)
 
494
        self.log_message_raw("{}: {}".format(timestamp, message),
 
495
                             level=level)
384
496
    
385
 
    def log_message_raw(self, markup):
 
497
    def log_message_raw(self, markup, level=1):
386
498
        """Add a log message to the log buffer."""
 
499
        if level < self.log_level:
 
500
            return
387
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
388
502
        if (self.max_log_length
389
503
            and len(self.log) > self.max_log_length):
390
504
            del self.log[0:len(self.log)-self.max_log_length-1]
391
505
        self.logbox.set_focus(len(self.logbox.body.contents),
392
 
                              coming_from=u"above")
 
506
                              coming_from="above")
393
507
        self.refresh()
394
508
    
395
509
    def toggle_log_display(self):
396
510
        """Toggle visibility of the log buffer."""
397
511
        self.log_visible = not self.log_visible
398
512
        self.rebuild()
399
 
        self.log_message(u"Log visibility changed to: "
400
 
                         + unicode(self.log_visible))
 
513
        self.log_message("Log visibility changed to: {}"
 
514
                         .format(self.log_visible), level=0)
401
515
    
402
516
    def change_log_display(self):
403
517
        """Change type of log display.
404
518
        Currently, this toggles wrapping of text lines."""
405
 
        if self.log_wrap == u"clip":
406
 
            self.log_wrap = u"any"
 
519
        if self.log_wrap == "clip":
 
520
            self.log_wrap = "any"
407
521
        else:
408
 
            self.log_wrap = u"clip"
 
522
            self.log_wrap = "clip"
409
523
        for textwidget in self.log:
410
524
            textwidget.set_wrap_mode(self.log_wrap)
411
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
525
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
526
                         level=0)
412
527
    
413
528
    def find_and_remove_client(self, path, name):
414
 
        """Find an client from its object path and remove it.
 
529
        """Find a client by its object path and remove it.
415
530
        
416
531
        This is connected to the ClientRemoved signal from the
417
532
        Mandos server object."""
419
534
            client = self.clients_dict[path]
420
535
        except KeyError:
421
536
            # not found?
 
537
            self.log_message("Unknown client {!r} ({!r}) removed"
 
538
                             .format(name, path))
422
539
            return
423
 
        self.remove_client(client, path)
 
540
        client.delete()
424
541
    
425
542
    def add_new_client(self, path):
426
543
        client_proxy_object = self.bus.get_object(self.busname, path)
441
558
        if path is None:
442
559
            path = client.proxy.object_path
443
560
        self.clients_dict[path] = client
444
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
561
        self.clients.sort(key=lambda c: c.properties["Name"])
445
562
        self.refresh()
446
563
    
447
564
    def remove_client(self, client, path=None):
449
566
        if path is None:
450
567
            path = client.proxy.object_path
451
568
        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()
457
569
        self.refresh()
458
570
    
459
571
    def refresh(self):
463
575
    
464
576
    def run(self):
465
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
        
466
624
        self.refresh()
467
625
        self._input_callback_tag = (gobject.io_add_watch
468
626
                                    (sys.stdin.fileno(),
478
636
    
479
637
    def process_input(self, source, condition):
480
638
        keys = self.screen.get_input()
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
 
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
490
648
                         }
491
649
        for key in keys:
492
650
            try:
494
652
            except KeyError:    # :-)
495
653
                pass
496
654
            
497
 
            if key == u"q" or key == u"Q":
 
655
            if key == "q" or key == "Q":
498
656
                self.stop()
499
657
                break
500
 
            elif key == u"window resize":
 
658
            elif key == "window resize":
501
659
                self.size = self.screen.get_cols_rows()
502
660
                self.refresh()
503
 
            elif key == u"\f":  # Ctrl-L
 
661
            elif key == "ctrl l":
 
662
                self.screen.clear()
504
663
                self.refresh()
505
 
            elif key == u"l" or key == u"D":
 
664
            elif key == "l" or key == "D":
506
665
                self.toggle_log_display()
507
666
                self.refresh()
508
 
            elif key == u"w" or key == u"i":
 
667
            elif key == "w" or key == "i":
509
668
                self.change_log_display()
510
669
                self.refresh()
511
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
670
            elif key == "?" or key == "f1" or key == "esc":
512
671
                if not self.log_visible:
513
672
                    self.log_visible = True
514
673
                    self.rebuild()
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"))))
 
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"))))
531
694
                self.refresh()
532
 
            elif key == u"tab":
 
695
            elif key == "tab":
533
696
                if self.topwidget.get_focus() is self.logbox:
534
697
                    self.topwidget.set_focus(0)
535
698
                else:
536
699
                    self.topwidget.set_focus(self.logbox)
537
700
                self.refresh()
538
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
539
 
            #      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 == ">"):
540
710
            #    pass            # xxx end-of-buffer
541
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
542
 
            #      or key == u"<"):
 
711
            #elif (key == "home" or key == "meta <" or key == "g"
 
712
            #      or key == "<"):
543
713
            #    pass            # xxx beginning-of-buffer
544
 
            #elif key == u"ctrl e" or key == u"$":
 
714
            #elif key == "ctrl e" or key == "$":
545
715
            #    pass            # xxx move-end-of-line
546
 
            #elif key == u"ctrl a" or key == u"^":
 
716
            #elif key == "ctrl a" or key == "^":
547
717
            #    pass            # xxx move-beginning-of-line
548
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
718
            #elif key == "ctrl b" or key == "meta (" or key == "h":
549
719
            #    pass            # xxx left
550
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
720
            #elif key == "ctrl f" or key == "meta )" or key == "l":
551
721
            #    pass            # xxx right
552
 
            #elif key == u"a":
 
722
            #elif key == "a":
553
723
            #    pass            # scroll up log
554
 
            #elif key == u"z":
 
724
            #elif key == "z":
555
725
            #    pass            # scroll down log
556
726
            elif self.topwidget.selectable():
557
727
                self.topwidget.keypress(self.size, key)
561
731
ui = UserInterface()
562
732
try:
563
733
    ui.run()
564
 
except Exception, e:
565
 
    ui.log_message(unicode(e))
 
734
except KeyboardInterrupt:
 
735
    ui.screen.stop()
 
736
except Exception as e:
 
737
    ui.log_message(str(e))
566
738
    ui.screen.stop()
567
739
    raise