/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

  • Committer: Teddy Hogeborn
  • Date: 2009-01-20 02:23:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090120022359-0go4voqdz5pxc1pu
* mandos (Client.CheckerCompleted): Changed signature to "nxs"; return
                                    exitstatus and waitstatus, not
                                    just a bool and waitstatus.  All
                                    emitters changed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
11
11
# and some lines in "main".
12
12
# 
13
13
# Everything else is
14
 
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
 
14
# Copyright © 2008,2009 Teddy Hogeborn
 
15
# Copyright © 2008,2009 Björn Påhlsson
15
16
# 
16
17
# This program is free software: you can redistribute it and/or modify
17
18
# it under the terms of the GNU General Public License as published by
30
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
32
# 
32
33
 
33
 
from __future__ import division
 
34
from __future__ import division, with_statement, absolute_import
34
35
 
35
36
import SocketServer
36
37
import socket
37
 
from optparse import OptionParser
 
38
import optparse
38
39
import datetime
39
40
import errno
40
41
import gnutls.crypto
55
56
import logging
56
57
import logging.handlers
57
58
import pwd
 
59
from contextlib import closing
58
60
 
59
61
import dbus
 
62
import dbus.service
60
63
import gobject
61
64
import avahi
62
65
from dbus.mainloop.glib import DBusGMainLoop
63
66
import ctypes
64
67
import ctypes.util
65
68
 
66
 
version = "1.0"
 
69
version = "1.0.5"
67
70
 
68
71
logger = logging.Logger('mandos')
69
 
syslogger = logging.handlers.SysLogHandler\
70
 
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
71
 
             address = "/dev/log")
72
 
syslogger.setFormatter(logging.Formatter\
73
 
                        ('Mandos: %(levelname)s: %(message)s'))
 
72
syslogger = (logging.handlers.SysLogHandler
 
73
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
74
              address = "/dev/log"))
 
75
syslogger.setFormatter(logging.Formatter
 
76
                       ('Mandos: %(levelname)s: %(message)s'))
74
77
logger.addHandler(syslogger)
75
78
 
76
79
console = logging.StreamHandler()
79
82
logger.addHandler(console)
80
83
 
81
84
class AvahiError(Exception):
82
 
    def __init__(self, value):
 
85
    def __init__(self, value, *args, **kwargs):
83
86
        self.value = value
84
 
        super(AvahiError, self).__init__()
85
 
    def __str__(self):
86
 
        return repr(self.value)
 
87
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
88
    def __unicode__(self):
 
89
        return unicode(repr(self.value))
87
90
 
88
91
class AvahiServiceError(AvahiError):
89
92
    pass
109
112
                  a sensible number of times
110
113
    """
111
114
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
112
 
                 servicetype = None, port = None, TXT = None, domain = "",
113
 
                 host = "", max_renames = 32768):
 
115
                 servicetype = None, port = None, TXT = None,
 
116
                 domain = "", host = "", max_renames = 32768):
114
117
        self.interface = interface
115
118
        self.name = name
116
119
        self.type = servicetype
117
120
        self.port = port
118
 
        if TXT is None:
119
 
            self.TXT = []
120
 
        else:
121
 
            self.TXT = TXT
 
121
        self.TXT = TXT if TXT is not None else []
122
122
        self.domain = domain
123
123
        self.host = host
124
124
        self.rename_count = 0
129
129
            logger.critical(u"No suitable Zeroconf service name found"
130
130
                            u" after %i retries, exiting.",
131
131
                            self.rename_count)
132
 
            raise AvahiServiceError("Too many renames")
 
132
            raise AvahiServiceError(u"Too many renames")
133
133
        self.name = server.GetAlternativeServiceName(self.name)
134
134
        logger.info(u"Changing Zeroconf service name to %r ...",
135
135
                    str(self.name))
136
 
        syslogger.setFormatter(logging.Formatter\
 
136
        syslogger.setFormatter(logging.Formatter
137
137
                               ('Mandos (%s): %%(levelname)s:'
138
 
                               ' %%(message)s' % self.name))
 
138
                                ' %%(message)s' % self.name))
139
139
        self.remove()
140
140
        self.add()
141
141
        self.rename_count += 1
147
147
        """Derived from the Avahi example code"""
148
148
        global group
149
149
        if group is None:
150
 
            group = dbus.Interface\
151
 
                    (bus.get_object(avahi.DBUS_NAME,
 
150
            group = dbus.Interface(bus.get_object
 
151
                                   (avahi.DBUS_NAME,
152
152
                                    server.EntryGroupNew()),
153
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
153
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
154
            group.connect_to_signal('StateChanged',
155
155
                                    entry_group_state_changed)
156
156
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
170
170
# End of Avahi example code
171
171
 
172
172
 
173
 
class Client(object):
 
173
def _datetime_to_dbus(dt, variant_level=0):
 
174
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
175
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
176
 
 
177
 
 
178
class Client(dbus.service.Object):
174
179
    """A representation of a client host served by this server.
175
180
    Attributes:
176
 
    name:      string; from the config file, used in log messages
 
181
    name:       string; from the config file, used in log messages and
 
182
                        D-Bus identifiers
177
183
    fingerprint: string (40 or 32 hexadecimal digits); used to
178
184
                 uniquely identify the client
179
 
    secret:    bytestring; sent verbatim (over TLS) to client
180
 
    host:      string; available for use by the checker command
181
 
    created:   datetime.datetime(); object creation, not client host
182
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
183
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
184
 
                                     until this client is invalid
185
 
    interval:  datetime.timedelta(); How often to start a new checker
186
 
    stop_hook: If set, called by stop() as stop_hook(self)
187
 
    checker:   subprocess.Popen(); a running checker process used
188
 
                                   to see if the client lives.
189
 
                                   'None' if no process is running.
 
185
    secret:     bytestring; sent verbatim (over TLS) to client
 
186
    host:       string; available for use by the checker command
 
187
    created:    datetime.datetime(); (UTC) object creation
 
188
    last_enabled: datetime.datetime(); (UTC)
 
189
    enabled:    bool()
 
190
    last_checked_ok: datetime.datetime(); (UTC) or None
 
191
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
192
                                      until this client is invalid
 
193
    interval:   datetime.timedelta(); How often to start a new checker
 
194
    disable_hook:  If set, called by disable() as disable_hook(self)
 
195
    checker:    subprocess.Popen(); a running checker process used
 
196
                                    to see if the client lives.
 
197
                                    'None' if no process is running.
190
198
    checker_initiator_tag: a gobject event source tag, or None
191
 
    stop_initiator_tag:    - '' -
 
199
    disable_initiator_tag:    - '' -
192
200
    checker_callback_tag:  - '' -
193
201
    checker_command: string; External command which is run to check if
194
202
                     client lives.  %() expansions are done at
195
203
                     runtime with vars(self) as dict, so that for
196
204
                     instance %(name)s can be used in the command.
197
 
    Private attibutes:
198
 
    _timeout: Real variable for 'timeout'
199
 
    _interval: Real variable for 'interval'
200
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
201
 
    _interval_milliseconds: - '' -
 
205
    use_dbus: bool(); Whether to provide D-Bus interface and signals
 
206
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
202
207
    """
203
 
    def _set_timeout(self, timeout):
204
 
        "Setter function for 'timeout' attribute"
205
 
        self._timeout = timeout
206
 
        self._timeout_milliseconds = ((self.timeout.days
207
 
                                       * 24 * 60 * 60 * 1000)
208
 
                                      + (self.timeout.seconds * 1000)
209
 
                                      + (self.timeout.microseconds
210
 
                                         // 1000))
211
 
    timeout = property(lambda self: self._timeout,
212
 
                       _set_timeout)
213
 
    del _set_timeout
214
 
    def _set_interval(self, interval):
215
 
        "Setter function for 'interval' attribute"
216
 
        self._interval = interval
217
 
        self._interval_milliseconds = ((self.interval.days
218
 
                                        * 24 * 60 * 60 * 1000)
219
 
                                       + (self.interval.seconds
220
 
                                          * 1000)
221
 
                                       + (self.interval.microseconds
222
 
                                          // 1000))
223
 
    interval = property(lambda self: self._interval,
224
 
                        _set_interval)
225
 
    del _set_interval
226
 
    def __init__(self, name = None, stop_hook=None, config=None):
 
208
    def timeout_milliseconds(self):
 
209
        "Return the 'timeout' attribute in milliseconds"
 
210
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
 
211
                + (self.timeout.seconds * 1000)
 
212
                + (self.timeout.microseconds // 1000))
 
213
    
 
214
    def interval_milliseconds(self):
 
215
        "Return the 'interval' attribute in milliseconds"
 
216
        return ((self.interval.days * 24 * 60 * 60 * 1000)
 
217
                + (self.interval.seconds * 1000)
 
218
                + (self.interval.microseconds // 1000))
 
219
    
 
220
    def __init__(self, name = None, disable_hook=None, config=None,
 
221
                 use_dbus=True):
227
222
        """Note: the 'checker' key in 'config' sets the
228
223
        'checker_command' attribute and *not* the 'checker'
229
224
        attribute."""
 
225
        self.name = name
230
226
        if config is None:
231
227
            config = {}
232
 
        self.name = name
233
228
        logger.debug(u"Creating client %r", self.name)
 
229
        self.use_dbus = False   # During __init__
234
230
        # Uppercase and remove spaces from fingerprint for later
235
231
        # comparison purposes with return value from the fingerprint()
236
232
        # function
237
 
        self.fingerprint = config["fingerprint"].upper()\
238
 
                           .replace(u" ", u"")
 
233
        self.fingerprint = (config["fingerprint"].upper()
 
234
                            .replace(u" ", u""))
239
235
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
240
236
        if "secret" in config:
241
237
            self.secret = config["secret"].decode(u"base64")
242
238
        elif "secfile" in config:
243
 
            secfile = open(os.path.expanduser(os.path.expandvars
244
 
                                              (config["secfile"])))
245
 
            self.secret = secfile.read()
246
 
            secfile.close()
 
239
            with closing(open(os.path.expanduser
 
240
                              (os.path.expandvars
 
241
                               (config["secfile"])))) as secfile:
 
242
                self.secret = secfile.read()
247
243
        else:
248
244
            raise TypeError(u"No secret or secfile for client %s"
249
245
                            % self.name)
250
246
        self.host = config.get("host", "")
251
 
        self.created = datetime.datetime.now()
 
247
        self.created = datetime.datetime.utcnow()
 
248
        self.enabled = False
 
249
        self.last_enabled = None
252
250
        self.last_checked_ok = None
253
251
        self.timeout = string_to_delta(config["timeout"])
254
252
        self.interval = string_to_delta(config["interval"])
255
 
        self.stop_hook = stop_hook
 
253
        self.disable_hook = disable_hook
256
254
        self.checker = None
257
255
        self.checker_initiator_tag = None
258
 
        self.stop_initiator_tag = None
 
256
        self.disable_initiator_tag = None
259
257
        self.checker_callback_tag = None
260
 
        self.check_command = config["checker"]
261
 
    def start(self):
 
258
        self.checker_command = config["checker"]
 
259
        self.last_connect = None
 
260
        # Only now, when this client is initialized, can it show up on
 
261
        # the D-Bus
 
262
        self.use_dbus = use_dbus
 
263
        if self.use_dbus:
 
264
            self.dbus_object_path = (dbus.ObjectPath
 
265
                                     ("/clients/"
 
266
                                      + self.name.replace(".", "_")))
 
267
            dbus.service.Object.__init__(self, bus,
 
268
                                         self.dbus_object_path)
 
269
    
 
270
    def enable(self):
262
271
        """Start this client's checker and timeout hooks"""
 
272
        self.last_enabled = datetime.datetime.utcnow()
263
273
        # Schedule a new checker to be started an 'interval' from now,
264
274
        # and every interval from then on.
265
 
        self.checker_initiator_tag = gobject.timeout_add\
266
 
                                     (self._interval_milliseconds,
267
 
                                      self.start_checker)
 
275
        self.checker_initiator_tag = (gobject.timeout_add
 
276
                                      (self.interval_milliseconds(),
 
277
                                       self.start_checker))
268
278
        # Also start a new checker *right now*.
269
279
        self.start_checker()
270
 
        # Schedule a stop() when 'timeout' has passed
271
 
        self.stop_initiator_tag = gobject.timeout_add\
272
 
                                  (self._timeout_milliseconds,
273
 
                                   self.stop)
274
 
    def stop(self):
275
 
        """Stop this client.
276
 
        The possibility that a client might be restarted is left open,
277
 
        but not currently used."""
278
 
        # If this client doesn't have a secret, it is already stopped.
279
 
        if hasattr(self, "secret") and self.secret:
280
 
            logger.info(u"Stopping client %s", self.name)
281
 
            self.secret = None
282
 
        else:
 
280
        # Schedule a disable() when 'timeout' has passed
 
281
        self.disable_initiator_tag = (gobject.timeout_add
 
282
                                   (self.timeout_milliseconds(),
 
283
                                    self.disable))
 
284
        self.enabled = True
 
285
        if self.use_dbus:
 
286
            # Emit D-Bus signals
 
287
            self.PropertyChanged(dbus.String(u"enabled"),
 
288
                                 dbus.Boolean(True, variant_level=1))
 
289
            self.PropertyChanged(dbus.String(u"last_enabled"),
 
290
                                 (_datetime_to_dbus(self.last_enabled,
 
291
                                                    variant_level=1)))
 
292
    
 
293
    def disable(self):
 
294
        """Disable this client."""
 
295
        if not getattr(self, "enabled", False):
283
296
            return False
284
 
        if getattr(self, "stop_initiator_tag", False):
285
 
            gobject.source_remove(self.stop_initiator_tag)
286
 
            self.stop_initiator_tag = None
 
297
        logger.info(u"Disabling client %s", self.name)
 
298
        if getattr(self, "disable_initiator_tag", False):
 
299
            gobject.source_remove(self.disable_initiator_tag)
 
300
            self.disable_initiator_tag = None
287
301
        if getattr(self, "checker_initiator_tag", False):
288
302
            gobject.source_remove(self.checker_initiator_tag)
289
303
            self.checker_initiator_tag = None
290
304
        self.stop_checker()
291
 
        if self.stop_hook:
292
 
            self.stop_hook(self)
 
305
        if self.disable_hook:
 
306
            self.disable_hook(self)
 
307
        self.enabled = False
 
308
        if self.use_dbus:
 
309
            # Emit D-Bus signal
 
310
            self.PropertyChanged(dbus.String(u"enabled"),
 
311
                                 dbus.Boolean(False, variant_level=1))
293
312
        # Do not run this again if called by a gobject.timeout_add
294
313
        return False
 
314
    
295
315
    def __del__(self):
296
 
        self.stop_hook = None
297
 
        self.stop()
298
 
    def checker_callback(self, pid, condition):
 
316
        self.disable_hook = None
 
317
        self.disable()
 
318
    
 
319
    def checker_callback(self, pid, condition, command):
299
320
        """The checker has completed, so take appropriate actions."""
300
 
        now = datetime.datetime.now()
301
321
        self.checker_callback_tag = None
302
322
        self.checker = None
303
 
        if os.WIFEXITED(condition) \
304
 
               and (os.WEXITSTATUS(condition) == 0):
305
 
            logger.info(u"Checker for %(name)s succeeded",
306
 
                        vars(self))
307
 
            self.last_checked_ok = now
308
 
            gobject.source_remove(self.stop_initiator_tag)
309
 
            self.stop_initiator_tag = gobject.timeout_add\
310
 
                                      (self._timeout_milliseconds,
311
 
                                       self.stop)
312
 
        elif not os.WIFEXITED(condition):
 
323
        if self.use_dbus:
 
324
            # Emit D-Bus signal
 
325
            self.PropertyChanged(dbus.String(u"checker_running"),
 
326
                                 dbus.Boolean(False, variant_level=1))
 
327
        if os.WIFEXITED(condition):
 
328
            exitstatus = os.WEXITSTATUS(condition)
 
329
            if exitstatus == 0:
 
330
                logger.info(u"Checker for %(name)s succeeded",
 
331
                            vars(self))
 
332
                self.bump_timeout()
 
333
            else:
 
334
                logger.info(u"Checker for %(name)s failed",
 
335
                            vars(self))
 
336
            if self.use_dbus:
 
337
                # Emit D-Bus signal
 
338
                self.CheckerCompleted(dbus.Int16(exitstatus),
 
339
                                      dbus.Int64(condition),
 
340
                                      dbus.String(command))
 
341
        else:
313
342
            logger.warning(u"Checker for %(name)s crashed?",
314
343
                           vars(self))
315
 
        else:
316
 
            logger.info(u"Checker for %(name)s failed",
317
 
                        vars(self))
 
344
            if self.use_dbus:
 
345
                # Emit D-Bus signal
 
346
                self.CheckerCompleted(dbus.Int16(-1),
 
347
                                      dbus.Int64(condition),
 
348
                                      dbus.String(command))
 
349
    
 
350
    def bump_timeout(self):
 
351
        """Bump up the timeout for this client.
 
352
        This should only be called when the client has been seen,
 
353
        alive and well.
 
354
        """
 
355
        self.last_checked_ok = datetime.datetime.utcnow()
 
356
        gobject.source_remove(self.disable_initiator_tag)
 
357
        self.disable_initiator_tag = (gobject.timeout_add
 
358
                                      (self.timeout_milliseconds(),
 
359
                                       self.disable))
 
360
        if self.use_dbus:
 
361
            # Emit D-Bus signal
 
362
            self.PropertyChanged(
 
363
                dbus.String(u"last_checked_ok"),
 
364
                (_datetime_to_dbus(self.last_checked_ok,
 
365
                                   variant_level=1)))
 
366
    
318
367
    def start_checker(self):
319
368
        """Start a new checker subprocess if one is not running.
320
369
        If a checker already exists, leave it running and do
329
378
        # is as it should be.
330
379
        if self.checker is None:
331
380
            try:
332
 
                # In case check_command has exactly one % operator
333
 
                command = self.check_command % self.host
 
381
                # In case checker_command has exactly one % operator
 
382
                command = self.checker_command % self.host
334
383
            except TypeError:
335
384
                # Escape attributes for the shell
336
385
                escaped_attrs = dict((key, re.escape(str(val)))
337
386
                                     for key, val in
338
387
                                     vars(self).iteritems())
339
388
                try:
340
 
                    command = self.check_command % escaped_attrs
 
389
                    command = self.checker_command % escaped_attrs
341
390
                except TypeError, error:
342
391
                    logger.error(u'Could not format string "%s":'
343
 
                                 u' %s', self.check_command, error)
 
392
                                 u' %s', self.checker_command, error)
344
393
                    return True # Try again later
345
394
            try:
346
395
                logger.info(u"Starting checker %r for %s",
352
401
                self.checker = subprocess.Popen(command,
353
402
                                                close_fds=True,
354
403
                                                shell=True, cwd="/")
355
 
                self.checker_callback_tag = gobject.child_watch_add\
356
 
                                            (self.checker.pid,
357
 
                                             self.checker_callback)
 
404
                if self.use_dbus:
 
405
                    # Emit D-Bus signal
 
406
                    self.CheckerStarted(command)
 
407
                    self.PropertyChanged(
 
408
                        dbus.String("checker_running"),
 
409
                        dbus.Boolean(True, variant_level=1))
 
410
                self.checker_callback_tag = (gobject.child_watch_add
 
411
                                             (self.checker.pid,
 
412
                                              self.checker_callback,
 
413
                                              data=command))
358
414
            except OSError, error:
359
415
                logger.error(u"Failed to start subprocess: %s",
360
416
                             error)
361
417
        # Re-run this periodically if run by gobject.timeout_add
362
418
        return True
 
419
    
363
420
    def stop_checker(self):
364
421
        """Force the checker process, if any, to stop."""
365
422
        if self.checker_callback_tag:
377
434
            if error.errno != errno.ESRCH: # No such process
378
435
                raise
379
436
        self.checker = None
 
437
        if self.use_dbus:
 
438
            self.PropertyChanged(dbus.String(u"checker_running"),
 
439
                                 dbus.Boolean(False, variant_level=1))
 
440
    
380
441
    def still_valid(self):
381
442
        """Has the timeout not yet passed for this client?"""
382
 
        now = datetime.datetime.now()
 
443
        if not getattr(self, "enabled", False):
 
444
            return False
 
445
        now = datetime.datetime.utcnow()
383
446
        if self.last_checked_ok is None:
384
447
            return now < (self.created + self.timeout)
385
448
        else:
386
449
            return now < (self.last_checked_ok + self.timeout)
 
450
    
 
451
    ## D-Bus methods & signals
 
452
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
453
    
 
454
    # BumpTimeout - method
 
455
    BumpTimeout = dbus.service.method(_interface)(bump_timeout)
 
456
    BumpTimeout.__name__ = "BumpTimeout"
 
457
    
 
458
    # CheckerCompleted - signal
 
459
    @dbus.service.signal(_interface, signature="nxs")
 
460
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
461
        "D-Bus signal"
 
462
        pass
 
463
    
 
464
    # CheckerStarted - signal
 
465
    @dbus.service.signal(_interface, signature="s")
 
466
    def CheckerStarted(self, command):
 
467
        "D-Bus signal"
 
468
        pass
 
469
    
 
470
    # GetAllProperties - method
 
471
    @dbus.service.method(_interface, out_signature="a{sv}")
 
472
    def GetAllProperties(self):
 
473
        "D-Bus method"
 
474
        return dbus.Dictionary({
 
475
                dbus.String("name"):
 
476
                    dbus.String(self.name, variant_level=1),
 
477
                dbus.String("fingerprint"):
 
478
                    dbus.String(self.fingerprint, variant_level=1),
 
479
                dbus.String("host"):
 
480
                    dbus.String(self.host, variant_level=1),
 
481
                dbus.String("created"):
 
482
                    _datetime_to_dbus(self.created, variant_level=1),
 
483
                dbus.String("last_enabled"):
 
484
                    (_datetime_to_dbus(self.last_enabled,
 
485
                                       variant_level=1)
 
486
                     if self.last_enabled is not None
 
487
                     else dbus.Boolean(False, variant_level=1)),
 
488
                dbus.String("enabled"):
 
489
                    dbus.Boolean(self.enabled, variant_level=1),
 
490
                dbus.String("last_checked_ok"):
 
491
                    (_datetime_to_dbus(self.last_checked_ok,
 
492
                                       variant_level=1)
 
493
                     if self.last_checked_ok is not None
 
494
                     else dbus.Boolean (False, variant_level=1)),
 
495
                dbus.String("timeout"):
 
496
                    dbus.UInt64(self.timeout_milliseconds(),
 
497
                                variant_level=1),
 
498
                dbus.String("interval"):
 
499
                    dbus.UInt64(self.interval_milliseconds(),
 
500
                                variant_level=1),
 
501
                dbus.String("checker"):
 
502
                    dbus.String(self.checker_command,
 
503
                                variant_level=1),
 
504
                dbus.String("checker_running"):
 
505
                    dbus.Boolean(self.checker is not None,
 
506
                                 variant_level=1),
 
507
                dbus.String("object_path"):
 
508
                    dbus.ObjectPath(self.dbus_object_path,
 
509
                                    variant_level=1)
 
510
                }, signature="sv")
 
511
    
 
512
    # IsStillValid - method
 
513
    IsStillValid = (dbus.service.method(_interface, out_signature="b")
 
514
                    (still_valid))
 
515
    IsStillValid.__name__ = "IsStillValid"
 
516
    
 
517
    # PropertyChanged - signal
 
518
    @dbus.service.signal(_interface, signature="sv")
 
519
    def PropertyChanged(self, property, value):
 
520
        "D-Bus signal"
 
521
        pass
 
522
    
 
523
    # SetChecker - method
 
524
    @dbus.service.method(_interface, in_signature="s")
 
525
    def SetChecker(self, checker):
 
526
        "D-Bus setter method"
 
527
        self.checker_command = checker
 
528
        # Emit D-Bus signal
 
529
        self.PropertyChanged(dbus.String(u"checker"),
 
530
                             dbus.String(self.checker_command,
 
531
                                         variant_level=1))
 
532
    
 
533
    # SetHost - method
 
534
    @dbus.service.method(_interface, in_signature="s")
 
535
    def SetHost(self, host):
 
536
        "D-Bus setter method"
 
537
        self.host = host
 
538
        # Emit D-Bus signal
 
539
        self.PropertyChanged(dbus.String(u"host"),
 
540
                             dbus.String(self.host, variant_level=1))
 
541
    
 
542
    # SetInterval - method
 
543
    @dbus.service.method(_interface, in_signature="t")
 
544
    def SetInterval(self, milliseconds):
 
545
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
 
546
        # Emit D-Bus signal
 
547
        self.PropertyChanged(dbus.String(u"interval"),
 
548
                             (dbus.UInt64(self.interval_milliseconds(),
 
549
                                          variant_level=1)))
 
550
    
 
551
    # SetSecret - method
 
552
    @dbus.service.method(_interface, in_signature="ay",
 
553
                         byte_arrays=True)
 
554
    def SetSecret(self, secret):
 
555
        "D-Bus setter method"
 
556
        self.secret = str(secret)
 
557
    
 
558
    # SetTimeout - method
 
559
    @dbus.service.method(_interface, in_signature="t")
 
560
    def SetTimeout(self, milliseconds):
 
561
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
 
562
        # Emit D-Bus signal
 
563
        self.PropertyChanged(dbus.String(u"timeout"),
 
564
                             (dbus.UInt64(self.timeout_milliseconds(),
 
565
                                          variant_level=1)))
 
566
    
 
567
    # Enable - method
 
568
    Enable = dbus.service.method(_interface)(enable)
 
569
    Enable.__name__ = "Enable"
 
570
    
 
571
    # StartChecker - method
 
572
    @dbus.service.method(_interface)
 
573
    def StartChecker(self):
 
574
        "D-Bus method"
 
575
        self.start_checker()
 
576
    
 
577
    # Disable - method
 
578
    @dbus.service.method(_interface)
 
579
    def Disable(self):
 
580
        "D-Bus method"
 
581
        self.disable()
 
582
    
 
583
    # StopChecker - method
 
584
    StopChecker = dbus.service.method(_interface)(stop_checker)
 
585
    StopChecker.__name__ = "StopChecker"
 
586
    
 
587
    del _interface
387
588
 
388
589
 
389
590
def peer_certificate(session):
390
591
    "Return the peer's OpenPGP certificate as a bytestring"
391
592
    # If not an OpenPGP certificate...
392
 
    if gnutls.library.functions.gnutls_certificate_type_get\
393
 
            (session._c_object) \
394
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
593
    if (gnutls.library.functions
 
594
        .gnutls_certificate_type_get(session._c_object)
 
595
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
395
596
        # ...do the normal thing
396
597
        return session.peer_certificate
397
598
    list_size = ctypes.c_uint()
398
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
399
 
        (session._c_object, ctypes.byref(list_size))
 
599
    cert_list = (gnutls.library.functions
 
600
                 .gnutls_certificate_get_peers
 
601
                 (session._c_object, ctypes.byref(list_size)))
400
602
    if list_size.value == 0:
401
603
        return None
402
604
    cert = cert_list[0]
406
608
def fingerprint(openpgp):
407
609
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
408
610
    # New GnuTLS "datum" with the OpenPGP public key
409
 
    datum = gnutls.library.types.gnutls_datum_t\
410
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
411
 
                     ctypes.POINTER(ctypes.c_ubyte)),
412
 
         ctypes.c_uint(len(openpgp)))
 
611
    datum = (gnutls.library.types
 
612
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
613
                                         ctypes.POINTER
 
614
                                         (ctypes.c_ubyte)),
 
615
                             ctypes.c_uint(len(openpgp))))
413
616
    # New empty GnuTLS certificate
414
617
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
415
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
416
 
        (ctypes.byref(crt))
 
618
    (gnutls.library.functions
 
619
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
417
620
    # Import the OpenPGP public key into the certificate
418
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
419
 
                    (crt, ctypes.byref(datum),
420
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
621
    (gnutls.library.functions
 
622
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
623
                                gnutls.library.constants
 
624
                                .GNUTLS_OPENPGP_FMT_RAW))
421
625
    # Verify the self signature in the key
422
626
    crtverify = ctypes.c_uint()
423
 
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
424
 
        (crt, 0, ctypes.byref(crtverify))
 
627
    (gnutls.library.functions
 
628
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
425
629
    if crtverify.value != 0:
426
630
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
427
631
        raise gnutls.errors.CertificateSecurityError("Verify failed")
429
633
    buf = ctypes.create_string_buffer(20)
430
634
    buf_len = ctypes.c_size_t()
431
635
    # Get the fingerprint from the certificate into the buffer
432
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
433
 
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
636
    (gnutls.library.functions
 
637
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
638
                                         ctypes.byref(buf_len)))
434
639
    # Deinit the certificate
435
640
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
436
641
    # Convert the buffer to a Python bytestring
447
652
    
448
653
    def handle(self):
449
654
        logger.info(u"TCP connection from: %s",
450
 
                     unicode(self.client_address))
451
 
        session = gnutls.connection.ClientSession\
452
 
                  (self.request, gnutls.connection.X509Credentials())
 
655
                    unicode(self.client_address))
 
656
        session = (gnutls.connection
 
657
                   .ClientSession(self.request,
 
658
                                  gnutls.connection
 
659
                                  .X509Credentials()))
453
660
        
454
661
        line = self.request.makefile().readline()
455
662
        logger.debug(u"Protocol version: %r", line)
468
675
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
469
676
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
470
677
        #                "+DHE-DSS"))
471
 
        priority = "NORMAL"             # Fallback default, since this
472
 
                                        # MUST be set.
473
 
        if self.server.settings["priority"]:
474
 
            priority = self.server.settings["priority"]
475
 
        gnutls.library.functions.gnutls_priority_set_direct\
476
 
            (session._c_object, priority, None)
 
678
        # Use a fallback default, since this MUST be set.
 
679
        priority = self.server.settings.get("priority", "NORMAL")
 
680
        (gnutls.library.functions
 
681
         .gnutls_priority_set_direct(session._c_object,
 
682
                                     priority, None))
477
683
        
478
684
        try:
479
685
            session.handshake()
489
695
            session.bye()
490
696
            return
491
697
        logger.debug(u"Fingerprint: %s", fpr)
492
 
        client = None
493
698
        for c in self.server.clients:
494
699
            if c.fingerprint == fpr:
495
700
                client = c
496
701
                break
497
 
        if not client:
 
702
        else:
498
703
            logger.warning(u"Client not found for fingerprint: %s",
499
704
                           fpr)
500
705
            session.bye()
507
712
                           vars(client))
508
713
            session.bye()
509
714
            return
 
715
        ## This won't work here, since we're in a fork.
 
716
        # client.bump_timeout()
510
717
        sent_size = 0
511
718
        while sent_size < len(client.secret):
512
719
            sent = session.send(client.secret[sent_size:])
517
724
        session.bye()
518
725
 
519
726
 
520
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
727
class IPv6_TCPServer(SocketServer.ForkingMixIn,
 
728
                     SocketServer.TCPServer, object):
521
729
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
522
730
    Attributes:
523
731
        settings:       Server settings
636
844
    elif state == avahi.ENTRY_GROUP_FAILURE:
637
845
        logger.critical(u"Avahi: Error in group state changed %s",
638
846
                        unicode(error))
639
 
        raise AvahiGroupError("State changed: %s", str(error))
 
847
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
640
848
 
641
849
def if_nametoindex(interface):
642
850
    """Call the C function if_nametoindex(), or equivalent"""
643
851
    global if_nametoindex
644
852
    try:
645
 
        if_nametoindex = ctypes.cdll.LoadLibrary\
646
 
            (ctypes.util.find_library("c")).if_nametoindex
 
853
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
854
                          (ctypes.util.find_library("c"))
 
855
                          .if_nametoindex)
647
856
    except (OSError, AttributeError):
648
857
        if "struct" not in sys.modules:
649
858
            import struct
652
861
        def if_nametoindex(interface):
653
862
            "Get an interface index the hard way, i.e. using fcntl()"
654
863
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
655
 
            s = socket.socket()
656
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
657
 
                                struct.pack("16s16x", interface))
658
 
            s.close()
 
864
            with closing(socket.socket()) as s:
 
865
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
866
                                    struct.pack("16s16x", interface))
659
867
            interface_index = struct.unpack("I", ifreq[16:20])[0]
660
868
            return interface_index
661
869
    return if_nametoindex(interface)
685
893
 
686
894
 
687
895
def main():
688
 
    parser = OptionParser(version = "%%prog %s" % version)
 
896
    parser = optparse.OptionParser(version = "%%prog %s" % version)
689
897
    parser.add_option("-i", "--interface", type="string",
690
898
                      metavar="IF", help="Bind to interface IF")
691
899
    parser.add_option("-a", "--address", type="string",
692
900
                      help="Address to listen for requests on")
693
901
    parser.add_option("-p", "--port", type="int",
694
902
                      help="Port number to receive requests on")
695
 
    parser.add_option("--check", action="store_true", default=False,
 
903
    parser.add_option("--check", action="store_true",
696
904
                      help="Run self-test")
697
905
    parser.add_option("--debug", action="store_true",
698
906
                      help="Debug mode; run in foreground and log to"
705
913
                      default="/etc/mandos", metavar="DIR",
706
914
                      help="Directory to search for configuration"
707
915
                      " files")
 
916
    parser.add_option("--no-dbus", action="store_false",
 
917
                      dest="use_dbus",
 
918
                      help="Do not provide D-Bus system bus"
 
919
                      " interface")
708
920
    options = parser.parse_args()[0]
709
921
    
710
922
    if options.check:
720
932
                        "priority":
721
933
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
722
934
                        "servicename": "Mandos",
 
935
                        "use_dbus": "True",
723
936
                        }
724
937
    
725
938
    # Parse config file for server-global settings
728
941
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
729
942
    # Convert the SafeConfigParser object to a dict
730
943
    server_settings = server_config.defaults()
731
 
    # Use getboolean on the boolean config option
732
 
    server_settings["debug"] = server_config.getboolean\
733
 
                               ("DEFAULT", "debug")
 
944
    # Use getboolean on the boolean config options
 
945
    server_settings["debug"] = (server_config.getboolean
 
946
                                ("DEFAULT", "debug"))
 
947
    server_settings["use_dbus"] = (server_config.getboolean
 
948
                                   ("DEFAULT", "use_dbus"))
734
949
    del server_config
735
950
    
736
951
    # Override the settings from the config file with command line
737
952
    # options, if set.
738
953
    for option in ("interface", "address", "port", "debug",
739
 
                   "priority", "servicename", "configdir"):
 
954
                   "priority", "servicename", "configdir",
 
955
                   "use_dbus"):
740
956
        value = getattr(options, option)
741
957
        if value is not None:
742
958
            server_settings[option] = value
743
959
    del options
744
960
    # Now we have our good server settings in "server_settings"
745
961
    
 
962
    # For convenience
746
963
    debug = server_settings["debug"]
 
964
    use_dbus = server_settings["use_dbus"]
747
965
    
748
966
    if not debug:
749
967
        syslogger.setLevel(logging.WARNING)
750
968
        console.setLevel(logging.WARNING)
751
969
    
752
970
    if server_settings["servicename"] != "Mandos":
753
 
        syslogger.setFormatter(logging.Formatter\
 
971
        syslogger.setFormatter(logging.Formatter
754
972
                               ('Mandos (%s): %%(levelname)s:'
755
973
                                ' %%(message)s'
756
974
                                % server_settings["servicename"]))
758
976
    # Parse config file with clients
759
977
    client_defaults = { "timeout": "1h",
760
978
                        "interval": "5m",
761
 
                        "checker": "fping -q -- %(host)s",
 
979
                        "checker": "fping -q -- %%(host)s",
762
980
                        "host": "",
763
981
                        }
764
982
    client_config = ConfigParser.SafeConfigParser(client_defaults)
777
995
    except IOError, error:
778
996
        logger.error("Could not open file %r", pidfilename)
779
997
    
780
 
    uid = 65534
781
 
    gid = 65534
782
 
    try:
783
 
        uid = pwd.getpwnam("mandos").pw_uid
784
 
    except KeyError:
785
 
        try:
786
 
            uid = pwd.getpwnam("nobody").pw_uid
787
 
        except KeyError:
788
 
            pass
789
 
    try:
790
 
        gid = pwd.getpwnam("mandos").pw_gid
791
 
    except KeyError:
792
 
        try:
793
 
            gid = pwd.getpwnam("nogroup").pw_gid
794
 
        except KeyError:
795
 
            pass
 
998
    try:
 
999
        uid = pwd.getpwnam("_mandos").pw_uid
 
1000
        gid = pwd.getpwnam("_mandos").pw_gid
 
1001
    except KeyError:
 
1002
        try:
 
1003
            uid = pwd.getpwnam("mandos").pw_uid
 
1004
            gid = pwd.getpwnam("mandos").pw_gid
 
1005
        except KeyError:
 
1006
            try:
 
1007
                uid = pwd.getpwnam("nobody").pw_uid
 
1008
                gid = pwd.getpwnam("nogroup").pw_gid
 
1009
            except KeyError:
 
1010
                uid = 65534
 
1011
                gid = 65534
796
1012
    try:
797
1013
        os.setuid(uid)
798
1014
        os.setgid(gid)
804
1020
    service = AvahiService(name = server_settings["servicename"],
805
1021
                           servicetype = "_mandos._tcp", )
806
1022
    if server_settings["interface"]:
807
 
        service.interface = if_nametoindex\
808
 
                            (server_settings["interface"])
 
1023
        service.interface = (if_nametoindex
 
1024
                             (server_settings["interface"]))
809
1025
    
810
1026
    global main_loop
811
1027
    global bus
818
1034
                                           avahi.DBUS_PATH_SERVER),
819
1035
                            avahi.DBUS_INTERFACE_SERVER)
820
1036
    # End of Avahi example code
821
 
    
822
 
    def remove_from_clients(client):
823
 
        clients.remove(client)
824
 
        if not clients:
825
 
            logger.critical(u"No clients left, exiting")
826
 
            sys.exit()
 
1037
    if use_dbus:
 
1038
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
827
1039
    
828
1040
    clients.update(Set(Client(name = section,
829
 
                              stop_hook = remove_from_clients,
830
1041
                              config
831
 
                              = dict(client_config.items(section)))
 
1042
                              = dict(client_config.items(section)),
 
1043
                              use_dbus = use_dbus)
832
1044
                       for section in client_config.sections()))
833
1045
    if not clients:
834
 
        logger.critical(u"No clients defined")
835
 
        sys.exit(1)
 
1046
        logger.warning(u"No clients defined")
836
1047
    
837
1048
    if debug:
838
1049
        # Redirect stdin so all checkers get /dev/null
870
1081
        
871
1082
        while clients:
872
1083
            client = clients.pop()
873
 
            client.stop_hook = None
874
 
            client.stop()
 
1084
            client.disable_hook = None
 
1085
            client.disable()
875
1086
    
876
1087
    atexit.register(cleanup)
877
1088
    
880
1091
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
881
1092
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
882
1093
    
 
1094
    if use_dbus:
 
1095
        class MandosServer(dbus.service.Object):
 
1096
            """A D-Bus proxy object"""
 
1097
            def __init__(self):
 
1098
                dbus.service.Object.__init__(self, bus, "/")
 
1099
            _interface = u"se.bsnet.fukt.Mandos"
 
1100
            
 
1101
            @dbus.service.signal(_interface, signature="oa{sv}")
 
1102
            def ClientAdded(self, objpath, properties):
 
1103
                "D-Bus signal"
 
1104
                pass
 
1105
            
 
1106
            @dbus.service.signal(_interface, signature="os")
 
1107
            def ClientRemoved(self, objpath, name):
 
1108
                "D-Bus signal"
 
1109
                pass
 
1110
            
 
1111
            @dbus.service.method(_interface, out_signature="ao")
 
1112
            def GetAllClients(self):
 
1113
                return dbus.Array(c.dbus_object_path for c in clients)
 
1114
            
 
1115
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
 
1116
            def GetAllClientsWithProperties(self):
 
1117
                return dbus.Dictionary(
 
1118
                    ((c.dbus_object_path, c.GetAllProperties())
 
1119
                     for c in clients),
 
1120
                    signature="oa{sv}")
 
1121
            
 
1122
            @dbus.service.method(_interface, in_signature="o")
 
1123
            def RemoveClient(self, object_path):
 
1124
                for c in clients:
 
1125
                    if c.dbus_object_path == object_path:
 
1126
                        clients.remove(c)
 
1127
                        # Don't signal anything except ClientRemoved
 
1128
                        c.use_dbus = False
 
1129
                        c.disable()
 
1130
                        # Emit D-Bus signal
 
1131
                        self.ClientRemoved(object_path, c.name)
 
1132
                        return
 
1133
                raise KeyError
 
1134
            
 
1135
            del _interface
 
1136
        
 
1137
        mandos_server = MandosServer()
 
1138
    
883
1139
    for client in clients:
884
 
        client.start()
 
1140
        if use_dbus:
 
1141
            # Emit D-Bus signal
 
1142
            mandos_server.ClientAdded(client.dbus_object_path,
 
1143
                                      client.GetAllProperties())
 
1144
        client.enable()
885
1145
    
886
1146
    tcp_server.enable()
887
1147
    tcp_server.server_activate()
905
1165
        
906
1166
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
907
1167
                             lambda *args, **kwargs:
908
 
                             tcp_server.handle_request\
909
 
                             (*args[2:], **kwargs) or True)
 
1168
                             (tcp_server.handle_request
 
1169
                              (*args[2:], **kwargs) or True))
910
1170
        
911
1171
        logger.debug(u"Starting main loop")
912
1172
        main_loop.run()
913
1173
    except AvahiError, error:
914
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
1174
        logger.critical(u"AvahiError: %s", error)
915
1175
        sys.exit(1)
916
1176
    except KeyboardInterrupt:
917
1177
        if debug: