/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-12 01:57:54 UTC
  • Revision ID: teddy@recompile.se-20150712015754-1lq7u2ejo7fdyfvi
* debian/mandos.prerm: Don't run init script, use only invoke-rc.d.

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