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

mandosclient
        segmentation fault bug fixed

Show diffs side-by-side

added added

removed removed

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