/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2015-07-27 09:23:56 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150727092356-65ul6jsiozlkjw4e
Debian bug fix for mandos-client: Remove dhparams.pem on purge.

* debian/mandos-client.postrm (purge): Bug fix: Remove dhparams.pem.

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