/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: 2008-10-18 10:58:29 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081018105829-qaav4114v6pengqr
* Makefile (all): Also depend on "mandos.lsm".
  (mandos.lsm): New; update version and date fields.

* mandos.lsm: New; for submission to ibiblio.org, and possibly others.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
16
15
17
16
# This program is free software: you can redistribute it and/or modify
18
17
# it under the terms of the GNU General Public License as published by
31
30
# Contact the authors at <mandos@fukt.bsnet.se>.
32
31
33
32
 
34
 
from __future__ import division, with_statement, absolute_import
 
33
from __future__ import division
35
34
 
36
35
import SocketServer
37
36
import socket
38
 
import optparse
 
37
from optparse import OptionParser
39
38
import datetime
40
39
import errno
41
40
import gnutls.crypto
56
55
import logging
57
56
import logging.handlers
58
57
import pwd
59
 
from contextlib import closing
60
58
 
61
59
import dbus
62
 
import dbus.service
63
60
import gobject
64
61
import avahi
65
62
from dbus.mainloop.glib import DBusGMainLoop
66
63
import ctypes
67
64
import ctypes.util
68
65
 
69
 
version = "1.0.5"
 
66
version = "1.0.2"
70
67
 
71
68
logger = logging.Logger('mandos')
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'))
 
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'))
77
74
logger.addHandler(syslogger)
78
75
 
79
76
console = logging.StreamHandler()
82
79
logger.addHandler(console)
83
80
 
84
81
class AvahiError(Exception):
85
 
    def __init__(self, value, *args, **kwargs):
 
82
    def __init__(self, value):
86
83
        self.value = value
87
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
88
 
    def __unicode__(self):
89
 
        return unicode(repr(self.value))
 
84
        super(AvahiError, self).__init__()
 
85
    def __str__(self):
 
86
        return repr(self.value)
90
87
 
91
88
class AvahiServiceError(AvahiError):
92
89
    pass
112
109
                  a sensible number of times
113
110
    """
114
111
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
 
                 servicetype = None, port = None, TXT = None,
116
 
                 domain = "", host = "", max_renames = 32768):
 
112
                 servicetype = None, port = None, TXT = None, domain = "",
 
113
                 host = "", max_renames = 32768):
117
114
        self.interface = interface
118
115
        self.name = name
119
116
        self.type = servicetype
120
117
        self.port = port
121
 
        self.TXT = TXT if TXT is not None else []
 
118
        if TXT is None:
 
119
            self.TXT = []
 
120
        else:
 
121
            self.TXT = TXT
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(u"Too many renames")
 
132
            raise AvahiServiceError("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(bus.get_object
151
 
                                   (avahi.DBUS_NAME,
 
150
            group = dbus.Interface\
 
151
                    (bus.get_object(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
 
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):
 
173
class Client(object):
179
174
    """A representation of a client host served by this server.
180
175
    Attributes:
181
 
    name:       string; from the config file, used in log messages and
182
 
                        D-Bus identifiers
 
176
    name:      string; from the config file, used in log messages
183
177
    fingerprint: string (40 or 32 hexadecimal digits); used to
184
178
                 uniquely identify the client
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.
 
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.
198
190
    checker_initiator_tag: a gobject event source tag, or None
199
 
    disable_initiator_tag:    - '' -
 
191
    stop_initiator_tag:    - '' -
200
192
    checker_callback_tag:  - '' -
201
193
    checker_command: string; External command which is run to check if
202
194
                     client lives.  %() expansions are done at
203
195
                     runtime with vars(self) as dict, so that for
204
196
                     instance %(name)s can be used in the command.
205
 
    use_dbus: bool(); Whether to provide D-Bus interface and signals
206
 
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
 
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: - '' -
207
202
    """
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):
 
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):
222
227
        """Note: the 'checker' key in 'config' sets the
223
228
        'checker_command' attribute and *not* the 'checker'
224
229
        attribute."""
225
 
        self.name = name
226
230
        if config is None:
227
231
            config = {}
 
232
        self.name = name
228
233
        logger.debug(u"Creating client %r", self.name)
229
 
        self.use_dbus = False   # During __init__
230
234
        # Uppercase and remove spaces from fingerprint for later
231
235
        # comparison purposes with return value from the fingerprint()
232
236
        # function
233
 
        self.fingerprint = (config["fingerprint"].upper()
234
 
                            .replace(u" ", u""))
 
237
        self.fingerprint = config["fingerprint"].upper()\
 
238
                           .replace(u" ", u"")
235
239
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
240
        if "secret" in config:
237
241
            self.secret = config["secret"].decode(u"base64")
238
242
        elif "secfile" in config:
239
 
            with closing(open(os.path.expanduser
240
 
                              (os.path.expandvars
241
 
                               (config["secfile"])))) as secfile:
242
 
                self.secret = secfile.read()
 
243
            secfile = open(os.path.expanduser(os.path.expandvars
 
244
                                              (config["secfile"])))
 
245
            self.secret = secfile.read()
 
246
            secfile.close()
243
247
        else:
244
248
            raise TypeError(u"No secret or secfile for client %s"
245
249
                            % self.name)
246
250
        self.host = config.get("host", "")
247
 
        self.created = datetime.datetime.utcnow()
248
 
        self.enabled = False
249
 
        self.last_enabled = None
 
251
        self.created = datetime.datetime.now()
250
252
        self.last_checked_ok = None
251
253
        self.timeout = string_to_delta(config["timeout"])
252
254
        self.interval = string_to_delta(config["interval"])
253
 
        self.disable_hook = disable_hook
 
255
        self.stop_hook = stop_hook
254
256
        self.checker = None
255
257
        self.checker_initiator_tag = None
256
 
        self.disable_initiator_tag = None
 
258
        self.stop_initiator_tag = None
257
259
        self.checker_callback_tag = None
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):
 
260
        self.check_command = config["checker"]
 
261
    def start(self):
271
262
        """Start this client's checker and timeout hooks"""
272
 
        self.last_enabled = datetime.datetime.utcnow()
273
263
        # Schedule a new checker to be started an 'interval' from now,
274
264
        # and every interval from then on.
275
 
        self.checker_initiator_tag = (gobject.timeout_add
276
 
                                      (self.interval_milliseconds(),
277
 
                                       self.start_checker))
 
265
        self.checker_initiator_tag = gobject.timeout_add\
 
266
                                     (self._interval_milliseconds,
 
267
                                      self.start_checker)
278
268
        # Also start a new checker *right now*.
279
269
        self.start_checker()
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):
 
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:
296
283
            return False
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
 
284
        if getattr(self, "stop_initiator_tag", False):
 
285
            gobject.source_remove(self.stop_initiator_tag)
 
286
            self.stop_initiator_tag = None
301
287
        if getattr(self, "checker_initiator_tag", False):
302
288
            gobject.source_remove(self.checker_initiator_tag)
303
289
            self.checker_initiator_tag = None
304
290
        self.stop_checker()
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))
 
291
        if self.stop_hook:
 
292
            self.stop_hook(self)
312
293
        # Do not run this again if called by a gobject.timeout_add
313
294
        return False
314
 
    
315
295
    def __del__(self):
316
 
        self.disable_hook = None
317
 
        self.disable()
318
 
    
319
 
    def checker_callback(self, pid, condition, command):
 
296
        self.stop_hook = None
 
297
        self.stop()
 
298
    def checker_callback(self, pid, condition):
320
299
        """The checker has completed, so take appropriate actions."""
 
300
        now = datetime.datetime.now()
321
301
        self.checker_callback_tag = None
322
302
        self.checker = None
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.checked_ok()
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:
 
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):
342
313
            logger.warning(u"Checker for %(name)s crashed?",
343
314
                           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 checked_ok(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
 
    
 
315
        else:
 
316
            logger.info(u"Checker for %(name)s failed",
 
317
                        vars(self))
367
318
    def start_checker(self):
368
319
        """Start a new checker subprocess if one is not running.
369
320
        If a checker already exists, leave it running and do
378
329
        # is as it should be.
379
330
        if self.checker is None:
380
331
            try:
381
 
                # In case checker_command has exactly one % operator
382
 
                command = self.checker_command % self.host
 
332
                # In case check_command has exactly one % operator
 
333
                command = self.check_command % self.host
383
334
            except TypeError:
384
335
                # Escape attributes for the shell
385
336
                escaped_attrs = dict((key, re.escape(str(val)))
386
337
                                     for key, val in
387
338
                                     vars(self).iteritems())
388
339
                try:
389
 
                    command = self.checker_command % escaped_attrs
 
340
                    command = self.check_command % escaped_attrs
390
341
                except TypeError, error:
391
342
                    logger.error(u'Could not format string "%s":'
392
 
                                 u' %s', self.checker_command, error)
 
343
                                 u' %s', self.check_command, error)
393
344
                    return True # Try again later
394
345
            try:
395
346
                logger.info(u"Starting checker %r for %s",
401
352
                self.checker = subprocess.Popen(command,
402
353
                                                close_fds=True,
403
354
                                                shell=True, cwd="/")
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))
 
355
                self.checker_callback_tag = gobject.child_watch_add\
 
356
                                            (self.checker.pid,
 
357
                                             self.checker_callback)
414
358
            except OSError, error:
415
359
                logger.error(u"Failed to start subprocess: %s",
416
360
                             error)
417
361
        # Re-run this periodically if run by gobject.timeout_add
418
362
        return True
419
 
    
420
363
    def stop_checker(self):
421
364
        """Force the checker process, if any, to stop."""
422
365
        if self.checker_callback_tag:
434
377
            if error.errno != errno.ESRCH: # No such process
435
378
                raise
436
379
        self.checker = None
437
 
        if self.use_dbus:
438
 
            self.PropertyChanged(dbus.String(u"checker_running"),
439
 
                                 dbus.Boolean(False, variant_level=1))
440
 
    
441
380
    def still_valid(self):
442
381
        """Has the timeout not yet passed for this client?"""
443
 
        if not getattr(self, "enabled", False):
444
 
            return False
445
 
        now = datetime.datetime.utcnow()
 
382
        now = datetime.datetime.now()
446
383
        if self.last_checked_ok is None:
447
384
            return now < (self.created + self.timeout)
448
385
        else:
449
386
            return now < (self.last_checked_ok + self.timeout)
450
 
    
451
 
    ## D-Bus methods & signals
452
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
453
 
    
454
 
    # CheckedOK - method
455
 
    CheckedOK = dbus.service.method(_interface)(checked_ok)
456
 
    CheckedOK.__name__ = "CheckedOK"
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
588
387
 
589
388
 
590
389
def peer_certificate(session):
591
390
    "Return the peer's OpenPGP certificate as a bytestring"
592
391
    # If not an OpenPGP certificate...
593
 
    if (gnutls.library.functions
594
 
        .gnutls_certificate_type_get(session._c_object)
595
 
        != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
392
    if gnutls.library.functions.gnutls_certificate_type_get\
 
393
            (session._c_object) \
 
394
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
596
395
        # ...do the normal thing
597
396
        return session.peer_certificate
598
 
    list_size = ctypes.c_uint(1)
599
 
    cert_list = (gnutls.library.functions
600
 
                 .gnutls_certificate_get_peers
601
 
                 (session._c_object, ctypes.byref(list_size)))
602
 
    if not bool(cert_list) and list_size.value != 0:
603
 
        raise gnutls.errors.GNUTLSError("error getting peer"
604
 
                                        " certificate")
 
397
    list_size = ctypes.c_uint()
 
398
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
399
        (session._c_object, ctypes.byref(list_size))
605
400
    if list_size.value == 0:
606
401
        return None
607
402
    cert = cert_list[0]
611
406
def fingerprint(openpgp):
612
407
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
613
408
    # New GnuTLS "datum" with the OpenPGP public key
614
 
    datum = (gnutls.library.types
615
 
             .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
616
 
                                         ctypes.POINTER
617
 
                                         (ctypes.c_ubyte)),
618
 
                             ctypes.c_uint(len(openpgp))))
 
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)))
619
413
    # New empty GnuTLS certificate
620
414
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
621
 
    (gnutls.library.functions
622
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
415
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
416
        (ctypes.byref(crt))
623
417
    # Import the OpenPGP public key into the certificate
624
 
    (gnutls.library.functions
625
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
626
 
                                gnutls.library.constants
627
 
                                .GNUTLS_OPENPGP_FMT_RAW))
 
418
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
419
                    (crt, ctypes.byref(datum),
 
420
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
628
421
    # Verify the self signature in the key
629
422
    crtverify = ctypes.c_uint()
630
 
    (gnutls.library.functions
631
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
 
423
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
424
        (crt, 0, ctypes.byref(crtverify))
632
425
    if crtverify.value != 0:
633
426
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
634
427
        raise gnutls.errors.CertificateSecurityError("Verify failed")
636
429
    buf = ctypes.create_string_buffer(20)
637
430
    buf_len = ctypes.c_size_t()
638
431
    # Get the fingerprint from the certificate into the buffer
639
 
    (gnutls.library.functions
640
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
641
 
                                         ctypes.byref(buf_len)))
 
432
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
433
        (crt, ctypes.byref(buf), ctypes.byref(buf_len))
642
434
    # Deinit the certificate
643
435
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
644
436
    # Convert the buffer to a Python bytestring
655
447
    
656
448
    def handle(self):
657
449
        logger.info(u"TCP connection from: %s",
658
 
                    unicode(self.client_address))
659
 
        session = (gnutls.connection
660
 
                   .ClientSession(self.request,
661
 
                                  gnutls.connection
662
 
                                  .X509Credentials()))
 
450
                     unicode(self.client_address))
 
451
        session = gnutls.connection.ClientSession\
 
452
                  (self.request, gnutls.connection.X509Credentials())
663
453
        
664
454
        line = self.request.makefile().readline()
665
455
        logger.debug(u"Protocol version: %r", line)
678
468
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
679
469
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
680
470
        #                "+DHE-DSS"))
681
 
        # Use a fallback default, since this MUST be set.
682
 
        priority = self.server.settings.get("priority", "NORMAL")
683
 
        (gnutls.library.functions
684
 
         .gnutls_priority_set_direct(session._c_object,
685
 
                                     priority, None))
 
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)
686
477
        
687
478
        try:
688
479
            session.handshake()
691
482
            # Do not run session.bye() here: the session is not
692
483
            # established.  Just abandon the request.
693
484
            return
694
 
        logger.debug(u"Handshake succeeded")
695
485
        try:
696
486
            fpr = fingerprint(peer_certificate(session))
697
487
        except (TypeError, gnutls.errors.GNUTLSError), error:
699
489
            session.bye()
700
490
            return
701
491
        logger.debug(u"Fingerprint: %s", fpr)
702
 
        
 
492
        client = None
703
493
        for c in self.server.clients:
704
494
            if c.fingerprint == fpr:
705
495
                client = c
706
496
                break
707
 
        else:
 
497
        if not client:
708
498
            logger.warning(u"Client not found for fingerprint: %s",
709
499
                           fpr)
710
500
            session.bye()
717
507
                           vars(client))
718
508
            session.bye()
719
509
            return
720
 
        ## This won't work here, since we're in a fork.
721
 
        # client.checked_ok()
722
510
        sent_size = 0
723
511
        while sent_size < len(client.secret):
724
512
            sent = session.send(client.secret[sent_size:])
729
517
        session.bye()
730
518
 
731
519
 
732
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
733
 
                     SocketServer.TCPServer, object):
 
520
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
734
521
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
735
522
    Attributes:
736
523
        settings:       Server settings
791
578
 
792
579
def string_to_delta(interval):
793
580
    """Parse a string and return a datetime.timedelta
794
 
    
 
581
 
795
582
    >>> string_to_delta('7d')
796
583
    datetime.timedelta(7)
797
584
    >>> string_to_delta('60s')
849
636
    elif state == avahi.ENTRY_GROUP_FAILURE:
850
637
        logger.critical(u"Avahi: Error in group state changed %s",
851
638
                        unicode(error))
852
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
639
        raise AvahiGroupError("State changed: %s", str(error))
853
640
 
854
641
def if_nametoindex(interface):
855
642
    """Call the C function if_nametoindex(), or equivalent"""
856
643
    global if_nametoindex
857
644
    try:
858
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
859
 
                          (ctypes.util.find_library("c"))
860
 
                          .if_nametoindex)
 
645
        if_nametoindex = ctypes.cdll.LoadLibrary\
 
646
            (ctypes.util.find_library("c")).if_nametoindex
861
647
    except (OSError, AttributeError):
862
648
        if "struct" not in sys.modules:
863
649
            import struct
866
652
        def if_nametoindex(interface):
867
653
            "Get an interface index the hard way, i.e. using fcntl()"
868
654
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
869
 
            with closing(socket.socket()) as s:
870
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
871
 
                                    struct.pack("16s16x", interface))
 
655
            s = socket.socket()
 
656
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
657
                                struct.pack("16s16x", interface))
 
658
            s.close()
872
659
            interface_index = struct.unpack("I", ifreq[16:20])[0]
873
660
            return interface_index
874
661
    return if_nametoindex(interface)
898
685
 
899
686
 
900
687
def main():
901
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
688
    parser = OptionParser(version = "%%prog %s" % version)
902
689
    parser.add_option("-i", "--interface", type="string",
903
690
                      metavar="IF", help="Bind to interface IF")
904
691
    parser.add_option("-a", "--address", type="string",
905
692
                      help="Address to listen for requests on")
906
693
    parser.add_option("-p", "--port", type="int",
907
694
                      help="Port number to receive requests on")
908
 
    parser.add_option("--check", action="store_true",
 
695
    parser.add_option("--check", action="store_true", default=False,
909
696
                      help="Run self-test")
910
697
    parser.add_option("--debug", action="store_true",
911
698
                      help="Debug mode; run in foreground and log to"
918
705
                      default="/etc/mandos", metavar="DIR",
919
706
                      help="Directory to search for configuration"
920
707
                      " files")
921
 
    parser.add_option("--no-dbus", action="store_false",
922
 
                      dest="use_dbus",
923
 
                      help="Do not provide D-Bus system bus"
924
 
                      " interface")
925
708
    options = parser.parse_args()[0]
926
709
    
927
710
    if options.check:
937
720
                        "priority":
938
721
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
939
722
                        "servicename": "Mandos",
940
 
                        "use_dbus": "True",
941
723
                        }
942
724
    
943
725
    # Parse config file for server-global settings
946
728
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
947
729
    # Convert the SafeConfigParser object to a dict
948
730
    server_settings = server_config.defaults()
949
 
    # Use the appropriate methods on the non-string config options
950
 
    server_settings["debug"] = server_config.getboolean("DEFAULT",
951
 
                                                        "debug")
952
 
    server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
953
 
                                                           "use_dbus")
954
 
    if server_settings["port"]:
955
 
        server_settings["port"] = server_config.getint("DEFAULT",
956
 
                                                       "port")
 
731
    # Use getboolean on the boolean config option
 
732
    server_settings["debug"] = server_config.getboolean\
 
733
                               ("DEFAULT", "debug")
957
734
    del server_config
958
735
    
959
736
    # Override the settings from the config file with command line
960
737
    # options, if set.
961
738
    for option in ("interface", "address", "port", "debug",
962
 
                   "priority", "servicename", "configdir",
963
 
                   "use_dbus"):
 
739
                   "priority", "servicename", "configdir"):
964
740
        value = getattr(options, option)
965
741
        if value is not None:
966
742
            server_settings[option] = value
967
743
    del options
968
744
    # Now we have our good server settings in "server_settings"
969
745
    
970
 
    # For convenience
971
746
    debug = server_settings["debug"]
972
 
    use_dbus = server_settings["use_dbus"]
973
 
 
974
 
    def sigsegvhandler(signum, frame):
975
 
        raise RuntimeError('Segmentation fault')
976
747
    
977
748
    if not debug:
978
749
        syslogger.setLevel(logging.WARNING)
979
750
        console.setLevel(logging.WARNING)
980
 
    else:
981
 
        signal.signal(signal.SIGSEGV, sigsegvhandler)
982
751
    
983
752
    if server_settings["servicename"] != "Mandos":
984
 
        syslogger.setFormatter(logging.Formatter
 
753
        syslogger.setFormatter(logging.Formatter\
985
754
                               ('Mandos (%s): %%(levelname)s:'
986
755
                                ' %%(message)s'
987
756
                                % server_settings["servicename"]))
989
758
    # Parse config file with clients
990
759
    client_defaults = { "timeout": "1h",
991
760
                        "interval": "5m",
992
 
                        "checker": "fping -q -- %%(host)s",
 
761
                        "checker": "fping -q -- %(host)s",
993
762
                        "host": "",
994
763
                        }
995
764
    client_config = ConfigParser.SafeConfigParser(client_defaults)
1008
777
    except IOError, error:
1009
778
        logger.error("Could not open file %r", pidfilename)
1010
779
    
1011
 
    try:
1012
 
        uid = pwd.getpwnam("_mandos").pw_uid
1013
 
        gid = pwd.getpwnam("_mandos").pw_gid
1014
 
    except KeyError:
1015
 
        try:
1016
 
            uid = pwd.getpwnam("mandos").pw_uid
1017
 
            gid = pwd.getpwnam("mandos").pw_gid
1018
 
        except KeyError:
1019
 
            try:
1020
 
                uid = pwd.getpwnam("nobody").pw_uid
1021
 
                gid = pwd.getpwnam("nogroup").pw_gid
1022
 
            except KeyError:
1023
 
                uid = 65534
1024
 
                gid = 65534
1025
 
    try:
 
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
 
796
    try:
 
797
        os.setuid(uid)
1026
798
        os.setgid(gid)
1027
 
        os.setuid(uid)
1028
799
    except OSError, error:
1029
800
        if error[0] != errno.EPERM:
1030
801
            raise error
1031
802
    
1032
 
    # Enable all possible GnuTLS debugging
1033
 
    if debug:
1034
 
        # "Use a log level over 10 to enable all debugging options."
1035
 
        # - GnuTLS manual
1036
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
1037
 
        
1038
 
        @gnutls.library.types.gnutls_log_func
1039
 
        def debug_gnutls(level, string):
1040
 
            logger.debug("GnuTLS: %s", string[:-1])
1041
 
        
1042
 
        (gnutls.library.functions
1043
 
         .gnutls_global_set_log_function(debug_gnutls))
1044
 
    
1045
803
    global service
1046
804
    service = AvahiService(name = server_settings["servicename"],
1047
805
                           servicetype = "_mandos._tcp", )
1048
806
    if server_settings["interface"]:
1049
 
        service.interface = (if_nametoindex
1050
 
                             (server_settings["interface"]))
 
807
        service.interface = if_nametoindex\
 
808
                            (server_settings["interface"])
1051
809
    
1052
810
    global main_loop
1053
811
    global bus
1060
818
                                           avahi.DBUS_PATH_SERVER),
1061
819
                            avahi.DBUS_INTERFACE_SERVER)
1062
820
    # End of Avahi example code
1063
 
    if use_dbus:
1064
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
 
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()
1065
827
    
1066
828
    clients.update(Set(Client(name = section,
 
829
                              stop_hook = remove_from_clients,
1067
830
                              config
1068
 
                              = dict(client_config.items(section)),
1069
 
                              use_dbus = use_dbus)
 
831
                              = dict(client_config.items(section)))
1070
832
                       for section in client_config.sections()))
1071
833
    if not clients:
1072
 
        logger.warning(u"No clients defined")
 
834
        logger.critical(u"No clients defined")
 
835
        sys.exit(1)
1073
836
    
1074
837
    if debug:
1075
838
        # Redirect stdin so all checkers get /dev/null
1107
870
        
1108
871
        while clients:
1109
872
            client = clients.pop()
1110
 
            client.disable_hook = None
1111
 
            client.disable()
 
873
            client.stop_hook = None
 
874
            client.stop()
1112
875
    
1113
876
    atexit.register(cleanup)
1114
877
    
1117
880
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1118
881
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1119
882
    
1120
 
    if use_dbus:
1121
 
        class MandosServer(dbus.service.Object):
1122
 
            """A D-Bus proxy object"""
1123
 
            def __init__(self):
1124
 
                dbus.service.Object.__init__(self, bus, "/")
1125
 
            _interface = u"se.bsnet.fukt.Mandos"
1126
 
            
1127
 
            @dbus.service.signal(_interface, signature="oa{sv}")
1128
 
            def ClientAdded(self, objpath, properties):
1129
 
                "D-Bus signal"
1130
 
                pass
1131
 
            
1132
 
            @dbus.service.signal(_interface, signature="os")
1133
 
            def ClientRemoved(self, objpath, name):
1134
 
                "D-Bus signal"
1135
 
                pass
1136
 
            
1137
 
            @dbus.service.method(_interface, out_signature="ao")
1138
 
            def GetAllClients(self):
1139
 
                "D-Bus method"
1140
 
                return dbus.Array(c.dbus_object_path for c in clients)
1141
 
            
1142
 
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
1143
 
            def GetAllClientsWithProperties(self):
1144
 
                "D-Bus method"
1145
 
                return dbus.Dictionary(
1146
 
                    ((c.dbus_object_path, c.GetAllProperties())
1147
 
                     for c in clients),
1148
 
                    signature="oa{sv}")
1149
 
            
1150
 
            @dbus.service.method(_interface, in_signature="o")
1151
 
            def RemoveClient(self, object_path):
1152
 
                "D-Bus method"
1153
 
                for c in clients:
1154
 
                    if c.dbus_object_path == object_path:
1155
 
                        clients.remove(c)
1156
 
                        # Don't signal anything except ClientRemoved
1157
 
                        c.use_dbus = False
1158
 
                        c.disable()
1159
 
                        # Emit D-Bus signal
1160
 
                        self.ClientRemoved(object_path, c.name)
1161
 
                        return
1162
 
                raise KeyError
1163
 
            
1164
 
            del _interface
1165
 
        
1166
 
        mandos_server = MandosServer()
1167
 
    
1168
883
    for client in clients:
1169
 
        if use_dbus:
1170
 
            # Emit D-Bus signal
1171
 
            mandos_server.ClientAdded(client.dbus_object_path,
1172
 
                                      client.GetAllProperties())
1173
 
        client.enable()
 
884
        client.start()
1174
885
    
1175
886
    tcp_server.enable()
1176
887
    tcp_server.server_activate()
1194
905
        
1195
906
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1196
907
                             lambda *args, **kwargs:
1197
 
                             (tcp_server.handle_request
1198
 
                              (*args[2:], **kwargs) or True))
 
908
                             tcp_server.handle_request\
 
909
                             (*args[2:], **kwargs) or True)
1199
910
        
1200
911
        logger.debug(u"Starting main loop")
1201
912
        main_loop.run()
1202
913
    except AvahiError, error:
1203
 
        logger.critical(u"AvahiError: %s", error)
 
914
        logger.critical(u"AvahiError: %s" + unicode(error))
1204
915
        sys.exit(1)
1205
916
    except KeyboardInterrupt:
1206
917
        if debug: