/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 server.py

  • Committer: Teddy Hogeborn
  • Date: 2008-07-21 23:18:02 UTC
  • mfrom: (15.1.5 mandos) (15.1.5 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080721231802-0emzdsxkfy457p9u
merge

Show diffs side-by-side

added added

removed removed

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