/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-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
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
27
32
 
28
33
import sys
29
34
import os
30
 
import signal
31
35
 
32
36
import datetime
33
37
 
35
39
import urwid
36
40
 
37
41
from dbus.mainloop.glib import DBusGMainLoop
38
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
39
46
 
40
47
import dbus
41
48
 
42
 
import UserList
43
 
 
44
49
import locale
45
50
 
 
51
if sys.version_info[0] == 2:
 
52
    str = unicode
 
53
 
46
54
locale.setlocale(locale.LC_ALL, '')
47
55
 
48
56
import logging
52
60
domain = 'se.recompile'
53
61
server_interface = domain + '.Mandos'
54
62
client_interface = domain + '.Mandos.Client'
55
 
version = "1.5.0"
56
 
 
57
 
# Always run in monochrome mode
58
 
urwid.curses_display.curses.has_colors = lambda : False
59
 
 
60
 
# Urwid doesn't support blinking, but we want it.  Since we have no
61
 
# use for underline on its own, we make underline also always blink.
62
 
urwid.curses_display.curses.A_UNDERLINE |= (
63
 
    urwid.curses_display.curses.A_BLINK)
 
63
version = "1.6.4"
64
64
 
65
65
def isoformat_to_datetime(iso):
66
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
83
83
    properties and calls a hook function when any of them are
84
84
    changed.
85
85
    """
86
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
87
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
88
        self.properties = dict() if properties is None else properties
90
89
        self.property_changed_match = (
91
90
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
91
                                         self._property_changed,
93
92
                                         client_interface,
94
93
                                         byte_arrays=True))
95
94
        
96
 
        self.properties.update(
97
 
            self.proxy.GetAll(client_interface,
98
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
99
 
 
100
 
        #XXX This breaks good super behaviour
101
 
#        super(MandosClientPropertyCache, self).__init__(
102
 
#            *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)
 
102
    
 
103
    def _property_changed(self, property, value):
 
104
        """Helper which takes positional arguments"""
 
105
        return self.property_changed(property=property, value=value)
103
106
    
104
107
    def property_changed(self, property=None, value=None):
105
108
        """This is called whenever we get a PropertyChanged signal
108
111
        # Update properties dict with new value
109
112
        self.properties[property] = value
110
113
    
111
 
    def delete(self, *args, **kwargs):
 
114
    def delete(self):
112
115
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
116
 
116
117
 
117
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
120
    """
120
121
    
121
122
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
123
                 delete_hook=None, logger=None, **kwargs):
123
124
        # Called on update
124
125
        self.update_hook = update_hook
125
126
        # Called on delete
130
131
        self.logger = logger
131
132
        
132
133
        self._update_timer_callback_tag = None
133
 
        self._update_timer_callback_lock = 0
134
 
        self.last_checker_failed = False
135
134
        
136
135
        # The widget shown normally
137
136
        self._text_widget = urwid.Text("")
138
137
        # The widget shown when we have focus
139
138
        self._focus_text_widget = urwid.Text("")
140
 
        super(MandosClientWidget, self).__init__(
141
 
            update_hook=update_hook, delete_hook=delete_hook,
142
 
            *args, **kwargs)
 
139
        super(MandosClientWidget, self).__init__(**kwargs)
143
140
        self.update()
144
141
        self.opened = False
145
142
        
146
 
        last_checked_ok = isoformat_to_datetime(self.properties
147
 
                                                ["LastCheckedOK"])
148
 
        if last_checked_ok is None:
149
 
            self.last_checker_failed = True
150
 
        else:
151
 
            self.last_checker_failed = ((datetime.datetime.utcnow()
152
 
                                         - last_checked_ok)
153
 
                                        > datetime.timedelta
154
 
                                        (milliseconds=
155
 
                                         self.properties
156
 
                                         ["Interval"]))
157
 
        
158
 
        if self.last_checker_failed:
159
 
            self.using_timer(True)
160
 
        
161
 
        if self.need_approval:
162
 
            self.using_timer(True)
163
 
        
164
143
        self.match_objects = (
165
144
            self.proxy.connect_to_signal("CheckerCompleted",
166
145
                                         self.checker_completed,
182
161
                                         self.rejected,
183
162
                                         client_interface,
184
163
                                         byte_arrays=True))
185
 
        #self.logger('Created client %s' % (self.properties["Name"]))
 
164
        #self.logger('Created client {0}'
 
165
        #            .format(self.properties["Name"]))
186
166
    
187
 
    def property_changed(self, property=None, value=None):
188
 
        super(self, MandosClientWidget).property_changed(property,
189
 
                                                         value)
190
 
        if property == "ApprovalPending":
191
 
            using_timer(bool(value))
192
 
        
193
167
    def using_timer(self, flag):
194
168
        """Call this method with True or False when timer should be
195
169
        activated or deactivated.
196
170
        """
197
 
        old = self._update_timer_callback_lock
198
 
        if flag:
199
 
            self._update_timer_callback_lock += 1
200
 
        else:
201
 
            self._update_timer_callback_lock -= 1
202
 
        if old == 0 and self._update_timer_callback_lock:
 
171
        if flag and self._update_timer_callback_tag is None:
203
172
            # Will update the shown timer value every second
204
173
            self._update_timer_callback_tag = (gobject.timeout_add
205
174
                                               (1000,
206
175
                                                self.update_timer))
207
 
        elif old and self._update_timer_callback_lock == 0:
 
176
        elif not (flag or self._update_timer_callback_tag is None):
208
177
            gobject.source_remove(self._update_timer_callback_tag)
209
178
            self._update_timer_callback_tag = None
210
179
    
211
180
    def checker_completed(self, exitstatus, condition, command):
212
181
        if exitstatus == 0:
213
 
            if self.last_checker_failed:
214
 
                self.last_checker_failed = False
215
 
                self.using_timer(False)
216
 
            #self.logger('Checker for client %s (command "%s")'
217
 
            #            ' was successful'
218
 
            #            % (self.properties["Name"], command))
219
182
            self.update()
220
183
            return
221
184
        # Checker failed
222
 
        if not self.last_checker_failed:
223
 
            self.last_checker_failed = True
224
 
            self.using_timer(True)
225
185
        if os.WIFEXITED(condition):
226
 
            self.logger('Checker for client %s (command "%s")'
227
 
                        ' failed with exit code %s'
228
 
                        % (self.properties["Name"], command,
229
 
                           os.WEXITSTATUS(condition)))
 
186
            self.logger('Checker for client {0} (command "{1}")'
 
187
                        ' failed with exit code {2}'
 
188
                        .format(self.properties["Name"], command,
 
189
                                os.WEXITSTATUS(condition)))
230
190
        elif os.WIFSIGNALED(condition):
231
 
            self.logger('Checker for client %s (command "%s")'
232
 
                        ' was killed by signal %s'
233
 
                        % (self.properties["Name"], command,
234
 
                           os.WTERMSIG(condition)))
 
191
            self.logger('Checker for client {0} (command "{1}") was'
 
192
                        ' killed by signal {2}'
 
193
                        .format(self.properties["Name"], command,
 
194
                                os.WTERMSIG(condition)))
235
195
        elif os.WCOREDUMP(condition):
236
 
            self.logger('Checker for client %s (command "%s")'
 
196
            self.logger('Checker for client {0} (command "{1}")'
237
197
                        ' dumped core'
238
 
                        % (self.properties["Name"], command))
 
198
                        .format(self.properties["Name"], command))
239
199
        else:
240
 
            self.logger('Checker for client %s completed'
241
 
                        ' mysteriously')
 
200
            self.logger('Checker for client {0} completed'
 
201
                        ' mysteriously'
 
202
                        .format(self.properties["Name"]))
242
203
        self.update()
243
204
    
244
205
    def checker_started(self, command):
245
206
        """Server signals that a checker started. This could be useful
246
207
           to log in the future. """
247
 
        #self.logger('Client %s started checker "%s"'
248
 
        #            % (self.properties["Name"], unicode(command)))
 
208
        #self.logger('Client {0} started checker "{1}"'
 
209
        #            .format(self.properties["Name"],
 
210
        #                    str(command)))
249
211
        pass
250
212
    
251
213
    def got_secret(self):
252
 
        self.last_checker_failed = False
253
 
        self.logger('Client %s received its secret'
254
 
                    % self.properties["Name"])
 
214
        self.logger('Client {0} received its secret'
 
215
                    .format(self.properties["Name"]))
255
216
    
256
217
    def need_approval(self, timeout, default):
257
218
        if not default:
258
 
            message = 'Client %s needs approval within %s seconds'
 
219
            message = 'Client {0} needs approval within {1} seconds'
259
220
        else:
260
 
            message = 'Client %s will get its secret in %s seconds'
261
 
        self.logger(message
262
 
                    % (self.properties["Name"], timeout/1000))
263
 
        self.using_timer(True)
 
221
            message = 'Client {0} will get its secret in {1} seconds'
 
222
        self.logger(message.format(self.properties["Name"],
 
223
                                   timeout/1000))
264
224
    
265
225
    def rejected(self, reason):
266
 
        self.logger('Client %s was rejected; reason: %s'
267
 
                    % (self.properties["Name"], reason))
 
226
        self.logger('Client {0} was rejected; reason: {1}'
 
227
                    .format(self.properties["Name"], reason))
268
228
    
269
229
    def selectable(self):
270
230
        """Make this a "selectable" widget.
292
252
                          "bold-underline-blink":
293
253
                              "bold-underline-blink-standout",
294
254
                          }
295
 
 
 
255
        
296
256
        # Rebuild focus and non-focus widgets using current properties
297
 
 
 
257
        
298
258
        # Base part of a client. Name!
299
 
        base = ('%(name)s: '
300
 
                      % {"name": self.properties["Name"]})
 
259
        base = '{name}: '.format(name=self.properties["Name"])
301
260
        if not self.properties["Enabled"]:
302
261
            message = "DISABLED"
 
262
            self.using_timer(False)
303
263
        elif self.properties["ApprovalPending"]:
304
264
            timeout = datetime.timedelta(milliseconds
305
265
                                         = self.properties
307
267
            last_approval_request = isoformat_to_datetime(
308
268
                self.properties["LastApprovalRequest"])
309
269
            if last_approval_request is not None:
310
 
                timer = timeout - (datetime.datetime.utcnow()
311
 
                                   - last_approval_request)
 
270
                timer = max(timeout - (datetime.datetime.utcnow()
 
271
                                       - last_approval_request),
 
272
                            datetime.timedelta())
312
273
            else:
313
274
                timer = datetime.timedelta()
314
275
            if self.properties["ApprovedByDefault"]:
315
 
                message = "Approval in %s. (d)eny?"
 
276
                message = "Approval in {0}. (d)eny?"
316
277
            else:
317
 
                message = "Denial in %s. (a)pprove?"
318
 
            message = message % unicode(timer).rsplit(".", 1)[0]
319
 
        elif self.last_checker_failed:
320
 
            # When checker has failed, print a timer until client expires
 
278
                message = "Denial in {0}. (a)pprove?"
 
279
            message = message.format(str(timer).rsplit(".", 1)[0])
 
280
            self.using_timer(True)
 
281
        elif self.properties["LastCheckerStatus"] != 0:
 
282
            # When checker has failed, show timer until client expires
321
283
            expires = self.properties["Expires"]
322
284
            if expires == "":
323
285
                timer = datetime.timedelta(0)
324
286
            else:
325
 
                expires = datetime.datetime.strptime(expires,
326
 
                                                     '%Y-%m-%dT%H:%M:%S.%f')
327
 
                timer = expires - datetime.datetime.utcnow()
 
287
                expires = (datetime.datetime.strptime
 
288
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
289
                timer = max(expires - datetime.datetime.utcnow(),
 
290
                            datetime.timedelta())
328
291
            message = ('A checker has failed! Time until client'
329
 
                       ' gets disabled: %s'
330
 
                           % unicode(timer).rsplit(".", 1)[0])
 
292
                       ' gets disabled: {0}'
 
293
                       .format(str(timer).rsplit(".", 1)[0]))
 
294
            self.using_timer(True)
331
295
        else:
332
296
            message = "enabled"
333
 
        self._text = "%s%s" % (base, message)
334
 
            
 
297
            self.using_timer(False)
 
298
        self._text = "{0}{1}".format(base, message)
 
299
        
335
300
        if not urwid.supports_unicode():
336
301
            self._text = self._text.encode("ascii", "replace")
337
302
        textlist = [("normal", self._text)]
354
319
        self.update()
355
320
        return True             # Keep calling this
356
321
    
357
 
    def delete(self, *args, **kwargs):
 
322
    def delete(self, **kwargs):
358
323
        if self._update_timer_callback_tag is not None:
359
324
            gobject.source_remove(self._update_timer_callback_tag)
360
325
            self._update_timer_callback_tag = None
363
328
        self.match_objects = ()
364
329
        if self.delete_hook is not None:
365
330
            self.delete_hook(self)
366
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
331
        return super(MandosClientWidget, self).delete(**kwargs)
367
332
    
368
333
    def render(self, maxcolrow, focus=False):
369
334
        """Render differently if we have focus.
411
376
        else:
412
377
            return key
413
378
    
414
 
    def property_changed(self, property=None, value=None,
415
 
                         *args, **kwargs):
 
379
    def property_changed(self, property=None, **kwargs):
416
380
        """Call self.update() if old value is not new value.
417
381
        This overrides the method from MandosClientPropertyCache"""
418
 
        property_name = unicode(property)
 
382
        property_name = str(property)
419
383
        old_value = self.properties.get(property_name)
420
384
        super(MandosClientWidget, self).property_changed(
421
 
            property=property, value=value, *args, **kwargs)
 
385
            property=property, **kwargs)
422
386
        if self.properties.get(property_name) != old_value:
423
387
            self.update()
424
388
 
428
392
    "down" key presses, thus not allowing any containing widgets to
429
393
    use them as an excuse to shift focus away from this widget.
430
394
    """
431
 
    def keypress(self, maxcolrow, key):
432
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
395
    def keypress(self, *args, **kwargs):
 
396
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
433
397
        if ret in ("up", "down"):
434
398
            return
435
399
        return ret
448
412
                ("normal",
449
413
                 "default", "default", None),
450
414
                ("bold",
451
 
                 "default", "default", "bold"),
 
415
                 "bold", "default", "bold"),
452
416
                ("underline-blink",
453
 
                 "default", "default", "underline"),
 
417
                 "underline,blink", "default", "underline,blink"),
454
418
                ("standout",
455
 
                 "default", "default", "standout"),
 
419
                 "standout", "default", "standout"),
456
420
                ("bold-underline-blink",
457
 
                 "default", "default", ("bold", "underline")),
 
421
                 "bold,underline,blink", "default", "bold,underline,blink"),
458
422
                ("bold-standout",
459
 
                 "default", "default", ("bold", "standout")),
 
423
                 "bold,standout", "default", "bold,standout"),
460
424
                ("underline-blink-standout",
461
 
                 "default", "default", ("underline", "standout")),
 
425
                 "underline,blink,standout", "default",
 
426
                 "underline,blink,standout"),
462
427
                ("bold-underline-blink-standout",
463
 
                 "default", "default", ("bold", "underline",
464
 
                                          "standout")),
 
428
                 "bold,underline,blink,standout", "default",
 
429
                 "bold,underline,blink,standout"),
465
430
                ))
466
431
        
467
432
        if urwid.supports_unicode():
501
466
        self.main_loop = gobject.MainLoop()
502
467
    
503
468
    def client_not_found(self, fingerprint, address):
504
 
        self.log_message(("Client with address %s and fingerprint %s"
505
 
                          " could not be found" % (address,
506
 
                                                    fingerprint)))
 
469
        self.log_message("Client with address {0} and fingerprint"
 
470
                         " {1} could not be found"
 
471
                         .format(address, fingerprint))
507
472
    
508
473
    def rebuild(self):
509
474
        """This rebuilds the User Interface.
522
487
        self.topwidget = urwid.Pile(self.uilist)
523
488
    
524
489
    def log_message(self, message):
 
490
        """Log message formatted with timestamp"""
525
491
        timestamp = datetime.datetime.now().isoformat()
526
492
        self.log_message_raw(timestamp + ": " + message)
527
493
    
540
506
        self.log_visible = not self.log_visible
541
507
        self.rebuild()
542
508
        #self.log_message("Log visibility changed to: "
543
 
        #                 + unicode(self.log_visible))
 
509
        #                 + str(self.log_visible))
544
510
    
545
511
    def change_log_display(self):
546
512
        """Change type of log display.
562
528
            client = self.clients_dict[path]
563
529
        except KeyError:
564
530
            # not found?
565
 
            self.log_message("Unknown client %r (%r) removed", name,
566
 
                             path)
 
531
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
532
                             .format(name, path))
567
533
            return
568
534
        client.delete()
569
535
    
586
552
        if path is None:
587
553
            path = client.proxy.object_path
588
554
        self.clients_dict[path] = client
589
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
555
        self.clients.sort(key=lambda c: c.properties["Name"])
590
556
        self.refresh()
591
557
    
592
558
    def remove_client(self, client, path=None):
594
560
        if path is None:
595
561
            path = client.proxy.object_path
596
562
        del self.clients_dict[path]
597
 
        if not self.clients_dict:
598
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
599
 
            # is completely emptied, we need to recreate it.
600
 
            self.clients = urwid.SimpleListWalker([])
601
 
            self.rebuild()
602
563
        self.refresh()
603
564
    
604
565
    def refresh(self):
617
578
        try:
618
579
            mandos_clients = (self.mandos_serv
619
580
                              .GetAllClientsWithProperties())
 
581
            if not mandos_clients:
 
582
                self.log_message_raw(("bold", "Note: Server has no clients."))
620
583
        except dbus.exceptions.DBusException:
 
584
            self.log_message_raw(("bold", "Note: No Mandos server running."))
621
585
            mandos_clients = dbus.Dictionary()
622
586
        
623
587
        (self.mandos_serv
635
599
                            self.client_not_found,
636
600
                            dbus_interface=server_interface,
637
601
                            byte_arrays=True))
638
 
        for path, client in mandos_clients.iteritems():
 
602
        for path, client in mandos_clients.items():
639
603
            client_proxy_object = self.bus.get_object(self.busname,
640
604
                                                      path)
641
605
            self.add_client(MandosClientWidget(server_proxy_object
650
614
                                               logger
651
615
                                               =self.log_message),
652
616
                            path=path)
653
 
 
 
617
        
654
618
        self.refresh()
655
619
        self._input_callback_tag = (gobject.io_add_watch
656
620
                                    (sys.stdin.fileno(),
753
717
    ui.run()
754
718
except KeyboardInterrupt:
755
719
    ui.screen.stop()
756
 
except Exception, e:
757
 
    ui.log_message(unicode(e))
 
720
except Exception as e:
 
721
    ui.log_message(str(e))
758
722
    ui.screen.stop()
759
723
    raise