/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-07-14 23:39:53 UTC
  • Revision ID: teddy@recompile.se-20190714233953-1zmsd3o062xloazt
Server bug fix: Allow restarts when using port= option

If the Mandos server is configured to use a specific TCP port to
listen to (by using the port= option in mandos.conf or the command
line --port option), that port becomes unusable for a time when the
Mandos server is restarted, making restarts fail.  Avoid this by, if a
port number is specified, using SO_REUSEADDR when binding the
listening TCP socket to a port number.

* mandos (IPv6_TCPServer.server_bind): Set self.allow_reuse_address if
                                       a port number is specified.

Reported-by: Juan Miguel Alcarria Herrera <juanmi@arco2000.es>

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