/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-ctl (main): Use D-Bus properties instead of methods.

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
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
21
# 
23
22
# Contact the authors at <mandos@recompile.se>.
24
23
# 
25
24
 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
 
try:
29
 
    from future_builtins import *
30
 
except ImportError:
31
 
    pass
32
27
 
33
28
import sys
34
29
import os
 
30
import signal
35
31
 
36
32
import datetime
37
33
 
39
35
import urwid
40
36
 
41
37
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
38
import gobject
46
39
 
47
40
import dbus
48
41
 
 
42
import UserList
 
43
 
49
44
import locale
50
45
 
51
 
if sys.version_info[0] == 2:
52
 
    str = unicode
53
 
 
54
46
locale.setlocale(locale.LC_ALL, '')
55
47
 
56
48
import logging
60
52
domain = 'se.recompile'
61
53
server_interface = domain + '.Mandos'
62
54
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.6"
 
55
version = "1.5.3"
 
56
 
 
57
# Always run in monochrome mode
 
58
urwid.curses_display.curses.has_colors = lambda : False
 
59
 
 
60
# Urwid doesn't support blinking, but we want it.  Since we have no
 
61
# use for underline on its own, we make underline also always blink.
 
62
urwid.curses_display.curses.A_UNDERLINE |= (
 
63
    urwid.curses_display.curses.A_BLINK)
64
64
 
65
65
def isoformat_to_datetime(iso):
66
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
83
83
    properties and calls a hook function when any of them are
84
84
    changed.
85
85
    """
86
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
86
    def __init__(self, proxy_object=None, *args, **kwargs):
87
87
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        self.properties = dict() if properties is None else properties
 
88
        
 
89
        self.properties = dict()
89
90
        self.property_changed_match = (
90
91
            self.proxy.connect_to_signal("PropertyChanged",
91
 
                                         self._property_changed,
 
92
                                         self.property_changed,
92
93
                                         client_interface,
93
94
                                         byte_arrays=True))
94
95
        
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)
 
96
        self.properties.update(
 
97
            self.proxy.GetAll(client_interface,
 
98
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
99
 
 
100
        #XXX This breaks good super behaviour
 
101
#        super(MandosClientPropertyCache, self).__init__(
 
102
#            *args, **kwargs)
106
103
    
107
104
    def property_changed(self, property=None, value=None):
108
105
        """This is called whenever we get a PropertyChanged signal
111
108
        # Update properties dict with new value
112
109
        self.properties[property] = value
113
110
    
114
 
    def delete(self):
 
111
    def delete(self, *args, **kwargs):
115
112
        self.property_changed_match.remove()
 
113
        super(MandosClientPropertyCache, self).__init__(
 
114
            *args, **kwargs)
116
115
 
117
116
 
118
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
119
    """
121
120
    
122
121
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, **kwargs):
 
122
                 delete_hook=None, logger=None, *args, **kwargs):
124
123
        # Called on update
125
124
        self.update_hook = update_hook
126
125
        # Called on delete
131
130
        self.logger = logger
132
131
        
133
132
        self._update_timer_callback_tag = None
 
133
        self._update_timer_callback_lock = 0
134
134
        
135
135
        # The widget shown normally
136
136
        self._text_widget = urwid.Text("")
137
137
        # The widget shown when we have focus
138
138
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
139
        super(MandosClientWidget, self).__init__(
 
140
            update_hook=update_hook, delete_hook=delete_hook,
 
141
            *args, **kwargs)
140
142
        self.update()
141
143
        self.opened = False
142
144
        
 
145
        last_checked_ok = isoformat_to_datetime(self.properties
 
146
                                                ["LastCheckedOK"])
 
147
        
 
148
        if self.properties ["LastCheckerStatus"] != 0:
 
149
            self.using_timer(True)
 
150
        
 
151
        if self.need_approval:
 
152
            self.using_timer(True)
 
153
        
143
154
        self.match_objects = (
144
155
            self.proxy.connect_to_signal("CheckerCompleted",
145
156
                                         self.checker_completed,
161
172
                                         self.rejected,
162
173
                                         client_interface,
163
174
                                         byte_arrays=True))
164
 
        self.logger('Created client {0}'
165
 
                    .format(self.properties["Name"]), level=0)
 
175
        #self.logger('Created client {0}'
 
176
        #            .format(self.properties["Name"]))
 
177
    
 
178
    def property_changed(self, property=None, value=None):
 
179
        super(self, MandosClientWidget).property_changed(property,
 
180
                                                         value)
 
181
        if property == "ApprovalPending":
 
182
            using_timer(bool(value))
 
183
        if property == "LastCheckerStatus":
 
184
            using_timer(value != 0)
 
185
            #self.logger('Checker for client {0} (command "{1}") was '
 
186
            #            ' successful'.format(self.properties["Name"],
 
187
            #                                 command))
166
188
    
167
189
    def using_timer(self, flag):
168
190
        """Call this method with True or False when timer should be
169
191
        activated or deactivated.
170
192
        """
171
 
        if flag and self._update_timer_callback_tag is None:
 
193
        old = self._update_timer_callback_lock
 
194
        if flag:
 
195
            self._update_timer_callback_lock += 1
 
196
        else:
 
197
            self._update_timer_callback_lock -= 1
 
198
        if old == 0 and self._update_timer_callback_lock:
172
199
            # Will update the shown timer value every second
173
200
            self._update_timer_callback_tag = (gobject.timeout_add
174
201
                                               (1000,
175
202
                                                self.update_timer))
176
 
        elif not (flag or self._update_timer_callback_tag is None):
 
203
        elif old and self._update_timer_callback_lock == 0:
177
204
            gobject.source_remove(self._update_timer_callback_tag)
178
205
            self._update_timer_callback_tag = None
179
206
    
180
207
    def checker_completed(self, exitstatus, condition, command):
181
208
        if exitstatus == 0:
182
 
            self.logger('Checker for client {0} (command "{1}")'
183
 
                        ' succeeded'.format(self.properties["Name"],
184
 
                                            command), level=0)
185
209
            self.update()
186
210
            return
187
211
        # Checker failed
206
230
        self.update()
207
231
    
208
232
    def checker_started(self, command):
209
 
        """Server signals that a checker started."""
210
 
        self.logger('Client {0} started checker "{1}"'
211
 
                    .format(self.properties["Name"],
212
 
                            command), level=0)
 
233
        """Server signals that a checker started. This could be useful
 
234
           to log in the future. """
 
235
        #self.logger('Client {0} started checker "{1}"'
 
236
        #            .format(self.properties["Name"],
 
237
        #                    unicode(command)))
 
238
        pass
213
239
    
214
240
    def got_secret(self):
215
241
        self.logger('Client {0} received its secret'
222
248
            message = 'Client {0} will get its secret in {1} seconds'
223
249
        self.logger(message.format(self.properties["Name"],
224
250
                                   timeout/1000))
 
251
        self.using_timer(True)
225
252
    
226
253
    def rejected(self, reason):
227
254
        self.logger('Client {0} was rejected; reason: {1}'
253
280
                          "bold-underline-blink":
254
281
                              "bold-underline-blink-standout",
255
282
                          }
256
 
        
 
283
 
257
284
        # Rebuild focus and non-focus widgets using current properties
258
 
        
 
285
 
259
286
        # Base part of a client. Name!
260
287
        base = '{name}: '.format(name=self.properties["Name"])
261
288
        if not self.properties["Enabled"]:
262
289
            message = "DISABLED"
263
 
            self.using_timer(False)
264
290
        elif self.properties["ApprovalPending"]:
265
291
            timeout = datetime.timedelta(milliseconds
266
292
                                         = self.properties
268
294
            last_approval_request = isoformat_to_datetime(
269
295
                self.properties["LastApprovalRequest"])
270
296
            if last_approval_request is not None:
271
 
                timer = max(timeout - (datetime.datetime.utcnow()
272
 
                                       - last_approval_request),
273
 
                            datetime.timedelta())
 
297
                timer = timeout - (datetime.datetime.utcnow()
 
298
                                   - last_approval_request)
274
299
            else:
275
300
                timer = datetime.timedelta()
276
301
            if self.properties["ApprovedByDefault"]:
277
302
                message = "Approval in {0}. (d)eny?"
278
303
            else:
279
304
                message = "Denial in {0}. (a)pprove?"
280
 
            message = message.format(str(timer).rsplit(".", 1)[0])
281
 
            self.using_timer(True)
 
305
            message = message.format(unicode(timer).rsplit(".", 1)[0])
282
306
        elif self.properties["LastCheckerStatus"] != 0:
283
 
            # When checker has failed, show timer until client expires
 
307
            # When checker has failed, print a timer until client expires
284
308
            expires = self.properties["Expires"]
285
309
            if expires == "":
286
310
                timer = datetime.timedelta(0)
287
311
            else:
288
 
                expires = (datetime.datetime.strptime
289
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
 
                timer = max(expires - datetime.datetime.utcnow(),
291
 
                            datetime.timedelta())
 
312
                expires = datetime.datetime.strptime(expires,
 
313
                                                     '%Y-%m-%dT%H:%M:%S.%f')
 
314
                timer = expires - datetime.datetime.utcnow()
292
315
            message = ('A checker has failed! Time until client'
293
316
                       ' gets disabled: {0}'
294
 
                       .format(str(timer).rsplit(".", 1)[0]))
295
 
            self.using_timer(True)
 
317
                       .format(unicode(timer).rsplit(".", 1)[0]))
296
318
        else:
297
319
            message = "enabled"
298
 
            self.using_timer(False)
299
320
        self._text = "{0}{1}".format(base, message)
300
 
        
 
321
            
301
322
        if not urwid.supports_unicode():
302
323
            self._text = self._text.encode("ascii", "replace")
303
324
        textlist = [("normal", self._text)]
320
341
        self.update()
321
342
        return True             # Keep calling this
322
343
    
323
 
    def delete(self, **kwargs):
 
344
    def delete(self, *args, **kwargs):
324
345
        if self._update_timer_callback_tag is not None:
325
346
            gobject.source_remove(self._update_timer_callback_tag)
326
347
            self._update_timer_callback_tag = None
329
350
        self.match_objects = ()
330
351
        if self.delete_hook is not None:
331
352
            self.delete_hook(self)
332
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
353
        return super(MandosClientWidget, self).delete(*args, **kwargs)
333
354
    
334
355
    def render(self, maxcolrow, focus=False):
335
356
        """Render differently if we have focus.
377
398
        else:
378
399
            return key
379
400
    
380
 
    def property_changed(self, property=None, **kwargs):
 
401
    def property_changed(self, property=None, value=None,
 
402
                         *args, **kwargs):
381
403
        """Call self.update() if old value is not new value.
382
404
        This overrides the method from MandosClientPropertyCache"""
383
 
        property_name = str(property)
 
405
        property_name = unicode(property)
384
406
        old_value = self.properties.get(property_name)
385
407
        super(MandosClientWidget, self).property_changed(
386
 
            property=property, **kwargs)
 
408
            property=property, value=value, *args, **kwargs)
387
409
        if self.properties.get(property_name) != old_value:
388
410
            self.update()
389
411
 
393
415
    "down" key presses, thus not allowing any containing widgets to
394
416
    use them as an excuse to shift focus away from this widget.
395
417
    """
396
 
    def keypress(self, *args, **kwargs):
397
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
418
    def keypress(self, maxcolrow, key):
 
419
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
398
420
        if ret in ("up", "down"):
399
421
            return
400
422
        return ret
404
426
    """This is the entire user interface - the whole screen
405
427
    with boxes, lists of client widgets, etc.
406
428
    """
407
 
    def __init__(self, max_log_length=1000, log_level=1):
 
429
    def __init__(self, max_log_length=1000):
408
430
        DBusGMainLoop(set_as_default=True)
409
431
        
410
432
        self.screen = urwid.curses_display.Screen()
413
435
                ("normal",
414
436
                 "default", "default", None),
415
437
                ("bold",
416
 
                 "bold", "default", "bold"),
 
438
                 "default", "default", "bold"),
417
439
                ("underline-blink",
418
 
                 "underline,blink", "default", "underline,blink"),
 
440
                 "default", "default", "underline"),
419
441
                ("standout",
420
 
                 "standout", "default", "standout"),
 
442
                 "default", "default", "standout"),
421
443
                ("bold-underline-blink",
422
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
444
                 "default", "default", ("bold", "underline")),
423
445
                ("bold-standout",
424
 
                 "bold,standout", "default", "bold,standout"),
 
446
                 "default", "default", ("bold", "standout")),
425
447
                ("underline-blink-standout",
426
 
                 "underline,blink,standout", "default",
427
 
                 "underline,blink,standout"),
 
448
                 "default", "default", ("underline", "standout")),
428
449
                ("bold-underline-blink-standout",
429
 
                 "bold,underline,blink,standout", "default",
430
 
                 "bold,underline,blink,standout"),
 
450
                 "default", "default", ("bold", "underline",
 
451
                                          "standout")),
431
452
                ))
432
453
        
433
454
        if urwid.supports_unicode():
448
469
        self.log = []
449
470
        self.max_log_length = max_log_length
450
471
        
451
 
        self.log_level = log_level
452
 
        
453
472
        # We keep a reference to the log widget so we can remove it
454
473
        # from the ListWalker without it getting destroyed
455
474
        self.logbox = ConstrainedListBox(self.log)
489
508
            self.uilist.append(self.logbox)
490
509
        self.topwidget = urwid.Pile(self.uilist)
491
510
    
492
 
    def log_message(self, message, level=1):
493
 
        """Log message formatted with timestamp"""
494
 
        if level < self.log_level:
495
 
            return
 
511
    def log_message(self, message):
496
512
        timestamp = datetime.datetime.now().isoformat()
497
 
        self.log_message_raw("{0}: {1}".format(timestamp, message),
498
 
                             level=level)
 
513
        self.log_message_raw(timestamp + ": " + message)
499
514
    
500
 
    def log_message_raw(self, markup, level=1):
 
515
    def log_message_raw(self, markup):
501
516
        """Add a log message to the log buffer."""
502
 
        if level < self.log_level:
503
 
            return
504
517
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
518
        if (self.max_log_length
506
519
            and len(self.log) > self.max_log_length):
513
526
        """Toggle visibility of the log buffer."""
514
527
        self.log_visible = not self.log_visible
515
528
        self.rebuild()
516
 
        self.log_message("Log visibility changed to: {0}"
517
 
                         .format(self.log_visible), level=0)
 
529
        #self.log_message("Log visibility changed to: "
 
530
        #                 + unicode(self.log_visible))
518
531
    
519
532
    def change_log_display(self):
520
533
        """Change type of log display.
525
538
            self.log_wrap = "clip"
526
539
        for textwidget in self.log:
527
540
            textwidget.set_wrap_mode(self.log_wrap)
528
 
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
529
 
                         level=0)
 
541
        #self.log_message("Wrap mode: " + self.log_wrap)
530
542
    
531
543
    def find_and_remove_client(self, path, name):
532
544
        """Find a client by its object path and remove it.
561
573
        if path is None:
562
574
            path = client.proxy.object_path
563
575
        self.clients_dict[path] = client
564
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
576
        self.clients.sort(None, lambda c: c.properties["Name"])
565
577
        self.refresh()
566
578
    
567
579
    def remove_client(self, client, path=None):
569
581
        if path is None:
570
582
            path = client.proxy.object_path
571
583
        del self.clients_dict[path]
 
584
        if not self.clients_dict:
 
585
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
586
            # is completely emptied, we need to recreate it.
 
587
            self.clients = urwid.SimpleListWalker([])
 
588
            self.rebuild()
572
589
        self.refresh()
573
590
    
574
591
    def refresh(self):
587
604
        try:
588
605
            mandos_clients = (self.mandos_serv
589
606
                              .GetAllClientsWithProperties())
590
 
            if not mandos_clients:
591
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
592
607
        except dbus.exceptions.DBusException:
593
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
594
608
            mandos_clients = dbus.Dictionary()
595
609
        
596
610
        (self.mandos_serv
608
622
                            self.client_not_found,
609
623
                            dbus_interface=server_interface,
610
624
                            byte_arrays=True))
611
 
        for path, client in mandos_clients.items():
 
625
        for path, client in mandos_clients.iteritems():
612
626
            client_proxy_object = self.bus.get_object(self.busname,
613
627
                                                      path)
614
628
            self.add_client(MandosClientWidget(server_proxy_object
623
637
                                               logger
624
638
                                               =self.log_message),
625
639
                            path=path)
626
 
        
 
640
 
627
641
        self.refresh()
628
642
        self._input_callback_tag = (gobject.io_add_watch
629
643
                                    (sys.stdin.fileno(),
679
693
                                            "?: Help",
680
694
                                            "l: Log window toggle",
681
695
                                            "TAB: Switch window",
682
 
                                            "w: Wrap (log lines)",
683
 
                                            "v: Toggle verbose log",
684
 
                                            ))))
 
696
                                            "w: Wrap (log)"))))
685
697
                self.log_message_raw(("bold",
686
698
                                      "  "
687
699
                                      .join(("Clients:",
700
712
                else:
701
713
                    self.topwidget.set_focus(self.logbox)
702
714
                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")
710
715
            #elif (key == "end" or key == "meta >" or key == "G"
711
716
            #      or key == ">"):
712
717
            #    pass            # xxx end-of-buffer
735
740
    ui.run()
736
741
except KeyboardInterrupt:
737
742
    ui.screen.stop()
738
 
except Exception as e:
739
 
    ui.log_message(str(e))
 
743
except Exception, e:
 
744
    ui.log_message(unicode(e))
740
745
    ui.screen.stop()
741
746
    raise