/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: 2016-06-21 19:47:08 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 344.
  • Revision ID: teddy@recompile.se-20160621194708-bmsd15fu32llgb4s
Fix typo in README.Debian for mandos-client package.

* debian/mandos.README.Debian: Replace "it it" with "it is", and make
  lintian warning tag "spelling-error-in-readme-debian" go away.

Show diffs side-by-side

added added

removed removed

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