/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-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

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 © 2007-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
import select
 
38
from optparse import OptionParser
39
39
import datetime
40
40
import errno
41
41
import gnutls.crypto
56
56
import logging
57
57
import logging.handlers
58
58
import pwd
59
 
from contextlib import closing
60
59
 
61
60
import dbus
62
 
import dbus.service
63
61
import gobject
64
62
import avahi
65
63
from dbus.mainloop.glib import DBusGMainLoop
66
64
import ctypes
67
 
import ctypes.util
68
65
 
69
 
version = "1.0.5"
 
66
version = "1.0"
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
    def __str__(self):
 
85
        return repr(self.value)
90
86
 
91
87
class AvahiServiceError(AvahiError):
92
88
    pass
112
108
                  a sensible number of times
113
109
    """
114
110
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
115
 
                 servicetype = None, port = None, TXT = None,
116
 
                 domain = "", host = "", max_renames = 32768):
 
111
                 type = None, port = None, TXT = None, domain = "",
 
112
                 host = "", max_renames = 32768):
117
113
        self.interface = interface
118
114
        self.name = name
119
 
        self.type = servicetype
 
115
        self.type = type
120
116
        self.port = port
121
 
        self.TXT = TXT if TXT is not None else []
 
117
        if TXT is None:
 
118
            self.TXT = []
 
119
        else:
 
120
            self.TXT = TXT
122
121
        self.domain = domain
123
122
        self.host = host
124
123
        self.rename_count = 0
128
127
        if self.rename_count >= self.max_renames:
129
128
            logger.critical(u"No suitable Zeroconf service name found"
130
129
                            u" after %i retries, exiting.",
131
 
                            self.rename_count)
132
 
            raise AvahiServiceError(u"Too many renames")
 
130
                            rename_count)
 
131
            raise AvahiServiceError("Too many renames")
133
132
        self.name = server.GetAlternativeServiceName(self.name)
134
133
        logger.info(u"Changing Zeroconf service name to %r ...",
135
134
                    str(self.name))
136
 
        syslogger.setFormatter(logging.Formatter
 
135
        syslogger.setFormatter(logging.Formatter\
137
136
                               ('Mandos (%s): %%(levelname)s:'
138
 
                                ' %%(message)s' % self.name))
 
137
                               ' %%(message)s' % self.name))
139
138
        self.remove()
140
139
        self.add()
141
140
        self.rename_count += 1
147
146
        """Derived from the Avahi example code"""
148
147
        global group
149
148
        if group is None:
150
 
            group = dbus.Interface(bus.get_object
151
 
                                   (avahi.DBUS_NAME,
 
149
            group = dbus.Interface\
 
150
                    (bus.get_object(avahi.DBUS_NAME,
152
151
                                    server.EntryGroupNew()),
153
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
152
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
154
153
            group.connect_to_signal('StateChanged',
155
154
                                    entry_group_state_changed)
156
155
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
170
169
# End of Avahi example code
171
170
 
172
171
 
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):
 
172
class Client(object):
179
173
    """A representation of a client host served by this server.
180
174
    Attributes:
181
 
    name:       string; from the config file, used in log messages and
182
 
                        D-Bus identifiers
 
175
    name:      string; from the config file, used in log messages
183
176
    fingerprint: string (40 or 32 hexadecimal digits); used to
184
177
                 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.
 
178
    secret:    bytestring; sent verbatim (over TLS) to client
 
179
    host:      string; available for use by the checker command
 
180
    created:   datetime.datetime(); object creation, not client host
 
181
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
182
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
183
                                     until this client is invalid
 
184
    interval:  datetime.timedelta(); How often to start a new checker
 
185
    stop_hook: If set, called by stop() as stop_hook(self)
 
186
    checker:   subprocess.Popen(); a running checker process used
 
187
                                   to see if the client lives.
 
188
                                   'None' if no process is running.
198
189
    checker_initiator_tag: a gobject event source tag, or None
199
 
    disable_initiator_tag:    - '' -
 
190
    stop_initiator_tag:    - '' -
200
191
    checker_callback_tag:  - '' -
201
192
    checker_command: string; External command which is run to check if
202
193
                     client lives.  %() expansions are done at
203
194
                     runtime with vars(self) as dict, so that for
204
195
                     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
 
196
    Private attibutes:
 
197
    _timeout: Real variable for 'timeout'
 
198
    _interval: Real variable for 'interval'
 
199
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
200
    _interval_milliseconds: - '' -
207
201
    """
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):
 
202
    def _set_timeout(self, timeout):
 
203
        "Setter function for 'timeout' attribute"
 
204
        self._timeout = timeout
 
205
        self._timeout_milliseconds = ((self.timeout.days
 
206
                                       * 24 * 60 * 60 * 1000)
 
207
                                      + (self.timeout.seconds * 1000)
 
208
                                      + (self.timeout.microseconds
 
209
                                         // 1000))
 
210
    timeout = property(lambda self: self._timeout,
 
211
                       _set_timeout)
 
212
    del _set_timeout
 
213
    def _set_interval(self, interval):
 
214
        "Setter function for 'interval' attribute"
 
215
        self._interval = interval
 
216
        self._interval_milliseconds = ((self.interval.days
 
217
                                        * 24 * 60 * 60 * 1000)
 
218
                                       + (self.interval.seconds
 
219
                                          * 1000)
 
220
                                       + (self.interval.microseconds
 
221
                                          // 1000))
 
222
    interval = property(lambda self: self._interval,
 
223
                        _set_interval)
 
224
    del _set_interval
 
225
    def __init__(self, name = None, stop_hook=None, config={}):
222
226
        """Note: the 'checker' key in 'config' sets the
223
227
        'checker_command' attribute and *not* the 'checker'
224
228
        attribute."""
225
229
        self.name = name
226
 
        if config is None:
227
 
            config = {}
228
230
        logger.debug(u"Creating client %r", self.name)
229
 
        self.use_dbus = False   # During __init__
230
231
        # Uppercase and remove spaces from fingerprint for later
231
232
        # comparison purposes with return value from the fingerprint()
232
233
        # function
233
 
        self.fingerprint = (config["fingerprint"].upper()
234
 
                            .replace(u" ", u""))
 
234
        self.fingerprint = config["fingerprint"].upper()\
 
235
                           .replace(u" ", u"")
235
236
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
236
237
        if "secret" in config:
237
238
            self.secret = config["secret"].decode(u"base64")
238
239
        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()
 
240
            sf = open(config["secfile"])
 
241
            self.secret = sf.read()
 
242
            sf.close()
243
243
        else:
244
244
            raise TypeError(u"No secret or secfile for client %s"
245
245
                            % self.name)
246
246
        self.host = config.get("host", "")
247
 
        self.created = datetime.datetime.utcnow()
248
 
        self.enabled = False
249
 
        self.last_enabled = None
 
247
        self.created = datetime.datetime.now()
250
248
        self.last_checked_ok = None
251
249
        self.timeout = string_to_delta(config["timeout"])
252
250
        self.interval = string_to_delta(config["interval"])
253
 
        self.disable_hook = disable_hook
 
251
        self.stop_hook = stop_hook
254
252
        self.checker = None
255
253
        self.checker_initiator_tag = None
256
 
        self.disable_initiator_tag = None
 
254
        self.stop_initiator_tag = None
257
255
        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):
 
256
        self.check_command = config["checker"]
 
257
    def start(self):
271
258
        """Start this client's checker and timeout hooks"""
272
 
        self.last_enabled = datetime.datetime.utcnow()
273
259
        # Schedule a new checker to be started an 'interval' from now,
274
260
        # and every interval from then on.
275
 
        self.checker_initiator_tag = (gobject.timeout_add
276
 
                                      (self.interval_milliseconds(),
277
 
                                       self.start_checker))
 
261
        self.checker_initiator_tag = gobject.timeout_add\
 
262
                                     (self._interval_milliseconds,
 
263
                                      self.start_checker)
278
264
        # Also start a new checker *right now*.
279
265
        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):
 
266
        # Schedule a stop() when 'timeout' has passed
 
267
        self.stop_initiator_tag = gobject.timeout_add\
 
268
                                  (self._timeout_milliseconds,
 
269
                                   self.stop)
 
270
    def stop(self):
 
271
        """Stop this client.
 
272
        The possibility that a client might be restarted is left open,
 
273
        but not currently used."""
 
274
        # If this client doesn't have a secret, it is already stopped.
 
275
        if hasattr(self, "secret") and self.secret:
 
276
            logger.info(u"Stopping client %s", self.name)
 
277
            self.secret = None
 
278
        else:
296
279
            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
 
280
        if getattr(self, "stop_initiator_tag", False):
 
281
            gobject.source_remove(self.stop_initiator_tag)
 
282
            self.stop_initiator_tag = None
301
283
        if getattr(self, "checker_initiator_tag", False):
302
284
            gobject.source_remove(self.checker_initiator_tag)
303
285
            self.checker_initiator_tag = None
304
286
        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))
 
287
        if self.stop_hook:
 
288
            self.stop_hook(self)
312
289
        # Do not run this again if called by a gobject.timeout_add
313
290
        return False
314
 
    
315
291
    def __del__(self):
316
 
        self.disable_hook = None
317
 
        self.disable()
318
 
    
319
 
    def checker_callback(self, pid, condition, command):
 
292
        self.stop_hook = None
 
293
        self.stop()
 
294
    def checker_callback(self, pid, condition):
320
295
        """The checker has completed, so take appropriate actions."""
 
296
        now = datetime.datetime.now()
321
297
        self.checker_callback_tag = None
322
298
        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.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:
 
299
        if os.WIFEXITED(condition) \
 
300
               and (os.WEXITSTATUS(condition) == 0):
 
301
            logger.info(u"Checker for %(name)s succeeded",
 
302
                        vars(self))
 
303
            self.last_checked_ok = now
 
304
            gobject.source_remove(self.stop_initiator_tag)
 
305
            self.stop_initiator_tag = gobject.timeout_add\
 
306
                                      (self._timeout_milliseconds,
 
307
                                       self.stop)
 
308
        elif not os.WIFEXITED(condition):
342
309
            logger.warning(u"Checker for %(name)s crashed?",
343
310
                           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
 
    
 
311
        else:
 
312
            logger.info(u"Checker for %(name)s failed",
 
313
                        vars(self))
367
314
    def start_checker(self):
368
315
        """Start a new checker subprocess if one is not running.
369
316
        If a checker already exists, leave it running and do
378
325
        # is as it should be.
379
326
        if self.checker is None:
380
327
            try:
381
 
                # In case checker_command has exactly one % operator
382
 
                command = self.checker_command % self.host
 
328
                # In case check_command has exactly one % operator
 
329
                command = self.check_command % self.host
383
330
            except TypeError:
384
331
                # Escape attributes for the shell
385
332
                escaped_attrs = dict((key, re.escape(str(val)))
386
333
                                     for key, val in
387
334
                                     vars(self).iteritems())
388
335
                try:
389
 
                    command = self.checker_command % escaped_attrs
 
336
                    command = self.check_command % escaped_attrs
390
337
                except TypeError, error:
391
338
                    logger.error(u'Could not format string "%s":'
392
 
                                 u' %s', self.checker_command, error)
 
339
                                 u' %s', self.check_command, error)
393
340
                    return True # Try again later
394
341
            try:
395
342
                logger.info(u"Starting checker %r for %s",
401
348
                self.checker = subprocess.Popen(command,
402
349
                                                close_fds=True,
403
350
                                                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))
 
351
                self.checker_callback_tag = gobject.child_watch_add\
 
352
                                            (self.checker.pid,
 
353
                                             self.checker_callback)
414
354
            except OSError, error:
415
355
                logger.error(u"Failed to start subprocess: %s",
416
356
                             error)
417
357
        # Re-run this periodically if run by gobject.timeout_add
418
358
        return True
419
 
    
420
359
    def stop_checker(self):
421
360
        """Force the checker process, if any, to stop."""
422
361
        if self.checker_callback_tag:
434
373
            if error.errno != errno.ESRCH: # No such process
435
374
                raise
436
375
        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
376
    def still_valid(self):
442
377
        """Has the timeout not yet passed for this client?"""
443
 
        if not getattr(self, "enabled", False):
444
 
            return False
445
 
        now = datetime.datetime.utcnow()
 
378
        now = datetime.datetime.now()
446
379
        if self.last_checked_ok is None:
447
380
            return now < (self.created + self.timeout)
448
381
        else:
449
382
            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
588
383
 
589
384
 
590
385
def peer_certificate(session):
591
386
    "Return the peer's OpenPGP certificate as a bytestring"
592
387
    # 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):
 
388
    if gnutls.library.functions.gnutls_certificate_type_get\
 
389
            (session._c_object) \
 
390
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
596
391
        # ...do the normal thing
597
392
        return session.peer_certificate
598
393
    list_size = ctypes.c_uint()
599
 
    cert_list = (gnutls.library.functions
600
 
                 .gnutls_certificate_get_peers
601
 
                 (session._c_object, ctypes.byref(list_size)))
 
394
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
395
        (session._c_object, ctypes.byref(list_size))
602
396
    if list_size.value == 0:
603
397
        return None
604
398
    cert = cert_list[0]
608
402
def fingerprint(openpgp):
609
403
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
610
404
    # New GnuTLS "datum" with the OpenPGP public key
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))))
 
405
    datum = gnutls.library.types.gnutls_datum_t\
 
406
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
407
                     ctypes.POINTER(ctypes.c_ubyte)),
 
408
         ctypes.c_uint(len(openpgp)))
616
409
    # New empty GnuTLS certificate
617
410
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
618
 
    (gnutls.library.functions
619
 
     .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
411
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
412
        (ctypes.byref(crt))
620
413
    # Import the OpenPGP public key into the certificate
621
 
    (gnutls.library.functions
622
 
     .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
623
 
                                gnutls.library.constants
624
 
                                .GNUTLS_OPENPGP_FMT_RAW))
 
414
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
415
                    (crt, ctypes.byref(datum),
 
416
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
625
417
    # Verify the self signature in the key
626
 
    crtverify = ctypes.c_uint()
627
 
    (gnutls.library.functions
628
 
     .gnutls_openpgp_crt_verify_self(crt, 0, ctypes.byref(crtverify)))
 
418
    crtverify = ctypes.c_uint();
 
419
    gnutls.library.functions.gnutls_openpgp_crt_verify_self\
 
420
        (crt, 0, ctypes.byref(crtverify))
629
421
    if crtverify.value != 0:
630
422
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
631
423
        raise gnutls.errors.CertificateSecurityError("Verify failed")
632
424
    # New buffer for the fingerprint
633
 
    buf = ctypes.create_string_buffer(20)
634
 
    buf_len = ctypes.c_size_t()
 
425
    buffer = ctypes.create_string_buffer(20)
 
426
    buffer_length = ctypes.c_size_t()
635
427
    # Get the fingerprint from the certificate into the buffer
636
 
    (gnutls.library.functions
637
 
     .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
638
 
                                         ctypes.byref(buf_len)))
 
428
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
429
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
639
430
    # Deinit the certificate
640
431
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
641
432
    # Convert the buffer to a Python bytestring
642
 
    fpr = ctypes.string_at(buf, buf_len.value)
 
433
    fpr = ctypes.string_at(buffer, buffer_length.value)
643
434
    # Convert the bytestring to hexadecimal notation
644
435
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
645
436
    return hex_fpr
646
437
 
647
438
 
648
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
 
439
class tcp_handler(SocketServer.BaseRequestHandler, object):
649
440
    """A TCP request handler class.
650
441
    Instantiated by IPv6_TCPServer for each request to handle it.
651
442
    Note: This will run in its own forked process."""
652
443
    
653
444
    def handle(self):
654
445
        logger.info(u"TCP connection from: %s",
655
 
                    unicode(self.client_address))
656
 
        session = (gnutls.connection
657
 
                   .ClientSession(self.request,
658
 
                                  gnutls.connection
659
 
                                  .X509Credentials()))
 
446
                     unicode(self.client_address))
 
447
        session = gnutls.connection.ClientSession\
 
448
                  (self.request, gnutls.connection.X509Credentials())
660
449
        
661
450
        line = self.request.makefile().readline()
662
451
        logger.debug(u"Protocol version: %r", line)
675
464
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
676
465
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
677
466
        #                "+DHE-DSS"))
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))
 
467
        priority = "NORMAL"             # Fallback default, since this
 
468
                                        # MUST be set.
 
469
        if self.server.settings["priority"]:
 
470
            priority = self.server.settings["priority"]
 
471
        gnutls.library.functions.gnutls_priority_set_direct\
 
472
            (session._c_object, priority, None);
683
473
        
684
474
        try:
685
475
            session.handshake()
695
485
            session.bye()
696
486
            return
697
487
        logger.debug(u"Fingerprint: %s", fpr)
 
488
        client = None
698
489
        for c in self.server.clients:
699
490
            if c.fingerprint == fpr:
700
491
                client = c
701
492
                break
702
 
        else:
 
493
        if not client:
703
494
            logger.warning(u"Client not found for fingerprint: %s",
704
495
                           fpr)
705
496
            session.bye()
712
503
                           vars(client))
713
504
            session.bye()
714
505
            return
715
 
        ## This won't work here, since we're in a fork.
716
 
        # client.bump_timeout()
717
506
        sent_size = 0
718
507
        while sent_size < len(client.secret):
719
508
            sent = session.send(client.secret[sent_size:])
724
513
        session.bye()
725
514
 
726
515
 
727
 
class IPv6_TCPServer(SocketServer.ForkingMixIn,
728
 
                     SocketServer.TCPServer, object):
 
516
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
729
517
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
730
518
    Attributes:
731
519
        settings:       Server settings
741
529
            self.clients = kwargs["clients"]
742
530
            del kwargs["clients"]
743
531
        self.enabled = False
744
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
532
        return super(type(self), self).__init__(*args, **kwargs)
745
533
    def server_bind(self):
746
534
        """This overrides the normal server_bind() function
747
535
        to bind to an interface if one was specified, and also NOT to
776
564
#                                            if_nametoindex
777
565
#                                            (self.settings
778
566
#                                             ["interface"]))
779
 
            return super(IPv6_TCPServer, self).server_bind()
 
567
            return super(type(self), self).server_bind()
780
568
    def server_activate(self):
781
569
        if self.enabled:
782
 
            return super(IPv6_TCPServer, self).server_activate()
 
570
            return super(type(self), self).server_activate()
783
571
    def enable(self):
784
572
        self.enabled = True
785
573
 
803
591
    timevalue = datetime.timedelta(0)
804
592
    for s in interval.split():
805
593
        try:
806
 
            suffix = unicode(s[-1])
807
 
            value = int(s[:-1])
 
594
            suffix=unicode(s[-1])
 
595
            value=int(s[:-1])
808
596
            if suffix == u"d":
809
597
                delta = datetime.timedelta(value)
810
598
            elif suffix == u"s":
844
632
    elif state == avahi.ENTRY_GROUP_FAILURE:
845
633
        logger.critical(u"Avahi: Error in group state changed %s",
846
634
                        unicode(error))
847
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
 
635
        raise AvahiGroupError("State changed: %s", str(error))
848
636
 
849
637
def if_nametoindex(interface):
850
638
    """Call the C function if_nametoindex(), or equivalent"""
851
639
    global if_nametoindex
852
640
    try:
853
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
854
 
                          (ctypes.util.find_library("c"))
855
 
                          .if_nametoindex)
 
641
        if "ctypes.util" not in sys.modules:
 
642
            import ctypes.util
 
643
        if_nametoindex = ctypes.cdll.LoadLibrary\
 
644
            (ctypes.util.find_library("c")).if_nametoindex
856
645
    except (OSError, AttributeError):
857
646
        if "struct" not in sys.modules:
858
647
            import struct
861
650
        def if_nametoindex(interface):
862
651
            "Get an interface index the hard way, i.e. using fcntl()"
863
652
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
864
 
            with closing(socket.socket()) as s:
865
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
866
 
                                    struct.pack("16s16x", interface))
 
653
            s = socket.socket()
 
654
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
655
                                struct.pack("16s16x", interface))
 
656
            s.close()
867
657
            interface_index = struct.unpack("I", ifreq[16:20])[0]
868
658
            return interface_index
869
659
    return if_nametoindex(interface)
893
683
 
894
684
 
895
685
def main():
896
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
686
    global main_loop_started
 
687
    main_loop_started = False
 
688
    
 
689
    parser = OptionParser(version = "%%prog %s" % version)
897
690
    parser.add_option("-i", "--interface", type="string",
898
691
                      metavar="IF", help="Bind to interface IF")
899
692
    parser.add_option("-a", "--address", type="string",
900
693
                      help="Address to listen for requests on")
901
694
    parser.add_option("-p", "--port", type="int",
902
695
                      help="Port number to receive requests on")
903
 
    parser.add_option("--check", action="store_true",
 
696
    parser.add_option("--check", action="store_true", default=False,
904
697
                      help="Run self-test")
905
698
    parser.add_option("--debug", action="store_true",
906
699
                      help="Debug mode; run in foreground and log to"
913
706
                      default="/etc/mandos", metavar="DIR",
914
707
                      help="Directory to search for configuration"
915
708
                      " 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")
920
 
    options = parser.parse_args()[0]
 
709
    (options, args) = parser.parse_args()
921
710
    
922
711
    if options.check:
923
712
        import doctest
932
721
                        "priority":
933
722
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
934
723
                        "servicename": "Mandos",
935
 
                        "use_dbus": "True",
936
724
                        }
937
725
    
938
726
    # Parse config file for server-global settings
941
729
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
942
730
    # Convert the SafeConfigParser object to a dict
943
731
    server_settings = server_config.defaults()
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"))
 
732
    # Use getboolean on the boolean config option
 
733
    server_settings["debug"] = server_config.getboolean\
 
734
                               ("DEFAULT", "debug")
949
735
    del server_config
950
736
    
951
737
    # Override the settings from the config file with command line
952
738
    # options, if set.
953
739
    for option in ("interface", "address", "port", "debug",
954
 
                   "priority", "servicename", "configdir",
955
 
                   "use_dbus"):
 
740
                   "priority", "servicename", "configdir"):
956
741
        value = getattr(options, option)
957
742
        if value is not None:
958
743
            server_settings[option] = value
959
744
    del options
960
745
    # Now we have our good server settings in "server_settings"
961
746
    
962
 
    # For convenience
963
747
    debug = server_settings["debug"]
964
 
    use_dbus = server_settings["use_dbus"]
965
748
    
966
749
    if not debug:
967
750
        syslogger.setLevel(logging.WARNING)
968
751
        console.setLevel(logging.WARNING)
969
752
    
970
753
    if server_settings["servicename"] != "Mandos":
971
 
        syslogger.setFormatter(logging.Formatter
 
754
        syslogger.setFormatter(logging.Formatter\
972
755
                               ('Mandos (%s): %%(levelname)s:'
973
756
                                ' %%(message)s'
974
757
                                % server_settings["servicename"]))
976
759
    # Parse config file with clients
977
760
    client_defaults = { "timeout": "1h",
978
761
                        "interval": "5m",
979
 
                        "checker": "fping -q -- %%(host)s",
 
762
                        "checker": "fping -q -- %(host)s",
980
763
                        "host": "",
981
764
                        }
982
765
    client_config = ConfigParser.SafeConfigParser(client_defaults)
986
769
    clients = Set()
987
770
    tcp_server = IPv6_TCPServer((server_settings["address"],
988
771
                                 server_settings["port"]),
989
 
                                TCP_handler,
 
772
                                tcp_handler,
990
773
                                settings=server_settings,
991
774
                                clients=clients)
992
775
    pidfilename = "/var/run/mandos.pid"
995
778
    except IOError, error:
996
779
        logger.error("Could not open file %r", pidfilename)
997
780
    
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
 
781
    uid = 65534
 
782
    gid = 65534
 
783
    try:
 
784
        uid = pwd.getpwnam("mandos").pw_uid
 
785
    except KeyError:
 
786
        try:
 
787
            uid = pwd.getpwnam("nobody").pw_uid
 
788
        except KeyError:
 
789
            pass
 
790
    try:
 
791
        gid = pwd.getpwnam("mandos").pw_gid
 
792
    except KeyError:
 
793
        try:
 
794
            gid = pwd.getpwnam("nogroup").pw_gid
 
795
        except KeyError:
 
796
            pass
1012
797
    try:
1013
798
        os.setuid(uid)
1014
799
        os.setgid(gid)
1018
803
    
1019
804
    global service
1020
805
    service = AvahiService(name = server_settings["servicename"],
1021
 
                           servicetype = "_mandos._tcp", )
 
806
                           type = "_mandos._tcp", );
1022
807
    if server_settings["interface"]:
1023
 
        service.interface = (if_nametoindex
1024
 
                             (server_settings["interface"]))
 
808
        service.interface = if_nametoindex\
 
809
                            (server_settings["interface"])
1025
810
    
1026
811
    global main_loop
1027
812
    global bus
1034
819
                                           avahi.DBUS_PATH_SERVER),
1035
820
                            avahi.DBUS_INTERFACE_SERVER)
1036
821
    # End of Avahi example code
1037
 
    if use_dbus:
1038
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
 
822
    
 
823
    def remove_from_clients(client):
 
824
        clients.remove(client)
 
825
        if not clients:
 
826
            logger.critical(u"No clients left, exiting")
 
827
            sys.exit()
1039
828
    
1040
829
    clients.update(Set(Client(name = section,
 
830
                              stop_hook = remove_from_clients,
1041
831
                              config
1042
 
                              = dict(client_config.items(section)),
1043
 
                              use_dbus = use_dbus)
 
832
                              = dict(client_config.items(section)))
1044
833
                       for section in client_config.sections()))
1045
834
    if not clients:
1046
 
        logger.warning(u"No clients defined")
 
835
        logger.critical(u"No clients defined")
 
836
        sys.exit(1)
1047
837
    
1048
838
    if debug:
1049
839
        # Redirect stdin so all checkers get /dev/null
1062
852
        pidfile.write(str(pid) + "\n")
1063
853
        pidfile.close()
1064
854
        del pidfile
1065
 
    except IOError:
 
855
    except IOError, err:
1066
856
        logger.error(u"Could not write to file %r with PID %d",
1067
857
                     pidfilename, pid)
1068
858
    except NameError:
1081
871
        
1082
872
        while clients:
1083
873
            client = clients.pop()
1084
 
            client.disable_hook = None
1085
 
            client.disable()
 
874
            client.stop_hook = None
 
875
            client.stop()
1086
876
    
1087
877
    atexit.register(cleanup)
1088
878
    
1091
881
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1092
882
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1093
883
    
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
 
    
1139
884
    for client in clients:
1140
 
        if use_dbus:
1141
 
            # Emit D-Bus signal
1142
 
            mandos_server.ClientAdded(client.dbus_object_path,
1143
 
                                      client.GetAllProperties())
1144
 
        client.enable()
 
885
        client.start()
1145
886
    
1146
887
    tcp_server.enable()
1147
888
    tcp_server.server_activate()
1165
906
        
1166
907
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1167
908
                             lambda *args, **kwargs:
1168
 
                             (tcp_server.handle_request
1169
 
                              (*args[2:], **kwargs) or True))
 
909
                             tcp_server.handle_request\
 
910
                             (*args[2:], **kwargs) or True)
1170
911
        
1171
912
        logger.debug(u"Starting main loop")
 
913
        main_loop_started = True
1172
914
        main_loop.run()
1173
915
    except AvahiError, error:
1174
 
        logger.critical(u"AvahiError: %s", error)
 
916
        logger.critical(u"AvahiError: %s" + unicode(error))
1175
917
        sys.exit(1)
1176
918
    except KeyboardInterrupt:
1177
919
        if debug: