/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: 2015-04-02 18:59:29 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150402185929-1q1rf1zelbpzzn74
Add "!RSA" also to examples/documentation.

* mandos.conf (priority): Add "!RSA" to default commented-out value.
* mandos.conf.xml (EXAMPLE): Add "!RSA" to example priority setting.

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