/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: 2016-03-19 03:19:04 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 341.
  • Revision ID: teddy@recompile.se-20160319031904-v76knawxxbef79xv
Client: Fix permissions on plugin helper directory.

The Makefile target "install-client-nokey" creates the plugin-helper
directory /usr/lib/<ARCH>/mandos/plugin-helpers as mode u=rwx,go=
(0700).  Make this also the case for the Debian package.  Also change
the Makefile so it does not install the plugin helper
"mandos-client-iprouteadddel" as setuid root; this is unnecessary and
was, due to dh_fixperms, never propagated to the Debian package
anyway.

* Makefile (install-client-nokey): Do not set setuid bit on
  "plugin-helpers/mandos-client-iprouteadddel".
* debian/mandos-client.postinst (configure): If older version, fix
  permissions on plugin helper directory.
* debian/rules (override_dh_fixperms-arch): Exclude plugin helper
  directory from dh_fixperms.

Show diffs side-by-side

added added

removed removed

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