/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2015-07-07 15:49:49 UTC
  • Revision ID: teddy@recompile.se-20150707154949-vbuj4pc6wf3o1vgz
mandos.service: Use Type=dbus (implicitly).

mandos.service ([Service]/Type): Removed.
               ([Service]/BusName): Uncommented; set to
                                    "se.recompile.Mandos".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2009-2012 Teddy Hogeborn
7
 
# Copyright © 2009-2012 Björn Påhlsson
 
6
# Copyright © 2009-2015 Teddy Hogeborn
 
7
# Copyright © 2009-2015 Björn Påhlsson
8
8
# 
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
28
32
 
29
33
import sys
30
34
import os
31
 
import signal
32
35
 
33
36
import datetime
34
37
 
36
39
import urwid
37
40
 
38
41
from dbus.mainloop.glib import DBusGMainLoop
39
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
40
46
 
41
47
import dbus
42
48
 
43
 
import UserList
44
 
 
45
49
import locale
46
50
 
 
51
if sys.version_info.major == 2:
 
52
    str = unicode
 
53
 
47
54
locale.setlocale(locale.LC_ALL, '')
48
55
 
49
56
import logging
53
60
domain = 'se.recompile'
54
61
server_interface = domain + '.Mandos'
55
62
client_interface = domain + '.Mandos.Client'
56
 
version = "1.5.3"
57
 
 
58
 
# Always run in monochrome mode
59
 
urwid.curses_display.curses.has_colors = lambda : False
60
 
 
61
 
# Urwid doesn't support blinking, but we want it.  Since we have no
62
 
# use for underline on its own, we make underline also always blink.
63
 
urwid.curses_display.curses.A_UNDERLINE |= (
64
 
    urwid.curses_display.curses.A_BLINK)
 
63
version = "1.6.9"
65
64
 
66
65
def isoformat_to_datetime(iso):
67
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
84
83
    properties and calls a hook function when any of them are
85
84
    changed.
86
85
    """
87
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
88
87
        self.proxy = proxy_object # Mandos Client proxy object
89
 
        
90
 
        self.properties = dict()
 
88
        self.properties = dict() if properties is None else properties
91
89
        self.property_changed_match = (
92
 
            self.proxy.connect_to_signal("PropertyChanged",
93
 
                                         self.property_changed,
94
 
                                         client_interface,
 
90
            self.proxy.connect_to_signal("PropertiesChanged",
 
91
                                         self.properties_changed,
 
92
                                         dbus.PROPERTIES_IFACE,
95
93
                                         byte_arrays=True))
96
94
        
97
 
        self.properties.update(
98
 
            self.proxy.GetAll(client_interface,
99
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
100
 
 
101
 
        #XXX This breaks good super behaviour
102
 
#        super(MandosClientPropertyCache, self).__init__(
103
 
#            *args, **kwargs)
 
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)
104
102
    
105
 
    def property_changed(self, property=None, value=None):
106
 
        """This is called whenever we get a PropertyChanged signal
107
 
        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.
108
106
        """
109
107
        # Update properties dict with new value
110
 
        self.properties[property] = value
 
108
        self.properties.update(properties)
111
109
    
112
 
    def delete(self, *args, **kwargs):
 
110
    def delete(self):
113
111
        self.property_changed_match.remove()
114
 
        super(MandosClientPropertyCache, self).__init__(
115
 
            *args, **kwargs)
116
112
 
117
113
 
118
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
116
    """
121
117
    
122
118
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
119
                 delete_hook=None, logger=None, **kwargs):
124
120
        # Called on update
125
121
        self.update_hook = update_hook
126
122
        # Called on delete
131
127
        self.logger = logger
132
128
        
133
129
        self._update_timer_callback_tag = None
134
 
        self._update_timer_callback_lock = 0
135
130
        
136
131
        # The widget shown normally
137
132
        self._text_widget = urwid.Text("")
138
133
        # The widget shown when we have focus
139
134
        self._focus_text_widget = urwid.Text("")
140
 
        super(MandosClientWidget, self).__init__(
141
 
            update_hook=update_hook, delete_hook=delete_hook,
142
 
            *args, **kwargs)
 
135
        super(MandosClientWidget, self).__init__(**kwargs)
143
136
        self.update()
144
137
        self.opened = False
145
138
        
146
 
        last_checked_ok = isoformat_to_datetime(self.properties
147
 
                                                ["LastCheckedOK"])
148
 
        
149
 
        if self.properties ["LastCheckerStatus"] != 0:
150
 
            self.using_timer(True)
151
 
        
152
 
        if self.need_approval:
153
 
            self.using_timer(True)
154
 
        
155
139
        self.match_objects = (
156
140
            self.proxy.connect_to_signal("CheckerCompleted",
157
141
                                         self.checker_completed,
173
157
                                         self.rejected,
174
158
                                         client_interface,
175
159
                                         byte_arrays=True))
176
 
        #self.logger('Created client {0}'
177
 
        #            .format(self.properties["Name"]))
178
 
    
179
 
    def property_changed(self, property=None, value=None):
180
 
        super(self, MandosClientWidget).property_changed(property,
181
 
                                                         value)
182
 
        if property == "ApprovalPending":
183
 
            using_timer(bool(value))
184
 
        if property == "LastCheckerStatus":
185
 
            using_timer(value != 0)
186
 
            #self.logger('Checker for client {0} (command "{1}") was '
187
 
            #            ' successful'.format(self.properties["Name"],
188
 
            #                                 command))
 
160
        self.logger('Created client {}'
 
161
                    .format(self.properties["Name"]), level=0)
189
162
    
190
163
    def using_timer(self, flag):
191
164
        """Call this method with True or False when timer should be
192
165
        activated or deactivated.
193
166
        """
194
 
        old = self._update_timer_callback_lock
195
 
        if flag:
196
 
            self._update_timer_callback_lock += 1
197
 
        else:
198
 
            self._update_timer_callback_lock -= 1
199
 
        if old == 0 and self._update_timer_callback_lock:
 
167
        if flag and self._update_timer_callback_tag is None:
200
168
            # Will update the shown timer value every second
201
169
            self._update_timer_callback_tag = (gobject.timeout_add
202
170
                                               (1000,
203
171
                                                self.update_timer))
204
 
        elif old and self._update_timer_callback_lock == 0:
 
172
        elif not (flag or self._update_timer_callback_tag is None):
205
173
            gobject.source_remove(self._update_timer_callback_tag)
206
174
            self._update_timer_callback_tag = None
207
175
    
208
 
    def checker_completed(self, exitstatus, condition, command):
 
176
    def checker_completed(self, exitstatus, signal, command):
209
177
        if exitstatus == 0:
 
178
            self.logger('Checker for client {} (command "{}")'
 
179
                        ' succeeded'.format(self.properties["Name"],
 
180
                                            command), level=0)
210
181
            self.update()
211
182
            return
212
183
        # Checker failed
213
 
        if os.WIFEXITED(condition):
214
 
            self.logger('Checker for client {0} (command "{1}")'
215
 
                        ' failed with exit code {2}'
216
 
                        .format(self.properties["Name"], command,
217
 
                                os.WEXITSTATUS(condition)))
218
 
        elif os.WIFSIGNALED(condition):
219
 
            self.logger('Checker for client {0} (command "{1}") was'
220
 
                        ' killed by signal {2}'
221
 
                        .format(self.properties["Name"], command,
222
 
                                os.WTERMSIG(condition)))
223
 
        elif os.WCOREDUMP(condition):
224
 
            self.logger('Checker for client {0} (command "{1}")'
225
 
                        ' dumped core'
226
 
                        .format(self.properties["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))
227
194
        else:
228
 
            self.logger('Checker for client {0} completed'
 
195
            self.logger('Checker for client {} completed'
229
196
                        ' mysteriously'
230
197
                        .format(self.properties["Name"]))
231
198
        self.update()
232
199
    
233
200
    def checker_started(self, command):
234
 
        """Server signals that a checker started. This could be useful
235
 
           to log in the future. """
236
 
        #self.logger('Client {0} started checker "{1}"'
237
 
        #            .format(self.properties["Name"],
238
 
        #                    unicode(command)))
239
 
        pass
 
201
        """Server signals that a checker started."""
 
202
        self.logger('Client {} started checker "{}"'
 
203
                    .format(self.properties["Name"],
 
204
                            command), level=0)
240
205
    
241
206
    def got_secret(self):
242
 
        self.logger('Client {0} received its secret'
 
207
        self.logger('Client {} received its secret'
243
208
                    .format(self.properties["Name"]))
244
209
    
245
210
    def need_approval(self, timeout, default):
246
211
        if not default:
247
 
            message = 'Client {0} needs approval within {1} seconds'
 
212
            message = 'Client {} needs approval within {} seconds'
248
213
        else:
249
 
            message = 'Client {0} will get its secret in {1} seconds'
 
214
            message = 'Client {} will get its secret in {} seconds'
250
215
        self.logger(message.format(self.properties["Name"],
251
216
                                   timeout/1000))
252
 
        self.using_timer(True)
253
217
    
254
218
    def rejected(self, reason):
255
 
        self.logger('Client {0} was rejected; reason: {1}'
 
219
        self.logger('Client {} was rejected; reason: {}'
256
220
                    .format(self.properties["Name"], reason))
257
221
    
258
222
    def selectable(self):
281
245
                          "bold-underline-blink":
282
246
                              "bold-underline-blink-standout",
283
247
                          }
284
 
 
 
248
        
285
249
        # Rebuild focus and non-focus widgets using current properties
286
 
 
 
250
        
287
251
        # Base part of a client. Name!
288
252
        base = '{name}: '.format(name=self.properties["Name"])
289
253
        if not self.properties["Enabled"]:
290
254
            message = "DISABLED"
 
255
            self.using_timer(False)
291
256
        elif self.properties["ApprovalPending"]:
292
257
            timeout = datetime.timedelta(milliseconds
293
258
                                         = self.properties
295
260
            last_approval_request = isoformat_to_datetime(
296
261
                self.properties["LastApprovalRequest"])
297
262
            if last_approval_request is not None:
298
 
                timer = timeout - (datetime.datetime.utcnow()
299
 
                                   - last_approval_request)
 
263
                timer = max(timeout - (datetime.datetime.utcnow()
 
264
                                       - last_approval_request),
 
265
                            datetime.timedelta())
300
266
            else:
301
267
                timer = datetime.timedelta()
302
268
            if self.properties["ApprovedByDefault"]:
303
 
                message = "Approval in {0}. (d)eny?"
 
269
                message = "Approval in {}. (d)eny?"
304
270
            else:
305
 
                message = "Denial in {0}. (a)pprove?"
306
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
271
                message = "Denial in {}. (a)pprove?"
 
272
            message = message.format(str(timer).rsplit(".", 1)[0])
 
273
            self.using_timer(True)
307
274
        elif self.properties["LastCheckerStatus"] != 0:
308
275
            # When checker has failed, show timer until client expires
309
276
            expires = self.properties["Expires"]
312
279
            else:
313
280
                expires = (datetime.datetime.strptime
314
281
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
315
 
                timer = expires - datetime.datetime.utcnow()
 
282
                timer = max(expires - datetime.datetime.utcnow(),
 
283
                            datetime.timedelta())
316
284
            message = ('A checker has failed! Time until client'
317
 
                       ' gets disabled: {0}'
318
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
285
                       ' gets disabled: {}'
 
286
                       .format(str(timer).rsplit(".", 1)[0]))
 
287
            self.using_timer(True)
319
288
        else:
320
289
            message = "enabled"
321
 
        self._text = "{0}{1}".format(base, message)
322
 
            
 
290
            self.using_timer(False)
 
291
        self._text = "{}{}".format(base, message)
 
292
        
323
293
        if not urwid.supports_unicode():
324
294
            self._text = self._text.encode("ascii", "replace")
325
295
        textlist = [("normal", self._text)]
342
312
        self.update()
343
313
        return True             # Keep calling this
344
314
    
345
 
    def delete(self, *args, **kwargs):
 
315
    def delete(self, **kwargs):
346
316
        if self._update_timer_callback_tag is not None:
347
317
            gobject.source_remove(self._update_timer_callback_tag)
348
318
            self._update_timer_callback_tag = None
351
321
        self.match_objects = ()
352
322
        if self.delete_hook is not None:
353
323
            self.delete_hook(self)
354
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
324
        return super(MandosClientWidget, self).delete(**kwargs)
355
325
    
356
326
    def render(self, maxcolrow, focus=False):
357
327
        """Render differently if we have focus.
399
369
        else:
400
370
            return key
401
371
    
402
 
    def property_changed(self, property=None, value=None,
403
 
                         *args, **kwargs):
404
 
        """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.
405
374
        This overrides the method from MandosClientPropertyCache"""
406
 
        property_name = unicode(property)
407
 
        old_value = self.properties.get(property_name)
408
 
        super(MandosClientWidget, self).property_changed(
409
 
            property=property, value=value, *args, **kwargs)
410
 
        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):
411
381
            self.update()
412
382
 
413
383
 
416
386
    "down" key presses, thus not allowing any containing widgets to
417
387
    use them as an excuse to shift focus away from this widget.
418
388
    """
419
 
    def keypress(self, maxcolrow, key):
420
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
389
    def keypress(self, *args, **kwargs):
 
390
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
421
391
        if ret in ("up", "down"):
422
392
            return
423
393
        return ret
427
397
    """This is the entire user interface - the whole screen
428
398
    with boxes, lists of client widgets, etc.
429
399
    """
430
 
    def __init__(self, max_log_length=1000):
 
400
    def __init__(self, max_log_length=1000, log_level=1):
431
401
        DBusGMainLoop(set_as_default=True)
432
402
        
433
403
        self.screen = urwid.curses_display.Screen()
436
406
                ("normal",
437
407
                 "default", "default", None),
438
408
                ("bold",
439
 
                 "default", "default", "bold"),
 
409
                 "bold", "default", "bold"),
440
410
                ("underline-blink",
441
 
                 "default", "default", "underline"),
 
411
                 "underline,blink", "default", "underline,blink"),
442
412
                ("standout",
443
 
                 "default", "default", "standout"),
 
413
                 "standout", "default", "standout"),
444
414
                ("bold-underline-blink",
445
 
                 "default", "default", ("bold", "underline")),
 
415
                 "bold,underline,blink", "default", "bold,underline,blink"),
446
416
                ("bold-standout",
447
 
                 "default", "default", ("bold", "standout")),
 
417
                 "bold,standout", "default", "bold,standout"),
448
418
                ("underline-blink-standout",
449
 
                 "default", "default", ("underline", "standout")),
 
419
                 "underline,blink,standout", "default",
 
420
                 "underline,blink,standout"),
450
421
                ("bold-underline-blink-standout",
451
 
                 "default", "default", ("bold", "underline",
452
 
                                          "standout")),
 
422
                 "bold,underline,blink,standout", "default",
 
423
                 "bold,underline,blink,standout"),
453
424
                ))
454
425
        
455
426
        if urwid.supports_unicode():
470
441
        self.log = []
471
442
        self.max_log_length = max_log_length
472
443
        
 
444
        self.log_level = log_level
 
445
        
473
446
        # We keep a reference to the log widget so we can remove it
474
447
        # from the ListWalker without it getting destroyed
475
448
        self.logbox = ConstrainedListBox(self.log)
489
462
        self.main_loop = gobject.MainLoop()
490
463
    
491
464
    def client_not_found(self, fingerprint, address):
492
 
        self.log_message("Client with address {0} and fingerprint"
493
 
                         " {1} could not be found"
 
465
        self.log_message("Client with address {} and fingerprint {}"
 
466
                         " could not be found"
494
467
                         .format(address, fingerprint))
495
468
    
496
469
    def rebuild(self):
509
482
            self.uilist.append(self.logbox)
510
483
        self.topwidget = urwid.Pile(self.uilist)
511
484
    
512
 
    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
513
489
        timestamp = datetime.datetime.now().isoformat()
514
 
        self.log_message_raw(timestamp + ": " + message)
 
490
        self.log_message_raw("{}: {}".format(timestamp, message),
 
491
                             level=level)
515
492
    
516
 
    def log_message_raw(self, markup):
 
493
    def log_message_raw(self, markup, level=1):
517
494
        """Add a log message to the log buffer."""
 
495
        if level < self.log_level:
 
496
            return
518
497
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
519
498
        if (self.max_log_length
520
499
            and len(self.log) > self.max_log_length):
527
506
        """Toggle visibility of the log buffer."""
528
507
        self.log_visible = not self.log_visible
529
508
        self.rebuild()
530
 
        #self.log_message("Log visibility changed to: "
531
 
        #                 + unicode(self.log_visible))
 
509
        self.log_message("Log visibility changed to: {}"
 
510
                         .format(self.log_visible), level=0)
532
511
    
533
512
    def change_log_display(self):
534
513
        """Change type of log display.
539
518
            self.log_wrap = "clip"
540
519
        for textwidget in self.log:
541
520
            textwidget.set_wrap_mode(self.log_wrap)
542
 
        #self.log_message("Wrap mode: " + self.log_wrap)
 
521
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
522
                         level=0)
543
523
    
544
524
    def find_and_remove_client(self, path, name):
545
525
        """Find a client by its object path and remove it.
550
530
            client = self.clients_dict[path]
551
531
        except KeyError:
552
532
            # not found?
553
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
533
            self.log_message("Unknown client {!r} ({!r}) removed"
554
534
                             .format(name, path))
555
535
            return
556
536
        client.delete()
574
554
        if path is None:
575
555
            path = client.proxy.object_path
576
556
        self.clients_dict[path] = client
577
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
557
        self.clients.sort(key=lambda c: c.properties["Name"])
578
558
        self.refresh()
579
559
    
580
560
    def remove_client(self, client, path=None):
582
562
        if path is None:
583
563
            path = client.proxy.object_path
584
564
        del self.clients_dict[path]
585
 
        if not self.clients_dict:
586
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
587
 
            # is completely emptied, we need to recreate it.
588
 
            self.clients = urwid.SimpleListWalker([])
589
 
            self.rebuild()
590
565
        self.refresh()
591
566
    
592
567
    def refresh(self):
605
580
        try:
606
581
            mandos_clients = (self.mandos_serv
607
582
                              .GetAllClientsWithProperties())
 
583
            if not mandos_clients:
 
584
                self.log_message_raw(("bold", "Note: Server has no clients."))
608
585
        except dbus.exceptions.DBusException:
 
586
            self.log_message_raw(("bold", "Note: No Mandos server running."))
609
587
            mandos_clients = dbus.Dictionary()
610
588
        
611
589
        (self.mandos_serv
623
601
                            self.client_not_found,
624
602
                            dbus_interface=server_interface,
625
603
                            byte_arrays=True))
626
 
        for path, client in mandos_clients.iteritems():
 
604
        for path, client in mandos_clients.items():
627
605
            client_proxy_object = self.bus.get_object(self.busname,
628
606
                                                      path)
629
607
            self.add_client(MandosClientWidget(server_proxy_object
638
616
                                               logger
639
617
                                               =self.log_message),
640
618
                            path=path)
641
 
 
 
619
        
642
620
        self.refresh()
643
621
        self._input_callback_tag = (gobject.io_add_watch
644
622
                                    (sys.stdin.fileno(),
676
654
            elif key == "window resize":
677
655
                self.size = self.screen.get_cols_rows()
678
656
                self.refresh()
679
 
            elif key == "\f":  # Ctrl-L
 
657
            elif key == "ctrl l":
 
658
                self.screen.clear()
680
659
                self.refresh()
681
660
            elif key == "l" or key == "D":
682
661
                self.toggle_log_display()
694
673
                                            "?: Help",
695
674
                                            "l: Log window toggle",
696
675
                                            "TAB: Switch window",
697
 
                                            "w: Wrap (log)"))))
 
676
                                            "w: Wrap (log lines)",
 
677
                                            "v: Toggle verbose log",
 
678
                                            ))))
698
679
                self.log_message_raw(("bold",
699
680
                                      "  "
700
681
                                      .join(("Clients:",
713
694
                else:
714
695
                    self.topwidget.set_focus(self.logbox)
715
696
                self.refresh()
 
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")
716
704
            #elif (key == "end" or key == "meta >" or key == "G"
717
705
            #      or key == ">"):
718
706
            #    pass            # xxx end-of-buffer
741
729
    ui.run()
742
730
except KeyboardInterrupt:
743
731
    ui.screen.stop()
744
 
except Exception, e:
745
 
    ui.log_message(unicode(e))
 
732
except Exception as e:
 
733
    ui.log_message(str(e))
746
734
    ui.screen.stop()
747
735
    raise