/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

* README: Hint that the intro(8mandos) manual page is in the server
          package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
21
 
# <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
21
23
22
# Contact the authors at <mandos@recompile.se>.
24
23
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
27
 
29
 
from future_builtins import *
30
 
 
31
28
import sys
32
29
import os
33
30
import signal
55
52
domain = 'se.recompile'
56
53
server_interface = domain + '.Mandos'
57
54
client_interface = domain + '.Mandos.Client'
58
 
version = "1.6.0"
 
55
version = "1.5.0"
59
56
 
60
57
# Always run in monochrome mode
61
58
urwid.curses_display.curses.has_colors = lambda : False
86
83
    properties and calls a hook function when any of them are
87
84
    changed.
88
85
    """
89
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
86
    def __init__(self, proxy_object=None, *args, **kwargs):
90
87
        self.proxy = proxy_object # Mandos Client proxy object
91
 
        self.properties = dict() if properties is None else properties
 
88
        
 
89
        self.properties = dict()
92
90
        self.property_changed_match = (
93
91
            self.proxy.connect_to_signal("PropertyChanged",
94
 
                                         self._property_changed,
 
92
                                         self.property_changed,
95
93
                                         client_interface,
96
94
                                         byte_arrays=True))
97
95
        
98
 
        if properties is None:
99
 
            self.properties.update(
100
 
                self.proxy.GetAll(client_interface,
101
 
                                  dbus_interface
102
 
                                  = dbus.PROPERTIES_IFACE))
103
 
        
104
 
        super(MandosClientPropertyCache, self).__init__(**kwargs)
105
 
    
106
 
    def _property_changed(self, property, value):
107
 
        """Helper which takes positional arguments"""
108
 
        return self.property_changed(property=property, value=value)
 
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)
109
103
    
110
104
    def property_changed(self, property=None, value=None):
111
105
        """This is called whenever we get a PropertyChanged signal
114
108
        # Update properties dict with new value
115
109
        self.properties[property] = value
116
110
    
117
 
    def delete(self):
 
111
    def delete(self, *args, **kwargs):
118
112
        self.property_changed_match.remove()
 
113
        super(MandosClientPropertyCache, self).__init__(
 
114
            *args, **kwargs)
119
115
 
120
116
 
121
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
123
119
    """
124
120
    
125
121
    def __init__(self, server_proxy_object=None, update_hook=None,
126
 
                 delete_hook=None, logger=None, **kwargs):
 
122
                 delete_hook=None, logger=None, *args, **kwargs):
127
123
        # Called on update
128
124
        self.update_hook = update_hook
129
125
        # Called on delete
134
130
        self.logger = logger
135
131
        
136
132
        self._update_timer_callback_tag = None
 
133
        self._update_timer_callback_lock = 0
 
134
        self.last_checker_failed = False
137
135
        
138
136
        # The widget shown normally
139
137
        self._text_widget = urwid.Text("")
140
138
        # The widget shown when we have focus
141
139
        self._focus_text_widget = urwid.Text("")
142
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
140
        super(MandosClientWidget, self).__init__(
 
141
            update_hook=update_hook, delete_hook=delete_hook,
 
142
            *args, **kwargs)
143
143
        self.update()
144
144
        self.opened = False
145
145
        
 
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
        
146
164
        self.match_objects = (
147
165
            self.proxy.connect_to_signal("CheckerCompleted",
148
166
                                         self.checker_completed,
164
182
                                         self.rejected,
165
183
                                         client_interface,
166
184
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
185
        #self.logger('Created client %s' % (self.properties["Name"]))
169
186
    
 
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
        
170
193
    def using_timer(self, flag):
171
194
        """Call this method with True or False when timer should be
172
195
        activated or deactivated.
173
196
        """
174
 
        if flag and self._update_timer_callback_tag is None:
 
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:
175
203
            # Will update the shown timer value every second
176
204
            self._update_timer_callback_tag = (gobject.timeout_add
177
205
                                               (1000,
178
206
                                                self.update_timer))
179
 
        elif not (flag or self._update_timer_callback_tag is None):
 
207
        elif old and self._update_timer_callback_lock == 0:
180
208
            gobject.source_remove(self._update_timer_callback_tag)
181
209
            self._update_timer_callback_tag = None
182
210
    
183
211
    def checker_completed(self, exitstatus, condition, command):
184
212
        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))
185
219
            self.update()
186
220
            return
187
221
        # Checker failed
 
222
        if not self.last_checker_failed:
 
223
            self.last_checker_failed = True
 
224
            self.using_timer(True)
188
225
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {0} (command "{1}")'
190
 
                        ' failed with exit code {2}'
191
 
                        .format(self.properties["Name"], command,
192
 
                                os.WEXITSTATUS(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)))
193
230
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {0} (command "{1}") was'
195
 
                        ' killed by signal {2}'
196
 
                        .format(self.properties["Name"], command,
197
 
                                os.WTERMSIG(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)))
198
235
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {0} (command "{1}")'
 
236
            self.logger('Checker for client %s (command "%s")'
200
237
                        ' dumped core'
201
 
                        .format(self.properties["Name"], command))
 
238
                        % (self.properties["Name"], command))
202
239
        else:
203
 
            self.logger('Checker for client {0} completed'
204
 
                        ' mysteriously'
205
 
                        .format(self.properties["Name"]))
 
240
            self.logger('Checker for client %s completed'
 
241
                        ' mysteriously')
206
242
        self.update()
207
243
    
208
244
    def checker_started(self, command):
209
245
        """Server signals that a checker started. This could be useful
210
246
           to log in the future. """
211
 
        #self.logger('Client {0} started checker "{1}"'
212
 
        #            .format(self.properties["Name"],
213
 
        #                    unicode(command)))
 
247
        #self.logger('Client %s started checker "%s"'
 
248
        #            % (self.properties["Name"], unicode(command)))
214
249
        pass
215
250
    
216
251
    def got_secret(self):
217
 
        self.logger('Client {0} received its secret'
218
 
                    .format(self.properties["Name"]))
 
252
        self.last_checker_failed = False
 
253
        self.logger('Client %s received its secret'
 
254
                    % self.properties["Name"])
219
255
    
220
256
    def need_approval(self, timeout, default):
221
257
        if not default:
222
 
            message = 'Client {0} needs approval within {1} seconds'
 
258
            message = 'Client %s needs approval within %s seconds'
223
259
        else:
224
 
            message = 'Client {0} will get its secret in {1} seconds'
225
 
        self.logger(message.format(self.properties["Name"],
226
 
                                   timeout/1000))
 
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)
227
264
    
228
265
    def rejected(self, reason):
229
 
        self.logger('Client {0} was rejected; reason: {1}'
230
 
                    .format(self.properties["Name"], reason))
 
266
        self.logger('Client %s was rejected; reason: %s'
 
267
                    % (self.properties["Name"], reason))
231
268
    
232
269
    def selectable(self):
233
270
        """Make this a "selectable" widget.
255
292
                          "bold-underline-blink":
256
293
                              "bold-underline-blink-standout",
257
294
                          }
258
 
        
 
295
 
259
296
        # Rebuild focus and non-focus widgets using current properties
260
 
        
 
297
 
261
298
        # Base part of a client. Name!
262
 
        base = '{name}: '.format(name=self.properties["Name"])
 
299
        base = ('%(name)s: '
 
300
                      % {"name": self.properties["Name"]})
263
301
        if not self.properties["Enabled"]:
264
302
            message = "DISABLED"
265
 
            self.using_timer(False)
266
303
        elif self.properties["ApprovalPending"]:
267
304
            timeout = datetime.timedelta(milliseconds
268
305
                                         = self.properties
270
307
            last_approval_request = isoformat_to_datetime(
271
308
                self.properties["LastApprovalRequest"])
272
309
            if last_approval_request is not None:
273
 
                timer = max(timeout - (datetime.datetime.utcnow()
274
 
                                       - last_approval_request),
275
 
                            datetime.timedelta())
 
310
                timer = timeout - (datetime.datetime.utcnow()
 
311
                                   - last_approval_request)
276
312
            else:
277
313
                timer = datetime.timedelta()
278
314
            if self.properties["ApprovedByDefault"]:
279
 
                message = "Approval in {0}. (d)eny?"
 
315
                message = "Approval in %s. (d)eny?"
280
316
            else:
281
 
                message = "Denial in {0}. (a)pprove?"
282
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
283
 
            self.using_timer(True)
284
 
        elif self.properties["LastCheckerStatus"] != 0:
285
 
            # When checker has failed, show timer until client expires
 
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
286
321
            expires = self.properties["Expires"]
287
322
            if expires == "":
288
323
                timer = datetime.timedelta(0)
289
324
            else:
290
 
                expires = (datetime.datetime.strptime
291
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
292
 
                timer = max(expires - datetime.datetime.utcnow(),
293
 
                            datetime.timedelta())
 
325
                expires = datetime.datetime.strptime(expires,
 
326
                                                     '%Y-%m-%dT%H:%M:%S.%f')
 
327
                timer = expires - datetime.datetime.utcnow()
294
328
            message = ('A checker has failed! Time until client'
295
 
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
297
 
            self.using_timer(True)
 
329
                       ' gets disabled: %s'
 
330
                           % unicode(timer).rsplit(".", 1)[0])
298
331
        else:
299
332
            message = "enabled"
300
 
            self.using_timer(False)
301
 
        self._text = "{0}{1}".format(base, message)
302
 
        
 
333
        self._text = "%s%s" % (base, message)
 
334
            
303
335
        if not urwid.supports_unicode():
304
336
            self._text = self._text.encode("ascii", "replace")
305
337
        textlist = [("normal", self._text)]
322
354
        self.update()
323
355
        return True             # Keep calling this
324
356
    
325
 
    def delete(self, **kwargs):
 
357
    def delete(self, *args, **kwargs):
326
358
        if self._update_timer_callback_tag is not None:
327
359
            gobject.source_remove(self._update_timer_callback_tag)
328
360
            self._update_timer_callback_tag = None
331
363
        self.match_objects = ()
332
364
        if self.delete_hook is not None:
333
365
            self.delete_hook(self)
334
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
366
        return super(MandosClientWidget, self).delete(*args, **kwargs)
335
367
    
336
368
    def render(self, maxcolrow, focus=False):
337
369
        """Render differently if we have focus.
379
411
        else:
380
412
            return key
381
413
    
382
 
    def property_changed(self, property=None, **kwargs):
 
414
    def property_changed(self, property=None, value=None,
 
415
                         *args, **kwargs):
383
416
        """Call self.update() if old value is not new value.
384
417
        This overrides the method from MandosClientPropertyCache"""
385
418
        property_name = unicode(property)
386
419
        old_value = self.properties.get(property_name)
387
420
        super(MandosClientWidget, self).property_changed(
388
 
            property=property, **kwargs)
 
421
            property=property, value=value, *args, **kwargs)
389
422
        if self.properties.get(property_name) != old_value:
390
423
            self.update()
391
424
 
395
428
    "down" key presses, thus not allowing any containing widgets to
396
429
    use them as an excuse to shift focus away from this widget.
397
430
    """
398
 
    def keypress(self, *args, **kwargs):
399
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
431
    def keypress(self, maxcolrow, key):
 
432
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
400
433
        if ret in ("up", "down"):
401
434
            return
402
435
        return ret
468
501
        self.main_loop = gobject.MainLoop()
469
502
    
470
503
    def client_not_found(self, fingerprint, address):
471
 
        self.log_message("Client with address {0} and fingerprint"
472
 
                         " {1} could not be found"
473
 
                         .format(address, fingerprint))
 
504
        self.log_message(("Client with address %s and fingerprint %s"
 
505
                          " could not be found" % (address,
 
506
                                                    fingerprint)))
474
507
    
475
508
    def rebuild(self):
476
509
        """This rebuilds the User Interface.
489
522
        self.topwidget = urwid.Pile(self.uilist)
490
523
    
491
524
    def log_message(self, message):
492
 
        """Log message formatted with timestamp"""
493
525
        timestamp = datetime.datetime.now().isoformat()
494
526
        self.log_message_raw(timestamp + ": " + message)
495
527
    
530
562
            client = self.clients_dict[path]
531
563
        except KeyError:
532
564
            # not found?
533
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
534
 
                             .format(name, path))
 
565
            self.log_message("Unknown client %r (%r) removed", name,
 
566
                             path)
535
567
            return
536
568
        client.delete()
537
569
    
585
617
        try:
586
618
            mandos_clients = (self.mandos_serv
587
619
                              .GetAllClientsWithProperties())
588
 
            if not mandos_clients:
589
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
590
620
        except dbus.exceptions.DBusException:
591
 
            self.log_message_raw(("bold", "Note: No Mandos servers running."))
592
621
            mandos_clients = dbus.Dictionary()
593
622
        
594
623
        (self.mandos_serv
621
650
                                               logger
622
651
                                               =self.log_message),
623
652
                            path=path)
624
 
        
 
653
 
625
654
        self.refresh()
626
655
        self._input_callback_tag = (gobject.io_add_watch
627
656
                                    (sys.stdin.fileno(),