/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-08-22 00:16:20 UTC
  • mfrom: (24.1.57 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080822001620-vxpn1evy0t0kyvj0
* clients.conf ([DEFAULT]/checker): Update to new default value.

* mandos (Client.start_checker): Bug fix: OSError, not
                                 subprocess.OSError.
  (main): Use "fping -q -- %(host)s" instead of "fping -q --
          %%(host)s" as default value for "checker".  Always redirect
          stdin to be from /dev/null, even if in debug mode.

* mandos-clients.conf.xml (DESCRIPTION): Improved wording and refer to
                                         the EXPANSION section.
  (OPTIONS): Added synopsis and improved wording for "checker",
             "fingerprint", and "secret".  Refer to the RUNTIME
             EXPANSION section for the "checker" option.
  (EXAMPLE): Update to new default value for "checker".

* mandos-keygen (trap): Split lines and add "set +e".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
 
3
# 
 
4
# Mandos server - give out binary blobs to connecting clients.
 
5
# 
 
6
# This program is partly derived from an example program for an Avahi
 
7
# service publisher, downloaded from
 
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
 
9
# methods "add" and "remove" in the "AvahiService" class, the
 
10
# "server_state_changed" and "entry_group_state_changed" functions,
 
11
# and some lines in "main".
 
12
# 
 
13
# Everything else is
 
14
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
15
# 
 
16
# This program is free software: you can redistribute it and/or modify
 
17
# it under the terms of the GNU General Public License as published by
 
18
# the Free Software Foundation, either version 3 of the License, or
 
19
# (at your option) any later version.
 
20
#
 
21
#     This program is distributed in the hope that it will be useful,
 
22
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
23
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
24
#     GNU General Public License for more details.
 
25
# 
 
26
# You should have received a copy of the GNU General Public License
 
27
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
28
# 
 
29
# Contact the authors at <mandos@fukt.bsnet.se>.
 
30
# 
 
31
 
 
32
from __future__ import division
 
33
 
 
34
import SocketServer
 
35
import socket
 
36
import select
 
37
from optparse import OptionParser
 
38
import datetime
 
39
import errno
 
40
import gnutls.crypto
 
41
import gnutls.connection
 
42
import gnutls.errors
 
43
import gnutls.library.functions
 
44
import gnutls.library.constants
 
45
import gnutls.library.types
 
46
import ConfigParser
 
47
import sys
 
48
import re
 
49
import os
 
50
import signal
 
51
from sets import Set
 
52
import subprocess
 
53
import atexit
 
54
import stat
 
55
import logging
 
56
import logging.handlers
 
57
 
 
58
import dbus
 
59
import gobject
 
60
import avahi
 
61
from dbus.mainloop.glib import DBusGMainLoop
 
62
import ctypes
 
63
 
 
64
version = "1.0"
 
65
 
 
66
logger = logging.Logger('mandos')
 
67
syslogger = logging.handlers.SysLogHandler\
 
68
            (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
69
             address = "/dev/log")
 
70
syslogger.setFormatter(logging.Formatter\
 
71
                        ('Mandos: %(levelname)s: %(message)s'))
 
72
logger.addHandler(syslogger)
 
73
 
 
74
console = logging.StreamHandler()
 
75
console.setFormatter(logging.Formatter('%(name)s: %(levelname)s:'
 
76
                                       ' %(message)s'))
 
77
logger.addHandler(console)
 
78
 
 
79
class AvahiError(Exception):
 
80
    def __init__(self, value):
 
81
        self.value = value
 
82
    def __str__(self):
 
83
        return repr(self.value)
 
84
 
 
85
class AvahiServiceError(AvahiError):
 
86
    pass
 
87
 
 
88
class AvahiGroupError(AvahiError):
 
89
    pass
 
90
 
 
91
 
 
92
class AvahiService(object):
 
93
    """An Avahi (Zeroconf) service.
 
94
    Attributes:
 
95
    interface: integer; avahi.IF_UNSPEC or an interface index.
 
96
               Used to optionally bind to the specified interface.
 
97
    name: string; Example: 'Mandos'
 
98
    type: string; Example: '_mandos._tcp'.
 
99
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
100
    port: integer; what port to announce
 
101
    TXT: list of strings; TXT record for the service
 
102
    domain: string; Domain to publish on, default to .local if empty.
 
103
    host: string; Host to publish records for, default is localhost
 
104
    max_renames: integer; maximum number of renames
 
105
    rename_count: integer; counter so we only rename after collisions
 
106
                  a sensible number of times
 
107
    """
 
108
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
109
                 type = None, port = None, TXT = None, domain = "",
 
110
                 host = "", max_renames = 32768):
 
111
        self.interface = interface
 
112
        self.name = name
 
113
        self.type = type
 
114
        self.port = port
 
115
        if TXT is None:
 
116
            self.TXT = []
 
117
        else:
 
118
            self.TXT = TXT
 
119
        self.domain = domain
 
120
        self.host = host
 
121
        self.rename_count = 0
 
122
        self.max_renames = max_renames
 
123
    def rename(self):
 
124
        """Derived from the Avahi example code"""
 
125
        if self.rename_count >= self.max_renames:
 
126
            logger.critical(u"No suitable service name found after %i"
 
127
                            u" retries, exiting.", rename_count)
 
128
            raise AvahiServiceError("Too many renames")
 
129
        self.name = server.GetAlternativeServiceName(self.name)
 
130
        logger.info(u"Changing name to %r ...", str(self.name))
 
131
        syslogger.setFormatter(logging.Formatter\
 
132
                               ('Mandos (%s): %%(levelname)s:'
 
133
                               ' %%(message)s' % self.name))
 
134
        self.remove()
 
135
        self.add()
 
136
        self.rename_count += 1
 
137
    def remove(self):
 
138
        """Derived from the Avahi example code"""
 
139
        if group is not None:
 
140
            group.Reset()
 
141
    def add(self):
 
142
        """Derived from the Avahi example code"""
 
143
        global group
 
144
        if group is None:
 
145
            group = dbus.Interface\
 
146
                    (bus.get_object(avahi.DBUS_NAME,
 
147
                                    server.EntryGroupNew()),
 
148
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
149
            group.connect_to_signal('StateChanged',
 
150
                                    entry_group_state_changed)
 
151
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
152
                     service.name, service.type)
 
153
        group.AddService(
 
154
                self.interface,         # interface
 
155
                avahi.PROTO_INET6,      # protocol
 
156
                dbus.UInt32(0),         # flags
 
157
                self.name, self.type,
 
158
                self.domain, self.host,
 
159
                dbus.UInt16(self.port),
 
160
                avahi.string_array_to_txt_array(self.TXT))
 
161
        group.Commit()
 
162
 
 
163
# From the Avahi example code:
 
164
group = None                            # our entry group
 
165
# End of Avahi example code
 
166
 
 
167
 
 
168
class Client(object):
 
169
    """A representation of a client host served by this server.
 
170
    Attributes:
 
171
    name:      string; from the config file, used in log messages
 
172
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
173
                 uniquely identify the client
 
174
    secret:    bytestring; sent verbatim (over TLS) to client
 
175
    host:      string; available for use by the checker command
 
176
    created:   datetime.datetime(); object creation, not client host
 
177
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
178
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
179
                                     until this client is invalid
 
180
    interval:  datetime.timedelta(); How often to start a new checker
 
181
    stop_hook: If set, called by stop() as stop_hook(self)
 
182
    checker:   subprocess.Popen(); a running checker process used
 
183
                                   to see if the client lives.
 
184
                                   'None' if no process is running.
 
185
    checker_initiator_tag: a gobject event source tag, or None
 
186
    stop_initiator_tag:    - '' -
 
187
    checker_callback_tag:  - '' -
 
188
    checker_command: string; External command which is run to check if
 
189
                     client lives.  %() expansions are done at
 
190
                     runtime with vars(self) as dict, so that for
 
191
                     instance %(name)s can be used in the command.
 
192
    Private attibutes:
 
193
    _timeout: Real variable for 'timeout'
 
194
    _interval: Real variable for 'interval'
 
195
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
196
    _interval_milliseconds: - '' -
 
197
    """
 
198
    def _set_timeout(self, timeout):
 
199
        "Setter function for 'timeout' attribute"
 
200
        self._timeout = timeout
 
201
        self._timeout_milliseconds = ((self.timeout.days
 
202
                                       * 24 * 60 * 60 * 1000)
 
203
                                      + (self.timeout.seconds * 1000)
 
204
                                      + (self.timeout.microseconds
 
205
                                         // 1000))
 
206
    timeout = property(lambda self: self._timeout,
 
207
                       _set_timeout)
 
208
    del _set_timeout
 
209
    def _set_interval(self, interval):
 
210
        "Setter function for 'interval' attribute"
 
211
        self._interval = interval
 
212
        self._interval_milliseconds = ((self.interval.days
 
213
                                        * 24 * 60 * 60 * 1000)
 
214
                                       + (self.interval.seconds
 
215
                                          * 1000)
 
216
                                       + (self.interval.microseconds
 
217
                                          // 1000))
 
218
    interval = property(lambda self: self._interval,
 
219
                        _set_interval)
 
220
    del _set_interval
 
221
    def __init__(self, name = None, stop_hook=None, config={}):
 
222
        """Note: the 'checker' key in 'config' sets the
 
223
        'checker_command' attribute and *not* the 'checker'
 
224
        attribute."""
 
225
        self.name = name
 
226
        logger.debug(u"Creating client %r", self.name)
 
227
        # Uppercase and remove spaces from fingerprint for later
 
228
        # comparison purposes with return value from the fingerprint()
 
229
        # function
 
230
        self.fingerprint = config["fingerprint"].upper()\
 
231
                           .replace(u" ", u"")
 
232
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
233
        if "secret" in config:
 
234
            self.secret = config["secret"].decode(u"base64")
 
235
        elif "secfile" in config:
 
236
            sf = open(config["secfile"])
 
237
            self.secret = sf.read()
 
238
            sf.close()
 
239
        else:
 
240
            raise TypeError(u"No secret or secfile for client %s"
 
241
                            % self.name)
 
242
        self.host = config.get("host", "")
 
243
        self.created = datetime.datetime.now()
 
244
        self.last_checked_ok = None
 
245
        self.timeout = string_to_delta(config["timeout"])
 
246
        self.interval = string_to_delta(config["interval"])
 
247
        self.stop_hook = stop_hook
 
248
        self.checker = None
 
249
        self.checker_initiator_tag = None
 
250
        self.stop_initiator_tag = None
 
251
        self.checker_callback_tag = None
 
252
        self.check_command = config["checker"]
 
253
    def start(self):
 
254
        """Start this client's checker and timeout hooks"""
 
255
        # Schedule a new checker to be started an 'interval' from now,
 
256
        # and every interval from then on.
 
257
        self.checker_initiator_tag = gobject.timeout_add\
 
258
                                     (self._interval_milliseconds,
 
259
                                      self.start_checker)
 
260
        # Also start a new checker *right now*.
 
261
        self.start_checker()
 
262
        # Schedule a stop() when 'timeout' has passed
 
263
        self.stop_initiator_tag = gobject.timeout_add\
 
264
                                  (self._timeout_milliseconds,
 
265
                                   self.stop)
 
266
    def stop(self):
 
267
        """Stop this client.
 
268
        The possibility that a client might be restarted is left open,
 
269
        but not currently used."""
 
270
        # If this client doesn't have a secret, it is already stopped.
 
271
        if hasattr(self, "secret") and self.secret:
 
272
            logger.info(u"Stopping client %s", self.name)
 
273
            self.secret = None
 
274
        else:
 
275
            return False
 
276
        if getattr(self, "stop_initiator_tag", False):
 
277
            gobject.source_remove(self.stop_initiator_tag)
 
278
            self.stop_initiator_tag = None
 
279
        if getattr(self, "checker_initiator_tag", False):
 
280
            gobject.source_remove(self.checker_initiator_tag)
 
281
            self.checker_initiator_tag = None
 
282
        self.stop_checker()
 
283
        if self.stop_hook:
 
284
            self.stop_hook(self)
 
285
        # Do not run this again if called by a gobject.timeout_add
 
286
        return False
 
287
    def __del__(self):
 
288
        self.stop_hook = None
 
289
        self.stop()
 
290
    def checker_callback(self, pid, condition):
 
291
        """The checker has completed, so take appropriate actions."""
 
292
        now = datetime.datetime.now()
 
293
        self.checker_callback_tag = None
 
294
        self.checker = None
 
295
        if os.WIFEXITED(condition) \
 
296
               and (os.WEXITSTATUS(condition) == 0):
 
297
            logger.info(u"Checker for %(name)s succeeded",
 
298
                        vars(self))
 
299
            self.last_checked_ok = now
 
300
            gobject.source_remove(self.stop_initiator_tag)
 
301
            self.stop_initiator_tag = gobject.timeout_add\
 
302
                                      (self._timeout_milliseconds,
 
303
                                       self.stop)
 
304
        elif not os.WIFEXITED(condition):
 
305
            logger.warning(u"Checker for %(name)s crashed?",
 
306
                           vars(self))
 
307
        else:
 
308
            logger.info(u"Checker for %(name)s failed",
 
309
                        vars(self))
 
310
    def start_checker(self):
 
311
        """Start a new checker subprocess if one is not running.
 
312
        If a checker already exists, leave it running and do
 
313
        nothing."""
 
314
        # The reason for not killing a running checker is that if we
 
315
        # did that, then if a checker (for some reason) started
 
316
        # running slowly and taking more than 'interval' time, the
 
317
        # client would inevitably timeout, since no checker would get
 
318
        # a chance to run to completion.  If we instead leave running
 
319
        # checkers alone, the checker would have to take more time
 
320
        # than 'timeout' for the client to be declared invalid, which
 
321
        # is as it should be.
 
322
        if self.checker is None:
 
323
            try:
 
324
                # In case check_command has exactly one % operator
 
325
                command = self.check_command % self.host
 
326
            except TypeError:
 
327
                # Escape attributes for the shell
 
328
                escaped_attrs = dict((key, re.escape(str(val)))
 
329
                                     for key, val in
 
330
                                     vars(self).iteritems())
 
331
                try:
 
332
                    command = self.check_command % escaped_attrs
 
333
                except TypeError, error:
 
334
                    logger.error(u'Could not format string "%s":'
 
335
                                 u' %s', self.check_command, error)
 
336
                    return True # Try again later
 
337
            try:
 
338
                logger.info(u"Starting checker %r for %s",
 
339
                            command, self.name)
 
340
                # We don't need to redirect stdout and stderr, since
 
341
                # in normal mode, that is already done by daemon(),
 
342
                # and in debug mode we don't want to.  (Stdin is
 
343
                # always replaced by /dev/null.)
 
344
                self.checker = subprocess.Popen(command,
 
345
                                                close_fds=True,
 
346
                                                shell=True, cwd="/")
 
347
                self.checker_callback_tag = gobject.child_watch_add\
 
348
                                            (self.checker.pid,
 
349
                                             self.checker_callback)
 
350
            except OSError, error:
 
351
                logger.error(u"Failed to start subprocess: %s",
 
352
                             error)
 
353
        # Re-run this periodically if run by gobject.timeout_add
 
354
        return True
 
355
    def stop_checker(self):
 
356
        """Force the checker process, if any, to stop."""
 
357
        if self.checker_callback_tag:
 
358
            gobject.source_remove(self.checker_callback_tag)
 
359
            self.checker_callback_tag = None
 
360
        if getattr(self, "checker", None) is None:
 
361
            return
 
362
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
363
        try:
 
364
            os.kill(self.checker.pid, signal.SIGTERM)
 
365
            #os.sleep(0.5)
 
366
            #if self.checker.poll() is None:
 
367
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
368
        except OSError, error:
 
369
            if error.errno != errno.ESRCH: # No such process
 
370
                raise
 
371
        self.checker = None
 
372
    def still_valid(self):
 
373
        """Has the timeout not yet passed for this client?"""
 
374
        now = datetime.datetime.now()
 
375
        if self.last_checked_ok is None:
 
376
            return now < (self.created + self.timeout)
 
377
        else:
 
378
            return now < (self.last_checked_ok + self.timeout)
 
379
 
 
380
 
 
381
def peer_certificate(session):
 
382
    "Return the peer's OpenPGP certificate as a bytestring"
 
383
    # If not an OpenPGP certificate...
 
384
    if gnutls.library.functions.gnutls_certificate_type_get\
 
385
            (session._c_object) \
 
386
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
387
        # ...do the normal thing
 
388
        return session.peer_certificate
 
389
    list_size = ctypes.c_uint()
 
390
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
391
        (session._c_object, ctypes.byref(list_size))
 
392
    if list_size.value == 0:
 
393
        return None
 
394
    cert = cert_list[0]
 
395
    return ctypes.string_at(cert.data, cert.size)
 
396
 
 
397
 
 
398
def fingerprint(openpgp):
 
399
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
400
    # New GnuTLS "datum" with the OpenPGP public key
 
401
    datum = gnutls.library.types.gnutls_datum_t\
 
402
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
403
                     ctypes.POINTER(ctypes.c_ubyte)),
 
404
         ctypes.c_uint(len(openpgp)))
 
405
    # New empty GnuTLS certificate
 
406
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
407
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
408
        (ctypes.byref(crt))
 
409
    # Import the OpenPGP public key into the certificate
 
410
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
411
                    (crt, ctypes.byref(datum),
 
412
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
413
    # New buffer for the fingerprint
 
414
    buffer = ctypes.create_string_buffer(20)
 
415
    buffer_length = ctypes.c_size_t()
 
416
    # Get the fingerprint from the certificate into the buffer
 
417
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
418
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
419
    # Deinit the certificate
 
420
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
421
    # Convert the buffer to a Python bytestring
 
422
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
423
    # Convert the bytestring to hexadecimal notation
 
424
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
425
    return hex_fpr
 
426
 
 
427
 
 
428
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
429
    """A TCP request handler class.
 
430
    Instantiated by IPv6_TCPServer for each request to handle it.
 
431
    Note: This will run in its own forked process."""
 
432
    
 
433
    def handle(self):
 
434
        logger.info(u"TCP connection from: %s",
 
435
                     unicode(self.client_address))
 
436
        session = gnutls.connection.ClientSession\
 
437
                  (self.request, gnutls.connection.X509Credentials())
 
438
        
 
439
        line = self.request.makefile().readline()
 
440
        logger.debug(u"Protocol version: %r", line)
 
441
        try:
 
442
            if int(line.strip().split()[0]) > 1:
 
443
                raise RuntimeError
 
444
        except (ValueError, IndexError, RuntimeError), error:
 
445
            logger.error(u"Unknown protocol version: %s", error)
 
446
            return
 
447
        
 
448
        # Note: gnutls.connection.X509Credentials is really a generic
 
449
        # GnuTLS certificate credentials object so long as no X.509
 
450
        # keys are added to it.  Therefore, we can use it here despite
 
451
        # using OpenPGP certificates.
 
452
        
 
453
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
454
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
455
        #                "+DHE-DSS"))
 
456
        priority = "NORMAL"             # Fallback default, since this
 
457
                                        # MUST be set.
 
458
        if self.server.settings["priority"]:
 
459
            priority = self.server.settings["priority"]
 
460
        gnutls.library.functions.gnutls_priority_set_direct\
 
461
            (session._c_object, priority, None);
 
462
        
 
463
        try:
 
464
            session.handshake()
 
465
        except gnutls.errors.GNUTLSError, error:
 
466
            logger.warning(u"Handshake failed: %s", error)
 
467
            # Do not run session.bye() here: the session is not
 
468
            # established.  Just abandon the request.
 
469
            return
 
470
        try:
 
471
            fpr = fingerprint(peer_certificate(session))
 
472
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
473
            logger.warning(u"Bad certificate: %s", error)
 
474
            session.bye()
 
475
            return
 
476
        logger.debug(u"Fingerprint: %s", fpr)
 
477
        client = None
 
478
        for c in self.server.clients:
 
479
            if c.fingerprint == fpr:
 
480
                client = c
 
481
                break
 
482
        if not client:
 
483
            logger.warning(u"Client not found for fingerprint: %s",
 
484
                           fpr)
 
485
            session.bye()
 
486
            return
 
487
        # Have to check if client.still_valid(), since it is possible
 
488
        # that the client timed out while establishing the GnuTLS
 
489
        # session.
 
490
        if not client.still_valid():
 
491
            logger.warning(u"Client %(name)s is invalid",
 
492
                           vars(client))
 
493
            session.bye()
 
494
            return
 
495
        sent_size = 0
 
496
        while sent_size < len(client.secret):
 
497
            sent = session.send(client.secret[sent_size:])
 
498
            logger.debug(u"Sent: %d, remaining: %d",
 
499
                         sent, len(client.secret)
 
500
                         - (sent_size + sent))
 
501
            sent_size += sent
 
502
        session.bye()
 
503
 
 
504
 
 
505
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
506
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
507
    Attributes:
 
508
        settings:       Server settings
 
509
        clients:        Set() of Client objects
 
510
    """
 
511
    address_family = socket.AF_INET6
 
512
    def __init__(self, *args, **kwargs):
 
513
        if "settings" in kwargs:
 
514
            self.settings = kwargs["settings"]
 
515
            del kwargs["settings"]
 
516
        if "clients" in kwargs:
 
517
            self.clients = kwargs["clients"]
 
518
            del kwargs["clients"]
 
519
        return super(type(self), self).__init__(*args, **kwargs)
 
520
    def server_bind(self):
 
521
        """This overrides the normal server_bind() function
 
522
        to bind to an interface if one was specified, and also NOT to
 
523
        bind to an address or port if they were not specified."""
 
524
        if self.settings["interface"]:
 
525
            # 25 is from /usr/include/asm-i486/socket.h
 
526
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
527
            try:
 
528
                self.socket.setsockopt(socket.SOL_SOCKET,
 
529
                                       SO_BINDTODEVICE,
 
530
                                       self.settings["interface"])
 
531
            except socket.error, error:
 
532
                if error[0] == errno.EPERM:
 
533
                    logger.error(u"No permission to"
 
534
                                 u" bind to interface %s",
 
535
                                 self.settings["interface"])
 
536
                else:
 
537
                    raise error
 
538
        # Only bind(2) the socket if we really need to.
 
539
        if self.server_address[0] or self.server_address[1]:
 
540
            if not self.server_address[0]:
 
541
                in6addr_any = "::"
 
542
                self.server_address = (in6addr_any,
 
543
                                       self.server_address[1])
 
544
            elif not self.server_address[1]:
 
545
                self.server_address = (self.server_address[0],
 
546
                                       0)
 
547
#                 if self.settings["interface"]:
 
548
#                     self.server_address = (self.server_address[0],
 
549
#                                            0, # port
 
550
#                                            0, # flowinfo
 
551
#                                            if_nametoindex
 
552
#                                            (self.settings
 
553
#                                             ["interface"]))
 
554
            return super(type(self), self).server_bind()
 
555
 
 
556
 
 
557
def string_to_delta(interval):
 
558
    """Parse a string and return a datetime.timedelta
 
559
 
 
560
    >>> string_to_delta('7d')
 
561
    datetime.timedelta(7)
 
562
    >>> string_to_delta('60s')
 
563
    datetime.timedelta(0, 60)
 
564
    >>> string_to_delta('60m')
 
565
    datetime.timedelta(0, 3600)
 
566
    >>> string_to_delta('24h')
 
567
    datetime.timedelta(1)
 
568
    >>> string_to_delta(u'1w')
 
569
    datetime.timedelta(7)
 
570
    >>> string_to_delta('5m 30s')
 
571
    datetime.timedelta(0, 330)
 
572
    """
 
573
    timevalue = datetime.timedelta(0)
 
574
    for s in interval.split():
 
575
        try:
 
576
            suffix=unicode(s[-1])
 
577
            value=int(s[:-1])
 
578
            if suffix == u"d":
 
579
                delta = datetime.timedelta(value)
 
580
            elif suffix == u"s":
 
581
                delta = datetime.timedelta(0, value)
 
582
            elif suffix == u"m":
 
583
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
584
            elif suffix == u"h":
 
585
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
586
            elif suffix == u"w":
 
587
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
588
            else:
 
589
                raise ValueError
 
590
        except (ValueError, IndexError):
 
591
            raise ValueError
 
592
        timevalue += delta
 
593
    return timevalue
 
594
 
 
595
 
 
596
def server_state_changed(state):
 
597
    """Derived from the Avahi example code"""
 
598
    if state == avahi.SERVER_COLLISION:
 
599
        logger.error(u"Server name collision")
 
600
        service.remove()
 
601
    elif state == avahi.SERVER_RUNNING:
 
602
        service.add()
 
603
 
 
604
 
 
605
def entry_group_state_changed(state, error):
 
606
    """Derived from the Avahi example code"""
 
607
    logger.debug(u"state change: %i", state)
 
608
    
 
609
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
610
        logger.debug(u"Service established.")
 
611
    elif state == avahi.ENTRY_GROUP_COLLISION:
 
612
        logger.warning(u"Service name collision.")
 
613
        service.rename()
 
614
    elif state == avahi.ENTRY_GROUP_FAILURE:
 
615
        logger.critical(u"Error in group state changed %s",
 
616
                        unicode(error))
 
617
        raise AvahiGroupError("State changed: %s", str(error))
 
618
 
 
619
def if_nametoindex(interface):
 
620
    """Call the C function if_nametoindex(), or equivalent"""
 
621
    global if_nametoindex
 
622
    try:
 
623
        if "ctypes.util" not in sys.modules:
 
624
            import ctypes.util
 
625
        if_nametoindex = ctypes.cdll.LoadLibrary\
 
626
            (ctypes.util.find_library("c")).if_nametoindex
 
627
    except (OSError, AttributeError):
 
628
        if "struct" not in sys.modules:
 
629
            import struct
 
630
        if "fcntl" not in sys.modules:
 
631
            import fcntl
 
632
        def if_nametoindex(interface):
 
633
            "Get an interface index the hard way, i.e. using fcntl()"
 
634
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
635
            s = socket.socket()
 
636
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
637
                                struct.pack("16s16x", interface))
 
638
            s.close()
 
639
            interface_index = struct.unpack("I", ifreq[16:20])[0]
 
640
            return interface_index
 
641
    return if_nametoindex(interface)
 
642
 
 
643
 
 
644
def daemon(nochdir = False, noclose = False):
 
645
    """See daemon(3).  Standard BSD Unix function.
 
646
    This should really exist as os.daemon, but it doesn't (yet)."""
 
647
    if os.fork():
 
648
        sys.exit()
 
649
    os.setsid()
 
650
    if not nochdir:
 
651
        os.chdir("/")
 
652
    if os.fork():
 
653
        sys.exit()
 
654
    if not noclose:
 
655
        # Close all standard open file descriptors
 
656
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
657
        if not stat.S_ISCHR(os.fstat(null).st_mode):
 
658
            raise OSError(errno.ENODEV,
 
659
                          "/dev/null not a character device")
 
660
        os.dup2(null, sys.stdin.fileno())
 
661
        os.dup2(null, sys.stdout.fileno())
 
662
        os.dup2(null, sys.stderr.fileno())
 
663
        if null > 2:
 
664
            os.close(null)
 
665
 
 
666
 
 
667
def main():
 
668
    global main_loop_started
 
669
    main_loop_started = False
 
670
    
 
671
    parser = OptionParser(version = "%%prog %s" % version)
 
672
    parser.add_option("-i", "--interface", type="string",
 
673
                      metavar="IF", help="Bind to interface IF")
 
674
    parser.add_option("-a", "--address", type="string",
 
675
                      help="Address to listen for requests on")
 
676
    parser.add_option("-p", "--port", type="int",
 
677
                      help="Port number to receive requests on")
 
678
    parser.add_option("--check", action="store_true", default=False,
 
679
                      help="Run self-test")
 
680
    parser.add_option("--debug", action="store_true",
 
681
                      help="Debug mode; run in foreground and log to"
 
682
                      " terminal")
 
683
    parser.add_option("--priority", type="string", help="GnuTLS"
 
684
                      " priority string (see GnuTLS documentation)")
 
685
    parser.add_option("--servicename", type="string", metavar="NAME",
 
686
                      help="Zeroconf service name")
 
687
    parser.add_option("--configdir", type="string",
 
688
                      default="/etc/mandos", metavar="DIR",
 
689
                      help="Directory to search for configuration"
 
690
                      " files")
 
691
    (options, args) = parser.parse_args()
 
692
    
 
693
    if options.check:
 
694
        import doctest
 
695
        doctest.testmod()
 
696
        sys.exit()
 
697
    
 
698
    # Default values for config file for server-global settings
 
699
    server_defaults = { "interface": "",
 
700
                        "address": "",
 
701
                        "port": "",
 
702
                        "debug": "False",
 
703
                        "priority":
 
704
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
705
                        "servicename": "Mandos",
 
706
                        }
 
707
    
 
708
    # Parse config file for server-global settings
 
709
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
710
    del server_defaults
 
711
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
712
    # Convert the SafeConfigParser object to a dict
 
713
    server_settings = server_config.defaults()
 
714
    # Use getboolean on the boolean config option
 
715
    server_settings["debug"] = server_config.getboolean\
 
716
                               ("DEFAULT", "debug")
 
717
    del server_config
 
718
    
 
719
    # Override the settings from the config file with command line
 
720
    # options, if set.
 
721
    for option in ("interface", "address", "port", "debug",
 
722
                   "priority", "servicename", "configdir"):
 
723
        value = getattr(options, option)
 
724
        if value is not None:
 
725
            server_settings[option] = value
 
726
    del options
 
727
    # Now we have our good server settings in "server_settings"
 
728
    
 
729
    debug = server_settings["debug"]
 
730
    
 
731
    if not debug:
 
732
        syslogger.setLevel(logging.WARNING)
 
733
        console.setLevel(logging.WARNING)
 
734
    
 
735
    if server_settings["servicename"] != "Mandos":
 
736
        syslogger.setFormatter(logging.Formatter\
 
737
                               ('Mandos (%s): %%(levelname)s:'
 
738
                                ' %%(message)s'
 
739
                                % server_settings["servicename"]))
 
740
    
 
741
    # Parse config file with clients
 
742
    client_defaults = { "timeout": "1h",
 
743
                        "interval": "5m",
 
744
                        "checker": "fping -q -- %(host)s",
 
745
                        "host": "",
 
746
                        }
 
747
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
748
    client_config.read(os.path.join(server_settings["configdir"],
 
749
                                    "clients.conf"))
 
750
    
 
751
    global service
 
752
    service = AvahiService(name = server_settings["servicename"],
 
753
                           type = "_mandos._tcp", );
 
754
    if server_settings["interface"]:
 
755
        service.interface = if_nametoindex(server_settings["interface"])
 
756
    
 
757
    global main_loop
 
758
    global bus
 
759
    global server
 
760
    # From the Avahi example code
 
761
    DBusGMainLoop(set_as_default=True )
 
762
    main_loop = gobject.MainLoop()
 
763
    bus = dbus.SystemBus()
 
764
    server = dbus.Interface(
 
765
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
766
            avahi.DBUS_INTERFACE_SERVER )
 
767
    # End of Avahi example code
 
768
    
 
769
    clients = Set()
 
770
    def remove_from_clients(client):
 
771
        clients.remove(client)
 
772
        if not clients:
 
773
            logger.critical(u"No clients left, exiting")
 
774
            sys.exit()
 
775
    
 
776
    clients.update(Set(Client(name = section,
 
777
                              stop_hook = remove_from_clients,
 
778
                              config
 
779
                              = dict(client_config.items(section)))
 
780
                       for section in client_config.sections()))
 
781
    if not clients:
 
782
        logger.critical(u"No clients defined")
 
783
        sys.exit(1)
 
784
    
 
785
    if debug:
 
786
        # Redirect stdin so all checkers get /dev/null
 
787
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
788
        os.dup2(null, sys.stdin.fileno())
 
789
        if null > 2:
 
790
            os.close(null)
 
791
    else:
 
792
        # No console logging
 
793
        logger.removeHandler(console)
 
794
        # Close all input and output, do double fork, etc.
 
795
        daemon()
 
796
    
 
797
    pidfilename = "/var/run/mandos/mandos.pid"
 
798
    pid = os.getpid()
 
799
    try:
 
800
        pidfile = open(pidfilename, "w")
 
801
        pidfile.write(str(pid) + "\n")
 
802
        pidfile.close()
 
803
        del pidfile
 
804
    except IOError, err:
 
805
        logger.error(u"Could not write %s file with PID %d",
 
806
                     pidfilename, os.getpid())
 
807
    
 
808
    def cleanup():
 
809
        "Cleanup function; run on exit"
 
810
        global group
 
811
        # From the Avahi example code
 
812
        if not group is None:
 
813
            group.Free()
 
814
            group = None
 
815
        # End of Avahi example code
 
816
        
 
817
        while clients:
 
818
            client = clients.pop()
 
819
            client.stop_hook = None
 
820
            client.stop()
 
821
    
 
822
    atexit.register(cleanup)
 
823
    
 
824
    if not debug:
 
825
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
826
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
827
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
828
    
 
829
    for client in clients:
 
830
        client.start()
 
831
    
 
832
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
833
                                 server_settings["port"]),
 
834
                                tcp_handler,
 
835
                                settings=server_settings,
 
836
                                clients=clients)
 
837
    # Find out what port we got
 
838
    service.port = tcp_server.socket.getsockname()[1]
 
839
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
840
                u" scope_id %d" % tcp_server.socket.getsockname())
 
841
    
 
842
    #service.interface = tcp_server.socket.getsockname()[3]
 
843
    
 
844
    try:
 
845
        # From the Avahi example code
 
846
        server.connect_to_signal("StateChanged", server_state_changed)
 
847
        try:
 
848
            server_state_changed(server.GetState())
 
849
        except dbus.exceptions.DBusException, error:
 
850
            logger.critical(u"DBusException: %s", error)
 
851
            sys.exit(1)
 
852
        # End of Avahi example code
 
853
        
 
854
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
855
                             lambda *args, **kwargs:
 
856
                             tcp_server.handle_request\
 
857
                             (*args[2:], **kwargs) or True)
 
858
        
 
859
        logger.debug(u"Starting main loop")
 
860
        main_loop_started = True
 
861
        main_loop.run()
 
862
    except AvahiError, error:
 
863
        logger.critical(u"AvahiError: %s" + unicode(error))
 
864
        sys.exit(1)
 
865
    except KeyboardInterrupt:
 
866
        if debug:
 
867
            print
 
868
 
 
869
if __name__ == '__main__':
 
870
    main()