/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-03-01 09:39:25 UTC
  • Revision ID: teddy@recompile.se-20140301093925-0x6nwf21f0zljk6e
* debian/copyright: Change year to "2014".
* mandos-ctl: - '' -
* mandos-monitor: - '' -
* plugins.d/mandos-client.xml: - '' -

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
48
48
 
49
49
import locale
50
50
 
51
 
if sys.version_info.major == 2:
 
51
if sys.version_info[0] == 2:
52
52
    str = unicode
53
53
 
54
54
locale.setlocale(locale.LC_ALL, '')
60
60
domain = 'se.recompile'
61
61
server_interface = domain + '.Mandos'
62
62
client_interface = domain + '.Mandos.Client'
63
 
version = "1.7.3"
64
 
 
65
 
try:
66
 
    dbus.OBJECT_MANAGER_IFACE
67
 
except AttributeError:
68
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
63
version = "1.6.4"
69
64
 
70
65
def isoformat_to_datetime(iso):
71
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
92
87
        self.proxy = proxy_object # Mandos Client proxy object
93
88
        self.properties = dict() if properties is None else properties
94
89
        self.property_changed_match = (
95
 
            self.proxy.connect_to_signal("PropertiesChanged",
96
 
                                         self.properties_changed,
97
 
                                         dbus.PROPERTIES_IFACE,
 
90
            self.proxy.connect_to_signal("PropertyChanged",
 
91
                                         self._property_changed,
 
92
                                         client_interface,
98
93
                                         byte_arrays=True))
99
94
        
100
95
        if properties is None:
105
100
        
106
101
        super(MandosClientPropertyCache, self).__init__(**kwargs)
107
102
    
108
 
    def properties_changed(self, interface, properties, invalidated):
109
 
        """This is called whenever we get a PropertiesChanged signal
110
 
        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.
111
110
        """
112
111
        # Update properties dict with new value
113
 
        if interface == client_interface:
114
 
            self.properties.update(properties)
 
112
        self.properties[property] = value
115
113
    
116
114
    def delete(self):
117
115
        self.property_changed_match.remove()
163
161
                                         self.rejected,
164
162
                                         client_interface,
165
163
                                         byte_arrays=True))
166
 
        self.logger('Created client {}'
167
 
                    .format(self.properties["Name"]), level=0)
 
164
        #self.logger('Created client {0}'
 
165
        #            .format(self.properties["Name"]))
168
166
    
169
167
    def using_timer(self, flag):
170
168
        """Call this method with True or False when timer should be
181
179
    
182
180
    def checker_completed(self, exitstatus, condition, command):
183
181
        if exitstatus == 0:
184
 
            self.logger('Checker for client {} (command "{}")'
185
 
                        ' succeeded'.format(self.properties["Name"],
186
 
                                            command), level=0)
187
182
            self.update()
188
183
            return
189
184
        # Checker failed
190
185
        if os.WIFEXITED(condition):
191
 
            self.logger('Checker for client {} (command "{}") failed'
192
 
                        ' with exit code {}'
 
186
            self.logger('Checker for client {0} (command "{1}")'
 
187
                        ' failed with exit code {2}'
193
188
                        .format(self.properties["Name"], command,
194
189
                                os.WEXITSTATUS(condition)))
195
190
        elif os.WIFSIGNALED(condition):
196
 
            self.logger('Checker for client {} (command "{}") was'
197
 
                        ' killed by signal {}'
 
191
            self.logger('Checker for client {0} (command "{1}") was'
 
192
                        ' killed by signal {2}'
198
193
                        .format(self.properties["Name"], command,
199
194
                                os.WTERMSIG(condition)))
 
195
        elif os.WCOREDUMP(condition):
 
196
            self.logger('Checker for client {0} (command "{1}")'
 
197
                        ' dumped core'
 
198
                        .format(self.properties["Name"], command))
 
199
        else:
 
200
            self.logger('Checker for client {0} completed'
 
201
                        ' mysteriously'
 
202
                        .format(self.properties["Name"]))
200
203
        self.update()
201
204
    
202
205
    def checker_started(self, command):
203
 
        """Server signals that a checker started."""
204
 
        self.logger('Client {} started checker "{}"'
205
 
                    .format(self.properties["Name"],
206
 
                            command), level=0)
 
206
        """Server signals that a checker started. This could be useful
 
207
           to log in the future. """
 
208
        #self.logger('Client {0} started checker "{1}"'
 
209
        #            .format(self.properties["Name"],
 
210
        #                    str(command)))
 
211
        pass
207
212
    
208
213
    def got_secret(self):
209
 
        self.logger('Client {} received its secret'
 
214
        self.logger('Client {0} received its secret'
210
215
                    .format(self.properties["Name"]))
211
216
    
212
217
    def need_approval(self, timeout, default):
213
218
        if not default:
214
 
            message = 'Client {} needs approval within {} seconds'
 
219
            message = 'Client {0} needs approval within {1} seconds'
215
220
        else:
216
 
            message = 'Client {} will get its secret in {} seconds'
 
221
            message = 'Client {0} will get its secret in {1} seconds'
217
222
        self.logger(message.format(self.properties["Name"],
218
223
                                   timeout/1000))
219
224
    
220
225
    def rejected(self, reason):
221
 
        self.logger('Client {} was rejected; reason: {}'
 
226
        self.logger('Client {0} was rejected; reason: {1}'
222
227
                    .format(self.properties["Name"], reason))
223
228
    
224
229
    def selectable(self):
268
273
            else:
269
274
                timer = datetime.timedelta()
270
275
            if self.properties["ApprovedByDefault"]:
271
 
                message = "Approval in {}. (d)eny?"
 
276
                message = "Approval in {0}. (d)eny?"
272
277
            else:
273
 
                message = "Denial in {}. (a)pprove?"
 
278
                message = "Denial in {0}. (a)pprove?"
274
279
            message = message.format(str(timer).rsplit(".", 1)[0])
275
280
            self.using_timer(True)
276
281
        elif self.properties["LastCheckerStatus"] != 0:
284
289
                timer = max(expires - datetime.datetime.utcnow(),
285
290
                            datetime.timedelta())
286
291
            message = ('A checker has failed! Time until client'
287
 
                       ' gets disabled: {}'
 
292
                       ' gets disabled: {0}'
288
293
                       .format(str(timer).rsplit(".", 1)[0]))
289
294
            self.using_timer(True)
290
295
        else:
291
296
            message = "enabled"
292
297
            self.using_timer(False)
293
 
        self._text = "{}{}".format(base, message)
 
298
        self._text = "{0}{1}".format(base, message)
294
299
        
295
300
        if not urwid.supports_unicode():
296
301
            self._text = self._text.encode("ascii", "replace")
335
340
        """Handle keys.
336
341
        This overrides the method from urwid.FlowWidget"""
337
342
        if key == "+":
338
 
            self.proxy.Set(client_interface, "Enabled",
339
 
                           dbus.Boolean(True), ignore_reply = True,
340
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
343
            self.proxy.Enable(dbus_interface = client_interface,
 
344
                              ignore_reply=True)
341
345
        elif key == "-":
342
 
            self.proxy.Set(client_interface, "Enabled", False,
343
 
                           ignore_reply = True,
344
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
346
            self.proxy.Disable(dbus_interface = client_interface,
 
347
                               ignore_reply=True)
345
348
        elif key == "a":
346
349
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
350
                               dbus_interface = client_interface,
355
358
                                                  .object_path,
356
359
                                                  ignore_reply=True)
357
360
        elif key == "s":
358
 
            self.proxy.Set(client_interface, "CheckerRunning",
359
 
                           dbus.Boolean(True), ignore_reply = True,
360
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
361
            self.proxy.StartChecker(dbus_interface = client_interface,
 
362
                                    ignore_reply=True)
361
363
        elif key == "S":
362
 
            self.proxy.Set(client_interface, "CheckerRunning",
363
 
                           dbus.Boolean(False), ignore_reply = True,
364
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
364
            self.proxy.StopChecker(dbus_interface = client_interface,
 
365
                                   ignore_reply=True)
365
366
        elif key == "C":
366
367
            self.proxy.CheckedOK(dbus_interface = client_interface,
367
368
                                 ignore_reply=True)
375
376
        else:
376
377
            return key
377
378
    
378
 
    def properties_changed(self, interface, properties, invalidated):
379
 
        """Call self.update() if any properties changed.
 
379
    def property_changed(self, property=None, **kwargs):
 
380
        """Call self.update() if old value is not new value.
380
381
        This overrides the method from MandosClientPropertyCache"""
381
 
        old_values = { key: self.properties.get(key)
382
 
                       for key in properties.keys() }
383
 
        super(MandosClientWidget, self).properties_changed(
384
 
            interface, properties, invalidated)
385
 
        if any(old_values[key] != self.properties.get(key)
386
 
               for key in old_values):
 
382
        property_name = str(property)
 
383
        old_value = self.properties.get(property_name)
 
384
        super(MandosClientWidget, self).property_changed(
 
385
            property=property, **kwargs)
 
386
        if self.properties.get(property_name) != old_value:
387
387
            self.update()
388
388
 
389
389
 
403
403
    """This is the entire user interface - the whole screen
404
404
    with boxes, lists of client widgets, etc.
405
405
    """
406
 
    def __init__(self, max_log_length=1000, log_level=1):
 
406
    def __init__(self, max_log_length=1000):
407
407
        DBusGMainLoop(set_as_default=True)
408
408
        
409
409
        self.screen = urwid.curses_display.Screen()
447
447
        self.log = []
448
448
        self.max_log_length = max_log_length
449
449
        
450
 
        self.log_level = log_level
451
 
        
452
450
        # We keep a reference to the log widget so we can remove it
453
451
        # from the ListWalker without it getting destroyed
454
452
        self.logbox = ConstrainedListBox(self.log)
468
466
        self.main_loop = gobject.MainLoop()
469
467
    
470
468
    def client_not_found(self, fingerprint, address):
471
 
        self.log_message("Client with address {} and fingerprint {}"
472
 
                         " could not be found"
 
469
        self.log_message("Client with address {0} and fingerprint"
 
470
                         " {1} could not be found"
473
471
                         .format(address, fingerprint))
474
472
    
475
473
    def rebuild(self):
488
486
            self.uilist.append(self.logbox)
489
487
        self.topwidget = urwid.Pile(self.uilist)
490
488
    
491
 
    def log_message(self, message, level=1):
 
489
    def log_message(self, message):
492
490
        """Log message formatted with timestamp"""
493
 
        if level < self.log_level:
494
 
            return
495
491
        timestamp = datetime.datetime.now().isoformat()
496
 
        self.log_message_raw("{}: {}".format(timestamp, message),
497
 
                             level=level)
 
492
        self.log_message_raw(timestamp + ": " + message)
498
493
    
499
 
    def log_message_raw(self, markup, level=1):
 
494
    def log_message_raw(self, markup):
500
495
        """Add a log message to the log buffer."""
501
 
        if level < self.log_level:
502
 
            return
503
496
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
504
497
        if (self.max_log_length
505
498
            and len(self.log) > self.max_log_length):
512
505
        """Toggle visibility of the log buffer."""
513
506
        self.log_visible = not self.log_visible
514
507
        self.rebuild()
515
 
        self.log_message("Log visibility changed to: {}"
516
 
                         .format(self.log_visible), level=0)
 
508
        #self.log_message("Log visibility changed to: "
 
509
        #                 + str(self.log_visible))
517
510
    
518
511
    def change_log_display(self):
519
512
        """Change type of log display.
524
517
            self.log_wrap = "clip"
525
518
        for textwidget in self.log:
526
519
            textwidget.set_wrap_mode(self.log_wrap)
527
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
528
 
                         level=0)
 
520
        #self.log_message("Wrap mode: " + self.log_wrap)
529
521
    
530
 
    def find_and_remove_client(self, path, interfaces):
 
522
    def find_and_remove_client(self, path, name):
531
523
        """Find a client by its object path and remove it.
532
524
        
533
 
        This is connected to the InterfacesRemoved signal from the
 
525
        This is connected to the ClientRemoved signal from the
534
526
        Mandos server object."""
535
 
        if client_interface not in interfaces:
536
 
            # Not a Mandos client object; ignore
537
 
            return
538
527
        try:
539
528
            client = self.clients_dict[path]
540
529
        except KeyError:
541
530
            # not found?
542
 
            self.log_message("Unknown client {!r} removed"
543
 
                             .format(path))
 
531
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
532
                             .format(name, path))
544
533
            return
545
534
        client.delete()
546
535
    
547
 
    def add_new_client(self, path, ifs_and_props):
548
 
        """Find a client by its object path and remove it.
549
 
        
550
 
        This is connected to the InterfacesAdded signal from the
551
 
        Mandos server object.
552
 
        """
553
 
        if client_interface not in ifs_and_props:
554
 
            # Not a Mandos client object; ignore
555
 
            return
 
536
    def add_new_client(self, path):
556
537
        client_proxy_object = self.bus.get_object(self.busname, path)
557
538
        self.add_client(MandosClientWidget(server_proxy_object
558
539
                                           =self.mandos_serv,
563
544
                                           delete_hook
564
545
                                           =self.remove_client,
565
546
                                           logger
566
 
                                           =self.log_message,
567
 
                                           properties
568
 
                                           = dict(ifs_and_props[
569
 
                                               client_interface])),
 
547
                                           =self.log_message),
570
548
                        path=path)
571
549
    
572
550
    def add_client(self, client, path=None):
607
585
            mandos_clients = dbus.Dictionary()
608
586
        
609
587
        (self.mandos_serv
610
 
         .connect_to_signal("InterfacesRemoved",
 
588
         .connect_to_signal("ClientRemoved",
611
589
                            self.find_and_remove_client,
612
 
                            dbus_interface
613
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
590
                            dbus_interface=server_interface,
614
591
                            byte_arrays=True))
615
592
        (self.mandos_serv
616
 
         .connect_to_signal("InterfacesAdded",
 
593
         .connect_to_signal("ClientAdded",
617
594
                            self.add_new_client,
618
 
                            dbus_interface
619
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
595
                            dbus_interface=server_interface,
620
596
                            byte_arrays=True))
621
597
        (self.mandos_serv
622
598
         .connect_to_signal("ClientNotFound",
676
652
            elif key == "window resize":
677
653
                self.size = self.screen.get_cols_rows()
678
654
                self.refresh()
679
 
            elif key == "ctrl l":
680
 
                self.screen.clear()
 
655
            elif key == "\f":  # Ctrl-L
681
656
                self.refresh()
682
657
            elif key == "l" or key == "D":
683
658
                self.toggle_log_display()
695
670
                                            "?: Help",
696
671
                                            "l: Log window toggle",
697
672
                                            "TAB: Switch window",
698
 
                                            "w: Wrap (log lines)",
699
 
                                            "v: Toggle verbose log",
700
 
                                            ))))
 
673
                                            "w: Wrap (log)"))))
701
674
                self.log_message_raw(("bold",
702
675
                                      "  "
703
676
                                      .join(("Clients:",
716
689
                else:
717
690
                    self.topwidget.set_focus(self.logbox)
718
691
                self.refresh()
719
 
            elif key == "v":
720
 
                if self.log_level == 0:
721
 
                    self.log_level = 1
722
 
                    self.log_message("Verbose mode: Off")
723
 
                else:
724
 
                    self.log_level = 0
725
 
                    self.log_message("Verbose mode: On")
726
692
            #elif (key == "end" or key == "meta >" or key == "G"
727
693
            #      or key == ">"):
728
694
            #    pass            # xxx end-of-buffer