/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

merge
new approve/deny functionallity in mandos-monitor

Show diffs side-by-side

added added

removed removed

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