/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 at bsnet
  • Date: 2010-10-05 19:32:45 UTC
  • mfrom: (237.4.8 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20101005193245-2ku2c6a9ht4bfv43
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
5
# 
 
6
# Copyright © 2009,2010 Teddy Hogeborn
 
7
# Copyright © 2009,2010 Björn Påhlsson
 
8
# 
 
9
# This program is free software: you can redistribute it and/or modify
 
10
# it under the terms of the GNU General Public License as published by
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
# 
 
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/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# 
3
24
 
4
25
from __future__ import division, absolute_import, with_statement
5
26
 
6
27
import sys
 
28
import os
7
29
import signal
8
30
 
 
31
import datetime
 
32
 
9
33
import urwid.curses_display
10
34
import urwid
11
35
 
16
40
 
17
41
import UserList
18
42
 
 
43
import locale
 
44
 
 
45
locale.setlocale(locale.LC_ALL, u'')
 
46
 
 
47
import logging
 
48
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
49
 
19
50
# Some useful constants
20
51
domain = 'se.bsnet.fukt'
21
52
server_interface = domain + '.Mandos'
22
53
client_interface = domain + '.Mandos.Client'
23
 
version = "1.0.14"
 
54
version = "1.2.1"
24
55
 
25
56
# Always run in monochrome mode
26
57
urwid.curses_display.curses.has_colors = lambda : False
30
61
urwid.curses_display.curses.A_UNDERLINE |= (
31
62
    urwid.curses_display.curses.A_BLINK)
32
63
 
 
64
def isoformat_to_datetime(iso):
 
65
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
66
    if not iso:
 
67
        return None
 
68
    d, t = iso.split(u"T", 1)
 
69
    year, month, day = d.split(u"-", 2)
 
70
    hour, minute, second = t.split(u":", 2)
 
71
    second, fraction = divmod(float(second), 1)
 
72
    return datetime.datetime(int(year),
 
73
                             int(month),
 
74
                             int(day),
 
75
                             int(hour),
 
76
                             int(minute),
 
77
                             int(second),           # Whole seconds
 
78
                             int(fraction*1000000)) # Microseconds
 
79
 
33
80
class MandosClientPropertyCache(object):
34
81
    """This wraps a Mandos Client D-Bus proxy object, caches the
35
82
    properties and calls a hook function when any of them are
36
83
    changed.
37
84
    """
38
 
    def __init__(self, proxy_object=None, properties=None, *args,
39
 
                 **kwargs):
 
85
    def __init__(self, proxy_object=None, *args, **kwargs):
40
86
        self.proxy = proxy_object # Mandos Client proxy object
41
87
        
42
 
        if properties is None:
43
 
            self.properties = dict()
44
 
        else:
45
 
            self.properties = properties
46
 
        self.proxy.connect_to_signal("PropertyChanged",
 
88
        self.properties = dict()
 
89
        self.proxy.connect_to_signal(u"PropertyChanged",
47
90
                                     self.property_changed,
48
91
                                     client_interface,
49
92
                                     byte_arrays=True)
50
93
        
51
 
        if properties is None:
52
 
            self.properties.update(self.proxy.GetAll(client_interface,
53
 
                                                     dbus_interface =
54
 
                                                     dbus.PROPERTIES_IFACE))
55
 
        super(MandosClientPropertyCache, self).__init__(
56
 
            proxy_object=proxy_object,
57
 
            properties=properties, *args, **kwargs)
 
94
        self.properties.update(
 
95
            self.proxy.GetAll(client_interface,
 
96
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
97
 
 
98
        #XXX This break good super behaviour!
 
99
#        super(MandosClientPropertyCache, self).__init__(
 
100
#            *args, **kwargs)
58
101
    
59
102
    def property_changed(self, property=None, value=None):
60
103
        """This is called whenever we get a PropertyChanged signal
69
112
    """
70
113
    
71
114
    def __init__(self, server_proxy_object=None, update_hook=None,
72
 
                 delete_hook=None, *args, **kwargs):
 
115
                 delete_hook=None, logger=None, *args, **kwargs):
73
116
        # Called on update
74
117
        self.update_hook = update_hook
75
118
        # Called on delete
76
119
        self.delete_hook = delete_hook
77
120
        # Mandos Server proxy object
78
121
        self.server_proxy_object = server_proxy_object
 
122
        # Logger
 
123
        self.logger = logger
 
124
        
 
125
        self._update_timer_callback_tag = None
 
126
        self._update_timer_callback_lock = 0
 
127
        self.last_checker_failed = False
79
128
        
80
129
        # The widget shown normally
81
 
        self._text_widget = urwid.Text("")
 
130
        self._text_widget = urwid.Text(u"")
82
131
        # The widget shown when we have focus
83
 
        self._focus_text_widget = urwid.Text("")
 
132
        self._focus_text_widget = urwid.Text(u"")
84
133
        super(MandosClientWidget, self).__init__(
85
134
            update_hook=update_hook, delete_hook=delete_hook,
86
135
            *args, **kwargs)
87
136
        self.update()
88
137
        self.opened = False
 
138
        
 
139
        last_checked_ok = isoformat_to_datetime(self.properties
 
140
                                                [u"LastCheckedOK"])
 
141
        if last_checked_ok is None:
 
142
            self.last_checker_failed = True
 
143
        else:
 
144
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
145
                                         - last_checked_ok)
 
146
                                        > datetime.timedelta
 
147
                                        (milliseconds=
 
148
                                         self.properties
 
149
                                         [u"Interval"]))
 
150
        
 
151
        if self.last_checker_failed:
 
152
            self.using_timer(True)
 
153
        
 
154
        if self.need_approval:
 
155
            self.using_timer(True)
 
156
        
 
157
        self.proxy.connect_to_signal(u"CheckerCompleted",
 
158
                                     self.checker_completed,
 
159
                                     client_interface,
 
160
                                     byte_arrays=True)
 
161
        self.proxy.connect_to_signal(u"CheckerStarted",
 
162
                                     self.checker_started,
 
163
                                     client_interface,
 
164
                                     byte_arrays=True)
 
165
        self.proxy.connect_to_signal(u"GotSecret",
 
166
                                     self.got_secret,
 
167
                                     client_interface,
 
168
                                     byte_arrays=True)
 
169
        self.proxy.connect_to_signal(u"NeedApproval",
 
170
                                     self.need_approval,
 
171
                                     client_interface,
 
172
                                     byte_arrays=True)
 
173
        self.proxy.connect_to_signal(u"Rejected",
 
174
                                     self.rejected,
 
175
                                     client_interface,
 
176
                                     byte_arrays=True)
 
177
    
 
178
    def property_changed(self, property=None, value=None):
 
179
        super(self, MandosClientWidget).property_changed(property,
 
180
                                                         value)
 
181
        if property == u"ApprovalPending":
 
182
            using_timer(bool(value))
 
183
        
 
184
    def using_timer(self, flag):
 
185
        """Call this method with True or False when timer should be
 
186
        activated or deactivated.
 
187
        """
 
188
        old = self._update_timer_callback_lock
 
189
        if flag:
 
190
            self._update_timer_callback_lock += 1
 
191
        else:
 
192
            self._update_timer_callback_lock -= 1
 
193
        if old == 0 and self._update_timer_callback_lock:
 
194
            self._update_timer_callback_tag = (gobject.timeout_add
 
195
                                               (1000,
 
196
                                                self.update_timer))
 
197
        elif old and self._update_timer_callback_lock == 0:
 
198
            gobject.source_remove(self._update_timer_callback_tag)
 
199
            self._update_timer_callback_tag = None
 
200
    
 
201
    def checker_completed(self, exitstatus, condition, command):
 
202
        if exitstatus == 0:
 
203
            if self.last_checker_failed:
 
204
                self.last_checker_failed = False
 
205
                self.using_timer(False)
 
206
            #self.logger(u'Checker for client %s (command "%s")'
 
207
            #            u' was successful'
 
208
            #            % (self.properties[u"Name"], command))
 
209
            self.update()
 
210
            return
 
211
        # Checker failed
 
212
        if not self.last_checker_failed:
 
213
            self.last_checker_failed = True
 
214
            self.using_timer(True)
 
215
        if os.WIFEXITED(condition):
 
216
            self.logger(u'Checker for client %s (command "%s")'
 
217
                        u' failed with exit code %s'
 
218
                        % (self.properties[u"Name"], command,
 
219
                           os.WEXITSTATUS(condition)))
 
220
        elif os.WIFSIGNALED(condition):
 
221
            self.logger(u'Checker for client %s (command "%s")'
 
222
                        u' was killed by signal %s'
 
223
                        % (self.properties[u"Name"], command,
 
224
                           os.WTERMSIG(condition)))
 
225
        elif os.WCOREDUMP(condition):
 
226
            self.logger(u'Checker for client %s (command "%s")'
 
227
                        u' dumped core'
 
228
                        % (self.properties[u"Name"], command))
 
229
        else:
 
230
            self.logger(u'Checker for client %s completed'
 
231
                        u' mysteriously')
 
232
        self.update()
 
233
    
 
234
    def checker_started(self, command):
 
235
        #self.logger(u'Client %s started checker "%s"'
 
236
        #            % (self.properties[u"Name"], unicode(command)))
 
237
        pass
 
238
    
 
239
    def got_secret(self):
 
240
        self.last_checker_failed = False
 
241
        self.logger(u'Client %s received its secret'
 
242
                    % self.properties[u"Name"])
 
243
    
 
244
    def need_approval(self, timeout, default):
 
245
        if not default:
 
246
            message = u'Client %s needs approval within %s seconds'
 
247
        else:
 
248
            message = u'Client %s will get its secret in %s seconds'
 
249
        self.logger(message
 
250
                    % (self.properties[u"Name"], timeout/1000))
 
251
        self.using_timer(True)
 
252
    
 
253
    def rejected(self, reason):
 
254
        self.logger(u'Client %s was rejected; reason: %s'
 
255
                    % (self.properties[u"Name"], reason))
89
256
    
90
257
    def selectable(self):
91
258
        """Make this a "selectable" widget.
113
280
                          u"bold-underline-blink":
114
281
                              u"bold-underline-blink-standout",
115
282
                          }
116
 
        
 
283
 
117
284
        # Rebuild focus and non-focus widgets using current properties
118
 
        self._text = (u'name="%(name)s", enabled=%(enabled)s'
119
 
                      % self.properties)
 
285
 
 
286
        # Base part of a client. Name!
 
287
        base = (u'%(name)s: '
 
288
                      % {u"name": self.properties[u"Name"]})
 
289
        if not self.properties[u"Enabled"]:
 
290
            message = u"DISABLED"
 
291
        elif self.properties[u"ApprovalPending"]:
 
292
            timeout = datetime.timedelta(milliseconds
 
293
                                         = self.properties
 
294
                                         [u"ApprovalDelay"])
 
295
            last_approval_request = isoformat_to_datetime(
 
296
                self.properties[u"LastApprovalRequest"])
 
297
            if last_approval_request is not None:
 
298
                timer = timeout - (datetime.datetime.utcnow()
 
299
                                   - last_approval_request)
 
300
            else:
 
301
                timer = datetime.timedelta()
 
302
            if self.properties[u"ApprovedByDefault"]:
 
303
                message = u"Approval in %s. (d)eny?"
 
304
            else:
 
305
                message = u"Denial in %s. (a)pprove?"
 
306
            message = message % unicode(timer).rsplit(".", 1)[0]
 
307
        elif self.last_checker_failed:
 
308
            timeout = datetime.timedelta(milliseconds
 
309
                                         = self.properties
 
310
                                         [u"Timeout"])
 
311
            last_ok = isoformat_to_datetime(
 
312
                max((self.properties[u"LastCheckedOK"]
 
313
                     or self.properties[u"Created"]),
 
314
                    self.properties[u"LastEnabled"]))
 
315
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
316
            message = (u'A checker has failed! Time until client'
 
317
                       u' gets disabled: %s'
 
318
                           % unicode(timer).rsplit(".", 1)[0])
 
319
        else:
 
320
            message = u"enabled"
 
321
        self._text = "%s%s" % (base, message)
 
322
            
120
323
        if not urwid.supports_unicode():
121
324
            self._text = self._text.encode("ascii", "replace")
122
 
        textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
 
325
        textlist = [(u"normal", self._text)]
123
326
        self._text_widget.set_text(textlist)
124
327
        self._focus_text_widget.set_text([(with_standout[text[0]],
125
328
                                           text[1])
133
336
        if self.update_hook is not None:
134
337
            self.update_hook()
135
338
    
 
339
    def update_timer(self):
 
340
        "called by gobject"
 
341
        self.update()
 
342
        return True             # Keep calling this
 
343
    
136
344
    def delete(self):
 
345
        if self._update_timer_callback_tag is not None:
 
346
            gobject.source_remove(self._update_timer_callback_tag)
 
347
            self._update_timer_callback_tag = None
137
348
        if self.delete_hook is not None:
138
349
            self.delete_hook(self)
139
350
    
146
357
    def keypress(self, (maxcol,), key):
147
358
        """Handle keys.
148
359
        This overrides the method from urwid.FlowWidget"""
149
 
        if key == u"e" or key == u"+":
150
 
            self.proxy.Enable()
151
 
        elif key == u"d" or key == u"-":
152
 
            self.proxy.Disable()
153
 
        elif key == u"r" or key == u"_":
 
360
        if key == u"+":
 
361
            self.proxy.Enable(dbus_interface = client_interface)
 
362
        elif key == u"-":
 
363
            self.proxy.Disable(dbus_interface = client_interface)
 
364
        elif key == u"a":
 
365
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
366
                               dbus_interface = client_interface)
 
367
        elif key == u"d":
 
368
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
369
                                  dbus_interface = client_interface)
 
370
        elif key == u"R" or key == u"_" or key == u"ctrl k":
154
371
            self.server_proxy_object.RemoveClient(self.proxy
155
372
                                                  .object_path)
156
373
        elif key == u"s":
157
 
            self.proxy.StartChecker()
 
374
            self.proxy.StartChecker(dbus_interface = client_interface)
158
375
        elif key == u"S":
159
 
            self.proxy.StopChecker()
 
376
            self.proxy.StopChecker(dbus_interface = client_interface)
160
377
        elif key == u"C":
161
 
            self.proxy.CheckedOK()
 
378
            self.proxy.CheckedOK(dbus_interface = client_interface)
162
379
        # xxx
163
380
#         elif key == u"p" or key == "=":
164
381
#             self.proxy.pause()
187
404
    use them as an excuse to shift focus away from this widget.
188
405
    """
189
406
    def keypress(self, (maxcol, maxrow), key):
190
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
 
407
        ret = super(ConstrainedListBox, self).keypress((maxcol,
 
408
                                                        maxrow), key)
191
409
        if ret in (u"up", u"down"):
192
410
            return
193
411
        return ret
223
441
                ))
224
442
        
225
443
        if urwid.supports_unicode():
226
 
            #self.divider = u"─" # \u2500
227
 
            self.divider = u"━" # \u2501
 
444
            self.divider = u"─" # \u2500
 
445
            #self.divider = u"━" # \u2501
228
446
        else:
229
447
            #self.divider = u"-" # \u002d
230
448
            self.divider = u"_" # \u005f
250
468
        self.log_wrap = u"any"
251
469
        
252
470
        self.rebuild()
253
 
        self.log_message((u"bold",
254
 
                          u"Mandos Monitor version " + version))
255
 
        self.log_message((u"bold",
256
 
                          u"q: Quit  ?: Help"))
 
471
        self.log_message_raw((u"bold",
 
472
                              u"Mandos Monitor version " + version))
 
473
        self.log_message_raw((u"bold",
 
474
                              u"q: Quit  ?: Help"))
257
475
        
258
476
        self.busname = domain + '.Mandos'
259
477
        self.main_loop = gobject.MainLoop()
270
488
            mandos_clients = dbus.Dictionary()
271
489
        
272
490
        (self.mandos_serv
273
 
         .connect_to_signal("ClientRemoved",
 
491
         .connect_to_signal(u"ClientRemoved",
274
492
                            self.find_and_remove_client,
275
493
                            dbus_interface=server_interface,
276
494
                            byte_arrays=True))
277
495
        (self.mandos_serv
278
 
         .connect_to_signal("ClientAdded",
 
496
         .connect_to_signal(u"ClientAdded",
279
497
                            self.add_new_client,
280
498
                            dbus_interface=server_interface,
281
499
                            byte_arrays=True))
 
500
        (self.mandos_serv
 
501
         .connect_to_signal(u"ClientNotFound",
 
502
                            self.client_not_found,
 
503
                            dbus_interface=server_interface,
 
504
                            byte_arrays=True))
282
505
        for path, client in mandos_clients.iteritems():
283
506
            client_proxy_object = self.bus.get_object(self.busname,
284
507
                                                      path)
290
513
                                               update_hook
291
514
                                               =self.refresh,
292
515
                                               delete_hook
293
 
                                               =self.remove_client),
 
516
                                               =self.remove_client,
 
517
                                               logger
 
518
                                               =self.log_message),
294
519
                            path=path)
295
520
    
 
521
    def client_not_found(self, fingerprint, address):
 
522
        self.log_message((u"Client with address %s and fingerprint %s"
 
523
                          u" could not be found" % (address,
 
524
                                                    fingerprint)))
 
525
    
296
526
    def rebuild(self):
297
527
        """This rebuilds the User Interface.
298
528
        Call this when the widget layout needs to change"""
299
529
        self.uilist = []
300
530
        #self.uilist.append(urwid.ListBox(self.clients))
301
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
531
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
532
                                                          clients),
302
533
                                       #header=urwid.Divider(),
303
534
                                       header=None,
304
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
535
                                       footer=
 
536
                                       urwid.Divider(div_char=
 
537
                                                     self.divider)))
305
538
        if self.log_visible:
306
539
            self.uilist.append(self.logbox)
307
540
            pass
308
541
        self.topwidget = urwid.Pile(self.uilist)
309
542
    
310
 
    def log_message(self, markup):
 
543
    def log_message(self, message):
 
544
        timestamp = datetime.datetime.now().isoformat()
 
545
        self.log_message_raw(timestamp + u": " + message)
 
546
    
 
547
    def log_message_raw(self, markup):
311
548
        """Add a log message to the log buffer."""
312
549
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
313
550
        if (self.max_log_length
314
551
            and len(self.log) > self.max_log_length):
315
552
            del self.log[0:len(self.log)-self.max_log_length-1]
 
553
        self.logbox.set_focus(len(self.logbox.body.contents),
 
554
                              coming_from=u"above")
 
555
        self.refresh()
316
556
    
317
557
    def toggle_log_display(self):
318
558
        """Toggle visibility of the log buffer."""
319
559
        self.log_visible = not self.log_visible
320
560
        self.rebuild()
321
 
        self.log_message(u"Log visibility changed to: "
322
 
                         + unicode(self.log_visible))
 
561
        #self.log_message(u"Log visibility changed to: "
 
562
        #                 + unicode(self.log_visible))
323
563
    
324
564
    def change_log_display(self):
325
565
        """Change type of log display.
330
570
            self.log_wrap = u"clip"
331
571
        for textwidget in self.log:
332
572
            textwidget.set_wrap_mode(self.log_wrap)
333
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
573
        #self.log_message(u"Wrap mode: " + self.log_wrap)
334
574
    
335
575
    def find_and_remove_client(self, path, name):
336
576
        """Find an client from its object path and remove it.
344
584
            return
345
585
        self.remove_client(client, path)
346
586
    
347
 
    def add_new_client(self, path, properties):
 
587
    def add_new_client(self, path):
348
588
        client_proxy_object = self.bus.get_object(self.busname, path)
349
589
        self.add_client(MandosClientWidget(server_proxy_object
350
590
                                           =self.mandos_serv,
351
591
                                           proxy_object
352
592
                                           =client_proxy_object,
353
 
                                           properties=properties,
354
593
                                           update_hook
355
594
                                           =self.refresh,
356
595
                                           delete_hook
357
 
                                           =self.remove_client),
 
596
                                           =self.remove_client,
 
597
                                           logger
 
598
                                           =self.log_message),
358
599
                        path=path)
359
600
    
360
601
    def add_client(self, client, path=None):
362
603
        if path is None:
363
604
            path = client.proxy.object_path
364
605
        self.clients_dict[path] = client
365
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
606
        self.clients.sort(None, lambda c: c.properties[u"Name"])
366
607
        self.refresh()
367
608
    
368
609
    def remove_client(self, client, path=None):
429
670
            elif key == u"w" or key == u"i":
430
671
                self.change_log_display()
431
672
                self.refresh()
432
 
            elif key == u"?" or key == u"f1":
 
673
            elif key == u"?" or key == u"f1" or key == u"esc":
433
674
                if not self.log_visible:
434
675
                    self.log_visible = True
435
676
                    self.rebuild()
436
 
                self.log_message((u"bold",
437
 
                                  u"  ".join((u"q: Quit",
438
 
                                              u"?: Help",
439
 
                                              u"l: Log window toggle",
440
 
                                              u"TAB: Switch window",
441
 
                                              u"w: Wrap (log)"))))
442
 
                self.log_message((u"bold",
443
 
                                  u"  ".join((u"Clients:",
444
 
                                              u"e: Enable",
445
 
                                              u"d: Disable",
446
 
                                              u"r: Remove",
447
 
                                              u"s: Start new checker",
448
 
                                              u"S: Stop checker",
449
 
                                              u"C: Checker OK"))))
 
677
                self.log_message_raw((u"bold",
 
678
                                      u"  ".
 
679
                                      join((u"q: Quit",
 
680
                                            u"?: Help",
 
681
                                            u"l: Log window toggle",
 
682
                                            u"TAB: Switch window",
 
683
                                            u"w: Wrap (log)"))))
 
684
                self.log_message_raw((u"bold",
 
685
                                      u"  "
 
686
                                      .join((u"Clients:",
 
687
                                             u"+: Enable",
 
688
                                             u"-: Disable",
 
689
                                             u"R: Remove",
 
690
                                             u"s: Start new checker",
 
691
                                             u"S: Stop checker",
 
692
                                             u"C: Checker OK",
 
693
                                             u"a: Approve",
 
694
                                             u"d: Deny"))))
450
695
                self.refresh()
451
696
            elif key == u"tab":
452
697
                if self.topwidget.get_focus() is self.logbox:
480
725
ui = UserInterface()
481
726
try:
482
727
    ui.run()
483
 
except:
 
728
except KeyboardInterrupt:
 
729
    ui.screen.stop()
 
730
except Exception, e:
 
731
    ui.log_message(unicode(e))
484
732
    ui.screen.stop()
485
733
    raise