/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

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-2016 Teddy Hogeborn
7
 
# Copyright © 2009-2016 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
39
39
import urwid
40
40
 
41
41
from dbus.mainloop.glib import DBusGMainLoop
42
 
from gi.repository import GLib
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
43
46
 
44
47
import dbus
45
48
 
46
49
import locale
47
50
 
48
 
if sys.version_info.major == 2:
 
51
if sys.version_info[0] == 2:
49
52
    str = unicode
50
53
 
51
54
locale.setlocale(locale.LC_ALL, '')
57
60
domain = 'se.recompile'
58
61
server_interface = domain + '.Mandos'
59
62
client_interface = domain + '.Mandos.Client'
60
 
version = "1.7.10"
61
 
 
62
 
try:
63
 
    dbus.OBJECT_MANAGER_IFACE
64
 
except AttributeError:
65
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
63
version = "1.6.6"
66
64
 
67
65
def isoformat_to_datetime(iso):
68
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
89
87
        self.proxy = proxy_object # Mandos Client proxy object
90
88
        self.properties = dict() if properties is None else properties
91
89
        self.property_changed_match = (
92
 
            self.proxy.connect_to_signal("PropertiesChanged",
93
 
                                         self.properties_changed,
94
 
                                         dbus.PROPERTIES_IFACE,
 
90
            self.proxy.connect_to_signal("PropertyChanged",
 
91
                                         self._property_changed,
 
92
                                         client_interface,
95
93
                                         byte_arrays=True))
96
94
        
97
95
        if properties is None:
102
100
        
103
101
        super(MandosClientPropertyCache, self).__init__(**kwargs)
104
102
    
105
 
    def properties_changed(self, interface, properties, invalidated):
106
 
        """This is called whenever we get a PropertiesChanged signal
107
 
        It updates the changed properties in the "properties" dict.
 
103
    def _property_changed(self, property, value):
 
104
        """Helper which takes positional arguments"""
 
105
        return self.property_changed(property=property, value=value)
 
106
    
 
107
    def property_changed(self, property=None, value=None):
 
108
        """This is called whenever we get a PropertyChanged signal
 
109
        It updates the changed property in the "properties" dict.
108
110
        """
109
111
        # Update properties dict with new value
110
 
        if interface == client_interface:
111
 
            self.properties.update(properties)
 
112
        self.properties[property] = value
112
113
    
113
114
    def delete(self):
114
115
        self.property_changed_match.remove()
160
161
                                         self.rejected,
161
162
                                         client_interface,
162
163
                                         byte_arrays=True))
163
 
        self.logger('Created client {}'
 
164
        self.logger('Created client {0}'
164
165
                    .format(self.properties["Name"]), level=0)
165
166
    
166
167
    def using_timer(self, flag):
169
170
        """
170
171
        if flag and self._update_timer_callback_tag is None:
171
172
            # Will update the shown timer value every second
172
 
            self._update_timer_callback_tag = (GLib.timeout_add
 
173
            self._update_timer_callback_tag = (gobject.timeout_add
173
174
                                               (1000,
174
175
                                                self.update_timer))
175
176
        elif not (flag or self._update_timer_callback_tag is None):
176
 
            GLib.source_remove(self._update_timer_callback_tag)
 
177
            gobject.source_remove(self._update_timer_callback_tag)
177
178
            self._update_timer_callback_tag = None
178
179
    
179
180
    def checker_completed(self, exitstatus, condition, command):
180
181
        if exitstatus == 0:
181
 
            self.logger('Checker for client {} (command "{}")'
 
182
            self.logger('Checker for client {0} (command "{1}")'
182
183
                        ' succeeded'.format(self.properties["Name"],
183
184
                                            command), level=0)
184
185
            self.update()
185
186
            return
186
187
        # Checker failed
187
188
        if os.WIFEXITED(condition):
188
 
            self.logger('Checker for client {} (command "{}") failed'
189
 
                        ' with exit code {}'
 
189
            self.logger('Checker for client {0} (command "{1}")'
 
190
                        ' failed with exit code {2}'
190
191
                        .format(self.properties["Name"], command,
191
192
                                os.WEXITSTATUS(condition)))
192
193
        elif os.WIFSIGNALED(condition):
193
 
            self.logger('Checker for client {} (command "{}") was'
194
 
                        ' killed by signal {}'
 
194
            self.logger('Checker for client {0} (command "{1}") was'
 
195
                        ' killed by signal {2}'
195
196
                        .format(self.properties["Name"], command,
196
197
                                os.WTERMSIG(condition)))
 
198
        elif os.WCOREDUMP(condition):
 
199
            self.logger('Checker for client {0} (command "{1}")'
 
200
                        ' dumped core'
 
201
                        .format(self.properties["Name"], command))
 
202
        else:
 
203
            self.logger('Checker for client {0} completed'
 
204
                        ' mysteriously'
 
205
                        .format(self.properties["Name"]))
197
206
        self.update()
198
207
    
199
208
    def checker_started(self, command):
200
209
        """Server signals that a checker started."""
201
 
        self.logger('Client {} started checker "{}"'
 
210
        self.logger('Client {0} started checker "{1}"'
202
211
                    .format(self.properties["Name"],
203
212
                            command), level=0)
204
213
    
205
214
    def got_secret(self):
206
 
        self.logger('Client {} received its secret'
 
215
        self.logger('Client {0} received its secret'
207
216
                    .format(self.properties["Name"]))
208
217
    
209
218
    def need_approval(self, timeout, default):
210
219
        if not default:
211
 
            message = 'Client {} needs approval within {} seconds'
 
220
            message = 'Client {0} needs approval within {1} seconds'
212
221
        else:
213
 
            message = 'Client {} will get its secret in {} seconds'
 
222
            message = 'Client {0} will get its secret in {1} seconds'
214
223
        self.logger(message.format(self.properties["Name"],
215
224
                                   timeout/1000))
216
225
    
217
226
    def rejected(self, reason):
218
 
        self.logger('Client {} was rejected; reason: {}'
 
227
        self.logger('Client {0} was rejected; reason: {1}'
219
228
                    .format(self.properties["Name"], reason))
220
229
    
221
230
    def selectable(self):
265
274
            else:
266
275
                timer = datetime.timedelta()
267
276
            if self.properties["ApprovedByDefault"]:
268
 
                message = "Approval in {}. (d)eny?"
 
277
                message = "Approval in {0}. (d)eny?"
269
278
            else:
270
 
                message = "Denial in {}. (a)pprove?"
 
279
                message = "Denial in {0}. (a)pprove?"
271
280
            message = message.format(str(timer).rsplit(".", 1)[0])
272
281
            self.using_timer(True)
273
282
        elif self.properties["LastCheckerStatus"] != 0:
281
290
                timer = max(expires - datetime.datetime.utcnow(),
282
291
                            datetime.timedelta())
283
292
            message = ('A checker has failed! Time until client'
284
 
                       ' gets disabled: {}'
 
293
                       ' gets disabled: {0}'
285
294
                       .format(str(timer).rsplit(".", 1)[0]))
286
295
            self.using_timer(True)
287
296
        else:
288
297
            message = "enabled"
289
298
            self.using_timer(False)
290
 
        self._text = "{}{}".format(base, message)
 
299
        self._text = "{0}{1}".format(base, message)
291
300
        
292
301
        if not urwid.supports_unicode():
293
302
            self._text = self._text.encode("ascii", "replace")
306
315
            self.update_hook()
307
316
    
308
317
    def update_timer(self):
309
 
        """called by GLib. Will indefinitely loop until
310
 
        GLib.source_remove() on tag is called
311
 
        """
 
318
        """called by gobject. Will indefinitely loop until
 
319
        gobject.source_remove() on tag is called"""
312
320
        self.update()
313
321
        return True             # Keep calling this
314
322
    
315
323
    def delete(self, **kwargs):
316
324
        if self._update_timer_callback_tag is not None:
317
 
            GLib.source_remove(self._update_timer_callback_tag)
 
325
            gobject.source_remove(self._update_timer_callback_tag)
318
326
            self._update_timer_callback_tag = None
319
327
        for match in self.match_objects:
320
328
            match.remove()
333
341
        """Handle keys.
334
342
        This overrides the method from urwid.FlowWidget"""
335
343
        if key == "+":
336
 
            self.proxy.Set(client_interface, "Enabled",
337
 
                           dbus.Boolean(True), ignore_reply = True,
338
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
344
            self.proxy.Enable(dbus_interface = client_interface,
 
345
                              ignore_reply=True)
339
346
        elif key == "-":
340
 
            self.proxy.Set(client_interface, "Enabled", False,
341
 
                           ignore_reply = True,
342
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
347
            self.proxy.Disable(dbus_interface = client_interface,
 
348
                               ignore_reply=True)
343
349
        elif key == "a":
344
350
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
351
                               dbus_interface = client_interface,
353
359
                                                  .object_path,
354
360
                                                  ignore_reply=True)
355
361
        elif key == "s":
356
 
            self.proxy.Set(client_interface, "CheckerRunning",
357
 
                           dbus.Boolean(True), ignore_reply = True,
358
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
362
            self.proxy.StartChecker(dbus_interface = client_interface,
 
363
                                    ignore_reply=True)
359
364
        elif key == "S":
360
 
            self.proxy.Set(client_interface, "CheckerRunning",
361
 
                           dbus.Boolean(False), ignore_reply = True,
362
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
365
            self.proxy.StopChecker(dbus_interface = client_interface,
 
366
                                   ignore_reply=True)
363
367
        elif key == "C":
364
368
            self.proxy.CheckedOK(dbus_interface = client_interface,
365
369
                                 ignore_reply=True)
373
377
        else:
374
378
            return key
375
379
    
376
 
    def properties_changed(self, interface, properties, invalidated):
377
 
        """Call self.update() if any properties changed.
 
380
    def property_changed(self, property=None, **kwargs):
 
381
        """Call self.update() if old value is not new value.
378
382
        This overrides the method from MandosClientPropertyCache"""
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):
 
383
        property_name = str(property)
 
384
        old_value = self.properties.get(property_name)
 
385
        super(MandosClientWidget, self).property_changed(
 
386
            property=property, **kwargs)
 
387
        if self.properties.get(property_name) != old_value:
385
388
            self.update()
386
389
 
387
390
 
463
466
                              "q: Quit  ?: Help"))
464
467
        
465
468
        self.busname = domain + '.Mandos'
466
 
        self.main_loop = GLib.MainLoop()
 
469
        self.main_loop = gobject.MainLoop()
467
470
    
468
471
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {} and fingerprint {}"
470
 
                         " could not be found"
 
472
        self.log_message("Client with address {0} and fingerprint"
 
473
                         " {1} could not be found"
471
474
                         .format(address, fingerprint))
472
475
    
473
476
    def rebuild(self):
491
494
        if level < self.log_level:
492
495
            return
493
496
        timestamp = datetime.datetime.now().isoformat()
494
 
        self.log_message_raw("{}: {}".format(timestamp, message),
 
497
        self.log_message_raw("{0}: {1}".format(timestamp, message),
495
498
                             level=level)
496
499
    
497
500
    def log_message_raw(self, markup, level=1):
510
513
        """Toggle visibility of the log buffer."""
511
514
        self.log_visible = not self.log_visible
512
515
        self.rebuild()
513
 
        self.log_message("Log visibility changed to: {}"
 
516
        self.log_message("Log visibility changed to: {0}"
514
517
                         .format(self.log_visible), level=0)
515
518
    
516
519
    def change_log_display(self):
522
525
            self.log_wrap = "clip"
523
526
        for textwidget in self.log:
524
527
            textwidget.set_wrap_mode(self.log_wrap)
525
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
528
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
526
529
                         level=0)
527
530
    
528
 
    def find_and_remove_client(self, path, interfaces):
 
531
    def find_and_remove_client(self, path, name):
529
532
        """Find a client by its object path and remove it.
530
533
        
531
 
        This is connected to the InterfacesRemoved signal from the
 
534
        This is connected to the ClientRemoved signal from the
532
535
        Mandos server object."""
533
 
        if client_interface not in interfaces:
534
 
            # Not a Mandos client object; ignore
535
 
            return
536
536
        try:
537
537
            client = self.clients_dict[path]
538
538
        except KeyError:
539
539
            # not found?
540
 
            self.log_message("Unknown client {!r} removed"
541
 
                             .format(path))
 
540
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
541
                             .format(name, path))
542
542
            return
543
543
        client.delete()
544
544
    
545
 
    def add_new_client(self, path, ifs_and_props):
546
 
        """Find a client by its object path and remove it.
547
 
        
548
 
        This is connected to the InterfacesAdded signal from the
549
 
        Mandos server object.
550
 
        """
551
 
        if client_interface not in ifs_and_props:
552
 
            # Not a Mandos client object; ignore
553
 
            return
 
545
    def add_new_client(self, path):
554
546
        client_proxy_object = self.bus.get_object(self.busname, path)
555
547
        self.add_client(MandosClientWidget(server_proxy_object
556
548
                                           =self.mandos_serv,
561
553
                                           delete_hook
562
554
                                           =self.remove_client,
563
555
                                           logger
564
 
                                           =self.log_message,
565
 
                                           properties
566
 
                                           = dict(ifs_and_props[
567
 
                                               client_interface])),
 
556
                                           =self.log_message),
568
557
                        path=path)
569
558
    
570
559
    def add_client(self, client, path=None):
605
594
            mandos_clients = dbus.Dictionary()
606
595
        
607
596
        (self.mandos_serv
608
 
         .connect_to_signal("InterfacesRemoved",
 
597
         .connect_to_signal("ClientRemoved",
609
598
                            self.find_and_remove_client,
610
 
                            dbus_interface
611
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
599
                            dbus_interface=server_interface,
612
600
                            byte_arrays=True))
613
601
        (self.mandos_serv
614
 
         .connect_to_signal("InterfacesAdded",
 
602
         .connect_to_signal("ClientAdded",
615
603
                            self.add_new_client,
616
 
                            dbus_interface
617
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
604
                            dbus_interface=server_interface,
618
605
                            byte_arrays=True))
619
606
        (self.mandos_serv
620
607
         .connect_to_signal("ClientNotFound",
638
625
                            path=path)
639
626
        
640
627
        self.refresh()
641
 
        self._input_callback_tag = (GLib.io_add_watch
 
628
        self._input_callback_tag = (gobject.io_add_watch
642
629
                                    (sys.stdin.fileno(),
643
 
                                     GLib.IO_IN,
 
630
                                     gobject.IO_IN,
644
631
                                     self.process_input))
645
632
        self.main_loop.run()
646
633
        # Main loop has finished, we should close everything now
647
 
        GLib.source_remove(self._input_callback_tag)
 
634
        gobject.source_remove(self._input_callback_tag)
648
635
        self.screen.stop()
649
636
    
650
637
    def stop(self):
674
661
            elif key == "window resize":
675
662
                self.size = self.screen.get_cols_rows()
676
663
                self.refresh()
677
 
            elif key == "ctrl l":
678
 
                self.screen.clear()
 
664
            elif key == "\f":  # Ctrl-L
679
665
                self.refresh()
680
666
            elif key == "l" or key == "D":
681
667
                self.toggle_log_display()