/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-07-12 01:57:54 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150712015754-1lq7u2ejo7fdyfvi
* debian/mandos.prerm: Don't run init script, use only invoke-rc.d.

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