/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
4
4
from __future__ import division, absolute_import, with_statement
5
5
 
6
6
import sys
 
7
import os
7
8
import signal
8
9
 
 
10
import datetime
 
11
 
9
12
import urwid.curses_display
10
13
import urwid
11
14
 
16
19
 
17
20
import UserList
18
21
 
 
22
import locale
 
23
 
 
24
locale.setlocale(locale.LC_ALL, u'')
 
25
 
 
26
import logging
 
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
 
28
 
19
29
# Some useful constants
20
30
domain = 'se.bsnet.fukt'
21
31
server_interface = domain + '.Mandos'
22
32
client_interface = domain + '.Mandos.Client'
23
 
version = "1.0.14"
 
33
version = "1.0.15"
24
34
 
25
35
# Always run in monochrome mode
26
36
urwid.curses_display.curses.has_colors = lambda : False
30
40
urwid.curses_display.curses.A_UNDERLINE |= (
31
41
    urwid.curses_display.curses.A_BLINK)
32
42
 
 
43
def isoformat_to_datetime(iso):
 
44
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
45
    if not iso:
 
46
        return None
 
47
    d, t = iso.split(u"T", 1)
 
48
    year, month, day = d.split(u"-", 2)
 
49
    hour, minute, second = t.split(u":", 2)
 
50
    second, fraction = divmod(float(second), 1)
 
51
    return datetime.datetime(int(year),
 
52
                             int(month),
 
53
                             int(day),
 
54
                             int(hour),
 
55
                             int(minute),
 
56
                             int(second),           # Whole seconds
 
57
                             int(fraction*1000000)) # Microseconds
 
58
 
33
59
class MandosClientPropertyCache(object):
34
60
    """This wraps a Mandos Client D-Bus proxy object, caches the
35
61
    properties and calls a hook function when any of them are
36
62
    changed.
37
63
    """
38
 
    def __init__(self, proxy_object=None, properties=None, *args,
39
 
                 **kwargs):
 
64
    def __init__(self, proxy_object=None, *args, **kwargs):
40
65
        self.proxy = proxy_object # Mandos Client proxy object
41
66
        
42
 
        if properties is None:
43
 
            self.properties = dict()
44
 
        else:
45
 
            self.properties = properties
46
 
        self.proxy.connect_to_signal("PropertyChanged",
 
67
        self.properties = dict()
 
68
        self.proxy.connect_to_signal(u"PropertyChanged",
47
69
                                     self.property_changed,
48
70
                                     client_interface,
49
71
                                     byte_arrays=True)
50
72
        
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)
 
73
        self.properties.update(
 
74
            self.proxy.GetAll(client_interface,
 
75
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
76
 
 
77
        #XXX This break good super behaviour!
 
78
#        super(MandosClientPropertyCache, self).__init__(
 
79
#            *args, **kwargs)
58
80
    
59
81
    def property_changed(self, property=None, value=None):
60
82
        """This is called whenever we get a PropertyChanged signal
69
91
    """
70
92
    
71
93
    def __init__(self, server_proxy_object=None, update_hook=None,
72
 
                 delete_hook=None, *args, **kwargs):
 
94
                 delete_hook=None, logger=None, *args, **kwargs):
73
95
        # Called on update
74
96
        self.update_hook = update_hook
75
97
        # Called on delete
76
98
        self.delete_hook = delete_hook
77
99
        # Mandos Server proxy object
78
100
        self.server_proxy_object = server_proxy_object
 
101
        # Logger
 
102
        self.logger = logger
 
103
        
 
104
        self._update_timer_callback_tag = None
 
105
        self.last_checker_failed = False
79
106
        
80
107
        # The widget shown normally
81
 
        self._text_widget = urwid.Text("")
 
108
        self._text_widget = urwid.Text(u"")
82
109
        # The widget shown when we have focus
83
 
        self._focus_text_widget = urwid.Text("")
 
110
        self._focus_text_widget = urwid.Text(u"")
84
111
        super(MandosClientWidget, self).__init__(
85
112
            update_hook=update_hook, delete_hook=delete_hook,
86
113
            *args, **kwargs)
87
114
        self.update()
88
115
        self.opened = False
 
116
        self.proxy.connect_to_signal(u"CheckerCompleted",
 
117
                                     self.checker_completed,
 
118
                                     client_interface,
 
119
                                     byte_arrays=True)
 
120
        self.proxy.connect_to_signal(u"CheckerStarted",
 
121
                                     self.checker_started,
 
122
                                     client_interface,
 
123
                                     byte_arrays=True)
 
124
        self.proxy.connect_to_signal(u"GotSecret",
 
125
                                     self.got_secret,
 
126
                                     client_interface,
 
127
                                     byte_arrays=True)
 
128
        self.proxy.connect_to_signal(u"NeedApproval",
 
129
                                     self.need_approval,
 
130
                                     client_interface,
 
131
                                     byte_arrays=True)
 
132
        self.proxy.connect_to_signal(u"Rejected",
 
133
                                     self.rejected,
 
134
                                     client_interface,
 
135
                                     byte_arrays=True)
 
136
        last_checked_ok = isoformat_to_datetime(self.properties
 
137
                                                [u"LastCheckedOK"])
 
138
        if last_checked_ok is None:
 
139
            self.last_checker_failed = True
 
140
        else:
 
141
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
142
                                         - last_checked_ok)
 
143
                                        > datetime.timedelta
 
144
                                        (milliseconds=
 
145
                                         self.properties
 
146
                                         [u"Interval"]))
 
147
        if self.last_checker_failed:
 
148
            self._update_timer_callback_tag = (gobject.timeout_add
 
149
                                               (1000,
 
150
                                                self.update_timer))
 
151
    
 
152
    def checker_completed(self, exitstatus, condition, command):
 
153
        if exitstatus == 0:
 
154
            if self.last_checker_failed:
 
155
                self.last_checker_failed = False
 
156
                gobject.source_remove(self._update_timer_callback_tag)
 
157
                self._update_timer_callback_tag = None
 
158
            self.logger(u'Checker for client %s (command "%s")'
 
159
                        u' was successful'
 
160
                        % (self.properties[u"Name"], command))
 
161
            self.update()
 
162
            return
 
163
        # Checker failed
 
164
        if not self.last_checker_failed:
 
165
            self.last_checker_failed = True
 
166
            self._update_timer_callback_tag = (gobject.timeout_add
 
167
                                               (1000,
 
168
                                                self.update_timer))
 
169
        if os.WIFEXITED(condition):
 
170
            self.logger(u'Checker for client %s (command "%s")'
 
171
                        u' failed with exit code %s'
 
172
                        % (self.properties[u"Name"], command,
 
173
                           os.WEXITSTATUS(condition)))
 
174
        elif os.WIFSIGNALED(condition):
 
175
            self.logger(u'Checker for client %s (command "%s")'
 
176
                        u' was killed by signal %s'
 
177
                        % (self.properties[u"Name"], command,
 
178
                           os.WTERMSIG(condition)))
 
179
        elif os.WCOREDUMP(condition):
 
180
            self.logger(u'Checker for client %s (command "%s")'
 
181
                        u' dumped core'
 
182
                        % (self.properties[u"Name"], command))
 
183
        else:
 
184
            self.logger(u'Checker for client %s completed'
 
185
                        u' mysteriously')
 
186
        self.update()
 
187
    
 
188
    def checker_started(self, command):
 
189
        #self.logger(u'Client %s started checker "%s"'
 
190
        #            % (self.properties[u"Name"], unicode(command)))
 
191
        pass
 
192
    
 
193
    def got_secret(self):
 
194
        self.last_checker_failed = False
 
195
        self.logger(u'Client %s received its secret'
 
196
                    % self.properties[u"Name"])
 
197
    
 
198
    def need_approval(self, timeout, default):
 
199
        if not default:
 
200
            message = u'Client %s needs approval within %s seconds'
 
201
        else:
 
202
            message = u'Client %s will get its secret in %s seconds'
 
203
        self.logger(message
 
204
                    % (self.properties[u"Name"], timeout/1000))
 
205
    
 
206
    def rejected(self, reason):
 
207
        self.logger(u'Client %s was rejected; reason: %s'
 
208
                    % (self.properties[u"Name"], reason))
89
209
    
90
210
    def selectable(self):
91
211
        """Make this a "selectable" widget.
113
233
                          u"bold-underline-blink":
114
234
                              u"bold-underline-blink-standout",
115
235
                          }
116
 
        
 
236
 
117
237
        # Rebuild focus and non-focus widgets using current properties
118
 
        self._text = (u'name="%(name)s", enabled=%(enabled)s'
119
 
                      % self.properties)
 
238
 
 
239
        # Base part of a client. Name!
 
240
        base = (u'%(name)s: '
 
241
                      % {u"name": self.properties[u"Name"]})
 
242
        if not self.properties[u"Enabled"]:
 
243
            message = u"DISABLED"
 
244
        elif self.properties[u"ApprovalPending"]:
 
245
            if self.properties[u"ApprovedByDefault"]:
 
246
                message = u"Connection established to client. (d)eny?"
 
247
            else:
 
248
                message = u"Seeks approval to send secret. (a)pprove?"
 
249
        elif self.last_checker_failed:
 
250
            timeout = datetime.timedelta(milliseconds
 
251
                                         = self.properties
 
252
                                         [u"Timeout"])
 
253
            last_ok = isoformat_to_datetime(
 
254
                max((self.properties[u"LastCheckedOK"]
 
255
                     or self.properties[u"Created"]),
 
256
                    self.properties[u"LastEnabled"]))
 
257
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
258
            message = (u'A checker has failed! Time until client'
 
259
                       u' gets diabled: %s'
 
260
                           % unicode(timer).rsplit(".", 1)[0])
 
261
        else:
 
262
            message = u"enabled"
 
263
        self._text = "%s%s" % (base, message)
 
264
            
120
265
        if not urwid.supports_unicode():
121
266
            self._text = self._text.encode("ascii", "replace")
122
 
        textlist = [(u"normal", u"BLARGH: "), (u"bold", self._text)]
 
267
        textlist = [(u"normal", self._text)]
123
268
        self._text_widget.set_text(textlist)
124
269
        self._focus_text_widget.set_text([(with_standout[text[0]],
125
270
                                           text[1])
133
278
        if self.update_hook is not None:
134
279
            self.update_hook()
135
280
    
 
281
    def update_timer(self):
 
282
        "called by gobject"
 
283
        self.update()
 
284
        return True             # Keep calling this
 
285
    
136
286
    def delete(self):
 
287
        if self._update_timer_callback_tag is not None:
 
288
            gobject.source_remove(self._update_timer_callback_tag)
 
289
            self._update_timer_callback_tag = None
137
290
        if self.delete_hook is not None:
138
291
            self.delete_hook(self)
139
292
    
146
299
    def keypress(self, (maxcol,), key):
147
300
        """Handle keys.
148
301
        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"_":
 
302
        if key == u"+":
 
303
            self.proxy.Enable(dbus_interface = client_interface)
 
304
        elif key == u"-":
 
305
            self.proxy.Disable(dbus_interface = client_interface)
 
306
        elif key == u"a":
 
307
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
308
                               dbus_interface = client_interface)
 
309
        elif key == u"d":
 
310
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
311
                                  dbus_interface = client_interface)
 
312
        elif key == u"r" or key == u"_" or key == u"ctrl k":
154
313
            self.server_proxy_object.RemoveClient(self.proxy
155
314
                                                  .object_path)
156
315
        elif key == u"s":
157
 
            self.proxy.StartChecker()
158
 
        elif key == u"c":
159
 
            self.proxy.StopChecker()
 
316
            self.proxy.StartChecker(dbus_interface = client_interface)
160
317
        elif key == u"S":
161
 
            self.proxy.CheckedOK()
 
318
            self.proxy.StopChecker(dbus_interface = client_interface)
 
319
        elif key == u"C":
 
320
            self.proxy.CheckedOK(dbus_interface = client_interface)
162
321
        # xxx
163
322
#         elif key == u"p" or key == "=":
164
323
#             self.proxy.pause()
166
325
#             self.proxy.unpause()
167
326
#         elif key == u"RET":
168
327
#             self.open()
 
328
#        elif key == u"+":
 
329
#            self.proxy.Approve(True)
 
330
#        elif key == u"-":
 
331
#            self.proxy.Approve(False)
169
332
        else:
170
333
            return key
171
334
    
187
350
    use them as an excuse to shift focus away from this widget.
188
351
    """
189
352
    def keypress(self, (maxcol, maxrow), key):
190
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
 
353
        ret = super(ConstrainedListBox, self).keypress((maxcol,
 
354
                                                        maxrow), key)
191
355
        if ret in (u"up", u"down"):
192
356
            return
193
357
        return ret
223
387
                ))
224
388
        
225
389
        if urwid.supports_unicode():
226
 
            #self.divider = u"─" # \u2500
227
 
            self.divider = u"━" # \u2501
 
390
            self.divider = u"─" # \u2500
 
391
            #self.divider = u"━" # \u2501
228
392
        else:
229
393
            #self.divider = u"-" # \u002d
230
394
            self.divider = u"_" # \u005f
250
414
        self.log_wrap = u"any"
251
415
        
252
416
        self.rebuild()
253
 
        self.log_message(u"Message")
254
 
        self.log_message(u"Message0 Message1 Message2 Message3 Message4 Message5 Message6 Message7 Message8 Message9")
255
 
        self.log_message(u"Message10 Message11 Message12 Message13 Message14 Message15 Message16 Message17 Message18 Message19")
256
 
        self.log_message(u"Message20 Message21 Message22 Message23 Message24 Message25 Message26 Message27 Message28 Message29")
 
417
        self.log_message_raw((u"bold",
 
418
                              u"Mandos Monitor version " + version))
 
419
        self.log_message_raw((u"bold",
 
420
                              u"q: Quit  ?: Help"))
257
421
        
258
422
        self.busname = domain + '.Mandos'
259
423
        self.main_loop = gobject.MainLoop()
270
434
            mandos_clients = dbus.Dictionary()
271
435
        
272
436
        (self.mandos_serv
273
 
         .connect_to_signal("ClientRemoved",
 
437
         .connect_to_signal(u"ClientRemoved",
274
438
                            self.find_and_remove_client,
275
439
                            dbus_interface=server_interface,
276
440
                            byte_arrays=True))
277
441
        (self.mandos_serv
278
 
         .connect_to_signal("ClientAdded",
 
442
         .connect_to_signal(u"ClientAdded",
279
443
                            self.add_new_client,
280
444
                            dbus_interface=server_interface,
281
445
                            byte_arrays=True))
 
446
        (self.mandos_serv
 
447
         .connect_to_signal(u"ClientNotFound",
 
448
                            self.client_not_found,
 
449
                            dbus_interface=server_interface,
 
450
                            byte_arrays=True))
282
451
        for path, client in mandos_clients.iteritems():
283
452
            client_proxy_object = self.bus.get_object(self.busname,
284
453
                                                      path)
290
459
                                               update_hook
291
460
                                               =self.refresh,
292
461
                                               delete_hook
293
 
                                               =self.remove_client),
 
462
                                               =self.remove_client,
 
463
                                               logger
 
464
                                               =self.log_message),
294
465
                            path=path)
295
466
    
 
467
    def client_not_found(self, fingerprint, address):
 
468
        self.log_message((u"Client with address %s and fingerprint %s"
 
469
                          u" could not be found" % (address,
 
470
                                                    fingerprint)))
 
471
    
296
472
    def rebuild(self):
297
473
        """This rebuilds the User Interface.
298
474
        Call this when the widget layout needs to change"""
299
475
        self.uilist = []
300
476
        #self.uilist.append(urwid.ListBox(self.clients))
301
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
477
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
478
                                                          clients),
302
479
                                       #header=urwid.Divider(),
303
480
                                       header=None,
304
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
481
                                       footer=
 
482
                                       urwid.Divider(div_char=
 
483
                                                     self.divider)))
305
484
        if self.log_visible:
306
485
            self.uilist.append(self.logbox)
307
486
            pass
308
487
        self.topwidget = urwid.Pile(self.uilist)
309
488
    
310
 
    def log_message(self, markup):
 
489
    def log_message(self, message):
 
490
        timestamp = datetime.datetime.now().isoformat()
 
491
        self.log_message_raw(timestamp + u": " + message)
 
492
    
 
493
    def log_message_raw(self, markup):
311
494
        """Add a log message to the log buffer."""
312
495
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
313
496
        if (self.max_log_length
314
497
            and len(self.log) > self.max_log_length):
315
498
            del self.log[0:len(self.log)-self.max_log_length-1]
 
499
        self.logbox.set_focus(len(self.logbox.body.contents),
 
500
                              coming_from=u"above")
 
501
        self.refresh()
316
502
    
317
503
    def toggle_log_display(self):
318
504
        """Toggle visibility of the log buffer."""
344
530
            return
345
531
        self.remove_client(client, path)
346
532
    
347
 
    def add_new_client(self, path, properties):
 
533
    def add_new_client(self, path):
348
534
        client_proxy_object = self.bus.get_object(self.busname, path)
349
535
        self.add_client(MandosClientWidget(server_proxy_object
350
536
                                           =self.mandos_serv,
351
537
                                           proxy_object
352
538
                                           =client_proxy_object,
353
 
                                           properties=properties,
354
539
                                           update_hook
355
540
                                           =self.refresh,
356
541
                                           delete_hook
357
 
                                           =self.remove_client),
 
542
                                           =self.remove_client,
 
543
                                           logger
 
544
                                           =self.log_message),
358
545
                        path=path)
359
546
    
360
547
    def add_client(self, client, path=None):
362
549
        if path is None:
363
550
            path = client.proxy.object_path
364
551
        self.clients_dict[path] = client
365
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
552
        self.clients.sort(None, lambda c: c.properties[u"Name"])
366
553
        self.refresh()
367
554
    
368
555
    def remove_client(self, client, path=None):
429
616
            elif key == u"w" or key == u"i":
430
617
                self.change_log_display()
431
618
                self.refresh()
432
 
            elif key == u"?" or key == u"f1":
433
 
                self.log_message(u"Help!")
 
619
            elif key == u"?" or key == u"f1" or key == u"esc":
 
620
                if not self.log_visible:
 
621
                    self.log_visible = True
 
622
                    self.rebuild()
 
623
                self.log_message_raw((u"bold",
 
624
                                      u"  ".
 
625
                                      join((u"q: Quit",
 
626
                                            u"?: Help",
 
627
                                            u"l: Log window toggle",
 
628
                                            u"TAB: Switch window",
 
629
                                            u"w: Wrap (log)"))))
 
630
                self.log_message_raw((u"bold",
 
631
                                      u"  "
 
632
                                      .join((u"Clients:",
 
633
                                             u"+: Enable",
 
634
                                             u"-: Disable",
 
635
                                             u"r: Remove",
 
636
                                             u"s: Start new checker",
 
637
                                             u"S: Stop checker",
 
638
                                             u"C: Checker OK",
 
639
                                             u"a: Approve",
 
640
                                             u"d: Deny"))))
434
641
                self.refresh()
435
642
            elif key == u"tab":
436
643
                if self.topwidget.get_focus() is self.logbox:
438
645
                else:
439
646
                    self.topwidget.set_focus(self.logbox)
440
647
                self.refresh()
441
 
            elif (key == u"end" or key == u"meta >" or key == u"G"
442
 
                  or key == u">"):
443
 
                pass            # xxx end-of-buffer
444
 
            elif (key == u"home" or key == u"meta <" or key == u"g"
445
 
                  or key == u"<"):
446
 
                pass            # xxx beginning-of-buffer
447
 
            elif key == u"ctrl e" or key == u"$":
448
 
                pass            # xxx move-end-of-line
449
 
            elif key == u"ctrl a" or key == u"^":
450
 
                pass            # xxx move-beginning-of-line
451
 
            elif key == u"ctrl b" or key == u"meta (" or key == u"h":
452
 
                pass            # xxx left
453
 
            elif key == u"ctrl f" or key == u"meta )" or key == u"l":
454
 
                pass            # xxx right
455
 
            elif key == u"a":
456
 
                pass            # scroll up log
457
 
            elif key == u"z":
458
 
                pass            # scroll down log
 
648
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
649
            #      or key == u">"):
 
650
            #    pass            # xxx end-of-buffer
 
651
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
652
            #      or key == u"<"):
 
653
            #    pass            # xxx beginning-of-buffer
 
654
            #elif key == u"ctrl e" or key == u"$":
 
655
            #    pass            # xxx move-end-of-line
 
656
            #elif key == u"ctrl a" or key == u"^":
 
657
            #    pass            # xxx move-beginning-of-line
 
658
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
659
            #    pass            # xxx left
 
660
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
661
            #    pass            # xxx right
 
662
            #elif key == u"a":
 
663
            #    pass            # scroll up log
 
664
            #elif key == u"z":
 
665
            #    pass            # scroll down log
459
666
            elif self.topwidget.selectable():
460
667
                self.topwidget.keypress(self.size, key)
461
668
                self.refresh()
464
671
ui = UserInterface()
465
672
try:
466
673
    ui.run()
467
 
except:
 
674
except KeyboardInterrupt:
 
675
    ui.screen.stop()
 
676
except Exception, e:
 
677
    ui.log_message(unicode(e))
468
678
    ui.screen.stop()
469
679
    raise