/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

merge +
mandosclient
        Added a adjustbuffer function.

Show diffs side-by-side

added added

removed removed

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