/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-03-05 21:47:03 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140305214703-c5ulnh1c9i51yzl9
* Makefile (WARN): Re-add "-Wunreachable-code".
  (.PHONY): Update; add "mostlyclean", "maintainer-clean",
            "install-html", and "install-client-nokey".

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.2"
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
134
        
135
135
        # The widget shown normally
136
136
        self._text_widget = urwid.Text("")
137
137
        # The widget shown when we have focus
138
138
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(
140
 
            update_hook=update_hook, delete_hook=delete_hook,
141
 
            *args, **kwargs)
 
139
        super(MandosClientWidget, self).__init__(**kwargs)
142
140
        self.update()
143
141
        self.opened = False
144
142
        
145
 
        last_checked_ok = isoformat_to_datetime(self.properties
146
 
                                                ["LastCheckedOK"])
147
 
        
148
 
        if self.properties ["LastCheckerStatus"] != 0:
149
 
            self.using_timer(True)
150
 
        
151
 
        if self.need_approval:
152
 
            self.using_timer(True)
153
 
        
154
143
        self.match_objects = (
155
144
            self.proxy.connect_to_signal("CheckerCompleted",
156
145
                                         self.checker_completed,
172
161
                                         self.rejected,
173
162
                                         client_interface,
174
163
                                         byte_arrays=True))
175
 
        #self.logger('Created client %s' % (self.properties["Name"]))
176
 
    
177
 
    def property_changed(self, property=None, value=None):
178
 
        super(self, MandosClientWidget).property_changed(property,
179
 
                                                         value)
180
 
        if property == "ApprovalPending":
181
 
            using_timer(bool(value))
182
 
        if property == "LastCheckerStatus":
183
 
            using_timer(value != 0)
184
 
            #self.logger('Checker for client %s (command "%s")'
185
 
            #            ' was successful'
186
 
            #            % (self.properties["Name"], command))
 
164
        #self.logger('Created client {0}'
 
165
        #            .format(self.properties["Name"]))
187
166
    
188
167
    def using_timer(self, flag):
189
168
        """Call this method with True or False when timer should be
190
169
        activated or deactivated.
191
170
        """
192
 
        old = self._update_timer_callback_lock
193
 
        if flag:
194
 
            self._update_timer_callback_lock += 1
195
 
        else:
196
 
            self._update_timer_callback_lock -= 1
197
 
        if old == 0 and self._update_timer_callback_lock:
 
171
        if flag and self._update_timer_callback_tag is None:
198
172
            # Will update the shown timer value every second
199
173
            self._update_timer_callback_tag = (gobject.timeout_add
200
174
                                               (1000,
201
175
                                                self.update_timer))
202
 
        elif old and self._update_timer_callback_lock == 0:
 
176
        elif not (flag or self._update_timer_callback_tag is None):
203
177
            gobject.source_remove(self._update_timer_callback_tag)
204
178
            self._update_timer_callback_tag = None
205
179
    
209
183
            return
210
184
        # Checker failed
211
185
        if os.WIFEXITED(condition):
212
 
            self.logger('Checker for client %s (command "%s")'
213
 
                        ' failed with exit code %s'
214
 
                        % (self.properties["Name"], command,
215
 
                           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)))
216
190
        elif os.WIFSIGNALED(condition):
217
 
            self.logger('Checker for client %s (command "%s")'
218
 
                        ' was killed by signal %s'
219
 
                        % (self.properties["Name"], command,
220
 
                           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)))
221
195
        elif os.WCOREDUMP(condition):
222
 
            self.logger('Checker for client %s (command "%s")'
 
196
            self.logger('Checker for client {0} (command "{1}")'
223
197
                        ' dumped core'
224
 
                        % (self.properties["Name"], command))
 
198
                        .format(self.properties["Name"], command))
225
199
        else:
226
 
            self.logger('Checker for client %s completed'
227
 
                        ' mysteriously')
 
200
            self.logger('Checker for client {0} completed'
 
201
                        ' mysteriously'
 
202
                        .format(self.properties["Name"]))
228
203
        self.update()
229
204
    
230
205
    def checker_started(self, command):
231
206
        """Server signals that a checker started. This could be useful
232
207
           to log in the future. """
233
 
        #self.logger('Client %s started checker "%s"'
234
 
        #            % (self.properties["Name"], unicode(command)))
 
208
        #self.logger('Client {0} started checker "{1}"'
 
209
        #            .format(self.properties["Name"],
 
210
        #                    str(command)))
235
211
        pass
236
212
    
237
213
    def got_secret(self):
238
 
        self.logger('Client %s received its secret'
239
 
                    % self.properties["Name"])
 
214
        self.logger('Client {0} received its secret'
 
215
                    .format(self.properties["Name"]))
240
216
    
241
217
    def need_approval(self, timeout, default):
242
218
        if not default:
243
 
            message = 'Client %s needs approval within %s seconds'
 
219
            message = 'Client {0} needs approval within {1} seconds'
244
220
        else:
245
 
            message = 'Client %s will get its secret in %s seconds'
246
 
        self.logger(message
247
 
                    % (self.properties["Name"], timeout/1000))
248
 
        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))
249
224
    
250
225
    def rejected(self, reason):
251
 
        self.logger('Client %s was rejected; reason: %s'
252
 
                    % (self.properties["Name"], reason))
 
226
        self.logger('Client {0} was rejected; reason: {1}'
 
227
                    .format(self.properties["Name"], reason))
253
228
    
254
229
    def selectable(self):
255
230
        """Make this a "selectable" widget.
277
252
                          "bold-underline-blink":
278
253
                              "bold-underline-blink-standout",
279
254
                          }
280
 
 
 
255
        
281
256
        # Rebuild focus and non-focus widgets using current properties
282
 
 
 
257
        
283
258
        # Base part of a client. Name!
284
 
        base = ('%(name)s: '
285
 
                      % {"name": self.properties["Name"]})
 
259
        base = '{name}: '.format(name=self.properties["Name"])
286
260
        if not self.properties["Enabled"]:
287
261
            message = "DISABLED"
 
262
            self.using_timer(False)
288
263
        elif self.properties["ApprovalPending"]:
289
264
            timeout = datetime.timedelta(milliseconds
290
265
                                         = self.properties
292
267
            last_approval_request = isoformat_to_datetime(
293
268
                self.properties["LastApprovalRequest"])
294
269
            if last_approval_request is not None:
295
 
                timer = timeout - (datetime.datetime.utcnow()
296
 
                                   - last_approval_request)
 
270
                timer = max(timeout - (datetime.datetime.utcnow()
 
271
                                       - last_approval_request),
 
272
                            datetime.timedelta())
297
273
            else:
298
274
                timer = datetime.timedelta()
299
275
            if self.properties["ApprovedByDefault"]:
300
 
                message = "Approval in %s. (d)eny?"
 
276
                message = "Approval in {0}. (d)eny?"
301
277
            else:
302
 
                message = "Denial in %s. (a)pprove?"
303
 
            message = message % unicode(timer).rsplit(".", 1)[0]
 
278
                message = "Denial in {0}. (a)pprove?"
 
279
            message = message.format(str(timer).rsplit(".", 1)[0])
 
280
            self.using_timer(True)
304
281
        elif self.properties["LastCheckerStatus"] != 0:
305
 
            # When checker has failed, print a timer until client expires
 
282
            # When checker has failed, show timer until client expires
306
283
            expires = self.properties["Expires"]
307
284
            if expires == "":
308
285
                timer = datetime.timedelta(0)
309
286
            else:
310
 
                expires = datetime.datetime.strptime(expires,
311
 
                                                     '%Y-%m-%dT%H:%M:%S.%f')
312
 
                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())
313
291
            message = ('A checker has failed! Time until client'
314
 
                       ' gets disabled: %s'
315
 
                           % unicode(timer).rsplit(".", 1)[0])
 
292
                       ' gets disabled: {0}'
 
293
                       .format(str(timer).rsplit(".", 1)[0]))
 
294
            self.using_timer(True)
316
295
        else:
317
296
            message = "enabled"
318
 
        self._text = "%s%s" % (base, message)
319
 
            
 
297
            self.using_timer(False)
 
298
        self._text = "{0}{1}".format(base, message)
 
299
        
320
300
        if not urwid.supports_unicode():
321
301
            self._text = self._text.encode("ascii", "replace")
322
302
        textlist = [("normal", self._text)]
339
319
        self.update()
340
320
        return True             # Keep calling this
341
321
    
342
 
    def delete(self, *args, **kwargs):
 
322
    def delete(self, **kwargs):
343
323
        if self._update_timer_callback_tag is not None:
344
324
            gobject.source_remove(self._update_timer_callback_tag)
345
325
            self._update_timer_callback_tag = None
348
328
        self.match_objects = ()
349
329
        if self.delete_hook is not None:
350
330
            self.delete_hook(self)
351
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
331
        return super(MandosClientWidget, self).delete(**kwargs)
352
332
    
353
333
    def render(self, maxcolrow, focus=False):
354
334
        """Render differently if we have focus.
396
376
        else:
397
377
            return key
398
378
    
399
 
    def property_changed(self, property=None, value=None,
400
 
                         *args, **kwargs):
 
379
    def property_changed(self, property=None, **kwargs):
401
380
        """Call self.update() if old value is not new value.
402
381
        This overrides the method from MandosClientPropertyCache"""
403
 
        property_name = unicode(property)
 
382
        property_name = str(property)
404
383
        old_value = self.properties.get(property_name)
405
384
        super(MandosClientWidget, self).property_changed(
406
 
            property=property, value=value, *args, **kwargs)
 
385
            property=property, **kwargs)
407
386
        if self.properties.get(property_name) != old_value:
408
387
            self.update()
409
388
 
413
392
    "down" key presses, thus not allowing any containing widgets to
414
393
    use them as an excuse to shift focus away from this widget.
415
394
    """
416
 
    def keypress(self, maxcolrow, key):
417
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
395
    def keypress(self, *args, **kwargs):
 
396
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
418
397
        if ret in ("up", "down"):
419
398
            return
420
399
        return ret
433
412
                ("normal",
434
413
                 "default", "default", None),
435
414
                ("bold",
436
 
                 "default", "default", "bold"),
 
415
                 "bold", "default", "bold"),
437
416
                ("underline-blink",
438
 
                 "default", "default", "underline"),
 
417
                 "underline,blink", "default", "underline,blink"),
439
418
                ("standout",
440
 
                 "default", "default", "standout"),
 
419
                 "standout", "default", "standout"),
441
420
                ("bold-underline-blink",
442
 
                 "default", "default", ("bold", "underline")),
 
421
                 "bold,underline,blink", "default", "bold,underline,blink"),
443
422
                ("bold-standout",
444
 
                 "default", "default", ("bold", "standout")),
 
423
                 "bold,standout", "default", "bold,standout"),
445
424
                ("underline-blink-standout",
446
 
                 "default", "default", ("underline", "standout")),
 
425
                 "underline,blink,standout", "default",
 
426
                 "underline,blink,standout"),
447
427
                ("bold-underline-blink-standout",
448
 
                 "default", "default", ("bold", "underline",
449
 
                                          "standout")),
 
428
                 "bold,underline,blink,standout", "default",
 
429
                 "bold,underline,blink,standout"),
450
430
                ))
451
431
        
452
432
        if urwid.supports_unicode():
486
466
        self.main_loop = gobject.MainLoop()
487
467
    
488
468
    def client_not_found(self, fingerprint, address):
489
 
        self.log_message(("Client with address %s and fingerprint %s"
490
 
                          " could not be found" % (address,
491
 
                                                    fingerprint)))
 
469
        self.log_message("Client with address {0} and fingerprint"
 
470
                         " {1} could not be found"
 
471
                         .format(address, fingerprint))
492
472
    
493
473
    def rebuild(self):
494
474
        """This rebuilds the User Interface.
507
487
        self.topwidget = urwid.Pile(self.uilist)
508
488
    
509
489
    def log_message(self, message):
 
490
        """Log message formatted with timestamp"""
510
491
        timestamp = datetime.datetime.now().isoformat()
511
492
        self.log_message_raw(timestamp + ": " + message)
512
493
    
525
506
        self.log_visible = not self.log_visible
526
507
        self.rebuild()
527
508
        #self.log_message("Log visibility changed to: "
528
 
        #                 + unicode(self.log_visible))
 
509
        #                 + str(self.log_visible))
529
510
    
530
511
    def change_log_display(self):
531
512
        """Change type of log display.
547
528
            client = self.clients_dict[path]
548
529
        except KeyError:
549
530
            # not found?
550
 
            self.log_message("Unknown client %r (%r) removed", name,
551
 
                             path)
 
531
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
532
                             .format(name, path))
552
533
            return
553
534
        client.delete()
554
535
    
571
552
        if path is None:
572
553
            path = client.proxy.object_path
573
554
        self.clients_dict[path] = client
574
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
555
        self.clients.sort(key=lambda c: c.properties["Name"])
575
556
        self.refresh()
576
557
    
577
558
    def remove_client(self, client, path=None):
579
560
        if path is None:
580
561
            path = client.proxy.object_path
581
562
        del self.clients_dict[path]
582
 
        if not self.clients_dict:
583
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
584
 
            # is completely emptied, we need to recreate it.
585
 
            self.clients = urwid.SimpleListWalker([])
586
 
            self.rebuild()
587
563
        self.refresh()
588
564
    
589
565
    def refresh(self):
602
578
        try:
603
579
            mandos_clients = (self.mandos_serv
604
580
                              .GetAllClientsWithProperties())
 
581
            if not mandos_clients:
 
582
                self.log_message_raw(("bold", "Note: Server has no clients."))
605
583
        except dbus.exceptions.DBusException:
 
584
            self.log_message_raw(("bold", "Note: No Mandos server running."))
606
585
            mandos_clients = dbus.Dictionary()
607
586
        
608
587
        (self.mandos_serv
620
599
                            self.client_not_found,
621
600
                            dbus_interface=server_interface,
622
601
                            byte_arrays=True))
623
 
        for path, client in mandos_clients.iteritems():
 
602
        for path, client in mandos_clients.items():
624
603
            client_proxy_object = self.bus.get_object(self.busname,
625
604
                                                      path)
626
605
            self.add_client(MandosClientWidget(server_proxy_object
635
614
                                               logger
636
615
                                               =self.log_message),
637
616
                            path=path)
638
 
 
 
617
        
639
618
        self.refresh()
640
619
        self._input_callback_tag = (gobject.io_add_watch
641
620
                                    (sys.stdin.fileno(),
738
717
    ui.run()
739
718
except KeyboardInterrupt:
740
719
    ui.screen.stop()
741
 
except Exception, e:
742
 
    ui.log_message(unicode(e))
 
720
except Exception as e:
 
721
    ui.log_message(str(e))
743
722
    ui.screen.stop()
744
723
    raise