/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

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