/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: 2023-02-11 06:58:15 UTC
  • Revision ID: teddy@recompile.se-20230211065815-jtffi61tbdrgr875
Suppress warnings

Suppress warnings about mlock()ing uninitialized memory and reading an
ievent struct.

* dracut-module/password-agent.c (send_password_to_socket): Suppress
  "-Wmaybe-uninitialized" when mlock()ing password send buffer.
  (test_read_inotify_event_IN_DELETE_badname): When reading from
    a struct ievent, suppress "-Wstringop-overread".

Show diffs side-by-side

added added

removed removed

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