/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

* mandos (peer_certificate): Handle NULL pointer from
                             "gnutls_certificate_get_peers" slightly
                             better.
  (TCP_handler.handle): Added some extra debug output.

  (MandosServer.GetAllClients,
  MandosServer.GetAllClientsWithProperties,
  MandosServer.RemoveClient): Added doc string.

Show diffs side-by-side

added added

removed removed

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