/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

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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-2014 Teddy Hogeborn
7
 
# Copyright © 2009-2014 Björn Påhlsson
 
6
# Copyright © 2009-2012 Teddy Hogeborn
 
7
# Copyright © 2009-2012 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
 
 
29
from future_builtins import *
32
30
 
33
31
import sys
34
32
import os
 
33
import signal
35
34
 
36
35
import datetime
37
36
 
39
38
import urwid
40
39
 
41
40
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
41
import gobject
46
42
 
47
43
import dbus
48
44
 
 
45
import UserList
 
46
 
49
47
import locale
50
48
 
51
 
if sys.version_info[0] == 2:
52
 
    str = unicode
53
 
 
54
49
locale.setlocale(locale.LC_ALL, '')
55
50
 
56
51
import logging
60
55
domain = 'se.recompile'
61
56
server_interface = domain + '.Mandos'
62
57
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.7"
 
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)
64
67
 
65
68
def isoformat_to_datetime(iso):
66
69
    "Parse an ISO 8601 date string to a datetime.datetime()"
83
86
    properties and calls a hook function when any of them are
84
87
    changed.
85
88
    """
86
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
89
    def __init__(self, proxy_object=None, *args, **kwargs):
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        self.properties = dict() if properties is None else properties
 
91
        
 
92
        self.properties = dict()
89
93
        self.property_changed_match = (
90
94
            self.proxy.connect_to_signal("PropertyChanged",
91
 
                                         self._property_changed,
 
95
                                         self.property_changed,
92
96
                                         client_interface,
93
97
                                         byte_arrays=True))
94
98
        
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)
102
 
    
103
 
    def _property_changed(self, property, value):
104
 
        """Helper which takes positional arguments"""
105
 
        return self.property_changed(property=property, value=value)
 
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)
106
106
    
107
107
    def property_changed(self, property=None, value=None):
108
108
        """This is called whenever we get a PropertyChanged signal
111
111
        # Update properties dict with new value
112
112
        self.properties[property] = value
113
113
    
114
 
    def delete(self):
 
114
    def delete(self, *args, **kwargs):
115
115
        self.property_changed_match.remove()
 
116
        super(MandosClientPropertyCache, self).__init__(
 
117
            *args, **kwargs)
116
118
 
117
119
 
118
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
122
    """
121
123
    
122
124
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, **kwargs):
 
125
                 delete_hook=None, logger=None, *args, **kwargs):
124
126
        # Called on update
125
127
        self.update_hook = update_hook
126
128
        # Called on delete
131
133
        self.logger = logger
132
134
        
133
135
        self._update_timer_callback_tag = None
 
136
        self._update_timer_callback_lock = 0
134
137
        
135
138
        # The widget shown normally
136
139
        self._text_widget = urwid.Text("")
137
140
        # The widget shown when we have focus
138
141
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
142
        super(MandosClientWidget, self).__init__(
 
143
            update_hook=update_hook, delete_hook=delete_hook,
 
144
            *args, **kwargs)
140
145
        self.update()
141
146
        self.opened = False
142
147
        
 
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
        
143
157
        self.match_objects = (
144
158
            self.proxy.connect_to_signal("CheckerCompleted",
145
159
                                         self.checker_completed,
161
175
                                         self.rejected,
162
176
                                         client_interface,
163
177
                                         byte_arrays=True))
164
 
        self.logger('Created client {}'
165
 
                    .format(self.properties["Name"]), level=0)
 
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))
166
191
    
167
192
    def using_timer(self, flag):
168
193
        """Call this method with True or False when timer should be
169
194
        activated or deactivated.
170
195
        """
171
 
        if flag and self._update_timer_callback_tag is None:
 
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:
172
202
            # Will update the shown timer value every second
173
203
            self._update_timer_callback_tag = (gobject.timeout_add
174
204
                                               (1000,
175
205
                                                self.update_timer))
176
 
        elif not (flag or self._update_timer_callback_tag is None):
 
206
        elif old and self._update_timer_callback_lock == 0:
177
207
            gobject.source_remove(self._update_timer_callback_tag)
178
208
            self._update_timer_callback_tag = None
179
209
    
180
210
    def checker_completed(self, exitstatus, condition, command):
181
211
        if exitstatus == 0:
182
 
            self.logger('Checker for client {} (command "{}")'
183
 
                        ' succeeded'.format(self.properties["Name"],
184
 
                                            command), level=0)
185
212
            self.update()
186
213
            return
187
214
        # Checker failed
188
215
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {} (command "{}") failed'
190
 
                        ' with exit code {}'
 
216
            self.logger('Checker for client {0} (command "{1}")'
 
217
                        ' failed with exit code {2}'
191
218
                        .format(self.properties["Name"], command,
192
219
                                os.WEXITSTATUS(condition)))
193
220
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {} (command "{}") was'
195
 
                        ' killed by signal {}'
 
221
            self.logger('Checker for client {0} (command "{1}") was'
 
222
                        ' killed by signal {2}'
196
223
                        .format(self.properties["Name"], command,
197
224
                                os.WTERMSIG(condition)))
198
225
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {} (command "{}") dumped'
200
 
                        ' core'.format(self.properties["Name"],
201
 
                                       command))
 
226
            self.logger('Checker for client {0} (command "{1}")'
 
227
                        ' dumped core'
 
228
                        .format(self.properties["Name"], command))
202
229
        else:
203
 
            self.logger('Checker for client {} completed'
 
230
            self.logger('Checker for client {0} completed'
204
231
                        ' mysteriously'
205
232
                        .format(self.properties["Name"]))
206
233
        self.update()
207
234
    
208
235
    def checker_started(self, command):
209
 
        """Server signals that a checker started."""
210
 
        self.logger('Client {} started checker "{}"'
211
 
                    .format(self.properties["Name"],
212
 
                            command), level=0)
 
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
213
242
    
214
243
    def got_secret(self):
215
 
        self.logger('Client {} received its secret'
 
244
        self.logger('Client {0} received its secret'
216
245
                    .format(self.properties["Name"]))
217
246
    
218
247
    def need_approval(self, timeout, default):
219
248
        if not default:
220
 
            message = 'Client {} needs approval within {} seconds'
 
249
            message = 'Client {0} needs approval within {1} seconds'
221
250
        else:
222
 
            message = 'Client {} will get its secret in {} seconds'
 
251
            message = 'Client {0} will get its secret in {1} seconds'
223
252
        self.logger(message.format(self.properties["Name"],
224
253
                                   timeout/1000))
 
254
        self.using_timer(True)
225
255
    
226
256
    def rejected(self, reason):
227
 
        self.logger('Client {} was rejected; reason: {}'
 
257
        self.logger('Client {0} was rejected; reason: {1}'
228
258
                    .format(self.properties["Name"], reason))
229
259
    
230
260
    def selectable(self):
253
283
                          "bold-underline-blink":
254
284
                              "bold-underline-blink-standout",
255
285
                          }
256
 
        
 
286
 
257
287
        # Rebuild focus and non-focus widgets using current properties
258
 
        
 
288
 
259
289
        # Base part of a client. Name!
260
290
        base = '{name}: '.format(name=self.properties["Name"])
261
291
        if not self.properties["Enabled"]:
262
292
            message = "DISABLED"
263
 
            self.using_timer(False)
264
293
        elif self.properties["ApprovalPending"]:
265
294
            timeout = datetime.timedelta(milliseconds
266
295
                                         = self.properties
268
297
            last_approval_request = isoformat_to_datetime(
269
298
                self.properties["LastApprovalRequest"])
270
299
            if last_approval_request is not None:
271
 
                timer = max(timeout - (datetime.datetime.utcnow()
272
 
                                       - last_approval_request),
273
 
                            datetime.timedelta())
 
300
                timer = timeout - (datetime.datetime.utcnow()
 
301
                                   - last_approval_request)
274
302
            else:
275
303
                timer = datetime.timedelta()
276
304
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {}. (d)eny?"
 
305
                message = "Approval in {0}. (d)eny?"
278
306
            else:
279
 
                message = "Denial in {}. (a)pprove?"
280
 
            message = message.format(str(timer).rsplit(".", 1)[0])
281
 
            self.using_timer(True)
 
307
                message = "Denial in {0}. (a)pprove?"
 
308
            message = message.format(unicode(timer).rsplit(".", 1)[0])
282
309
        elif self.properties["LastCheckerStatus"] != 0:
283
310
            # When checker has failed, show timer until client expires
284
311
            expires = self.properties["Expires"]
287
314
            else:
288
315
                expires = (datetime.datetime.strptime
289
316
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
 
                timer = max(expires - datetime.datetime.utcnow(),
291
 
                            datetime.timedelta())
 
317
                timer = expires - datetime.datetime.utcnow()
292
318
            message = ('A checker has failed! Time until client'
293
 
                       ' gets disabled: {}'
294
 
                       .format(str(timer).rsplit(".", 1)[0]))
295
 
            self.using_timer(True)
 
319
                       ' gets disabled: {0}'
 
320
                       .format(unicode(timer).rsplit(".", 1)[0]))
296
321
        else:
297
322
            message = "enabled"
298
 
            self.using_timer(False)
299
 
        self._text = "{}{}".format(base, message)
300
 
        
 
323
        self._text = "{0}{1}".format(base, message)
 
324
            
301
325
        if not urwid.supports_unicode():
302
326
            self._text = self._text.encode("ascii", "replace")
303
327
        textlist = [("normal", self._text)]
320
344
        self.update()
321
345
        return True             # Keep calling this
322
346
    
323
 
    def delete(self, **kwargs):
 
347
    def delete(self, *args, **kwargs):
324
348
        if self._update_timer_callback_tag is not None:
325
349
            gobject.source_remove(self._update_timer_callback_tag)
326
350
            self._update_timer_callback_tag = None
329
353
        self.match_objects = ()
330
354
        if self.delete_hook is not None:
331
355
            self.delete_hook(self)
332
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
356
        return super(MandosClientWidget, self).delete(*args, **kwargs)
333
357
    
334
358
    def render(self, maxcolrow, focus=False):
335
359
        """Render differently if we have focus.
377
401
        else:
378
402
            return key
379
403
    
380
 
    def property_changed(self, property=None, **kwargs):
 
404
    def property_changed(self, property=None, value=None,
 
405
                         *args, **kwargs):
381
406
        """Call self.update() if old value is not new value.
382
407
        This overrides the method from MandosClientPropertyCache"""
383
 
        property_name = str(property)
 
408
        property_name = unicode(property)
384
409
        old_value = self.properties.get(property_name)
385
410
        super(MandosClientWidget, self).property_changed(
386
 
            property=property, **kwargs)
 
411
            property=property, value=value, *args, **kwargs)
387
412
        if self.properties.get(property_name) != old_value:
388
413
            self.update()
389
414
 
393
418
    "down" key presses, thus not allowing any containing widgets to
394
419
    use them as an excuse to shift focus away from this widget.
395
420
    """
396
 
    def keypress(self, *args, **kwargs):
397
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
421
    def keypress(self, maxcolrow, key):
 
422
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
398
423
        if ret in ("up", "down"):
399
424
            return
400
425
        return ret
404
429
    """This is the entire user interface - the whole screen
405
430
    with boxes, lists of client widgets, etc.
406
431
    """
407
 
    def __init__(self, max_log_length=1000, log_level=1):
 
432
    def __init__(self, max_log_length=1000):
408
433
        DBusGMainLoop(set_as_default=True)
409
434
        
410
435
        self.screen = urwid.curses_display.Screen()
413
438
                ("normal",
414
439
                 "default", "default", None),
415
440
                ("bold",
416
 
                 "bold", "default", "bold"),
 
441
                 "default", "default", "bold"),
417
442
                ("underline-blink",
418
 
                 "underline,blink", "default", "underline,blink"),
 
443
                 "default", "default", "underline"),
419
444
                ("standout",
420
 
                 "standout", "default", "standout"),
 
445
                 "default", "default", "standout"),
421
446
                ("bold-underline-blink",
422
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
447
                 "default", "default", ("bold", "underline")),
423
448
                ("bold-standout",
424
 
                 "bold,standout", "default", "bold,standout"),
 
449
                 "default", "default", ("bold", "standout")),
425
450
                ("underline-blink-standout",
426
 
                 "underline,blink,standout", "default",
427
 
                 "underline,blink,standout"),
 
451
                 "default", "default", ("underline", "standout")),
428
452
                ("bold-underline-blink-standout",
429
 
                 "bold,underline,blink,standout", "default",
430
 
                 "bold,underline,blink,standout"),
 
453
                 "default", "default", ("bold", "underline",
 
454
                                          "standout")),
431
455
                ))
432
456
        
433
457
        if urwid.supports_unicode():
448
472
        self.log = []
449
473
        self.max_log_length = max_log_length
450
474
        
451
 
        self.log_level = log_level
452
 
        
453
475
        # We keep a reference to the log widget so we can remove it
454
476
        # from the ListWalker without it getting destroyed
455
477
        self.logbox = ConstrainedListBox(self.log)
469
491
        self.main_loop = gobject.MainLoop()
470
492
    
471
493
    def client_not_found(self, fingerprint, address):
472
 
        self.log_message("Client with address {} and fingerprint {}"
473
 
                         " could not be found"
 
494
        self.log_message("Client with address {0} and fingerprint"
 
495
                         " {1} could not be found"
474
496
                         .format(address, fingerprint))
475
497
    
476
498
    def rebuild(self):
489
511
            self.uilist.append(self.logbox)
490
512
        self.topwidget = urwid.Pile(self.uilist)
491
513
    
492
 
    def log_message(self, message, level=1):
493
 
        """Log message formatted with timestamp"""
494
 
        if level < self.log_level:
495
 
            return
 
514
    def log_message(self, message):
496
515
        timestamp = datetime.datetime.now().isoformat()
497
 
        self.log_message_raw("{}: {}".format(timestamp, message),
498
 
                             level=level)
 
516
        self.log_message_raw(timestamp + ": " + message)
499
517
    
500
 
    def log_message_raw(self, markup, level=1):
 
518
    def log_message_raw(self, markup):
501
519
        """Add a log message to the log buffer."""
502
 
        if level < self.log_level:
503
 
            return
504
520
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
521
        if (self.max_log_length
506
522
            and len(self.log) > self.max_log_length):
513
529
        """Toggle visibility of the log buffer."""
514
530
        self.log_visible = not self.log_visible
515
531
        self.rebuild()
516
 
        self.log_message("Log visibility changed to: {}"
517
 
                         .format(self.log_visible), level=0)
 
532
        #self.log_message("Log visibility changed to: "
 
533
        #                 + unicode(self.log_visible))
518
534
    
519
535
    def change_log_display(self):
520
536
        """Change type of log display.
525
541
            self.log_wrap = "clip"
526
542
        for textwidget in self.log:
527
543
            textwidget.set_wrap_mode(self.log_wrap)
528
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
529
 
                         level=0)
 
544
        #self.log_message("Wrap mode: " + self.log_wrap)
530
545
    
531
546
    def find_and_remove_client(self, path, name):
532
547
        """Find a client by its object path and remove it.
537
552
            client = self.clients_dict[path]
538
553
        except KeyError:
539
554
            # not found?
540
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
555
            self.log_message("Unknown client {0!r} ({1!r}) removed"
541
556
                             .format(name, path))
542
557
            return
543
558
        client.delete()
561
576
        if path is None:
562
577
            path = client.proxy.object_path
563
578
        self.clients_dict[path] = client
564
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
579
        self.clients.sort(None, lambda c: c.properties["Name"])
565
580
        self.refresh()
566
581
    
567
582
    def remove_client(self, client, path=None):
569
584
        if path is None:
570
585
            path = client.proxy.object_path
571
586
        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()
572
592
        self.refresh()
573
593
    
574
594
    def refresh(self):
587
607
        try:
588
608
            mandos_clients = (self.mandos_serv
589
609
                              .GetAllClientsWithProperties())
590
 
            if not mandos_clients:
591
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
592
610
        except dbus.exceptions.DBusException:
593
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
594
611
            mandos_clients = dbus.Dictionary()
595
612
        
596
613
        (self.mandos_serv
608
625
                            self.client_not_found,
609
626
                            dbus_interface=server_interface,
610
627
                            byte_arrays=True))
611
 
        for path, client in mandos_clients.items():
 
628
        for path, client in mandos_clients.iteritems():
612
629
            client_proxy_object = self.bus.get_object(self.busname,
613
630
                                                      path)
614
631
            self.add_client(MandosClientWidget(server_proxy_object
623
640
                                               logger
624
641
                                               =self.log_message),
625
642
                            path=path)
626
 
        
 
643
 
627
644
        self.refresh()
628
645
        self._input_callback_tag = (gobject.io_add_watch
629
646
                                    (sys.stdin.fileno(),
661
678
            elif key == "window resize":
662
679
                self.size = self.screen.get_cols_rows()
663
680
                self.refresh()
664
 
            elif key == "ctrl l":
665
 
                self.screen.clear()
 
681
            elif key == "\f":  # Ctrl-L
666
682
                self.refresh()
667
683
            elif key == "l" or key == "D":
668
684
                self.toggle_log_display()
680
696
                                            "?: Help",
681
697
                                            "l: Log window toggle",
682
698
                                            "TAB: Switch window",
683
 
                                            "w: Wrap (log lines)",
684
 
                                            "v: Toggle verbose log",
685
 
                                            ))))
 
699
                                            "w: Wrap (log)"))))
686
700
                self.log_message_raw(("bold",
687
701
                                      "  "
688
702
                                      .join(("Clients:",
701
715
                else:
702
716
                    self.topwidget.set_focus(self.logbox)
703
717
                self.refresh()
704
 
            elif key == "v":
705
 
                if self.log_level == 0:
706
 
                    self.log_level = 1
707
 
                    self.log_message("Verbose mode: Off")
708
 
                else:
709
 
                    self.log_level = 0
710
 
                    self.log_message("Verbose mode: On")
711
718
            #elif (key == "end" or key == "meta >" or key == "G"
712
719
            #      or key == ">"):
713
720
            #    pass            # xxx end-of-buffer
736
743
    ui.run()
737
744
except KeyboardInterrupt:
738
745
    ui.screen.stop()
739
 
except Exception as e:
740
 
    ui.log_message(str(e))
 
746
except Exception, e:
 
747
    ui.log_message(unicode(e))
741
748
    ui.screen.stop()
742
749
    raise