/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-01-20 20:54:47 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20140120205447-z5fwrk7r2y9gkbfg
Documentation change to clarify support of --connect option.

* plugins.d/mandos.xml (OPTIONS): Clarify support of --connect option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
6
 
# Copyright © 2009-2015 Teddy Hogeborn
7
 
# Copyright © 2009-2015 Björn Påhlsson
 
6
# Copyright © 2009-2013 Teddy Hogeborn
 
7
# Copyright © 2009-2013 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
32
32
 
33
33
import sys
34
34
import os
 
35
import signal
35
36
 
36
37
import datetime
37
38
 
48
49
 
49
50
import locale
50
51
 
51
 
if sys.version_info.major == 2:
 
52
if sys.version_info[0] == 2:
52
53
    str = unicode
53
54
 
54
55
locale.setlocale(locale.LC_ALL, '')
60
61
domain = 'se.recompile'
61
62
server_interface = domain + '.Mandos'
62
63
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.9"
 
64
version = "1.6.2"
64
65
 
65
66
def isoformat_to_datetime(iso):
66
67
    "Parse an ISO 8601 date string to a datetime.datetime()"
87
88
        self.proxy = proxy_object # Mandos Client proxy object
88
89
        self.properties = dict() if properties is None else properties
89
90
        self.property_changed_match = (
90
 
            self.proxy.connect_to_signal("PropertiesChanged",
91
 
                                         self.properties_changed,
92
 
                                         dbus.PROPERTIES_IFACE,
 
91
            self.proxy.connect_to_signal("PropertyChanged",
 
92
                                         self._property_changed,
 
93
                                         client_interface,
93
94
                                         byte_arrays=True))
94
95
        
95
96
        if properties is None:
100
101
        
101
102
        super(MandosClientPropertyCache, self).__init__(**kwargs)
102
103
    
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.
 
104
    def _property_changed(self, property, value):
 
105
        """Helper which takes positional arguments"""
 
106
        return self.property_changed(property=property, value=value)
 
107
    
 
108
    def property_changed(self, property=None, value=None):
 
109
        """This is called whenever we get a PropertyChanged signal
 
110
        It updates the changed property in the "properties" dict.
106
111
        """
107
112
        # Update properties dict with new value
108
 
        self.properties.update(properties)
 
113
        self.properties[property] = value
109
114
    
110
115
    def delete(self):
111
116
        self.property_changed_match.remove()
157
162
                                         self.rejected,
158
163
                                         client_interface,
159
164
                                         byte_arrays=True))
160
 
        self.logger('Created client {}'
161
 
                    .format(self.properties["Name"]), level=0)
 
165
        #self.logger('Created client {0}'
 
166
        #            .format(self.properties["Name"]))
162
167
    
163
168
    def using_timer(self, flag):
164
169
        """Call this method with True or False when timer should be
173
178
            gobject.source_remove(self._update_timer_callback_tag)
174
179
            self._update_timer_callback_tag = None
175
180
    
176
 
    def checker_completed(self, exitstatus, signal, command):
 
181
    def checker_completed(self, exitstatus, condition, command):
177
182
        if exitstatus == 0:
178
 
            self.logger('Checker for client {} (command "{}")'
179
 
                        ' succeeded'.format(self.properties["Name"],
180
 
                                            command), level=0)
181
183
            self.update()
182
184
            return
183
185
        # Checker failed
184
 
        if exitstatus >= 0:
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
187
 
                        .format(self.properties["Name"], command,
188
 
                                exitstatus))
189
 
        elif signal != 0:
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
192
 
                        .format(self.properties["Name"], command,
193
 
                                signal))
 
186
        if os.WIFEXITED(condition):
 
187
            self.logger('Checker for client {0} (command "{1}")'
 
188
                        ' failed with exit code {2}'
 
189
                        .format(self.properties["Name"], command,
 
190
                                os.WEXITSTATUS(condition)))
 
191
        elif os.WIFSIGNALED(condition):
 
192
            self.logger('Checker for client {0} (command "{1}") was'
 
193
                        ' killed by signal {2}'
 
194
                        .format(self.properties["Name"], command,
 
195
                                os.WTERMSIG(condition)))
 
196
        elif os.WCOREDUMP(condition):
 
197
            self.logger('Checker for client {0} (command "{1}")'
 
198
                        ' dumped core'
 
199
                        .format(self.properties["Name"], command))
194
200
        else:
195
 
            self.logger('Checker for client {} completed'
 
201
            self.logger('Checker for client {0} completed'
196
202
                        ' mysteriously'
197
203
                        .format(self.properties["Name"]))
198
204
        self.update()
199
205
    
200
206
    def checker_started(self, command):
201
 
        """Server signals that a checker started."""
202
 
        self.logger('Client {} started checker "{}"'
203
 
                    .format(self.properties["Name"],
204
 
                            command), level=0)
 
207
        """Server signals that a checker started. This could be useful
 
208
           to log in the future. """
 
209
        #self.logger('Client {0} started checker "{1}"'
 
210
        #            .format(self.properties["Name"],
 
211
        #                    str(command)))
 
212
        pass
205
213
    
206
214
    def got_secret(self):
207
 
        self.logger('Client {} received its secret'
 
215
        self.logger('Client {0} received its secret'
208
216
                    .format(self.properties["Name"]))
209
217
    
210
218
    def need_approval(self, timeout, default):
211
219
        if not default:
212
 
            message = 'Client {} needs approval within {} seconds'
 
220
            message = 'Client {0} needs approval within {1} seconds'
213
221
        else:
214
 
            message = 'Client {} will get its secret in {} seconds'
 
222
            message = 'Client {0} will get its secret in {1} seconds'
215
223
        self.logger(message.format(self.properties["Name"],
216
224
                                   timeout/1000))
217
225
    
218
226
    def rejected(self, reason):
219
 
        self.logger('Client {} was rejected; reason: {}'
 
227
        self.logger('Client {0} was rejected; reason: {1}'
220
228
                    .format(self.properties["Name"], reason))
221
229
    
222
230
    def selectable(self):
266
274
            else:
267
275
                timer = datetime.timedelta()
268
276
            if self.properties["ApprovedByDefault"]:
269
 
                message = "Approval in {}. (d)eny?"
 
277
                message = "Approval in {0}. (d)eny?"
270
278
            else:
271
 
                message = "Denial in {}. (a)pprove?"
 
279
                message = "Denial in {0}. (a)pprove?"
272
280
            message = message.format(str(timer).rsplit(".", 1)[0])
273
281
            self.using_timer(True)
274
282
        elif self.properties["LastCheckerStatus"] != 0:
282
290
                timer = max(expires - datetime.datetime.utcnow(),
283
291
                            datetime.timedelta())
284
292
            message = ('A checker has failed! Time until client'
285
 
                       ' gets disabled: {}'
 
293
                       ' gets disabled: {0}'
286
294
                       .format(str(timer).rsplit(".", 1)[0]))
287
295
            self.using_timer(True)
288
296
        else:
289
297
            message = "enabled"
290
298
            self.using_timer(False)
291
 
        self._text = "{}{}".format(base, message)
 
299
        self._text = "{0}{1}".format(base, message)
292
300
        
293
301
        if not urwid.supports_unicode():
294
302
            self._text = self._text.encode("ascii", "replace")
369
377
        else:
370
378
            return key
371
379
    
372
 
    def properties_changed(self, interface, properties, invalidated):
373
 
        """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.
374
382
        This overrides the method from MandosClientPropertyCache"""
375
 
        old_values = { key: self.properties.get(key)
376
 
                       for key in properties.keys() }
377
 
        super(MandosClientWidget, self).properties_changed(
378
 
            interface, properties, invalidated)
379
 
        if any(old_values[key] != self.properties.get(key)
380
 
               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:
381
388
            self.update()
382
389
 
383
390
 
397
404
    """This is the entire user interface - the whole screen
398
405
    with boxes, lists of client widgets, etc.
399
406
    """
400
 
    def __init__(self, max_log_length=1000, log_level=1):
 
407
    def __init__(self, max_log_length=1000):
401
408
        DBusGMainLoop(set_as_default=True)
402
409
        
403
410
        self.screen = urwid.curses_display.Screen()
441
448
        self.log = []
442
449
        self.max_log_length = max_log_length
443
450
        
444
 
        self.log_level = log_level
445
 
        
446
451
        # We keep a reference to the log widget so we can remove it
447
452
        # from the ListWalker without it getting destroyed
448
453
        self.logbox = ConstrainedListBox(self.log)
462
467
        self.main_loop = gobject.MainLoop()
463
468
    
464
469
    def client_not_found(self, fingerprint, address):
465
 
        self.log_message("Client with address {} and fingerprint {}"
466
 
                         " could not be found"
 
470
        self.log_message("Client with address {0} and fingerprint"
 
471
                         " {1} could not be found"
467
472
                         .format(address, fingerprint))
468
473
    
469
474
    def rebuild(self):
482
487
            self.uilist.append(self.logbox)
483
488
        self.topwidget = urwid.Pile(self.uilist)
484
489
    
485
 
    def log_message(self, message, level=1):
 
490
    def log_message(self, message):
486
491
        """Log message formatted with timestamp"""
487
 
        if level < self.log_level:
488
 
            return
489
492
        timestamp = datetime.datetime.now().isoformat()
490
 
        self.log_message_raw("{}: {}".format(timestamp, message),
491
 
                             level=level)
 
493
        self.log_message_raw(timestamp + ": " + message)
492
494
    
493
 
    def log_message_raw(self, markup, level=1):
 
495
    def log_message_raw(self, markup):
494
496
        """Add a log message to the log buffer."""
495
 
        if level < self.log_level:
496
 
            return
497
497
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
498
        if (self.max_log_length
499
499
            and len(self.log) > self.max_log_length):
506
506
        """Toggle visibility of the log buffer."""
507
507
        self.log_visible = not self.log_visible
508
508
        self.rebuild()
509
 
        self.log_message("Log visibility changed to: {}"
510
 
                         .format(self.log_visible), level=0)
 
509
        #self.log_message("Log visibility changed to: "
 
510
        #                 + str(self.log_visible))
511
511
    
512
512
    def change_log_display(self):
513
513
        """Change type of log display.
518
518
            self.log_wrap = "clip"
519
519
        for textwidget in self.log:
520
520
            textwidget.set_wrap_mode(self.log_wrap)
521
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
522
 
                         level=0)
 
521
        #self.log_message("Wrap mode: " + self.log_wrap)
523
522
    
524
523
    def find_and_remove_client(self, path, name):
525
524
        """Find a client by its object path and remove it.
530
529
            client = self.clients_dict[path]
531
530
        except KeyError:
532
531
            # not found?
533
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
532
            self.log_message("Unknown client {0!r} ({1!r}) removed"
534
533
                             .format(name, path))
535
534
            return
536
535
        client.delete()
654
653
            elif key == "window resize":
655
654
                self.size = self.screen.get_cols_rows()
656
655
                self.refresh()
657
 
            elif key == "ctrl l":
658
 
                self.screen.clear()
 
656
            elif key == "\f":  # Ctrl-L
659
657
                self.refresh()
660
658
            elif key == "l" or key == "D":
661
659
                self.toggle_log_display()
673
671
                                            "?: Help",
674
672
                                            "l: Log window toggle",
675
673
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log lines)",
677
 
                                            "v: Toggle verbose log",
678
 
                                            ))))
 
674
                                            "w: Wrap (log)"))))
679
675
                self.log_message_raw(("bold",
680
676
                                      "  "
681
677
                                      .join(("Clients:",
694
690
                else:
695
691
                    self.topwidget.set_focus(self.logbox)
696
692
                self.refresh()
697
 
            elif key == "v":
698
 
                if self.log_level == 0:
699
 
                    self.log_level = 1
700
 
                    self.log_message("Verbose mode: Off")
701
 
                else:
702
 
                    self.log_level = 0
703
 
                    self.log_message("Verbose mode: On")
704
693
            #elif (key == "end" or key == "meta >" or key == "G"
705
694
            #      or key == ">"):
706
695
            #    pass            # xxx end-of-buffer