/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: 2014-07-17 03:50:57 UTC
  • mfrom: (320 release)
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140717035057-bg2gbhm4dqbcjewx
Merge from release branch.

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